Common Parameters
This section lists common parameters applicable to several activities.
| Name | Semantics | Type | Valid Values | Multiplicity |
|---|---|---|---|---|
| AsynProcessIndicator | Indicates whether the activity needs to be processed synchronously or asynchronously.
This should not be confused with activity definition <Execution>SYNCHR</Execution>. This indicator is a suggestion to the process engine to optimize execution of the activity. The activity may initiate processing using multiple threads. This parameter works with RecordPerAsyncCall to determine if parallel processing should be initiated. When the records to be imported are large in number, they can be divided into groups and imported by different asynchronous calls. When the records to be processed are less than the RecordPerAsyncCall, the AsynProcessIndicator is false even if it is specified as true in the workflow. |
boolean | True (Default)
False |
0..1 |
| IncludeDraftRecords | Specifies that if there are any draft record versions associated with the event, such versions should be considered.
For example: <Parameter direction="in" name="IncludeDraftRecords" type="boolean" eval="constant">false</Parameter> If not specified, default is true to include draft records. This parameter may be set to false if the designer is certain that no draft records should be included. This would result in slightly better performance. |
boolean | True (Default)
False |
1 |
| InDocument | The document to process (typically the workflow request document) in the workflow. There can currently only be one document. | document | MLXML document. | 1 |
| InRecordList | Specifies which records to work on.
If a record collection is passed as input to this activity, this activity processes the record collection. For example: <Parameter direction="in" name="InRecordList" type="recordlist" eval="variable">inRL</Pa rameter> |
recordlist | Valid variable.
Holds the records to be processed. |
1 |
| MasterCatalog (Optional) | The name of the repository. | long or string | Any existing Repository ID or Name. | 0..1 |
| OutDocument (Optional) | The output or returned document. | document | N/A | N/A |
| OutRecordList (Optional) | Output Record List. | recordlist | Output records. | 1 |
| RecordPerAsyncCall | If the activity is being processed asynchronously, this parameter indicates records to be processed asynchronously called message.
The configuration file parameter can be set using the Configurator (Optimization > Records Per Asynchronous Call). The order of configuration is: Workflow file > Configuration file > Default value. |
long | Any number.
20 (Default) The default value is 100. |
1 |
| BundlePerAsyncCall (Optional) | When the records are processed using a record Collection (which is a set of bundles), this parameter needs to be specified. Either BundlePerAsyncCall or RecordPerAsyncCall is used depending on whether bundles are being processed or not.
If the activity is being processed asynchronously, this parameter indicates the bundles to be processed per asynchronously called message. Set the following option to 10 in the Configurator: Optimization > Bundles Per Asynchronous Call. The order of configuration is: Workflow file > Configuration file > Default value. |
long | Any number.
10 (Default) |
1 |
| Rulebase (Optional) | The Rulebase to execute.
Relative to
$MQ_COMMON_DIR.
You can also specify an absolute path, however it is not recommended. If you do not specify any rulebase file, the standard catalogvalidation.xml file is used. The file is located at $MQ_COMMON_DIR\<enterprise_name>catalog>master><repositoryID>. However, to use this file, you must specify the true value for the CatalogValidation parameter of the EvaluateRulebase activity. |
string | Existing Rulebase file. | 1 |
| VersionOption | Specifies the version of a record to be considered for processing. | string | CONFIRMED (Default)
LATEST ALL |
1 |
| ErrorSeverity (Optional) | Defines the error severity. Any severity higher than the specified severity are considered errors and reported using the ValidationErrors output parameter.
This parameter applies when a rulebase is used in the or EvaluateRuleBase activity |
long | 0 – 9.
0 : nothing is considered an error. 9 : everything is considered an error. The default value is 9. |
0..n |
| eventState | Determines the latest state of the workflow. | string | Valid value differs per activity. | 0..1 |
| WorkflowPriority (Optional) | Defines the priority for any workflow initiated from the activity or any message to external JMS queue by Send activity. | long | 0 – 9.
0 – Workflow with 0 is considered low priority. 9 – Workflow with 9 is considered high priority. The default value is 4. |
0 or 1 |
| FEDOption (Optional) | Indicates whether the exported data contains Future Effective Date records. | string | The valid values are:
O: If specified, export data includes only Future Effective Date records. N: If specified, export data does not include Future Effective Date records. I: If specified, export data includes Future Effective Date records and non Future Effective Date records. |
0..1 |