Searching the Help
To search for information in the Help, type a word or phrase in the Search box. When you enter a group of words, OR is inferred. You can use Boolean operators to refine your search.
Results returned are case insensitive. However, results ranking takes case into account and assigns higher scores to case matches. Therefore, a search for "cats" followed by a search for "Cats" would return the same number of Help topics, but the order in which the topics are listed would be different.
Search for | Example | Results |
---|---|---|
A single word | cat
|
Topics that contain the word "cat". You will also find its grammatical variations, such as "cats". |
A phrase. You can specify that the search results contain a specific phrase. |
"cat food" (quotation marks) |
Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase. |
Search for | Operator | Example |
---|---|---|
Two or more words in the same topic |
|
|
Either word in a topic |
|
|
Topics that do not contain a specific word or phrase |
|
|
Topics that contain one string and do not contain another | ^ (caret) |
cat ^ mouse
|
A combination of search types | ( ) parentheses |
|
- Consuming a Service Manager Web Service
- Dynamic and static Web Services clients
- Updating Service Manager tables
- Requirements for developing custom Web Services clients
- Checklist: Creating a custom Web Services client
- Sample Web Services client for sc62server PWS URL
- Command line arguments for the .NET sample application
- Command line arguments for the Axis sample application
- Using query syntax
- Retrieving data from Service Manager
- Example: Retreiving data from Service Manager via a Web Service
- Retrieving data from Service Manager using Pagination
- Retrieve data from Service Manager for Optimistic Locking
- Web Services examples in the RUN directory
- Special considerations for using Keep-Alive with Service Manager
- Use SSL to consume Service Manager Web Services
- Attachment handling
Retrieving data from Service Manager
Retrieval methods are not defined in the extaccess record. The following list shows the methods for retrieval that are available and under which circumstances to use each one:
• Retrieve<FileName>
— Used if only one record will be returned. Throws a fault if multiple records are returned.
• Retrieve<FileName>KeysList
— Retrieves the list of unique keys (which does not have to be the unique key of the Service Manager dbdicts). The list can either be passed as an array to the Retrieve<FileName>List
method, or looped through to pass to the Retrieve<FileName>
method.
• Retrieve<FileName>List
— Retrieves a list of records with information that was gathered either in the Retrieve<FileName>KeysList
method or by passing in a query directly through the instance block. This method expects an array of keys unless the query approach is used.
Note When retrieving data from a single table rather than a Service such as the contacts table, request the WSDL for the alias name defined in extaccess
, such as "Contact" (singular form, upper-case “C”) rather than for contacts
(the actual file name).
There are different approaches to retrieving a list of records. When developing a custom client there are actually two separate methods that can be used to retrieve list data.
The first approach uses the following steps:
- Send the data query (such as
<open.time>>6/30/05</open.time>
) to theRetrieveKeysList
method. - The result is a list of records where each record contains only the “primary key” (such as Incident ID) for those records that match the query.
- You can either provide the list to the
RetrieveList
method and receive all records defined by the list in a single XML document, or loop through the list, one record at a time, callingRetrieve
once for each record by key.
The second approach uses these steps:
- Send the data query (such as <
open.time>>6/30/05</open.time>
) directly to theRetrieveList
method. Place the query in the “<instance>” block instead of the “<keys>” block. - This single method call returns the entire result set (all fields for all records matching the query) in a single XML response.
Note The second approach returns the entire query result set in one method call. If the result set is large, use the first approach to increase performance.