B2B Integration : Trading Networks Built-In Services Reference : Query Folder : Summary of Elements in this Folder : wm.tn.query:tpaQuery
wm.tn.query:tpaQuery
Queries the TPA store. If no TPA is found, the service returns null. For other service invocation- or DB-related errors, it throws an exception.
Input Parameters
query
Object The TPA query object.
disablePaging
String (optional) Determines whether the service returns the results of the service or an enumeration ID, which can be used 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 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.
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
results
Document List (optional) The results of the query.
resultCount
String (optional) The number of rows in the query result.
Copyright © 2016- 2017 Software AG, Darmstadt, Germany.

Product LogoContact Support   |   Community   |   Feedback