Graphit Node Properties

Node Properties are additional instructions that can be given to a node. For example, how to format a number, which database to query, or if the node is active or disabled.

Add Node Properties

node_properties_added.png

To assign a property to a node:

  1. Click the adjacent to the node, and at the left side of the opened popup - select the required property from the list. On selection:

    • A short description of the property is displayed at the bottom of the popup.
    • Property optional values will appear at the right side. Some of them are editable at the right side sub-panel.

  2. Select a value among the options.

  3. Click 'Add'. The popup would close and the property with its value will appear alongside the node, as a label.

Notes:

  • You can add several properties to each node.
  • Properties are not editable.
  • You can remove a node property by clicking elsewhere on its label.

Node Properties Options

The following table describes the node properties. Please refer to the files in the following table's Example column. The files can be found in the KB Demo Project under Project Tree > Web Services.

Node Property

Description

Examples

Session Provider Defines which interface should be used for a query. This property should be defined each time a node is defined as either SQL or Non-prepared SQL and the queried database is not Fabric.
Note that this property affects the node and its child nodes.
grShowFormat
Enabled If enabled is set to False, the node and its children are disregarded. grShowEnabled
Nice Defines the layout of the output format. True defines that each tag is printed in a new line and is indented. 
Note that this property affects the node and its child nodes.
grShowEnabled
One Defines whether the node is handled as an array or a single value. True defines that the result is always a single entry, also when the query it is based on - returns multiple rows. grOne
Entry Tag Defines the tag surrounding XML array entries. When not used or set as None, the [entry] value is used. grEntry
Attribute Defines in XML whether a value is set as an attribute or as a child node (default).  grAttribute
Format When defined, the node is evaluated and added when the output format matches the format's JSON, XML or CSV value. Note that this property only affects the node where it is defined.  grFormat
Show Empty Defines whether empty nodes are displayed in the output. Default = True.
Note that this property affects the node and its child nodes.
grShowEmpty
Show Null Defines whether null entries are displayed in the output. Default = True.
Note that this property affects the node and its child nodes. 
grShowNull
Number Format Controls how numbers are formatted in the output. Use either a built-in format or the following syntax to create your own:
0  Digit
#  Digit, zero shows as absent
.  Decimal separator or monetary decimal separator
-  Minus sign
,  Grouping separator
E  Separates mantissa and exponent in scientific notation.
;  Separates positive and negative subpatterns
%  Multiply by 100 and show as percentage
Note that this property affects the node and its child nodes. 
grFormatNumber
Keys Advanced mechanism that replaces nested queries by joining the data on the root query and grouping it with a key. This is done when query keys are used to select a subset of rows to group each invocation of the node. When keys are specified in children nodes, each node groups its parent's node according to the key. grKeys
csvHeader, csvRow, csvCol, csvEnclose The following node properties control CSV format:
  • csvHeader, disables a header row
  • csvRow, defines the delimiter between rows in CSV format. The default value is set to the CR sign (\n).
  • csvCol, defines the delimiter between columns in CSV format. The default value is set to the comma character.
  • csvEnclose, defines the character used to enclose a value in CSV format. This is used only if the value holds a special character (csvEnclose, csvRow, csvCol).
grCSV

Previous

Graphit Node Properties

Node Properties are additional instructions that can be given to a node. For example, how to format a number, which database to query, or if the node is active or disabled.

Add Node Properties

node_properties_added.png

To assign a property to a node:

  1. Click the adjacent to the node, and at the left side of the opened popup - select the required property from the list. On selection:

    • A short description of the property is displayed at the bottom of the popup.
    • Property optional values will appear at the right side. Some of them are editable at the right side sub-panel.

  2. Select a value among the options.

  3. Click 'Add'. The popup would close and the property with its value will appear alongside the node, as a label.

Notes:

  • You can add several properties to each node.
  • Properties are not editable.
  • You can remove a node property by clicking elsewhere on its label.

Node Properties Options

The following table describes the node properties. Please refer to the files in the following table's Example column. The files can be found in the KB Demo Project under Project Tree > Web Services.

Node Property

Description

Examples

Session Provider Defines which interface should be used for a query. This property should be defined each time a node is defined as either SQL or Non-prepared SQL and the queried database is not Fabric.
Note that this property affects the node and its child nodes.
grShowFormat
Enabled If enabled is set to False, the node and its children are disregarded. grShowEnabled
Nice Defines the layout of the output format. True defines that each tag is printed in a new line and is indented. 
Note that this property affects the node and its child nodes.
grShowEnabled
One Defines whether the node is handled as an array or a single value. True defines that the result is always a single entry, also when the query it is based on - returns multiple rows. grOne
Entry Tag Defines the tag surrounding XML array entries. When not used or set as None, the [entry] value is used. grEntry
Attribute Defines in XML whether a value is set as an attribute or as a child node (default).  grAttribute
Format When defined, the node is evaluated and added when the output format matches the format's JSON, XML or CSV value. Note that this property only affects the node where it is defined.  grFormat
Show Empty Defines whether empty nodes are displayed in the output. Default = True.
Note that this property affects the node and its child nodes.
grShowEmpty
Show Null Defines whether null entries are displayed in the output. Default = True.
Note that this property affects the node and its child nodes. 
grShowNull
Number Format Controls how numbers are formatted in the output. Use either a built-in format or the following syntax to create your own:
0  Digit
#  Digit, zero shows as absent
.  Decimal separator or monetary decimal separator
-  Minus sign
,  Grouping separator
E  Separates mantissa and exponent in scientific notation.
;  Separates positive and negative subpatterns
%  Multiply by 100 and show as percentage
Note that this property affects the node and its child nodes. 
grFormatNumber
Keys Advanced mechanism that replaces nested queries by joining the data on the root query and grouping it with a key. This is done when query keys are used to select a subset of rows to group each invocation of the node. When keys are specified in children nodes, each node groups its parent's node according to the key. grKeys
csvHeader, csvRow, csvCol, csvEnclose The following node properties control CSV format:
  • csvHeader, disables a header row
  • csvRow, defines the delimiter between rows in CSV format. The default value is set to the CR sign (\n).
  • csvCol, defines the delimiter between columns in CSV format. The default value is set to the comma character.
  • csvEnclose, defines the character used to enclose a value in CSV format. This is used only if the value holds a special character (csvEnclose, csvRow, csvCol).
grCSV

Previous