Create and Update Parameters in Schedule Integrations

You can create and update scalar-type scheduled parameters in schedule integrations that determine how to batch and read data received from a source location. You then use these parameter values downstream in the integration.

You create and assign values to these parameters in the Schedule parameters page that is available in schedule integrations. You can also assign values to these parameters in assign actions. Up to five parameters are supported in the Configure schedule parameters panel.

Create Parameters

You can also create and assign scheduled parameters as business identifiers that enable you to track fields in messages during runtime. See Assign Business Identifiers.

Scheduled parameters are available across all scheduled runs of an integration and can facilitate processing of data from one run to the next. For example, when performing batch processing, a scheduled parameter can track the current position of batch data between runs. This value is available across scheduled runs and cannot exceed 256 characters.

  1. In the navigation pane, click Design, then Integrations.
  2. Click Create.
  3. Select the Schedule pattern.
  4. Complete the fields of the dialog, and click Create.

    The integration canvas is displayed.

  5. For Schedule, click Actions icon, then select Edit.


    Schedule and Assign are shown. The Actions menu for Schedule has been clicked to show a menu with options for Edit, Edit Schedule Definition, and Replace.

  6. Click the field to open fields for entering a parameter name, description, and default value.
  7. Enter values. For this example, a parameter of ATOMLastRunDateTime and a value of "2018-01-01T00:00:00.000Z" are entered.


    The Configure schedule parameters panel shows the Parameter Name, Description, and Default Value fields completed with values.

  8. Click Save.

    If you enter a parameter without a value, a red warning icon is displayed after the Default Value field.

  9. Drag an Assign action into the integration.
  10. Drag the parameter you created in the Configure schedule parameters panel into the Variable field and specify a value.


    The Input Sources tab (which is selected) and Functions tabs are shown. After this is the Sources tree. On the right is the Configure Assignment section. A parameter and value are set. A Delete icon appears to the right. After this are the Variable, Operation, and Value fields. The Value field includes a Clear icon and a Switch to Developer View icon.

  11. Click Save.

    Note:

    If you create a for-each action without selecting the Process items in parallel option and then add an assign action within the for-each loop, parameters defined in schedule integrations are visible for selection in the assign action. If you later edit the for-each action and select the Process items in parallel option, a red fault icon is displayed on the impacted assign action indicating that a scheduled parameter is being used. You must correct this error for your integration to be valid. You can disable the Process items in parallel option or use the cut and paste options to move the assign action outside of the for-each loop.

Update Parameters

  1. In the navigation pane, click Design, then Integrations.
  2. Hover over the integration on which the scheduled run is defined.
  3. Click Actions Actions icon, then select Schedule.

    The Schedule and future runs page is displayed.

  4. Click Actions Schedule menu icon and select Update schedule parameters.
  5. Edit the parameter value in the New value column, and click Update. The value in the New value field replaces the currently stored value and is used for the next run. The value in the Current value field indicates the currently stored value.


    The Update Schedule parameters page shows columns for Parameter Name, Default Value, Current Value, and New Value.

Override Schedule Parameter Values

You can override schedule parameter values set at design-time when submitting an ad-hoc schedule request or starting a schedule in an activated integration. This feature enables you to provide parameter values while invoking an integration without deactivating it.

  1. Access the dialog to override parameter values in either of two ways. If the schedule integration has defined parameters, the Configure schedule parameters panel is displayed. Otherwise, the open is not displayed and the schedule integration starts.

    1. If submitting an ad-hoc schedule integration, select Run from one of the following locations:

      • Click Actions Schedule menu icon, then Run on the Schedule and future runs page.

      • Click Actions Actions icon, then Run on the Monitor integrations page.

      Both options invoke the Configure and run page, from which you can select Ad hoc request and click Run.

    2. If scheduling an integration, select Start schedule Start schedule icon on the Schedule and future runs page.

    The Schedule parameters page is displayed.


    Description of oic3_sched_params.png follows
    Description of the illustration oic3_sched_params.png

  2. Make updates to any necessary parameters.

    The following fields are displayed:

    • Parameter name: Displays the parameter name you provided during design-time.

    • Default value: Displays the parameter value you assigned during design-time.

    • Current value: Displays the value most recently used at runtime.

    • New value: Optionally enter new values for the schedule parameters. These values override the current and default values. If these fields remain empty, the current values are used. If there are no new or current values, the default values defined during design-time are used.

  3. In the New value row for the specific parameter, enter a value.

    If the integration updates these schedule parameter values using an assign action, the updated values are saved and become the current values for the next schedule run.

  4. Save your updates.

    1. If starting a schedule, click Start schedule.

    2. If submitting an ad-hoc schedule integration, click Run.

    The values you entered are used during processing of the schedule integration.