version

Node Graph

This component is not suitable for users who require assistive technologies.
This component is not suitable for use on mobile devices.

Appearance

Nodes in the graph always have a title, and can optionally contain free text or column data. Nodes with content can be opened (for example the Template node) and closed (for example the TemplateDocument node).

SQL

SQL Call: Get graph (mandatory)

The initial call made when the component is loaded.

May modify database: No

Parameters

@Action binary

Will be 'GetGraph'.

Resultset: Init data

Table count: repeated exactly once

Row count: exactly one row

Columns

Type mandatory string

Type of graph to generate.

Possible value	Description
ER	Entity-Relationship. Nodes are entities and connections are relationships.

MinHeight optional any

Height of the canvas the nodes are placed on. The canvas will, if possible, expand to fit the browser window, so specifying size is only necessary if you want an even larger canvas.

MinWidth optional int

Width of the canvas the nodes are placed on. The canvas will, if possible, expand to fit the browser window, so specifying size is only necessary if you want an even larger canvas.

Resultset: Nodes

Table count: repeated exactly once

Row count: zero or more rows

Columns

NodeId mandatory any

The node's ID.

X mandatory int

Where to show the node. The top left corner of the component is 0,0.

Y mandatory int

Where to show the node. The top left corner of the component is 0,0.

Title mandatory string

The node's title.

Subtitle optional string

The node's subtitle.

BodyHtml optional string

Extra HTML to show in the node. At most one of BodyHtml and BodyText can contain a value.

BodyText optional string

Extra HTML to show in the node. At most one of BodyHtml and BodyText can contain a value.

CanConnectFrom optional bit

Whether the user is allowed to create connections from this node.

Default: False.

CanConnectTo optional bit

Whether the user is allowed to create connections to this node.

Default: False.

CanDrag optional bit

If the user is allowed to move the box.

Default: False.

Icon optional string

The name of a system icon to show in the box.

IconColor optional string

Named color or hex code to assign to the icon.

IsExpanded optional bit

Whether the node starts expanded. Not used by nodes that do not have any content to show by expanding them.

Default: Start expanded.

xxx optional any

Additional columns can be referenced by links of the "Graph node link" type.

Resultset: Node fields (optional)

This optional table is used to display columns in a node's body. Its columns use field information from the menu item's field tables to get their label, alignment, etc..

Table count: repeated zero or more times

Row count: zero or more rows

Columns

NodeId mandatory any

Node to attach these columns to. This node must not have used the BodyHtml or BodyText columns when it was declared. Multiple rows may refer to the same NodeId.

xxx mandatory any

Column value to show in the node.

Resultset: Connections

Table count: repeated exactly once

Row count: zero or more rows

Columns

ConnectionId mandatory any

The connection's ID.

NodeIdFrom mandatory any

Node the connection goes from.

NodeIdTo mandatory any

Node the connection goes to.

FromHead optional string

How the part where the connection touches the from-node is drawn.

Possible value	Description
Arrow	An arrow head.
Crow	A crow's foot (to-many relationship).
NULL	No decoration.

Stroke optional string

How the line is drawn.

Default: Solid.

Possible value	Description
Dashed
Solid

ToHead optional string

How the part where the connection touches the to-node is drawn.

Possible value	Description
Arrow	An arrow head.
Crow	A crow's foot (to-many relationship).
NULL	No decoration.

xxx optional any

Additional columns can be referenced by links of the "Graph connection link" type.

SQL Call: Move nodes

Made when the user has moved nodes. This call will receive a temporary table with the new coordinates.

CREATE TABLE #MovedNode
(
	NodeId varchar(MAX) NOT NULL,
	X int NOT NULL,
	Y int NOT NULL,
)

May modify database: Yes

Resultset: Messages (optional)

Table count: repeated zero or one time

Row count: zero or more rows

Columns

ADMIN_Force optional string

Prompts the user with the specified text and the user may answer OK or cancel. If the user chooses OK the sql call will be rerun with the parameter @force set to 1.

ADMIN_Message optional string

Displays a user friendly message to the user.

SQL Call: Expand nodes

