Specify Execution Parameters

Select Number of Threshold Sets

Depending on the number of thresholds selected by the user, as many number of drop-downs will be appeared in next paragraph where different threshold set ids could be selected for the scenario.

Figure 4-5 Select Number of Threshold Sets

Description of "Figure 4-5 Select Number of Threshold Sets"

Select Threshold Set IDs

You can choose the base threshold set id or threshold set id which was generated through Threshold utility notebook depending on the requirement of the analysis.

Figure 4-6 Select Threshold Set IDs

Description of "Figure 4-6 Select Threshold Set IDs"

Select Run Dates and Batch Name

Figure 4-7 Select Run Dates - Date Strings

Description of "Figure 4-7 Select Run Dates - Date Strings"

When Select Run Dates is Date Strings the input text box takes the comma separated dates. Run dates when passed as a comma separated, then all possible combinations with threshold set ids will be created. For example: If run dates are passed as a comma separated 20211007, 20211014, 20211022 then threshold set ids are 116000048, 118860048, 78. The possible combinations are:
```
{"20211007": [116000068, 118860048, 78], 
    "20211014": [116000068, 118860048, 78], 
    "20211022": [116000068, 118860048, 78]}
```
Note:
Make sure that you enclosed keys of dictionary into the double quotes.

Figure 4-8 Select Dates - Date Strings

Description of "Figure 4-8 Select Dates - Date Strings"

The other option is selective run date - threshold set id combinations by passing dictionary as an input.

For example:

{"20211007": [116000068], 
    "20211014": [118860048, 78], 
    "20211022": [116000068, 118860048, 78]}

Note:

Make sure that you enclosed keys of dictionary into the double quotes.

Re-run/Update-run should be True if you are re-executing the scenarios for failed run_dates/threshold_set_ids or appending any new run_dates/threshold_set_ids to existing version.
- Re-run/Update-run is only applicable when Input Run Dates is selected as Date Strings.
- The run_dates can be passed either comma separated or dict of (run_dates,threshold_set_id) combinations.
- If it was re-executed with flag is False, then entries into DB tables will not be updated. However, scenario would be executed.

When Select Run Dates is Date Ranges the input text box takes date format as shown in the following figure.
The description for date range inputs are as follows:
- From Date: Enter the starting date. This field is mandatory. For example, 20211007 .
- To Date: Enter the ending date. If it is None, then the count should be mandatory to pass. This field is optional. For example, 20211022.
- Frequency: Frequency of a scenario. By default, it isMonthly. This field is mandatory. For example, Weekly.
- Count: The maximum number of recurrences to generate. This field is optional.
- By Month Day: Integer or a sequence of integers, meaning the month days to apply the recurrence. This field is optional.
- Re-run/Update-run: A Boolean flag (True/False) is provided to re-run the failed run dates or append the new run dates with the existing definition. The value is either True or False.
The selected parameters are as follows:
- From Date: 20211007
- To Date: 20211022
- Frequency: Weekly
- Count: None
- By Month Day: None
- Re-run/Update-run: False

Show Selected Parameters

%python-pgx
asc.show_scenario_parameters()

Note:

You must examine all parameters carefully especially Run Datesbefore these are feeding to scenario execution notebook. In case of any discrepancies, set the “Run Dates” again and verify using this API.

Create Definition

You can create a definition that will be used to track all data that is to be generated by executing this scenario and any analysis to be carried out thereafter on this data.

Figure 4-9 Create Definition

Description of "Figure 4-9 Create Definition"

To use an existing definition and overwrite the existing results, set Save With New Version = False, Clean Results = True and set Version to the version you want to cleanup the existing results and start again. If the Version is set to None, the most recent version will be cleaned up.
To use an existing definition and merge results to existing results, set Save With New Version = False, Clean Results = False and set Version to the version you want to merge. If the Version is set to None, the most recent version will be used.
To create a new version and map the results to this version, set Save With New Version = True and Version to the version you want to create. If you set Version to None, a new version will be created after incrementing the most recent version by 1. Clean Results will have no impact when creating a new version.

Show Definition

To show definition, execute the following.

%python-pgx

asc.show_definition()