SaveRecord Parameters and Valid Execution Modes
The valid execution mode for SaveRecord is SYNCHR or ASYNCHR.
The parameters of SaveRecord are as follows:
| Name | Semantics | Type | Valid Values | Multi-plicity |
|---|---|---|---|---|
| Direction: In | ||||
| ApplyValidation
(Optional) |
Indicates whether or not to run the standard rulebase (catalogvalidation.xml) for a repository when the Rulebase parameter is not specified. The parameter is ignored if the Rulebase parameter is specified.
The default value for the ApplyValidation parameter is False. For backward compatibility, you can set the default value to true through Enable standard validation execution in SaveRecord activity configuration property. In this case, the standard validations are always executed even though the Rulebase parameter is not specified. If the ApplyValidation parameter is explicitly passed in activity, it takes precedence over the Enable standard validation execution in SaveRecord activity configuration property. |
Boolean | True
False (Default) |
0..1 |
| AsynProcessIndicator (Optional) | See Common Parameters. | |||
| Comment (Optional) | Comment to be stored in the productlog message. This message is shown on the product history page. | string | 0..1 | |
| ErrorSeverity (Optional) | See Common Parameters. | |||
| InDocument (Optional) | See Common Parameters. | |||
| MasterCatalog (Optional) | This parameter needs to be specified if InDocument is specified.
The activity tries to get the repository name in the following order: From InParameter From InDocument An exception is thrown and the workflow quits if the:
If InDocument is not passed, it is mandatory to pass the repository name as a parameter in order to get the MCT_ID. |
string | 0..1 | |
| OverrideConflict (Optional) | If true, overrides the conflicting attributes else, conflict is fired. | boolean | True
False (Default) |
0..1 |
| Overwrite (Optional) | Overwrite flag indicates that data being saved will overwrite any concurrent updates being done by other processes if updates are attempted at the same time. | boolean | True
False (Default) |
0..1 |
| PerspectiveName (Optional) | See CreateWorkItem Parameters and Valid Execution Modes. | |||
| ProductExtns (Optional) | Used when the ProductIds parameter is used.
Indicates the extensions of the records to be processed. |
arraylist | 0..1 | |
| ProductIds (Optional) | Indicates the product IDs of the records to be processed.
This is a required parameter only when you want to process the record from the input. The attribute value can also be provided as an arraylist. However, the attribute value arraylist size must be equal to the product ID list size. |
ArrayList | 0..1 | |
| Reason (Optional) | The reason to be stored in the productlog message. This message is shown in the product history page. | string | 0..1 | |
| RecordPer AsyncCall (Optional) | See Common Parameters. | |||
| Rulebase (Optional) | See
Common Parameters.
If this parameter is not specified, the activity executes the standard validations. |
|||
|
RetainExistingRelati onships |
If InDocument is used as an input parameter, all the old relationships are removed if they are not part of the document. However, if you specify RetainExistingRelati onships to true, the existing relationships are retained, which are not part of the current document. | boolean | True
False (Default) |
0..1 |
| Standard Validation (Optional) | Whether to do Standard Validations in addition to those specified in Rulebase. | boolean | True
False (Default) |
0..1 |
| RecordState (Optional) | Specifies the state of a record. Valid values are DRAFT, CONFIRMED, or UNCONFIRMED.
This parameter replaces the Status parameter. Since 8.3.0 release, the Status parameter is deprecated. For backward compatibility, if you do not specify the RecordState parameter, the Status parameter is searched and used. However, it is recommended that you specify the RecordState parameter. |
string | DRAFT CONFIRMED UNCONFIRMED (Default) | 0..1 |
| VersionOption (Optional) | See Common Parameters. | |||
| VersionPolicy (Optional) | See ImportCatalogRecords Parameters and Valid Execution Modes. | |||
| Direction: Out | ||||
| OutDocument (Deprecated) | See
Common Parameters.
For backward compatibility, outDocument will be the same as InDocument. |
|||
| Records Attempted (Optional) | Number of records attempted to update. | long | ||
| RecordsWith Errors (Optional) | Number of records that had an error during save. Error could occur during save, relationship save, or classification extraction. | long | ||
| RecordsWith Warnings (Optional) | Number of records that had a warning during save. A warning could occur during save, relationship save, or classification extraction. | long | ||
| StaleDataError (Optional) | The StaleDataError is thrown from concurrent record updates by multiple users/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 resolve the StaleDataError, 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 the user has to wait to save the record that is concurrently being modified by another user. Specify the time period value for the Specify Timeout property in Configurator. By default the time period is 300. |
boolean | True
False (default) |
|