Query Record
By using the Query Record activity, you can 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 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. |
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 are searching for. The default record state is
Confirmed.
|
Command Qualifier | No | The default command qualifier is
None.
Note:
|
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.
|
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.
|
Active | No | Query active records. A record is considered active if it is not deleted. By default, the option is
TRUE.
|
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.
Input Item | Description | |
---|---|---|
Pagination | Specify the following detailed information:
|
|
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 metadata. This field appears when the attribute in the MDM metadata sets
Searchable to
TRUE, and the field disappears when
Searchable is set to
False.
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 the
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.
|
|
Return | Specify requirements for the records, related records and the relationship to be returned after the filter.
Note: The node appears only when the
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:
|
|
Transaction | ||
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.
|