Graph Import plugin
The Graph Import plugin allows you to import custom data into SquaredUp Cloud.
Using the JSON schema you can add new objects (known as vertices in the schema) and relationships (edges in the schema) to the Knowledge Graph.
This makes the objects available on dashboards, drilldowns and via the search.
This plugin is for advanced users, as the data must match the specified schema.
How to add the Graph Import plugin
In SquaredUp browse to Settings > Plugins > Add plugin and search for the plugin.
Enter a name for your plugin. This helps you to identify this plugin in the list of your plugins.
Provide a URL endpoint to fetch data from.
Choose either GET or POST as your HTTP method.
Leave the checkbox for Automatically create a workspace ticked, this will create a new workspace for this plugin containing out of the box dashboards and scopes.
Optionally, select whether you would like to restrict access to this plugin instance. By default, restricted access is set to off.Restrict access to this workspace?
The term plugin here really means plugin instance. For example, a user may configure two instances of the AWS plugin, one for their development environment and one for production. In that case, each plugin instance has its own access control settings.
By default, Restrict access to this plugin? is set to off. The plugin can be viewed, edited and administered by anyone. If you would like to control who has access to this plugin, switch Restrict access to this plugin? to on.
Use the Restrict access to this plugin? dropdown to control who has access to the workspace:
Plugin access levels
By default, the user setting the permissions for the plugin will be given Full Control and the Everyone group will be given Link to workspace permissions.
Tailor access to the plugin, as required, by selecting individual users or user groups from the dropdown and giving them Link to workspace or Full Control permissions.
If the user is not available from the dropdown, you are able to invite them to the plugin by typing in their email address and then clicking Add. The new user will then receive an email inviting them to create an account on SquaredUp Cloud. Once the account has been created, they will gain access to the tenant.
At least one user or group must be given Full Control.
Admin users can edit the configuration, modify the Access Control List (ACL) and delete the plugin, regardless of the ACL chosen.
Link to workspace
- User can link the plugin to any workspace they have at least Editor permissions for.
- Data from the plugin can then be viewed by anyone with any access to the workspace.
User can share the plugin data with anyone they want.
User cannot configure the plugin in any way, or delete it.
- User can change the plugin configuration, ACL, and delete the plugin.
See Access control for more information.
Using the Graph Import plugin
This plugin uses the JSON schema to import new objects into SquaredUp Cloud.
|Term||Description||Term used in JSON schema||Other terms|
|Object||An entity that can be described, such as a server, group, person etc.|
|node, entity, vertex object and item|
|Relationship||This is the link between two objects that defines the relationship between them.||Edge||label, connection, edge object and link|
The JSON schema
The data should contain one or both of the following two array properties:
"vertices": , // An array of vertices - see Vertex section below
"edges":  // An array of edges - see Edge section below
Mandatory and optional properties of each vertex are shown below. Other properties, specific to the particular object type the vertex represents may also be present.
|string||Mandatory||A unique id of this vertex within this instance of the plugin|
|string||Mandatory||A more specific type, name of relevance to the plugin (e.g. for scoping purposes). For example: “vmwareHost“|
|string||Mandatory||The name of the vertex to be displayed|
|string||Optional||A readable identifier of the plugin that imported the vertex|
"sourceId": "string", // Mandatory. Unique ID for this object, from your source - e.g. azure pipeline ID. This not not need to be globally unique, but should be unique within your data source.
"sourceType": "string", // Mandatory. the source type of this object, e.g. "Azure.DevOps.Project", "zendesk_ticket", etc.
"sourceName": "string", // Optional. Name displayed when grouping search results or in grouped visualizations like graph-nodes-as-blocks, e.g. "Azure DevOps Projects" or "Zendesk Tickets". If not provided, the underlying sourceType will be used instead.
"name": "string", // Mandatory. Name of the object, displayed in the UI.
"monitorUrl": "url", // Optional. If this is a monitor or an object being monitored (e.g. an app), specify the URL(s) being monitored. A single string or an array of strings can be specified where there are multiple monitored URLs.
"links": [ // Optional. An array of external links that will be shown in a dropdown in the web app on this item.
"url": "url", // Mandatory.
"label": "string" // Mandatory. Link text.
// Any other properties can be added and will be stored in the graph.
// These can then be used in tiles or for scoping / possibly filtering.
Each edge should contain the following three properties. Take great care that the label matches the direction of the edge. If your plugin has an edge type labeled “contains” intended to connect folder and file objects, the
inV value should be the
sourceId of the file object.
|A readable label for the edge (this will be shown in graph views in the UI)|
"outV": "string", // Mandatory. The from/source vertex (sourceId) for the edge.
"label": "string", // Mandatory. The label/verb for the edge, e.g. 'hosts' or 'serves'. The 'is' label is currently reserved for internal usage and is the only forbidden value.
"inV": "string" // Mandatory. The to/target vertex (sourceId) for the edge.
"label": "reports to"