B2B Integration 10.5 | Administering and Monitoring B2B Transactions | Trading Networks Built-In Services Reference | Query Folder | Summary of Elements in this Folder | wm.tn.query:documentQuery
 
wm.tn.query:documentQuery
Queries the Trading Networks database for documents.
Input Parameters
query
Object The query to run. The query must be an instance of com.wm.app.tn.db.SimpleDocQuery. You can use wm.tn.query:createDocumentQuery to create this query object.
aggregate
String (optional) Whether to aggregate query results. The aggregate version lists counts of all the documents satisfying the query grouped by sender and receiver. Valid values are:
*true Returns the aggregate version.
*false Default. Returns detailed information about each document.
disablePaging
String (optional) Whether to return the results of the service or an enumeration ID that you can use to get the results a page at a time. Valid values are:
*true - Returns the results of the query.
*false - Default. Returns an enumeration ID.
Use the enumeration ID as input into the services in the wm.tn.enumerate services to get the results a page at a time. For more information, see Enumerate Folder.
pageSize
String (optional) The page size to use when enumerating over the query results. This variable is only used when disablePaging is false. The default is 25.
maxRowCount
String (optional) The maximum number of rows of results to return. The service silently drops excess rows. Specify 0 to return all results. The default is 0.
queryTimeout
String (optional) Ignored.
threshold
String (optional) The number of rows of query results to store in the session object to optimize query execution. The service stores the remaining rows in the Integration Server repository. For best performance, specify a value equal to the page size. If you do not specify a value, the service uses -1 causing the service to use the value specified by the tn.query.threshold property.
For more information about this property, view the online help files as follows: from Integration Server Administrator, click Trading Networks from the Solutions menu of the Navigation panel. Trading Networks displays the TN Properties page. In the upper right corner of the TN Properties page, click Help.
If you are using Trading Networks in a cluster, do not specify threshold and ensure the tn.query.threshold property is set to -1, which disables using the session object.
id
String (optional) The unique identifier to store the paged query results. This parameter is applicable only when the results are paged. If this parameter is not set, an id is automatically generated.
Output Parameters
resultCount
String The number of rows in the query result.
results
Document List (optional) If disablePaging is true, this contains the results of the query. Each returned row is represented as an IS document (IData object) in results. The keys in each IS document depend on the parameters of the query.
id
String (optional) If disablePaging is false, this is an enumeration ID for use with the services in the wm.tn.enumerate folder.
Copyright © 2016- 2019 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.