Altair® Monarch® Server

 

Prerequisites Elements

Prerequisites elements in the Process Designer tool check prerequisites specified by the user.

The table below specifies functionality of the Prerequisites group elements.

Element Name

Description

Properties and Comments

Check File

File prerequisite that tests for  existence of the specified file or files. This can be a file name or a wildcard specification for the file.

When the process runs, Automator will check the specified prerequisites to see that they have been met, and if they have been, the operations defined by grey connectors will run.

If they have not, the operations defined by red connectors will run.

  • Name — name of the graphic element.

  • File Path — path that shows the File Prerequisite location.

The File Path parameter can be filled out manually or using Browse.

Actions:

  1. Click the Browse button to open the Browse dialog.

  2. Select the data source type in the Source Type drop-down list (currently, Local or Named Paths).

  3. Depending on the selected data source type, specify the other parameters:

    • For the Local type: Location of the prerequisite and Path to this file using the suggested folder directory;

    • For the Named Paths type: Named Paths and the path to the  prerequisite using the Named Path Content box (use search capabilities if needed).

  4. Click the OK button.

    • Test — use this button to check file availability in the specified location.

Check Cmd

Command line prerequisite that runs the specified command line and tests that it returns the given success code.

When evaluating this prerequisite, the server runs the command in a hidden window and checks that its return code matches the expected success code.

By default the success code is 0 (zero), which is the default success code for programs if they complete successfully.

  • Name — name of the graphic element.

  • File Path — path that shows the Command Line Prerequisite location.

The File Path parameter can be filled out manually or using Browse.

 Actions:

  1. Click the Browse button to open the Browse dialog.

  2. Select the data source type in the Source Type drop-down list (currently, Local or Named Paths).

  3. Depending on the selected data source type, specify the other parameters:

    • For the Local type: Location of the Command Line Prerequisite and Path to this file using the suggested folder directory;

    • For the Named Paths type: Named Paths and the path to the   Command Line Prerequisite using the Named Path Content box (use search capabilities if needed).

  4. Click the OK button.

    • Arguments — arguments for command line.

    • Success code — integer code which returns by the specified command line.

    • Test — use this button to check returning the command line success code.

Check Input

Input prerequisite that tests for the existence of the specified input.

  • Name — name of the graphic element.

  • All files must exist — specifies that all of the input files should exist. When the process runs, Automator will check all specified inputs to see that they have been met, and if they have been, the operations defined by grey connectors will run. If they have not, the operations defined by red connectors will run.

  • At least one file must exist — specifies that at least one of the input files should exist. When the process runs, Automator will check the specified inputs to see that they have been met according to the Check Input settings, and if at least one of them has been, the operations defined by grey connectors will run. If they have not, the  operations defined by red connectors will run.

  • Check file consistency — specifies that a file size check be carried out once the prerequisite is found. This allows the system to cope with slow, unreliable, or multi-stage write sources. Automator will test the input file by ensuring that the file size has not changed for a specified period and that the file is fully ready to be processed.

If Check Input is not added and the specified inputs do not exist, the process execution will not fail because non-existent inputs will be ignored.

Verify Model

Automator supports verification of report inputs on a process-by-process basis.

Note: Verification is not available for database inputs. If a process calls for database inputs, the verification options are simply ignored.

Verification settings allow you to specify the kind of verifications you want it to perform while processing. When verification is enabled, Automator may verify field boundaries, data types and filter results.

  • Name — name of the graphic element.

  • Filter produces at least one row — checks that when the specified filter is applied to the data, the resulting table contains at least one row.

  • Filter produces no rows — checks that when the specified filter is applied to the table, no rows are produced. For example, you may have created a filter that performs checks on your data to ensure that it is valid, and if any bad rows are returned by this filter, you wish to abort the procedure.

  • Unfiltered table has at least one row — checks that the unfiltered table contains at least one row of data.

  • Field boundaries and data types for text inputs — checks that all fields are in the correct location, have correct length, and are of the correct data type. This is equivalent to using the verify feature in Monarch. Note that any verification settings recorded in the Monarch model will be honored. These can be found in the Field List of Monarch.

Note: This feature is not available for database and PDF inputs.

  • Text field lengths — checks that all text fields have valid field length.

  • Numeric field decimals — checks that all numeric fields have valid decimals.

  • Numeric field lengths — checks that all numeric fields have valid field length.

  • Database fields — checks that all database fields have been defined correctly.

  • Calculated fields — checks that all calculated fields have been defined correctly.

  • Date/time format precisions — checks that all date/time fields have the correct format precision.

When you select a verification option, verification is activated.

 

If verification fails setting

  • Continue. Automator will continue processing the associated actions for all inputs even if a verification failure of the specified kind is encountered.

  • Continue with verified only. For input files processed as a group, Automator will continue processing the associated actions for these inputs only if they were all verified successfully. For input files processed individually, Automator will continue processing the associated actions only for the inputs verified successfully; those that failed verification will not be processed.

  • Stop. The first failed verification causes the Verify Model to immediately fail.

  • Stop without error notifications. The job is stopped, but no email alert is sent. In this case, the job log message is "Job completed without errors."

Note: To use input files that were not verified successfully, the Verify Model element should be connected to another element using the green line.

Verify Workspace

Automator allows results in a workspace to be verified so that users can stop, proceed, or proceed with notification.

  • Name — name of the graphic element.

  • Load Plans to be verified — select the load plan/s for verification.

The user can select several load plans by ticking their corresponding checkboxes. To export all load plans, select the All Load Plans checkbox.

Verification options — choose the verification to be done:

  • Verify DataSource availability – select this option to check whether the data source specified is available.

  • Check that number of rows is – select this option to check if the number of rows meets the specified value:

    • Greater than or equal to: set the minimum number of rows for verification

    • Equal to zero: set the number of rows for verification to zero

If verification fails setting

  • Continue. Automator will continue processing the associated actions for the workspace even if a verification failure of the specified kind is encountered.

  • Continue with verified only. Automator will continue processing the associated actions for the workspace only if it was verified successfully.

  • Stop. The first failed verification causes the Verify Workspace to immediately fail.

  • Stop without error notifications. The job is stopped, but no email alert is sent.