Configure SF_Scheduler Table
The following table provides detailed explanations for the columns in the SF_Scheduler table. If you are upgrading from a previous version, please refer to Important Upgrading Information prior to proceeding.
SF_Scheduler Table Column Explanations
| Column | Type | Description |
|---|---|---|
| ANALYSIS | String | Name of the analysis contained in the AF database.The name must be in the AF2 format <MODEL::ANALYSIS> (e.g. MYMODEL1::MASSBALANCE).Note that this parameter is not case-sensitive. |
| ENABLED | Boolean | If TRUE, automatic execution is enabled for the target analysis.If FALSE, automatic execution is disabled for the target analysis. |
| PERIOD | Int32 | Identifies the number of seconds the Scheduler attempts to fire an execution for the analysis.Note: This is not the period/frequency/offset/duration that is configurable at the AF TimeRule level.This parameter refers to the cycle in which the Scheduler attempts to run an execution. The parameter in this column must be lower or equal to the 'Frequency' parameter configured inside the TimeRule of the analysis. |
| RERUN | Boolean | If SKIPCHECKIN is FALSE and RERUN is TRUE, it is equivalent to checking the "Case Re-execution" checkbox in the Scheduler Configuration Tool. With this combination, every time the scheduler runs it must execute the last case of the analysis.If SKIPCHECKIN is FALSE and RERUN is FALSE, Scheduler will not re-execute the last case each time it runs.If SKIPCHECKIN is TRUE and RERUN is TRUE, it is equivalent to checkign the “Follow the time” checkbox in the Scheduler Configuration Tool.With this combination, every time the scheduler runs it align the case times to the latest available case, skipping any intermediate execution.If SKIPCHECKIN is FALSE and RERUN is FALSE, Scheduler will execute the next case after the latest executed case.CAUTION: Setting both SKIPCHECKIN and RERUN to TRUE disables any possibility of history recovery. In some special situations, it can also cause the Scheduler to skip several intermediate executions. |
| VALIDITY | String | The validity time inside the day.The value format is: HH:mm:ss-HH:mm:ss.For example: 01:00:00-19:30:00, meaning that the calculation is executed only within 01:00am and 7.30pm. Outside these limits the execution is skipped.To execute one analysis 24 hours per day, just configure this as 00:00:00-23:59:59. |
| INITIALCASE | DateTime | Indicates when the History Recover must start.For those analyses with SKIPCHECKIN set to TRUE, this parameter indicates when the history recovery should start.For those analyses with SKIPCHECKIN set to FALSE, the history recovery starts from the latest stored case in the database up until the current date and time. |
| MAXCASE | Int32 | Maximum number of newly created case for each execution. 0 or -1 means infinite case creation (a good practice is to leave this value from 10 to 20) in order to avoid heavy restart of the service and a heavy workload of the Sigmafine Server |
| SKIPPUBLISH | Boolean | TRUE means skip the Case Runner 'Publish' step.FALSE means perform the Case Runner 'Publish' step. |
| SKIPCHECKIN | Boolean | TRUE means skip Check-In step (avoid to storing case and results).FALSE means perform the Check-In step (store the case results).When this parameter is set to FALSE, it cannot be combined with the UTC parameter set to TRUE. |
| SQLPUBLISH | Boolean | TRUE means run SQLAccess publication at the end of the execution, FALSE means do not run SQL Access publication. This field is enabled, and it is working only in conjunction with SKIPCHECKIN = FALSE. |
| SQLTYPE | String | Indicates the type of server to which SQL Access should publish.PI = SQL Access Publication to PISQL = SQL Access Publication to SQL ServerFor further information please review SQL Access user’s Manual |
| DEPENDENCY | String | With a dependency analysis in the format: MODEL1::ANALYSIS1;MODEL1::ANALYSIS2;… etc., this setting forces the Scheduler to verify all the "depending" analysis."Depending"simply means that the Last Execution Case End-Time indicator is greater or equal to the actual analysis Last Executed Case End Time.Note that this parameter is not case-sensitive. |
| FOLLOWTIME | Boolean | If set to TRUE, this parameter instructs the Scheduler to recover from the latest available case, skipping any previous cases to be recovered.CAUTION: This is a very dangerous setting, as it may lead to data-loss if used without accuracy.The principle of this parameter is to support those analyses without the need of a chain of cases:If set to FALSE (default), this parameter instructs Scheduler to follow normal scheduling.Important Note: If the flag “FOLLOWTIME” is true, at restart in case of prolonged unavailability, the system restart from the latest available generating a data-hole over the chain of the executed cases. It is up to the user carefully check this feature activation. |
| INSTANCE | String | The Name of the Scheduler instance that is to run the analysis.Important Note: If this parameter is left blank (empty), the analysis will be executed by all Schedulers installed on the system. This can be dangerously risky, as it could cause overlapping executions and case duplication issues. |
| RERUNNUM | Integer | Number of automatic case re-runs to be performed.This parameter works only if the RERUN is enabled (activated).The default value is 1, meaning that the Scheduler will re-run only the last case. If this parameter is set to 5, the Scheduler re-runs the last case and the previous 4 cases starting from the less recent case. |
| PLATFORM | String | Identifies the platform.This parameter accepts only 2 settings: x64 or x86.By default, this parameter is set to a blank, which Scheduler interprets as x64, and therefore runs in x64 mode. |
| COPYVALUES | Boolean | If set to TRUE, this parameter activates the "Copy value from previous case" option in the Configuration Tool. What this does is instruct the Scheduler to replicate the same ADA (Sigmafine Advanced Diagnostic Add-In) feature for copying some values from the previous case. The configuration of which values have to be copied by the system can be configured via ADA. Please note that this feature will run only while Scheduler CREATES a new case and it does not run during re-runs.Prior to enabling this feature, Pimsoft strongly suggests that you carefully check the data in the Sigmafine database, as when this feature is automatically enabled, it may lead to some data overwrite issues. Moreover, like in ADA, this feature has the following limitations:It manages only elements, skipping TRANSFERSIt manages only elements based on templates. Elements without templates are skipped (since they cannot be managed by ADA configuration table)It Manages only GOOD data, so if the previous case has an attribute marked as “BAD”, the copy-action will be skipped .If set to FALSE (default), this parameter does not activate the "Copy value from previous case" option. |
| UTC | Boolean | If set to TRUE, it indicates that Scheduler should use UCT Scheduling.If set to FALSE, it indicates that Scheduler should use standard Scheduling.Note:Important Notes: This flag is supported over analyses with a daily or 24 hour execution only. No other settings are allowed. In cases where UTC Scheduling is enabled, the execution engine checks this parameter against the INITIALCASE. The engine evaluates the lag between the local-time and the UTC time of the Date/Time specified for the INITIALCASE. It then applies this rule, and upon changing the offset from UTC, it automatically changes the locale time accordingly. This ensures the same distance is kept from UCT, as shown in the following figure:![Figure 1044: Evaluated lag time between local time and UTC |
Important Upgrading Information
The following information is provided for those who are upgrading from a previous version of Pimsoft Sigmafine Scheduler:
- Scheduling tables have been heavily modified starting from Sigmafine Scheduler release 2.5.0. therefore, Sigmafine Scheduler 2.5 or greater is not compatible with scheduling tables of older versions of Sigmafine Scheduler (2.0, 2.1 and 2.2). If users are migrating from versions below 2.5, the configuration must be rebuilt from scratch.
- Several parameters were added along different versions. Here below the changes to the table:
- FollowTime option is available only in release 2.6.0 or greater
- Instance and ReRunNum parameters are only available from release 2.7.0 or greater
- Platform and UTC are only available from release 4.6.5 or greater
- CopyValues feature is only available from release 4.6.8 or greater