Property types

Tip: If you are not yet familiar with how to define data flow and node properties, see Defining properties.

 

When defining new properties, the following property types are available:

  • Boolean - Drop-down field allowing you to make a True / False choice.
  • Script - Multi-line field for you to enter Data360 Analyze Script.
  • Script Expression - Multi-line field for you to enter Data360 Analyze Script.
  • Script Output - Multi-line field for you to enter Data360 Analyze Script.
  • Choice - Drop-down field allowing you to choose an option from a pre-defined list. To define the choices, select Edit Details from the field menu, see Editing property details.
  • Color - Single-line text field for you to enter a color.
  • CSV - Multi-line field for you to enter data in comma-separated values format.
  • Filename - Single-line text field for you to enter a file path.
  • Inline File - Multi-line field for you to enter the contents of a file.
  • Include - Single-line field allowing you to specify a file path for an include file for code.
  • Java - Multi-line field for you to enter Java code.
  • Password - Single-line field for you to enter a password. The typed value is not shown.
  • Python - Multi-line field for you to enter Python code.
  • SQL- Multi-line field for you to enter SQL code.
  • String - Single-line field for you to enter a short text value. You should also use this type for numbers and dates.
  • Text- Multi-line field for you to enter a longer text value.
  • XML- Multi-line field for you to enter XML data.
  • Label - Displays the text entered for Documentation as a label in the Configure panel. To enter Documentation, choose Edit Details from the field menu, see Editing property details.
  • Drix - Multi-line field for you to enter a Data360 Analyze Data Reader Input Xml specification.
  • Drox - Multi-line field for you to enter a Data360 Analyze Data Reader Output Xml specification.

Tip: For more information on defining properties, see Defining properties.

Editing property details

Depending on the property type that you choose, you may also need to define additional attributes. For example, if you choose the Choice type property, you need to specify what the choices are.

  1. In the Properties panel, select the Define tab.
  2. Click the menu button to the right of the property that you are editing.
  3. Select Edit Details.

    The Edit Property Definition dialog appears:

    Edit property definition

    For Choice type properties, in the Choices field, list the options which you want to be available for users to select from the drop-down menu on this property in the Configure panel.

     

    In the Documentation field, describe how the property should be used. This text is shown in the tooltip which is displayed when you hover over the property label in the Configure panel.

    Tip: If you want to format your tooltip text, you can use standard HTML tags.

     

    For example, the following text would create the tooltip shown below:

     

    HTML formattingHTML formatting

For more information on defining properties, see Defining properties.

Editing advanced property details

There are a number of Advanced property details which you can define. In general, you only need to set these details when you are creating sophisticated library nodes which use custom scripts or code to execute logic.

  1. In the Properties panel, select the Define tab.
  2. Click the menu button to the right of the property that you are editing.
  3. Select Edit Details.

    The Edit Property Definition dialog appears.

  4. Edit the following details, as required:
    • Visibility - Determines whether nodes placed as instances of a library node display this property in the Configure panel.

      Note: This option is only relevant for properties defined inside library nodes.

    • Inputs - Selects which input pins this property acts upon, where it references input data.

      Note: This option is only relevant for properties defined on nodes.

    • Sources - Lists the sources available for the property. For more information see Property sources
    • Default Source - Nominates the default source to use if not explicitly set. For more information see Property sources
    • Run Time Property Name - Provides a name which can be used in scripts and code to refer to the property. This is commonly used with Java and Python nodes and within Data360 Analyze Script.