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.
Words and Phrases
| 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. |
Using Boolean Operators
| 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 |
|
- Publishing Service Manager data using WS API
- Things to consider prior to publishing data
- Example: Publishing request processes for integration
- List: Web Services available in the Service Manager Web Services API
- Field names in the extaccess record
- Create dedicated Web Services listeners
- Data conversion between Service Manager and SOAP Web Services
- Example: Publishing the Terminate Change functionality via Web Services
- Publish a table as a Web service
- Expose a table with more than one web service
- Remove a Document Engine display action from the Web Services API
- Remove a Service Manager field from the Web Services API
- Sample client for Web Services SM7 URL
- Command line arguments for the Axis2 sample application
- Add an external access action to the Web Services
Sample client for SOAP Web Services SM7 URL
The Service Manager server includes a sample Web Services client application for the http://servername:port_number/SM/7/service_name.wsdl. The sample application was created for Apache™ Axis2 (version 2.1.4). If you have Axis 2.1.4 and Apache™ Ant installed, you can review and update the source code of the sample application as well as generate updated proxy code to test the Service Manager Web Services functionality. The Apache Axis2 sample is written in Java. The sample client application is included with the server installation in the following folder:
<Service Manager server installation folder>
\webservices\sample\sm7webservice
The sample includes the source code for the client applications as well as support files for the Web Services development environment. The Apache Axis2 jar files are included and they are located under the "lib" folder. A set of the batch files that you can use to run each class are located under the "bin" folder and you can run each class from the Windows command prompt after you have compiled the sample Java. You can use the sample application as an example of how to create your own custom Web Services client applications.
Note All the sample applications use a command line interface. To see the usage information for the command line interface, change to "bin" folder, type xxxSample where xxxSample is the batch file name of the sample application.
The Apache Axis2 sample client application assumes that you have a Service Manager server instance running from the local host. If this is not the case, you can change the server host name and port number using the sample's command line interface.
Each of the sample folders includes a readme file that contains valuable information about using the sample application found in each of the sample folder.
The sample client application contains examples of how to send the MTOM attachments to the Service Manager server.
Configuration Management sample
The sample client applications contain the following classes for Configuration Management. Refer to the sample application source code for comments on the usage of each class.
| Field | Description |
|---|---|
| ConfigurationManagementServiceUtility |
|
| CreateContactSample | Creates a contact record with the supplied parameters. |
| DeleteContactSample |
Deletes the contact record listed in the supplied parameters. |
| RetrieveContactSample | Retrieves a single contact record matching the supplied parameters. |
| UpdateContactSample | Updates a contact record with the supplied parameters. |
Incident Management sample
The sample client applications contain the following classes for Incident Management. Refer to the sample application source code for comments on the usage of each class.
| Class | Description |
|---|---|
| CloseIncidentSample | Closes an incident record with the supplied parameters. |
| CreateIncidentSample | Creates an incident record with the supplied parameters. |
| IncidentManagementServiceUtility |
|
| ResolveIncidentSample | Resolves an incident record matching the supplied parameters. |
| RetrieveIncidentListSample | Retrieves multiple incident records matching the supplied parameters. |
| RetrieveIncidentSample | Retrieves a single incident record matching the supplied parameters. |
| UpdateIncidentSample | Updates an incident record with the supplied parameters. |
