Editing Runtime Variables

On the Variables page, you can select a set of variables that can be used as runtime parameter for Pipeline jobs. When you execute a Pipeline, you are provided an input value for these variables - a set of out-of-box or runtime values, from which parameter values can be used for individual jobs. Variables can be pre-defined types, such as: "Period," "Import Mode," or "Export Mode."

You can also add custom variable parameter as a job parameter. For example, if you want to pass static values using a substitution variable for the Start Period, change the Variable type to "Text" and then specify a substitution variable as a parameter (accepted by the integration RESI API), such as &ThisMonth#&ThisYear. (A substitution variable is a user variable name preceded by one or two ampersands (&)).

The default runtime variables include:

• Start Period
• End Period
• Import Mode
• Export Mode
• Send Mail
• Send To
• Attach Log

To modify Pipeline runtime variables:

1. From the Data Integration home page, click to the right of the Pipeline, and then select Pipeline Details.

2. From the Pipeline page, select the Variables tab.

3. Select the variable to modify.

4. In Variable Name, to add or modify a predefined variable name, specify the name.

   The variable name can be referenced as a job parameter. The name can be no longer than 20 characters and can contain no spaces.

5. In Display Name, specify the display prompt name for the variable.

6. In Display Order, specify the display order of the variable.

7. Check Required if a value for variable is required to execute the Pipeline.

8. From Validation Type drop-down, select the type of value used to validate the variable.

   Validation types include:

   • List—Use a LOV query and bind values are required.
   • Text—Free form text field

   • File—File name. A file browser window is available to select a file.

   • Custom List—User defined list of values

     To use this validation type, provide a list of values in the Validation Parameter window. The values must be specified in a Value,Label format and every line must end with a new line character, for example,

     M,Month
     Q,Quarter
     Y,Year

   • Lookup—Use of Lookup values available.

9. From Validation Parameters drop-down, select the predefined parameters for the variable based on the validation type.

   For example, you could select a Start Period variable parameter based on a list validation type such as:

   • Pipeline Status
   • Pipeline Export Mode LOV Query
   • Global Period Name LOV Query
   • Location No Security LOV Query
   • Trial Balance Converted by Target Entity/Account Query
   • Process Monitor Query

10. From Default Value, select the default value for the variable.

    The default value can be a static value or a Planning substitution variable.

11. Click Save.