This section lists and describes properties and fields in the following UI areas :
Graph View.
'Graph configuration' domain.
'Reference data' domain.
'Preference' domain.
The following UI areas are described in this section:
'Services' menu.
Left-click on a node.
Right-click on a node.
Node label symbols.
The 'Services' drop-down menu is located at the top-right of your screen when in the Graph View. The following menu options are available:
Menu Option | Definition |
---|---|
Actual size | Returns the zoom amount to the default level. |
Arrange nodes horizontally | Displays nodes in rows and columns that follow a horizontal orientation. Thus, the graph displays wider rather than taller. |
Arrange nodes as a square | Displays nodes so that they orient squarely in rows and columns around a center node. |
Arrange nodes vertically | Displays nodes so that they are in rows and columns that follow a vertical orientation. Thus, the graph displays taller rather than wider. |
In a center aligned hierarchy | Displays nodes according to your data structure. Generally, this type of hierarchy will be oriented more horizontally than vertically. |
Arrange nodes in a hierarchy | Displays nodes organized in parent and child levels. |
Arrange nodes in the default orientation (In graph of data values) | Displays nodes in rows and columns. Each row contains nodes from the same table. |
Arrange nodes in the default orientation (In graph of recursive hierarchy) | Displays nodes in rows and columns. Root nodes display in the first column, and each row contains nodes from the same connected table. |
Fit zoom to height | Adjusts the graph to fit the height of the window. |
Fit zoom to width | Adjusts the graph to fit the width of the window. |
Fit zoom to window | Adjusts the zoom level to display the entire graph. |
Center on root table | Centers the root node in your screen. The root node name displays in parenthesis. |
Show hidden nodes | Displays all nodes that have been hidden in this view. |
Export image | Exports an image of the current Graph View to a new browser window. You can print the image or save it for future use. The exported image mirrors what you see on your screen. For example, if you are zoomed in on only a few nodes, they are all that display in the exported image. |
Save layout (current data set) | Saves the currently displayed node layout that is applied for the current data set. |
Save layout (selected data set(s)) | Saves the currently displayed node layout that is applied to the current data set and other selected data set(s) that have the same data model. |
Save layout and context | Saves the currently displayed node layout that is applied for the current data set and the data query context. |
Restore layout and context | Restores the last saved layout and context. |
The following menu options are available when you left-click a node:
Option | Definition |
---|---|
Display graph data value | Displays the selected node's records in a new graph view window. The new graph is laid-out as a grid. Each row displays the records from one table. The arrows show relationships and relationship direction between records. |
Display recursive hierarchy | When a node contains recursive relationships you can select this option to display a hierarchical graph of data value nodes. The Graph View allows you to choose a relationship (if more than one exist) on which to base the hierarchy. Additionally, you can use a field to qualify the relationships. Values from the field you select display on the node transitions. You can execute this service on resolved and unresolved nodes. |
Data query | Opens up the corresponding table where you can select records for a query. You can execute this service on resolved and unresolved nodes. |
Open context | Opens a list of this nodes records that are part of the current context. This option is only available for nodes with more than one record. |
Resolve from context | Resolves all nodes based on the current context of the selected node. This option is only available for nodes with a context. Note: This option can change data values in other nodes. |
Continue data query | Initiates the resolution algorithm to resolve data values without changing the graph's current context context. |
Display graph from current node | Acts as a paging mechanism when the threshold defined by the 'Max. number of displayed nodes' property is reached. This service is available when the (->) symbol appears on a node label and opens a new graph displaying related nodes. The node from which this service was run becomes the new graph's root node. If the number of related nodes still exceeds the specified limit, then you will be prompted to select the nodes you want to display. Note that you cannot access this service when viewing a graph based on a recursive hierarchy. Instead, you can use the 'Expand nodes' and 'Collapse nodes' services. |
Expand nodes | Expands related nodes. The number of collapsed nodes displays in parenthesis below the node label. A graph configuration's 'Limit initial and expanded node display' restrict how many nodes display upon expansion. For example, the property may be set to '4' and there may be five collapsed, related nodes. In this case only four of the five nodes display when running this service. You can run this service again to expand the fifth node. |
Collapse nodes | Collapses all nodes in a forward transition of the selected node and any nodes related to the forward nodes. |
Unselect context | Deselects the current context and returns all nodes to an unresolved state. This option is only available for nodes that have a context and contain records. |
Hide node | Hides the selected node. If you want hidden nodes to display, select 'Show hidden nodes' from the 'Graph services' menu. You can execute this service on resolved and unresolved nodes. |
Actual size | Centers the selected node in the display window and returns the zoom level to the graph's physical size. You can execute this service on resolved and unresolved nodes. |
List of records (below the gray line) | Displays a list of records contained in this node. Selecting a record opens it in the tabular view. The length of this list is determined by the 'Number of max display records' property. If you see a '…' at the bottom of this list you can click on it to see the remaining records. |
Right-clicking a node acts a "quick-paging" mechanism and executes the 'Display graph from current node' service. For more information, see this service description in the 'Left-click on node' section.
The following table describes the symbols displayed on a node label:
Symbol | Description |
---|---|
(-) | Node is unresolved. |
(text) | When a node contains only one record, its name displays between parenthesis. For example, Client('Peter') shows that the 'Client' table has one resolved record named 'Peter'. Note: This may not be the total number of records contained in the table. |
(a number) | When a node contains more than one record, the number displayed between the parenthesis indicates how many resolved records the table contains. For example, Client(8) shows that the 'Client' table has eight resolved records in the current context. Note: This may not be the total number of records contained in the table. |
: | Indicates a forward resolution through the path indicated on the node label. For example, Product('running shoes'): Order portfolio shows that the 'Product' node resolution comes in a forward direction from its parent, 'Order portfolio'. |
:: | Indicates a backwards resolution through the path indicated on the node label. For example, Price('running shoes'):: Product shows that the 'Price' node is resolved in a reverse direction from its child, 'Product'. |
(*) | Indicates an unknown number of records. |
(0) with a line | The empty set symbol indicates a node has no records (in other words, the table is empty). |
[↑] | When a node has a recursive relationship this symbol displays on its label. |
(->) | Indicates the node has a relationship that isn't displayed. Using the 'Display graph from current node' service, allows you to view the hidden nodes. |
The following describes:
'Table'.
'Graph' table.
'Graph template' table.
When you select the 'Table', a table displays in the main screen. Each record in this table registers a table or a set of tables with the add-on. When you create a new record or update an existing record, the following properties are available:
Property | Definition |
---|---|
Code | A unique name without white spaces. |
Name | Any naming convention can be used to define this property. |
Dataspace, dataset: These properties specify the path or location of the tables you want to register with the add-on. | |
Data space | The data space containing the data set where the desired table(s) is located. |
Data set | The data set containing the table you want to register with the add-on. |
Table | The table you want to register with the add-on. You can select an individual table for this record to meet a specific application, or you can select [All tables] to grant access to all of the tables in the data set. |
Graph | The graph configurations are applied for current table. |
Recursive hierarchy service refresh date | Displays the most recent date and time that the 'Update hierarchy view' service executed on this table configuration. |
When you select the 'Graph' table, a table displays in the main screen. Each record in this table stores configurations that determine Graph View user access, look/feel and display behavior. It is also in this record where you specify which table-previously registered with the add-on-the configuration settings apply to. When you create a new record or update an existing record, the following properties are available:
Property | Definition |
---|---|
Code | A unique name without white spaces. |
Name | Any naming convention can be used to define this property. |
Graph use | Currently the type of use 'Standard' is available only. In a further version, other types of graphs will be possible in order to get some specific services and behaviors. |
Applied on table | This property determines which 'Table' configuration these record settings apply to. The drop-down list populates with all of the records contained in the 'Graph configuration's' 'Table' node. |
User profile | Allows users to access the Graph View depending on their profile. Possible values for this property are either a single profile, or [all profiles]. You can grant or limit user access to the table specified in the 'Applied on table' property using this property. |
Applied to data life cycle | Allows you to configure the graph for one or many data set(s). |
Graph template | A drop-down list that populates with a list of graph templates. The list is derived from the 'Graph template' table where you can store customized options as templates for reuse. Note: All of the following properties inherit from the template specified in this property. You can override the inheritance by toggling the square icon. When the icon is dark gray, the property inherits its value from the template. When the icon is light gray, inheritance is overridden and you can change the property. |
'Custom data value graph' tab: Defines a list of groups allowing you to specify a Java class and name the configuration. | |
Java class | The custom class you want to use for Graph View display. |
Label | The label, localized by language, used to identify the configuration. |
When you select the 'Graph template' table, a table displays in the main screen. Each record in this table defines a graph template. Graph templates are referenced by the 'Graph template' property in 'Graph' table records. The values you specify in these properties are inherited by records in the 'Graph' table that customize Graph View look/feel and display behavior. When you create a new record or update an existing record in the 'Graph template' table, the following properties are editable:
Property | Definition |
---|---|
'Home' tab | |
Code | A unique name without white spaces. |
Name | Any naming convention can be used to define this property. |
Max depth level after root | The maximum number of nodes levels that are displayed after the root table. |
Background color | Specified the color of the UI background. |
Text color | Specifies the color of the nodes' labels. |
Resolved node layout | Specifies which node layout is used for resolved nodes. The drop-down list contains node layout configurations that have been created in the 'Reference data' domain's 'Node layout' table. |
Transition highlight color | Specifies the color of the nodes' transitions for the last selected node. |
Color for 'Continue query' | Determines the color used to indicate availability of the 'Continue data query' service. |
Node label size | Determines the node label's font size. |
Transition label size | Determines the transition label's font size. |
Max record label size | This value determines the maximum length-in characters-of the displayed record. |
Root node layout | This property determines which node layout settings are used to display root nodes. The drop-down list contains node layout configurations that have been created in the 'Reference data' domain's 'Node layout' table. |
Node layout | This property determines which 'Node layout' settings this template uses. The drop-down list contains node layout configurations that have been created in the 'Reference data' domain's 'Node layout' table. |
Node transition | This property determines which 'Node transition' settings this template uses. See Reference data domain. |
Node distance | This property specifies the distance between nodes. See Reference data domain. |
Is node moveable | A boolean value that determines whether or not node can be rearranged in the graph view. You may want to restrict this option if a graph view has been laid out in a specific way for some purpose. Otherwise, a user with permission might accidentally change the layout. If set to 'Yes': The nodes in the graph view that this template applies to can be moved. If set to 'No': The nodes in the graph view that this template applies to cannot be rearranged. |
Display all nodes | If set to 'Yes': All tables (nodes) of the data model are displayed. If set to 'No': Only the tables (nodes) with direct or indirect relationships from the root table are displayed |
Zoom speed | This value specifies the rate at which the mouse wheel zooms in and out on the graph view. |
Default grid orientation | Indicate the default orientation of grid. The available orientation are: 'Horizontal', 'Random display', 'Square' and 'Vertical'. The default value of this property is 'Square'. |
Default display mode | Determines the display mode when the Graph View opens. You can specify that a graph displays all nodes at their actual size, or adjust the zoom level to fit all nodes in the window, or its height, or its width. |
Max. Nb. of resolved records | This value specifies the maximum number of records that are queried before the incremental data query is stopped. A '*' on a node's label indicates that the query has stopped and resolution has not completed because the threshold specified by this property has been reached. |
Max. Nb. of selectable records | This value specifies the maximum number of records that can be selected when querying a table. If the number of selected records exceeds this value, an error message displays. |
Max. Nb. Of records displayed per node | This value specifies the maximum number of records that display in a node's pop-up menu. '...' indicates that there are more records beyond those displayed. |
Zoom % for last selected node | Each time a node is queried the screen may change to show query results. When you return to the graph view it may be confusing-if there are many nodes-to remember which was the last node you were working with. This is why the last selected node displays larger than the others. This property determines the display percentage over regular nodes. |
Max. Nb. of displayed nodes | This property restricts the number of table, or record nodes displayed in a graph. Reducing the number of displayed nodes can improve performance. If you are using Firefox version 3.6. this value should be set no higher than 50. |
Limit initial and expanded node display | Restricts the number of nodes that display when a graph loads and the number of nodes that display when users expand nodes. This property only applies to graphs of recursive hierarchies. Additionally, this property can not be set higher than the 'Max. Nb. of displayed nodes' property. |
Max. backward resolution depth | Determines the maximum number of transitions the resolution algorithm navigates to resolve node data values. This number defaults to '2'. However, you can limit it to '1' for large volumes of data. |
Hide unresolved nodes by default | Determines whether the 'Hide unresolved nodes' check box is automatically selected. |
Display 'Hide node' service | Determines whether users can access the 'Hide node' service. |
'Data value graph' tab | |
Access data value graphs | This property determines whether or not users who access the graph view using this template can view records and recursive relationship values using the 'Display graph data value' and 'Display recursive hierarchy' services. |
Max. node (horizontally) | Limits the number of nodes that display on the grid's horizontal axis. |
Max. Nb. of levels | Limits the maximum number levels that can be paged through after the table that the 'Display graph data value' service was run from. |
Node layout | Determines how records display. The drop-down list references configurations made in the 'Reference data' domain's 'Node layout' table. |
Recursive transition | Determines the transition layout used for recursive nodes and using the 'Graph data values' service. |
Default node orientation | Indicates the default grid orientation for data value nodes. You can choose from: 'Horizontal', 'Square', 'Hierarchy', 'Center aligned hierarchy', 'Vertical' and 'Default grid'. The property defaults to 'Center aligned hierarchy'. |
Default recursive node orientation | Indicates the default grid orientation for data value nodes with recursive relationships. You can choose from: 'Horizontal', 'Square', 'Hierarchy', 'Center aligned hierarchy', 'Vertical' and 'Default grid'. The property defaults to 'Center aligned hierarchy'. |
Default custom graph node orientation | Indicates the default grid orientation when viewing a custom graph of data value nodes. You can choose from: 'Horizontal', 'Square', 'Hierarchy', 'Center aligned hierarchy', 'Vertical' and 'Default grid'. The property defaults to 'Center aligned hierarchy'. |
Default display mode | Determines the display mode when the Graph View displays data value nodes. You can specify that a graph displays all nodes at their actual size, or adjust the zoom level to fit all nodes in the window, or choose between its height and width. |
Display record label first | Determines in what order the record label, and additional node information displays. |
The nodes in the 'Reference data' domain store information referenced by graph templates.
This table declares the possible uses of a graph. In the current version, only the use 'Standard' is available. In further version, depending on the use, the graph will offer different services, such as to handle the meta-data.
Property | Definition |
---|---|
Code | Code of the 'graph use'. It is not possible to create user-defined 'Graph use'. |
Name | Name of the 'graph use' |
Description | Description of the 'graph use' |
This table allows you to manually create configurations that determine how an individual node displays. For example, you can use an image to represent a table and use other images to represent each table record. These configurations override those set in a graph configuration.
Property | Definition |
---|---|
Graph configuration | The 'Graph configuration' to which this table layout applies. |
Data space | The data space where the data set containing the table to use for this configuration is located. |
Data set | The data set containing the table for this configuration. |
Table | The table that this configuration applies to. |
Field for record image | If records in the specified table contain fields that link to images, logos, shapes etc., you can specify that field here. The field must be URI type. Each table record displays as its referenced image. Note: images can not be larger than the property specified in the 'Image configuration' table. |
Node layout | The node layout you want this table to display as. |
The 'Node layout' allows you to configure the frame (shape, image) and the size of the nodes.
Records in this table contain the following properties:
Property | Definition |
---|---|
Code | A unique name without white spaces. |
Name | Any naming convention can be used to define this property. |
Node frame | Drop-down list containing the list of shapes available for node frames. These are predefined in the 'Node frame' table and contain basic shapes, as well as, a frame for images. If the node frame is set to "Image layout", the 'Image' field will be available and allow you to configure the corresponding image. |
Node size | Drop-down list containing the list of available size configurations for nodes. These values are predefined in the 'Node size' node. You can click '+ Create' to open a new page to create a custom node size. |
Color | Defines the color for this configuration. You can chose a color from the color picker. |
Image | This drop-down list displays the images available for this configuration. These images are contained in the 'Image' table. |
Description | A description for this configuration. |
The 'Node size' allows you to configure the size of the nodes.
Records in this table contain the following properties:
Property | Definition |
---|---|
Code | A unique name without white spaces. |
Name | Any naming convention can be used to define this property. |
Dim (pixel) | The node's dimension in pixels. |
Height (pixel) | The node's height in pixels. |
Width (pixel) | The node's width in pixels. |
Description | A description for this configuration. |
Records in this table are predefined and determine node shape. These values are used in the 'Node layout' table. Possible values are:
Circle
Ellipse
Rectangle
Square
Star
Image layout
Property | Definition |
---|---|
Code | A unique name without white spaces. |
Name | Any naming convention can be used to define this property. |
Description | A description for this configuration. |
This table allows you to create and store predefined measurements that determine the distance between nodes. You can apply these settings when viewing a Custom data value graph in the default orientation.
Property | Definition |
---|---|
Code | A unique name without white spaces. |
Name | Any naming convention can be used to define this property. |
Distance (pixel) | The distance, in pixels, between nodes. |
Description | A description for this configuration. |
Records in this table specify the transition shape and contain the following properties :
Property | Definition |
---|---|
Code | A unique name without white spaces. |
Name | Any naming convention can be used to define this property. |
Type | Determines the transition's shape. You can specify a line, or arrow. |
Color | Color of the transition |
Text color | Specifies the transition's text color. |
Max. label length | Sets a limit on the number of characters that display on a transition's label. |
Dim (pixels) | Dimension of the transition in pixels |
Width (pixels) | Width of the transition in pixels |
Description | A description for this configuration. |
Records in this table specify the 'Data life cycle context' used for the graph configuration.
Property | Definition |
---|---|
Data space | Data space where the data set is configured |
Data set | Data set use as context |
Allows you to point the add-on to an upload location. This location is used to store images uploaded in the 'Image' table. These images can be used to represent tables.
Property | Definition |
---|---|
Code | Enter a unique code with no white spaces. |
Name | Enter name for this configuration. |
Upload folder | Path to the folder where you want to store images. By default, this path is If you want to change this location, the EBX® needs to have read, write and execute access in this location. Without sufficient permissions the Graph View may not have the ability to upload, delete or display images correctly. |
Max. upload size (KB) | Limits the uploaded image size. |
Time out (milliseconds) | Limits the image's allowed load time. If this value is exceeded, a colored rectangle displays instead of the image. |
This table is where you manage your image uploads. Use the 'Services' drop-down menu to upload and delete images. If the 'Upload' option does not display, you have to create an 'Image configuration' first.
Property | Definition |
---|---|
Name | Image name you would like to use in add-on configuration settings. |
File name | Actual image file name. |
The 'User graph data' table contains records that save node layout and context. The 'Transition's label' table stores configurations saved for hierarchy graphs. You can export and import this data when you want to share and reuse a certain layout.
The 'User graph data' node contains records that save node layout and context when you save using the 'Save layout'/ 'Save layout and context'' options from the 'Graph services' menu.
Property | Definition |
---|---|
Graph configuration | The configuration for the saved graph. |
Root table | The table that user runs service "Graph view" on. |
Data set | The specific data set that user selects to save layout. |
User profile | Allows users to access current layout and context depending on their profile. |
Scale | The scale (zooming) value of current graph. |
Selected table | The last selected table that user queries data on. |
Value | The selected records that user queries on. |
Node layout: The position, display state of nodes in graph. | |
X position | X position |
Y position | Y position |
Data space | Data space corresponds to a node. |
Data set | Data set corresponds to a node. |
Table | Table corresponds to a node. |
Is hidden | Determines node visibility. |
To display a recursive hierarchy, you can define a context by choosing a relationship and, an optional, qualifying field. The add-on uses the qualifying field to display node transition labels. When you choose to save this context, this table stores the values.
Property | Definition |
---|---|
Graph configuration | The configuration applied to the table that displayed as a hierarchy. |
User profile | The user who ran and saved this configuration. |
Parent table | The table on which this configuration was used. |
Selected foreign key | The relationship the hierarchy was based on. |
Selected field | The field chosen to qualify the relationship. |