Search Results

Query Record

The Query Record activity is used to query records based on the filter criteria.

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

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.

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.
Output Map No Specify the output map name of the selected repository model.

Click Select to open the Output Map dialog. All available output map names are listed in the dialog. Select one to apply to your current activity.

Note: This field appears only when the selected repository model is defined with Output Map.
Record State Yes Specify the state of the record that you want to query. The default value is Confirmed.
  • None: Record state is not specified for the query.
  • All: Query all the records.
  • Confirmed: Query confirmed records.
  • Unconfirmed: Query unconfirmed records.
  • Latest: Query the latest confirmed or unconfirmed records.
  • Draft: Query draft records.
  • Rejected: Query rejected records.
Command Qualifier No The qualifier of the command. The default option is None.
  • None: No command qualifier.
  • RelatedRecords: Validate records, and save them without initiating the New Record Introduction Edit workflow.
Note: The RelatedRecords option appears only when the selected repository mode is defined with relationship.
Note: When Command Qualifier is set to RelatedRecords, any option for the Record State and Active fields does not take effect.
File Type Attributes No 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 option is HREF.
  • HREF: Indicates that the client expects the server to return a hyperlink into the application, from where client can download the files represented by the file type attributes.
  • ATTACHMENT: Indicates that the client expects the server to return the file as SOAP attachments to the application.
Future Dated Record No Query records by FED options, and the returned records are based on FED options. By default, the option is No FED.
Note: This field appears only when the selected repository model is defined with the Effective attribute.
  • No FED: Future Effective Date records are not included.
  • Only FED: Include only Future Effective Date records.
  • Include FED: Include Future Effective Date records along with other records.
Active No Query active records. A record is considered active if it is not deleted. By default, the option is TRUE.
  • None: Data for active records and deleted records are retrieved. This option is only available when Record State is All.
  • True: Only data for active records are retrieved, and the query does not return any deleted records.
  • False: Only data for deleted records are retrieved, and the query does not return any active records.

Description

Provide a short description for the activity.

Advanced

The Advanced tab contains the following fields.

Field Module Property? Description
Query based on Classification Scheme No Select this check box to query records based on classification schemes.
Note: This check box is available only when the selected repository is defined with classification scheme and Command Qualifier is set to NONE. When this check box is selected, the Classification node appears in Transaction 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.
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
Pagination Specify the following detailed information:
  • MaxCount: Limit the number of returned records if more than one records match the query.
  • StartCount: Specify the count where the queried records start to be displayed.
  • OrderByColumnList: Sort order for the query results by column list.
EffectiveDate The effective date of the record.
Note: The node appears only when the repository model is defined with the Effective attribute, and the Future Dated Record is set to No FED in the General tab.
Classification Specify classification information of the record. You can specify the value of ClassificationSchema, or ClassificationCodePath.
Note: This node appears only when the Query based on Classification Scheme check box is selected in the Advanced tab.
Repository
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: Whether this field appears depends on the MDM metadate. This field appears when the attribute in the MDM metadate sets Searchable to TRUE, and the field disappears when Searchable is set to False.
  • PRODUCTID: Record ID. It is mandatory when Command Qualifier is set to RelatedRecords in the General tab.
  • PRODUCTIDEXT: Record ID extension. It is mandatory when Command Qualifier is set to RelatedRecords in the General tab.
Note: New data types Long and URL are supported. The XPath Expression is used to edit complex data types, use the function constructor.
Note: Operator NotIn is now supported for string data type.
RecordVersion Identify the version of the record to be queried.
Note: It is mandatory when Command Qualifier is set to RelatedRecords in the General tab.
RECORD_MODDATE Identify the modification date of the record being queried.
Note: The attribute does not appear when Command Qualifier is set to RelatedRecords in the General tab.
Relationship Specify the relationship of repositories. After selecting an available relationship name, the related repository is displayed, and you can specify the corresponding attributes in the target repository.
  • CheckExistence: You can specify true or false for each relationship search.

    If CheckExistence is true, then all the parent records which have related records in that relationship will be returned. If false, then all the parent records which do not have any related records in that relationship will be returned. By default, the value is true.

  • Count: Specify the count in the text field for the search.

    Count specifies the number of parent records with or without related records in that relationship depending on true or false selected for CheckExistence. The default value = -1 (all records which match criteria).

Return Specify requirements for the records, related records and the relationship to be returned after the filter.
  • All: Return all the child records. You can specify the depth of relationship.
  • RelationshipNames: Return records related to the specified relationship name.
  • ClassificationData: Return classification details of records. The node appears only when the Query based on Classification Scheme check box is selected in the Advanced tab.
Note: The node appears only when Command Qualifier is set to NONE, and the selected repository is defined with relationship or classification.

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

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