Trading Networks 10.7 | Administering and Monitoring B2B Transactions | Trading Networks Built-In Services Reference | IS Document Types | Summary of Elements in this Folder | wm.tn.rec:queryField
 
wm.tn.rec:queryField
The document structure of the fields variable in the wm.tn.rec:queryInput IS document type.
Variables
fieldName
String Name of the field for which you specify the filter criteria. The column names can be:
*Any custom attribute ID of a Document Type.
*Any of the following Strings based on the query type.
For the list of valid values, see List of Column names.
isOrQuery
String Whether the join condition for the filter criteria in the criteria variable is AND or OR. Valid values for the JOIN condition:
*true - OR
*false - AND (Default)
criteria
Document List The filter criteria. Each field can have more than one filter criteria. For example, UserStatus IS NULL AND UserStatus = IGNORED,
where UserStatus is the field name, IS NULL and '=' are the operators, AND is the join condition, and IGNORED is the value.
Each document in the document list contains the following variables:
*operator String The operator for the filter criteria. The valid values depend on the field type of the fieldName variable. If you specify a sub-query (dynamicCriteria), specify the operator value as Dynamic.
For the list of valid values based on the field types, see Valid Values for the criteria field variable.
*value String The value for the filter criteria.
For example, for the filter criteria, 'UserStatus = IGNORED', UserStatus is the field name, '=' is the operator, and IGNORED is the value.
If you specify a sub-query (dynamicCriteria), then to specify the join condition for the sub-query, the values are 'DynamicGlobalOR' or 'DynamicGlobalAND'.
*dynamicCriteria Document List Optional. A profile query used as a sub-query to filter the sender ID or the receiver ID.
The fieldName variable must be either SenderID or ReceiverID. The operator value for the parent criteria must be Dynamic. The sub-query is added to SenderID or ReceiverID, based on what value you provided in the fieldName.
If the value of receiverEqualsSender is true, then the sub-query is added to both SenderID and ReceiverID.
For the list of variables for each document, see Variables for dynamicCriteria variable.
List of Column names
This table describes the field names that are valid values for the fieldName variables in the wm.tn.rec:queryField and the resultSetColumns' variable in the wm.tn.rec:queryInput IS document types. For more information, see wm.tn.rec:queryField and wm.tn.rec:queryInput.
The column names can be:
*Any custom attribute ID of a Document Type.
*Any of the following Strings based on the query type.
Query Type...
Column names...
Document Query
*DocTimestamp
*DocID
*SenderID
*ReceiverID
*ConversationID
*NativeID
*DocTypeID
*GroupID
*RoutingStatus
*UserStatus
*Comments
*JobStatus
*SenderProfileGroup
*ReceiverProfileGroup
Event Query
*ActivityLogID
*RelatedDocID
*EntryTimestamp
*EntryType
*EntryClass
*BriefMessage
*RelatedPartnerID
*RelatedInstanceID
*RelatedStepID
*B2BUser
*FullMessage
Task Query
*dj.JobType
*d.ReceiverID
*d.SenderID
*dj.JobStatus
*dj.ServiceName
*dj.QueueName
*dj.DocID
*dj.JobID
*dj.TimeCreated
*dj.TimeUpdated
*dj.Retries
*dj.RetryLimit
*dj.RetryFactor
*dj.ServerID
*dj.TimeToWait
*dj.TransportStatus
*dj.TransportStatusMessage
*dj.TransportTime
Profile Query
*CorporationName
*OrgUnitName
*GroupName
*Status
*City
*State_Province
*Zip_PostalCode
*Country
*Username
*ExternalIDs
*keywords
Valid Values for the criteria field variable
The following table lists the valid values for the criteria field based on the field types. The field type is always 'STRING', unless the field name is a custom attribute of a document.
Field Types
Field Values
STRING
*IS NULL
*IS NOT NULL
*=
*<>
NUMBER
*IS NULL
*IS NOT NULL
*=
*<>
*>=
*<=
*>
*<
DATETIME
*IS NULL
*IS NOT NULL
*=
*BEFORE
*AFTER
DATETIME LIST
*IS NULL
*IS NOT NULL
NUMBER LIST or STRING LIST
*IS NULL
*IS NOT NULL
*INCLUDES
Variables for dynamicCriteria variable
The following table lists the variables for each document in the dynamicCriteria variable.
Value
Description
fieldName
String Name of the field for which you specify the sub-query filter criteria. For the list of valid values, see the values corresponding to Profile Query in the fieldName parameter.
isOrQuery
String Whether the join condition for the filter criteria in simpleCriteria is AND or OR. You can set the following values for the JOIN condition:
*true OR
*false AND (Default)
simpleCriteria
Document List The filter criteria for a field in the sub-query. Each field can have more than one filter criteria. For example,
'GroupName IS NULL' OR 'GroupName <> G1'
where GroupName is the field name, IS NULL and <> are the operators, OR is the join condition, and G1 is the value.
Each document in the document list contains the following variables:
*operator String The operator for the filter criteria. Valid values:
*IS NULL
*IS NOT NULL
*=
*<>
*value String The value for the filter criteria. For example, for the filter criteria,
'GroupName < > G1', G1 is the value