Trading Networks 10.3 | Administering and Monitoring B2B Transactions | Trading Networks Built-In Services Reference | Query Folder | Summary of Elements in this Folder | wm.tn.query:createDocumentQuery
 
wm.tn.query:createDocumentQuery
Creates a query for documents saved in the Trading Networks database.
Input Parameters
senderId
String (optional) The internal partner ID for sender of the documents to match.
receiverId
String (optional) The internal partner ID for receiver of the documents to match.
messageTypeId
String (optional) The internal TN document type ID of the documents to match.
routingStatus
String (optional) The processing status of the documents to match.
userStatus
String (optional) The user status of the documents to match.
documentId
String (optional) The document ID for the documents to match.
internalDocId
String (optional) The Trading Networks-generated internal ID of the document to match.
timeInterval
String (optional) The time period in which the documents were received by Trading Networks. Specify one of the following:
*TODAY
*YESTERDAY
*LAST_7_DAYS
*THIS_WEEK
*LAST_WEEK
*THIS_MONTH
*LAST_MONTH
*YTD
attribs
Document List (optional) The custom attribute criteria to use to match documents. For each custom attribute in the criteria, specify an IS document (IData object) in attribs with the following structure:
*attribName- Name of the attribute to use as search criteria. Use either attribName or attribId to identify the attribute.
*attribId- Internal ID of the attribute to use as search criteria. Use either attribName or attribId to identify the attribute.
*op- The operation to perform to match documents. Based on the data type of the attribute, specify the applicable operators. For the list of operators based on the data type, see Usage Notes.
*attribValue- The value to use when matching documents. The service uses this value and operation specified in op to perform the match.
You do not need to specify a value for attribValue if you specify either IS NULL or IS NOT NULL for op.
When specifying DATETIME values, use the format yyyy-mm-dd hh:mm:ss. fff where . fff represents nanoseconds. Specifying nanoseconds is optional.
When specifying NUMBER values, use the format xxx. xxx where the fractional part is optional.
Output Parameters
query
Object An instance of com.wm.app.tn.db.ComplexDocQuery.
Usage Notes
For the input parameter attribs, in the op variable of the document, specify one of the following operators based on the data type of the attribute:
For this data type...
Specify one of the following...
STRING
*=
*IS NULL
*IS NOT NULL
*CONTAINS
NUMBER
*=
*<>
*>=
*<=
*<
*>
*IS NULL
*IS NOT NULL
DATETIME
*=
*IS NULL
*IS NOT NULL
*BEFORE
*AFTER
STRING LIST
*IS NULL
*IS NOT NULL
*INCLUDES
NUMBER LIST
*IS NULL
*IS NOT NULL
*INCLUDES
DATETIME LIST
*IS NULL
*IS NOT NULL