Editing Runtime Variables

Shows how to select a set of variables that can be used as runtime parameter for Pipeline jobs.

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
Stage Execution

To modify Pipeline runtime variables:

From the Data Integration home page, click to the right of the Pipeline, and then select Pipeline Details.
From the Pipeline page, select the Variables tab.
Select the variable to modify.
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.
In Display Name, specify the display prompt name for the variable.
In Display Order, specify the display order of the variable.
Check Required if a value for variable is required to execute the Pipeline.
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.
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

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

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

The default runtime variables and their descriptions are provided in the following table.

Table 12-40 Default Runtime Variables and Descriptions

Variable Name	Available Values
Start Period	Specify the first time period included in the pipeline’s import/export processing scope. It sets the beginning of the period range used by the Data Exchange step (often together with End Period) to determine which periods’ data to process.
End Period	Specify the last time period included in the pipeline’s import/export processing scope. It sets the end of the period range (used with Start Period) to define which periods’ data the Data Exchange step will process.
Import Mode	Specifies how the Data Exchange pipeline should handle loading the incoming data during an import step, that is, whether the import replaces existing data or adds to/updates the existing data in the target. Replace: (Default value) Replaces existing target data for the import scope, then loads the new data. Append: Retains existing target data and adds new records and/or updates matching records based on the import rules. No Import: Doesn’t load data. Map and Validate: Runs the import using the defined mappings and validation rules to transform and validate the source data, but doesn’t write the data to the target. It’s used to confirm the file/format, mapping coverage, and rule validations and to review any errors or warnings before performing a load/commit mode.
Export Mode	Specifies how the Data Exchange pipeline should export the data: Merge: (Default value) Exports only the data in the current run scope and combines it with any existing export output for the target file/location. Existing records may be updated where keys match; new records are added. Accumulate: Adds the current run’s export output to the existing output as an additional set of records (append-only), preserving prior exported content. Replace: Generates a new export output for the current run scope and overwrites the existing export file/content in the target location. Dry Run: Executes the export process (scope selection, formatting, validations) without producing or writing the final export output, allowing you to verify results and detect issues before generating files. No Export: Doesn’t export the data.
Send Mail	Controls whether the pipeline sends an email notification for the pipeline run: Always: Sends an email notification for every pipeline run, regardless of outcome (success, warning, or failure). No: (Default value) Doesn’t send any email notification for the pipeline run. On Failure: Sends an email notification only when the pipeline run fails (or ends in an error status). On Success: Sends an email notification only when the pipeline run completes successfully.
Send To	Specify the email recipient list for pipeline run notifications when Send Mail is enabled.
Attach Logs	Controls whether the pipeline run’s execution logs are included as file attachments with the pipeline results/notifications (for example, in the job output or any configured email/notification payload). No: (Default value) Doesn’t attach logs Yes: Attaches logs
Stage Execution	Start from beginning: (Default value) When Pipeline fails, restart the process from the beginning. Start from failure: When Pipeline fails, instead of restarting the process, it starts the job from the last failed stage. When a pipeline is restarted from a failed stage, the status of the jobs from the previous stage are carried over to the new Pipeline execution. Note: If you select Start from failure, but the pipeline was successful, the pipeline won't run.

Click Save.