This call will receive a temporary table with the nodes that changed their expand state. You can use this call, in combination with the IsExpanded column in the Get Graph call to preserve a user's node expansion state.

CREATE TABLE #ExpandedNode
(
	NodeId varchar(MAX) NOT NULL,
	IsExpanded bit NOT NULL
)

May modify database: Yes

Parameters

@Action string

Will be 'ExpandNode'

SQL Call: Connect nodes

The user has created a connection between two nodes. You can either create a connection directly, or forward to NewEdit menu item to get more information about the connection.

If you do not forward then you should perform a partial update of the page, by at least returning the created connection.

May modify database: Yes

Parameters

@NodeIdFrom string

@NodeIdTo string

Resultset: Updated nodes (optional)

Any nodes that need to be updated because of the created connection. Usually you will not need to update any nodes.

Table count: repeated zero or one time

Row count: zero or more rows

Columns

NodeId mandatory any

The node's ID.

X mandatory int

Where to show the node. The top left corner of the component is 0,0.

Y mandatory int

Where to show the node. The top left corner of the component is 0,0.

Title mandatory string

The node's title.

Subtitle optional string

The node's subtitle.

BodyHtml optional string

Extra HTML to show in the node. At most one of BodyHtml and BodyText can contain a value.

BodyText optional string

Extra HTML to show in the node. At most one of BodyHtml and BodyText can contain a value.

CanConnectFrom optional bit

Whether the user is allowed to create connections from this node.

Default: False.

CanConnectTo optional bit

Whether the user is allowed to create connections to this node.

Default: False.

CanDrag optional bit

If the user is allowed to move the box.

Default: False.

Icon optional string

The name of a system icon to show in the box.

IconColor optional string

Named color or hex code to assign to the icon.

IsExpanded optional bit

Whether the node starts expanded. Not used by nodes that do not have any content to show by expanding them.

Default: Start expanded.

xxx optional any

Additional columns can be referenced by links of the "Graph node link" type.

Resultset: Fields for updated nodes (optional)

If you are using node fields, and node that was returned in the Updated nodes table will also need its node fields.

Table count: repeated zero or more times

Row count: zero or more rows

Columns

NodeId mandatory any

Node to attach these columns to. This node must not have used the BodyHtml or BodyText columns when it was declared. Multiple rows may refer to the same NodeId.

xxx mandatory any

Column value to show in the node.

Resultset: Updated connections (optional)

This table should contain the created connection.

Table count: repeated zero or one time

Row count: zero or more rows

Columns

ConnectionId mandatory any

The connection's ID.

NodeIdFrom mandatory any

Node the connection goes from.

NodeIdTo mandatory any

Node the connection goes to.

FromHead optional string

How the part where the connection touches the from-node is drawn.

Possible value	Description
Arrow	An arrow head.
Crow	A crow's foot (to-many relationship).
NULL	No decoration.

Stroke optional string

How the line is drawn.

Default: Solid.

Possible value	Description
Dashed
Solid

ToHead optional string

How the part where the connection touches the to-node is drawn.

Possible value	Description
Arrow	An arrow head.
Crow	A crow's foot (to-many relationship).
NULL	No decoration.

xxx optional any

Additional columns can be referenced by links of the "Graph connection link" type.

Resultset: Forwarding (optional)

Table count: repeated zero or one time

Row count: zero or one row

Columns

<passing_field> optional string

Any column with no other specific meaning will pe passed along to the menu item you are forwarding to.

ADMIN_CancelCidStepsBack optional int

Number of steps in the page history to jump back if the user clicks Cancel in an ADMIN_FORCE dialog (the default being none). This value overrides cancelcidstepsback specified in the query string.

ADMIN_CancelReturnToMenuItem optional string

Jumps back to the menu item with this alias if the user clicks Cancel in an ADMIN_FORCE dialog (the default being none). If no prior menu item is found with the given alias, then an error is thrown.

ADMIN_CancelMenuItem optional string

Alias of the menu item to execute if the user clicks Cancel in an ADMIN_FORCE dialog (the default being none). This value overrides cancelmenuitemid specified in the query string.

ADMIN_CidStepsBack optional int

