JSON syntax: Nodes section

These settings determine the display settings for nodes. You must add a node for each asset type and complex relation type that you want to include in the diagram.

Note The JSON representation of a diagram is always automatically generated. The JSON syntax allows you to update the diagram layout. Keep in mind that it is much easier to add and edit overlays through the graphical diagram view editor. See Edit a diagram view and The Node properties form.

JSON syntax Description
"id": "Business Asset"
  • Determines the name of the node.
  • This setting is mandatory.
  • You can type any string here, but it must be unique in this view. For readability, we recommend using the name of the asset type or complex relation type as the ID.
  • You can refer to this node by using its ID in the "from" and "to" key-value pairs of the edges section.

"type": {"id": "00000000-0000-0000-0000-000000011001"}

"layoutRegion": "flow", "context"
  • Determine if the node is treated as a flow node or a context node. This influences the traversal strategy. An edge from a flow node to a context node is always included in the diagram. An edge between two flow nodes FN1 and FN2 is only included in the diagram if the edge from FN1 to FN2 is traversed in the same direction as the edge that brought FN1 into the diagram.
  • This setting is optional.
  • You can choose one of the following values:
    • "flow": The node is part of the flow. This is the default setting.
    • "context": The node is part of the context. When you select the Flow/Context layout for a diagram, the edges between flow nodes are rendered horizontally, mostly from left to right (the from node is to the left of the to node). The edges from flow to context nodes are rendered vertically, from bottom to top.
"label": "Term"
  • Determines the name that is displayed on the node in the diagram design view. For a node that represents a complex relation type, the label is used in the diagram as well.
  • This setting is optional.
  • You can provide any string as the value. If you do not specify a label, the name of the asset type or the complex relation type is used.
"collapsed": false, true
  • Indicates if the selected node is collapsed in the initial diagram.
  • This setting is optional.
  • You can choose one of the following values:
    • false: The selected node is a boxing node and the boxed nodes are displayed.
    • true: The selected node is a boxing node and the boxed nodes are hidden.
"name":
  • Defines the name that has to be displayed on the node. By default, this is the asset's name, but you can specify any characteristic. Use the same syntax as for "fields".
"fields":
  • Defines which characteristics are shown in the node's overlay. The order of the fields determines the order of the characteristics in the overlay.
  • This setting is optional.
  • You can pick one or more of the following values:
    • "name": The asset's name, as defined in the "name": setting.
    • "status": The asset's status value.
    • "domain": The domain in which the asset is located.
    • "community": The lowest-level community in which the asset is located.
    • "assetType": The asset's type.
      Note When filtering a diagram by asset type, keep in mind that all subtypes are included, meaning they pass the filter along with the specified asset type.
    • "tags": Any tags that were created for the asset.
    • “responsibility_<ID>": The overlay is a resource role type with the ID that you type here. The diagram shows the avatars of users and user groups that have this role for this asset.
    • "createdOn": The date when the asset was created.
    • "createdBy": The name of the user who created the asset.
    • "lastModifiedOn": The date and time when the asset was last modified.
    • "lastModifiedBy": The name of the user who last modified the asset.
    • "stringAttribute_<ID>": The overlay is a string attribute type with the ID that you type here. Example: "stringAttribute_00000000-0000-0000-0000-000000000001"
    • "dateAttribute_<ID>": The overlay is a date attribute with the ID that you type here.
    • "numericAttribute_<ID>": The overlay is a date attribute with the ID that you type here.
    • "booleanAttribute_<ID>": The overlay is a boolean attribute with the ID that you type here.
    • "singleValueListAttribute_<ID>": The overlay is a single-selection attribute with the ID that you type here.
    • "multiValueListattribute_<ID>": The overlay is a multi-selection attribute with the ID that you type here.
    • "dataQualityRule_<ID>": The overlay is the percentage score of a data quality metric group with the ID that you type here. The score overlay shows the percentage, the color (red/amber/green) and trend (up/down/flat).
    • "sourceRelation_<ID>": The overlay is a relation type where the node is a tail asset and has the ID that you type here.
    • "targetRelation_<ID>": The overlay is a relation type where the node is a head asset and has the ID that you type here.