A quick recap on schedule parameters
Schedule Parameter feature supports adding scalar variables for Scheduled Orchestration Integrations. These parameter values are available across scheduled runs for the particular Integration and can be overridden by downstream actions like Assign. A maximum of five schedule parameters can be defined per Integration.
Requirements like the following can be achieved by using schedule parameters:
As mentioned above, schedule parameters can be updated in the orchestration by using Assign.
Please refer Oracle Documentation for more details about this feature.
How to override schedule parameters
Today if user wants to invoke a Scheduled Integration (containing schedule parameters) with different parameter values, they need to deactivate the Integration, configure a new default value and activate it back.
Schedule parameter override feature enables user to provide parameter values while invoking the Integration without deactivating it. This feature is controlled by feature flag oic.ics.console.schedule.parameter-override-support.
Once the feature is enabled, a popup will be displayed when user clicks Submit Now or Start Schedule - for Integrations that have schedule parameters defined. Users can view the Default and Current Value of parameters and, if required, input a New Value to override the Current/ Default values.
The New Value field is optional. If no new values are specified then Current Value will be considered for next Run. If Current Value is also empty then Default Value will be considered.
If the integration updates these schedule parameter values using Assign, then the updated value will be saved and will become the Current Value for the next Run.
Schedule parameter values for Submit Now and Scheduled Runs
Typically for a given Integration, schedule parameter values for Submit Now and Start Schedule use cases are not shared.
So if user defines new schedule parameter values as part of Submit Now operation it will be saved and shown as Current Value for all subsequent Submit Now operations. It will not impact the saved parameter values of Start Schedule.
In certain usecases, it might be required to share schedule parameter values between a scheduled Run and a Submit Now Run. To enable sharing, Run as part of schedule checkbox needs to be enabled when doing a Submit Now operation. Below image shows the option:
Note: Run as part of schedule checkbox shows up only if there is a schedule defined for the integration.
Based on the checkbox selection, appropriate Current Value and Default Value will be displayed in the table.
Updating schedule parameter values of a scheduled Run after starting schedule
Schedule parameter values of a scheduled Run can be updated in-between Runs. In order to do this, use the menu item Update Schedule Parameters in the Schedule and Future Runs page. This will launch schedule parameter popup and allow updating the values which will be used for the next Run.
Note: If any Run is in running state then update operation is not allowed. Updating parameter values is only allowed in-between Runs as mentioned above.