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 |
|
Basic operations in WSDL files
Each Web Service that Service Manager publishes has a set of valid operations that an administrator can enable or disable for custom Web Services clients. The list of valid Web Service operations comes from two sources:
- The Document Engine display actions defined for each Service Manager table
- The common operations available to all Web Services
The <Operation Name> is the alias name of the Service Manager display option as defined in the Web Services Configuration Utility. The <Object Name> is the alias name of the Service Manager table as published in the Web Service. Use a Request message to send SOAP operations to the Service Manager server. The Service Manager server uses a Response message to send its reply to the SOAP operation.
You can see the list of available Document Engine display actions for each table in the extaccess table. The Service Manager server converts each published display action into a separate <operation> element in the Web Services Definition Language (WSDL).
For example, the Resolve operation for the Incident object translates to the ResolveIncidentRequest SOAP message. The Service Manager server replies with a ResolveIncidentResponse SOAP message. Any custom Web Services client you create must be able to generate these SOAP message requests and understand the SOAP message response.
In addition to application-specific display actions, there are common operations available to all Service Manager Web Services objects. Just as with display options, the Service Manager server converts each common operation into a separate <operation> element in the Web Services Definition Language (WSDL). The following common messages are always available.
- Retrieve<Object>Request – retrieves a single record detail matching the value of the <keys> element or query attribute, for example an Incident record.
- Retrieve<Object>KeysList – retrieves a list of keys matching the value of query attribute.
- Retrieve<Object>List – retrieves a list of objects matching the value of query attribute.
The following common messages but are not always available.
- Update<Object>Request – updates a single record matching the value of the <keys> element or query attribute with the new values defined in the <instance> element
- Delete<Object>Request * – deletes a single record matching the value of the <keys> element
- Create<Object>Request – adds a single record with the values defined in the <instance> element
* The IncidentManagement Web Service does not offer the delete operation. To retrieve a single incident record, you can use the RetrieveIncident operation.
For more information about Web Services and WSDL, see the W3C Web site.