Delete Record

By using the Delete Record activity, you can delete records when they exist, and when the latest version of the records is not in any workflow. You can delete repository records, records related to target records, both repository records and related target records, and future effective date record versions.

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 DeleteRecord.

MDM Connection Yes The MDM connection resource establishes a connection to an MDM server, allowing the plug-in to communicate with TIBCO MDM.

Click to select an MDM connection.

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.
  • SYNCHR: The client invokes a service, and waits for the completion of the workflow execution.
  • ASYNCHR: The client invokes a service, but does not wait for the completion of the workflow execution.
Repository No The name of 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.
Command Qualifier No The qualifier of the command. The default option is DeleteAll.
  • Record: Delete the specified records, and initiate the delete workflow.
  • Record/NoProcess: Delete the specified records, and confirm it immediately without initiating the delete workflow.
  • RelationshipTargets: Only delete the related records, and initiate the delete workflow. Optionally, the relationship name can be specified.
  • RelationshipTargets/NoProcess: Only delete the related records, and confirm it immediately without initiating the delete workflow. Optionally, the relationship name can be specified, and users must have required privileges.
  • DeleteAll: Delete the specified records and related records, and initiate the delete workflow. Optionally, the relationship name can be specified.
  • DeleteAll/NoProcess: Delete the specified records and related records, and confirm the records immediately. Optionally, the relationship name can be specified, and users must have required privileges.

Description

Provide a short description for the activity.

Advanced

The Advanced tab contains the following fields.

Field Module Property? Description
Delete Future Effective Dated Version No Select this check box to delete a specified future effective dated version if:
  • The version number is specified.
  • The specified version is future effective dated and active.
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.

Input

The following is the input for the activity.

Note: See General Input for MDM Activities for details about some general input items for this activity.
Input Item Description
atomic Set the value of this attribute to:
  • on: Turn on MDM transaction atomicity. When any command executed in a transaction fails, the transaction fails and is rolled back.
  • off: Turn off MDM transaction atomicity. This is the default value. When some commands executed in a transaction fail and some succeed, the successful results are written to MDM system.
Repository
RecordVersion Specify the version of the record to be deleted. If this value is set to Yes, old record versions are deleted.
Note: This element appears only when the Delete Future Effective Dated Version check box is selected in the Advanced tab.
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.
  • PRODUCTID: Record ID. When PRODUCTID is not specified, a PRODUCTID will be generated automatically if users have configured rulebase on the MDM server; otherwise, an error is returned.
  • PRODUCTIDEXT: Record ID extension. Optionally used to identify a record.
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.
Note: When the Command Qualifier filed is set to Record or Record/NoProcess in the General tab, this item does not appear in the Input tab.

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.
This node contains the following three elements:
  • Severity: Can be Error, Warning, or Info.
  • Code: The error code.
  • Description: A readable description of the error.
Transaction
Response Detailed information of the repository and ResultList:
  • Repository: Contains the repository attributes and relationship information.
  • ResultList: Contains errors, warnings or informational messages. This element has one or more entries.
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.

This element also captures details such as Result, SuccessCount, EventID, EventStatus, EventState, Action, and so on.
  • SuccessCount: Indicates the number of records successfully processed.