Modify Record
By using the Modify Record activity, you can modify records and the relative relationship in repositories.
General
The General tab contains the following fields.
Field | Module Property? | Description |
---|---|---|
Name | No | The name to be displayed as the label for the activity in the process.
The default value is ModifyRecord. |
MDM Connection | Yes | The MDM connection resource establishes a connection to an TIBCO® MDM server, allowing the plug-in to communicate with TIBCO® MDM.
Click
If no matching MDM connections are found, click Create Shared Resource to create one. |
Execution Mode | Yes | Select an execution mode. The default option is
SYNCHR.
|
Repository | No | The name of the repository where records are stored.
Click Select to select a repository. Note: When the selected repository model is complex and involves many related repositories, you need to increase the value of the
-Xms and
-Xmx parameters in the
TIBCOBusinessStudio.ini file which is located in the
TIBCO_HOME\studio\version\eclipse directory.
|
Perspective | No | Specify the perspective name within the selected repository.
Click Select to open the Perspective dialog. All available perspective names are listed in the dialog. Select one to apply to your current activity. Note: The field appears only when the selected repository model is defined with Perspective.
Note: The usage of a context variable is not recommended. However, if used, the perspective drop down preferences takes precedence of the context variable.
|
Record State | Yes | The state of the record that you want to save. The default option is
Unconfirmed.
|
Command Qualifier | Yes | The qualifier of the command. The default option is
Validate/ProcessOnDataChange.
Note: When
Record State is set to
Draft, only
Validate/Process,
NoValidate/Process,
Validate/ProcessOnDataChange and
NoValidate/ProcessOnDataChange are available.
|
File Type Attributes | Yes | Specify how to upload a file with file type attributes. This field is available when any attribute defined in the selected repository model is a file type attribute. By default, the attribute is
ATTACHMENT.
Note: Currently, we only support
ATTACHMENT.
|
Correction | Yes | Select the checkbox to update a version of any record without incrementing the version.
By default, the checkbox is unchecked, the record is modified as per the normal modification guidelines with version update. If checked, the version policy of 'Correct' is inserted into the context of the modified request sent to the TIBCO® MDM server. Note: The usage of a context variable is not recommended. However, if used, the perspective drop down preferences takes precedence of the context variable.
|
Description
Provide a short description for the activity.
Advanced
The Advanced tab contains the following fields.
Field | Module Property? | Description |
---|---|---|
Classify Records Manually | No | Select this check box to manually classify records into a specified classification code by using Classification Scheme while modifying a record.
Note: This check box is available only when the selected repository model is defined with manual classification scheme or mixed classification scheme. When this check box is selected,
ClassificationSchemes is added to the
repository node in the
Input tab.
|
Modify Future Effective Dated Version | No | Select this check box to modify a specified future effective dated version if:
Note: This check box is available only when the selected repository model is enabled with the
EffectiveDate attribute. When this check box is selected,
RecordVersion is added to the
repository node in the
Input tab.
|
Modify in Work Item Context | No | Select this check box to modify records in a work item context. To modify records in a work item context, you should have the
Edit when record is in workflow permission.
Note: When this check box is selected,
WorkItemReference is added in the
Input tab.
|
Input
The following is the input for the activity.
Input Item | Description |
---|---|
atomic | Set the value of this attribute to:
|
WorkItemReference | Specify the work item ID that you want to reference.
Note: The node appears only when the
Modify in Work Item Context check box is selected in the
Advanced tab.
|
Repository | |
RecordVersion | Specify the version of the record to be modified.
Note: This element appears only when the
Modify Future Effective Dated Version check box is selected in the
Advanced tab.
|
PRODUCTID | ID of the record to be modified. You must specify PRODUCTID of the record to be modified. |
PRODUCTIDEXT | ID extension of the record to be modified. Optionally used to identify a record. |
Attribute Group | Specify group attributes of records. Each attribute is assigned to an attribute group:
Unassigned,
System or
New Group. The default attribute group
UNASSIGNED holds all attributes that do not belong to any specific group.
Note: New data types
Long and
URL are supported. The XPath Expression is used to edit complex data types, use the function constructor.
|
ClassificationSchemes | The
ClassificationSchemes attribute allows you to organize records based on their attributes. You can specify the value of
Name,
Action, and
ClassificationCode.
Note: The
ClassificationSchemes attribute is added to the
repository node when the
Classify Records Manually check box is selected in the
Advanced tab.
|
Relationship | Specify the relationship of records in repositories. After selecting an available relationship name, you can specify the corresponding relationship attributes and attributes in the target repository.
|
Output
The following is the output for the activity.
Output Item | Description | |
---|---|---|
Result | The execution result to indicate whether the execution has succeeded or not.
The node contains the following three elements:
|
|
WorkItemReference |
Return the work item ID that you have referenced. Note: The node appears only when the
Modify in Work Item Context check box is selected in the
Advanced tab.
|
|
Response | Detailed information of the repository and ResultList:
|
|
TransactionResult | The result of a transaction to indicate if the command has succeeded or not.
Success does not mean the successful completion of the command. However, a failure does mean that the command is aborted. The element also captures details such as Result, SuccessCount, EventID, EventStatus, EventState, Action, and so on.
|