Previous Topic: Dataset TypesNext Topic: Variable Data Types


Define Dataset Pages and Variables

Define the pages, variables, and values in a dataset. When you run a process, operators can reference the values in datasets.

New named datasets and process datasets include a default root page called Parameters. The pages and variables for operator datasets vary by operator. You can create new variables (fields) or you can edit existing variables. You can also add pages to group variables in logical ways. To edit an existing variable or its value, click the variable or its value, and then make your changes. You can also change values in dataset variables (fields) programmatically.

Follow these steps:

  1. Click the Library tab.
  2. Select a folder and locate a dataset. Use the optional search features if necessary.
  3. Double-click the dataset.

    The Dataset tab of the Dataset dialog appears.

  4. Click Check Out.
  5. To create a page, click Add Page.
  6. To create a variable:
    1. Select a page.
    2. Click Add Variable.
  7. To rename a page or variable, double-click it. Names must start with a letter and must have a maximum length of 32 characters.
  8. For variables, select the data type and page, enter an initial value, and provide an optional description.
    Page

    Defines the page that contains the variable. To move the variable to a different page, select that page. For custom operators, the page that is specified here corresponds to an expandable properties group on the Properties palette.

    Description

    (Optional) Provides helpful information about the variable when it appears later in a dataset. If provided, a tool tip displays the text that you enter here when you move the mouse pointer over the field name or value.

    Value

    Specifies the default value if the field is blank (cleared). For fields of the integer, long, and double type, the default value is 0. For fields of the integer, double, long, or string type, you can specify your own default value here. To view the Value field contents in a separate window, right-click in the Value field and choose Expand.

    Note: The Expand option is available for only the string data type.

    You can also enter constraints for a field of these types:

    • For fields of the Boolean type, you can select True or False.
    • For fields of the Object Reference type, click the browse button (...) to select a dataset object.
    • For fields of the Date type, click the browse button (...) to select a date.
    • Java Object fields are read-only.

    Note: The ValueMap field type cannot be assigned a default value.

  9. To define arrays:
    1. On the General tab, select the Array check box and select Single or Double in the Array Dimension field.
    2. Right-click the variable and select Add Indexed Value.
    3. Click the Value field to enter a value.

Note: To edit the dataset for a custom operator, open it, check it out, and click the Dataset tab. You can also edit process and operator datasets by clicking Edit dataset icon indicated by a pencil. in the title bar of the Dataset palette in the Process Designer.