Add Record

The Add Record activity enables you to add records and the relative relationship to repositories.


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

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.
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 context variable is not recommended. However, if used, the perspective drop down preferences takes precedence of the context variable.
Record State Yes The state in which you want to save the record. The default option is Unconfirmed.
  • Confirmed: Save as confirmed records.
  • Unconfirmed: Save as unconfirmed records.
  • Draft: Save as draft records.
Command Qualifier Yes The qualifier of the command. The default option is Validate/Process.
  • Validate/Process: Validate records, save them, and initiate the New Record Introduction Edit workflow.
  • Validate/NoProcess: Validate records, and save them without initiating the New Record Introduction Edit workflow.
  • NoValidate/Process: Save records without validation, and initiate the New Record Introduction Edit workflow.
  • NoValidate/NoProcess: Save records without validation nor initiation of the New Record Introduction Edit workflow.
Note: When Record State is set to Draft, only Validate/Process and NoValidate/Process 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.
  • ATTACHMENT: Indicates that the client sends the file as SOAP attachments to the MDM server.
Note: Currently, we only support ATTACHMENT.


Provide a short description for the activity.


The Advanced tab contains the following field.

Field Module Property? Description
Classify Records Manually No Select this check box to manually classify records into the specified classification code by using Classification Scheme while adding 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.


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.
Note: The input data (string constants) should be entered using double quotes. However, you may encounter validation error. For more information, on XPATH handling in BusinessWorks refer to the Chapter XPath in the TIBCO ActiveMatrix BusinessWorks™ Application Development.
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 the MDM system.
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, the error message Record ID cannot be empty is displayed.
  • PRODUCTIDEXT: Record ID extension. Optionally used to identify a record.
  • EFFECTIVEDATE: The effective date of the record. If you do not apply an effective date to a record, it is internally set to the current system date. By default, this attribute is not enabled for repositories, you must add this attribute manually to repositories if you want to add a future effective dated version to a record.
Note: New data types Long and URL are supported. The XPath Expression is used to edit complex data types, use the function constructor. Also the Fix Type-Casting Errors option can be used to correct data input format.
ClassificationSchemes The ClassificationSchemes attribute allows you to organize records based on their attributes. You can specify the value of Name, Action, and ClassificationCode.
  • Name: The name of classification scheme you want to specify.
  • Action: The classification action you want to take. The value is Classify.
  • ClassificationCode: The code of the classification scheme. Each node represents one level in the classification code hierarchy.
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.
  • Incremental: When the value is set to True, the relationship is only added to the specified record. When the value is set to False, the newly specified relationship is added, and all other relationships are deleted. By default, the value is set to True.
  • Delete: The relative relationship between records is deleted when the value is set to True, and the relative relationship between records is added when the value is set to False.


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