Managing Sequence Parameters

Parameters in a Sequence Job

One of the benefits of setting parameters at the Sequence level is that it is easier to achieve dynamic input for the Jobs being submitted. By default, parameters from the Sequence Job will override the parameters of the child Job selected in the Submit Job Task if the parameter names match. When using parameters from the Sequence Job, you have two options:

  • Use Parameters property: If a Job in a Submit Job Task has parameters with the same names as the parameters on the Sequence Job, the Job will use those parameter values from the parent Sequence Job.

  • Parameter Binding: For more granular control, use property binding, which lets you choose which individual properties should be used from another Sequence Task, Job parameter, or Job property.

Use Parameters Property

This option is applicable to only the Submit Job Task and it is selected by default. Only parameter inheritance is allowed. Properties such as Batch Queue or Agent values cannot be inherited.

The parameter names must exactly match in both the parent Sequence Job and child Job in the Submit Job Task. The data type must also be compatible. As a best practice, ensure the data types in both Jobs match. All child Job parameters that match this criteria in the parent Sequence are used.

Use Parameters from the Parent Sequence Job

By default, the parameters from the parent Sequence Job that have matching names and compatible data types in the child Job in the Submit Job Task will be used on the child Job if the Use Parameters checkbox is selected.

NOTE: If the parameter names match but data types are incompatible, an error will occur.

  1. Open the Submit Job Task.

  2. In the Sequence Editor, click in the Properties panel.

  3. Ensure the Use Parameters checkbox is selected. By default, this option is selected.

  4. Click Save and Close.

Use Parameters from the Child Job

You can use the Parameter value set on the child Job. If the parent Sequence Job contains any matching parameters, they will not be used on the child Job. If a parameter value is not set on the Submit Job Task, the value from the original referenced Job is used.

NOTE: It is recommended that you clear the Use Parameters option whenever the child Job Parameter value should be used, even if no matching Sequence Job Parameter names currently exist. This ensures the Job will work as intended if a matching Sequence Job Parameter is added in the future.

  1. Open the Submit Job Task.

  2. In the Sequence Editor, click in the Properties panel.

  3. Clear the Use Parameters checkbox.

  4. Click Save and Close.

Override both the Sequence and Child Job Parameter Values

You can override both the Parameter value on the Sequence Job and the child Job selected in the Submit Job Task, regardless of the Use Parameters field state.

  1. Open the Submit Job Task.

  2. In the Sequence Editor, click in the Properties panel.

  3. Under the Misc section, click in the Job Parameters field to expand it.

  4. Click the drop-down arrow. A screen is displayed.

  5. Click the arrow next to a parameter.

  6. In the Parameter Value field, enter the override value.

  7. Click Save and Close.

Parameter Binding

You can select which individual properties or parameters should be used from another Sequence Task or the parent Sequence Job. After you add a binding, you can hover your cursor over the field to see details about the binding. Binding will take priority over the Use Parameters option.

Adding a Binding

  1. Click a Job in the Sequence Job.

  2. In the Properties panel, click the square next to the parameter that you want to bind.

  3. Select Edit Binding. The Add Binding dialog is displayed. Three options are available: binding to a property in a Sequence Task, to a parameter in the parent Sequence Job, or to a property in the parent Sequence Job.

To bind a property from another Sequence Task:

  1. Select Sequence Task for the Binding Type.

  2. Under Source Task, select the Sequence Task containing the property.

  3. Under Source Property, select the property.

  4. Click OK. The field is now highlighted yellow and displays “Value Is Bound.”

To bind to a parameter from the parent Sequence Job:

  1. Select Job Parameter for the Binding Type.

  2. Select the Parameter.

  3. Click OK. The field is now highlighted yellow and displays “Value Is Bound.”

To bind to a property from the parent Sequence Job:

  1. Select Job Property for the Binding Type.

  2. Select the Property.

  3. Click OK. The field is now highlighted yellow and displays “Value Is Bound.”

Editing a Binding

  1. Click a Sequence Task in the Sequence Job.

  2. In the Properties panel, click the square next to the parameter that you want to bind. You can also click the yellow field displaying “Value Is Bound.”

  3. Select Edit Binding.

  4. On the Add Binding dialog, edit the binding as needed.

Clearing a Binding

  1. Click a Sequence Task in the Sequence Job.

  2. In the Properties panel, click the square next to the parameter that you want to bind.

  3. Select Edit Binding.

  4. On the Add Binding dialog, click Clear Binding.

  5. Click OK.

  6. Click Save.