Number of steps in the page history to jump back after execution (the default being one step back). This value overrides any destination specified by the query string.

ADMIN_ReturnToMenuItem optional string

Jumps back to the menu item with this alias after execution. This value overrides any destination specified by the query string. If no prior menu item is found with the given alias, then an error is thrown.

ADMIN_Force optional string

Prompts the user with the specified text and the user may answer OK or cancel. If the user chooses OK the sql call will be rerun with the parameter @force set to 1.

ADMIN_Forward optional string

Displays a user friendly message and then forwards to the next menu item.

ADMIN_ForwardLink optional string

Alias of the link to forward to.

ADMIN_ForwardMenuGroup optional string

Alias of the menu group to show after execution (instead of former menu item). This value overrides any destination specified by the query string.

ADMIN_ForwardMenuItem optional string

Alias of the menu item to execute after execution (instead of former menu item). This value overrides any destination specified by the query string.

ADMIN_Message optional string

Displays a user friendly error message to the user.

ADMIN_PasteHtmlFromPopup optional string

Pastes HTML into an HTML editor. See ADMIN_SetFieldValueFromPopup.

ADMIN_SetFieldValueFromPopup optional string

Sets the value of the field specified in the menuitempopup call. Only select this column if menu item is opened in a popup.

ADMIN_ClosePopup optional bit

If this column is anything but NULL the popup will be closed. Only select this column if the menu item is opened in a popup.

Default: The default behavior is to step back inside the popup window and close it if there is nothing to step back to.

ADMIN_ClearHistory optional any

When the value is not NULL all navigation history is cleared and the user can't navigate back. This is only supported when forwarding to another menu item.

ADMIN_RefreshMenu optional bit

Will trigger a reload of the sidebar if the column is anything but NULL.

Cache optional string

Cache key to be cleared. Supports wildcards.

CacheUserId optional string

Either a user id or '%'.

Clears all caches (e.g. access permissions) related to the specified user id.

Use '%' to clear caches for all users.

CancelButtonText optional string

Changes the text of the Cancel button when used with ADMIN_Force.

OkButtonText optional string

Changes the text of the OK button when used with ADMIN_Message, ADMIN_Force, or ADMIN_Forward.

SQL Call: Validate parameters

Allows you to validate the parameters supplied by the user before any other SQL is run in the component. This call is only made if the component has visible parameters, the SQL is a stored procedure, and Validate parameters is checked.

May modify database: No

Parameters

@Force bit

Set to 1 if the last call to validate parameters used admin_force and the user clicked OK in the OK/Cancel dialog.

@ValidateParams bit

Set to 1 when this call is made.

Resultset: Messages (optional)

Table count: repeated zero or one time

Row count: zero or one row

Columns

ADMIN_Force optional string

Message asking the end user to confirm their parameters.

ADMIN_Message optional string

Message explaining why the parameters are rejected.

Custom access control and logging

SQL Call: Custom access control and logging

Use this call to restrict which entries a user is allowed to view and edit, and to log which entries a user views.

Access to a menu item is normally controlled through functions and roles alone but some entities need more fine grained control. For example, a user may have access to the View Member menu item for normal members but not for members with a protected identity.

The menu items a user visits are always logged (in ADMINLogMenuItem) but for sensitive data you may need to log exactly what entries are viewed. Do the logging in this call as the common ways of viewing data (grid and InfoSQL) are not allowed to modify the database.

If you bind a scalar function instead of a stored procedure to this call then its name must end with '_GrantAccess'.

May modify database: Yes

Resultset: Access permissions

Return whether the user is allowed to visit the menu item with the current parameters.

Table count: repeated exactly once

Row count: exactly one row

Columns

GrantAccess mandatory bit

1 if the user is allowed to view the menu item, 0 if the user should not be allowed to view the menu item.

If 0 then an error will be logged as the user should not have been able to reach the menu item with the given parameters in the first place.

Querystring parameters

menuitemheading optional

String that replaces the menu item name when the menu item is loaded. It does not replace the name before that (like for example in the navigator). It is ignored if the menu item is displayed as a part in a multipart in which case the name can be set from the multipart procedure.