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 |
|
- Configuration details
- Integration Instance Information
- Integration Instance Parameters – General
- Integration Instance Parameters – Inbound
- Integration Instance Parameters – Outbound
- Integration Instance Parameters – Error Handling
- Integration Instance Parameters – Attachment Handling
- Integration Instance Parameters – Additional Script
Integration Instance Parameters – Inbound
The following tables explain the fields under the Inbound tab in the Integration Instance Parameters page.
| Fields | Value | Description |
|---|---|---|
| External Id Field |
User-defined. |
The relative path of the ID field in inbound JSON. This path is relative to the List path. The field name you entered must be a valid reference in the external system. For example, |
| External Status Field |
User-defined. |
The relative path of the Status field in inbound JSON. This path is relative to the List path. The field name you entered must be a valid reference in the external system. For example, |
| Internal Id Field |
User-defined. |
The name of the unique field of the Service Manager object. For example, enter “number” for the “probsummary” table. The field name you entered must be a valid dbdict field name in the selected Service Manager object. |
If you select the Activate Data Pulling option, Service Manager pulls the data of the inbound tasks from the endpoint system. The following fields appears when you select this option.
| Fields | Value | Description |
|---|---|---|
| Pulling From | User-defined. | The integration instance pulls all the records that are updated later than the time specified in this field from the end point. If you do not specify a time, system uses the current time. |
| Time difference (s) |
User-defined. Default: |
The time difference (in seconds) between Service Manager and the endpoint system. |
| Relative URL | User-defined. |
The relative URL that specifies the resource to be exchanged in the endpoint system. The string in this field is directly appended after the string you configured in the Base URL field under the General tab. |
| Query |
User-defined. |
The additional query parameters. The string in this field is directly appended after the Relative URL that is configured in the previous field. For more information on how to edit the Query strings, see Edit the query and pagination query strings |
| List path |
User-defined. |
The root path of the list result in the JSON response from the endpoint for a pulling request. For example, the list path is {
"entities": [
{
"entity_type": "Incident",
"properties": {
"Id": "***",
...
}
},
...
]
}
|
| Pagination | Selected/not selected. | When you select this option, the result list from the endpoint is transferred in pages. |
| Page Size |
User-defined. |
Specify the maximum number of records in a page. |
| First Record Offset |
User-defined. |
This value defines the index of the first record in each page.
Usually the value is 0 or 1. |
| Pagination Query |
User-defined. |
Pagination parameters. The string in this field is directly appended after the query parameters that are configured under the Inbound tab. For more information on how to edit the Pagination Query strings, see Edit the query and pagination query strings |
If you select the Activate Data Pushing option, the endpoint Service Manager system pushes the data of the inbound task to the native Service Manager system. This option only works for the integration between two Service Manager systems. The following fields appears when you select this option.
| Fields | Value | Description |
|---|---|---|
| Incoming WebService Action |
User-defined. For example, |
The action name in the RESTful API of the endpoint Service Manager system. In an out-of-box Service Manager system, the action names are Create and Update. |
| SM Action to execute |
User-defined. For example, |
The action to be executed in the native Service Manager system for the corresponding incoming action. Possible values for this field are |
Note By default, the integration template uses the Web Service: CaseExchange. To view this Web Service, go to the following location in Service Manager and search for "CaseExchange":
Tailoring > Web Service > Web Service Configuration
Case Exchange only supports the Web Service inbound push call that Action Type is Application Pass Through and Customer Action to Perform is CaseExchange.Pushing. Any other type of inbound push features for Case Exchange via SMIS are not supported.
