EvaluateRuleBase Parameters and Valid Execution Modes
The valid execution mode for EvaluateRuleBase is SYNCHR.
The parameters of EvaluateRuleBase are as follows:
| Name | Semantics | Type | Valid Values | Multi-plicity |
|---|---|---|---|---|
| Direction: In | ||||
| AllowDuplicate InOutput (Optional) | Configures whether to allow duplicates in output variables. | boolean | True (Default)
False |
0..1 |
| AllowDuplicate InReturn (Optional) | Configures whether to allow duplicates in the ResultArray. | boolean | True
False (Default) |
0..1 |
| AsynProcessIndicator(Optional) | See Common Parameters. | |||
| BundlePerAsyncCall (Optional) | See Common Parameters. | |||
| CatalogValidation (Optional) | Whether to execute the catalog’s
catalogvalidation.xml file.
Only works if the Rulebase parameter is not specified. |
boolean | True
False (default) |
0..1 |
| ErrorSeverity (Optional) | See Common Parameters. | |||
| EvaluateChildren (Optional) | Controls the rulebase evaluation on child records.
By default (true), the rulebase is evaluated on child records present in the bundle. If this parameter is set to false, the rulebase is applied on the root record and not on the child record. Limitation: This parameter only works if a record list is passed and not when a document is passed. |
boolean | True (default)
False |
0..1 |
| ExecutionMode (Optional) | Lets you select the Run once mode. You can execute a custom function, or any SQL based rulebase which operates on all the records in one execution. | string | NoRecords
AllRecords (default) NoRecords means that the rulebase will be executed only once without considering any records. |
0..1 |
| <InputNames> (Optional) | Any values can be passed to the activity. These values are available to the rulebase. The name of the variable must match the declaration in the rulebase:
<declare usage=”input”> |
string | Have to be declared as input variables in the rulebase. | 0..n |
| IncludeDeletedRecords (Optional) | When this parameter is set to true, deleted records are also processed. | boolean | True
False (default). |
0..1 |
| InDocument (Optional) | See Common Parameters. | document | 1 | |
| InRecordList | See Common Parameters. | |||
| LogOption (Optional) | Determines what information is logged and how it is to be logged. You can combine the options as per your requirement.
For example, if you want errors to be reported in a file, specify FE. |
string | A - Errors are stored in an AttributeLog database table.
E - Only errors are reported (warnings and information messages are not reported). F - Errors are reported in a file. |
0..1 |
| OverwriteRelationships
(Optional) |
If specified as True and relationship names are passed, the relationships of RecordCollection are overwritten. | Boolean | True
False (Default) |
1 |
| PerspectiveName (Optional) | See CreateWorkItem Parameters and Valid Execution Modes. | |||
| RecordPerAsyncCall (Optional) | See Common Parameters. | |||
| RelationshipName (Optional) | See
Common Parameters.
When processing rootrecord, the recordBundle is created for the rootRecord with all relationships as defined in the Database and the rulebase is applied on all the records in the bundle. If a rulebase is to be applied on a bundle with specific relationships, the name of the relationship can be specified in the workflow file using this parameter. A record bundle is then created for the specified relationshipName only. The order of configuration is: Workflow file > Configuration file > Default value. |
|||
| RemoveRecord (Optional) | Whether to remove a record from the RecordList if an error occurs.
If the parameter is set to FATAL, records with fatal errors are removed (as specified by Severity). This option is applicable only if InRecordList is present. |
string | NONE
FATAL (default) |
0..1 |
| Rulebase (Optional) | See Common Parameters. | |||
| SaveFlag (Optional) | Whether to save the product if transformations are done. | string |
SAVE NOSAVE |
0..1 |
| Severity# (Optional) | Additional Severity cut-offs. Start at 1.
Replace # with an integer, for example, Severity1, Severity2. Severity1 Severity2 … Severity9 |
long | 0 - 99. | 0-9 |
| StandardValidation (Optional) | Whether to perform Standard Validations in addition to those specified in the Rulebase. | Boolean | True
False (default). |
1 |
| ValidationExclusion
(Optional) |
Indicates the relationships to be excluded while applying validations on record bundle. | String | Default value is null. | |
| VersionPolicy (Optional) | See ImportCatalogRecords Parameters and Valid Execution Modes. | |||
| Direction: Out | ||||
| OutDocument (Optional) | See Common Parameters. | |||
| ValidationErrors (Optional) | Number of Validation errors encountered when checking all products with severity <= errorSeverity. | long | N/A | 1 |
| ValidationErrors# (Optional) | Count in Severity Buckets.
Replace # with an integer, for example, ValidationError1, ValidationError2. ValidationError1 = Severity <s<= Severity1, ValidationError2 = Severity1 <s<= Severity2, … Validation(n) = SeverityN-1<s<=SeverityN Validation(Last) = s > Severity(Last-1) Number of ValidationError counts will be one more than the Severity specifications, to allow for last (greater than) entry. |
long | N/A | 0-9 |
| ResultArray (Optional) | Array of Return values from the Rulebase.
Values for each Record will be concatenated. By default, duplicates are NOT allowed unless AllowDuplicateInReturn is set to True. |
arraylist | N/A | 0..n |
| <OutputName> (Optional) | Output Variables from the Rulebase.
Name must match the <declare usage=”output”> tag in Rulebase. By default, duplicates are allowed unless AllowDuplicateInOutput is set to “False”. |
arraylist | Have to be declared as “output” variables in the Rulebase. | 1 |
| RecordsProcessed (Optional) | Count of Number of Records processed by the activity. | long | 1 | |
| OutRecordList (Optional) | See Common Parameters. | |||
| OutRecordList2 (Optional) | List of records that failed validation. | recordlist | Records that fail validation. | 1 |
| StaleDataError (Optional) | The StaleDataError is thrown from concurrent record updates by multiple users or workflow threads. If this parameter is specified and if the StaleDataError occurs, this parameter is set to
true and the workflow continues. If this parameter is not specified and there is an error, an exception is thrown.
To prevent the StaleDataError that may occur due to concurrent modifications done through UI or web services, select true for the Enable Save Lock (com.tibco.cim.record.useSaveLock) property in Configurator. The property enables locks to avoid concurrent modification of parent and its child record. Additionally, you can specify the time period for which you can wait to save the record that is concurrently being modified by another user. Specify the time period for the Specify Timeout property in Configurator. By default, the time period is 300 seconds. |
boolean | True
False (Default) |
1 |