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 |
|
- 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 – Additional Script
The following table explains the fields under the Additional Script tab in the Integration Instance Parameters page.
Section | Fields | Value | Description |
---|---|---|---|
Authentication | Set the HTTP header |
User-defined. |
Specify additional JavaScript function to set the HTTP header. If you do not specify this field, the default HTTP header only provides Basic Authentication and Content-Type. |
Login to the external system |
User-defined. |
Specify additional JavaScript function for login if the endpoint requires special login process. If you do not specify this field, Case Exchange does not perform any login process and only sets the authentication information into the HTTP header. |
|
Inbound | Validate inbound response |
User-defined. |
Specify additional JavaScript function to validate the response body of an inbound request. When the data comes in, this script validates the data before the data is pushed into the SMIS task queue. If you do not specify this field, Case Exchange only validates the response HTTP code and does not validate the response body. |
Inbound & Push post processing activities |
User-defined. |
Specify additional JavaScript function to perform post process for inbound tasks. This script performs post processing after SMIS processes the inbound task. If you do not specify this field, Case Exchange does not perform any post process for inbound tasks. |
|
Outbound | Validate & Parse outbound response |
User-defined. |
Specify additional JavaScript function to validate and parse the response body of outbound request. The function works in the following way:
If you do not specify this field, Case Exchange only validates the HTTP code and retrieves the ID according to the definitions in the Inbound tab. |
Outbound post processing activities |
User-defined. |
Specify additional JavaScript function to perform post process for outbound tasks. This script performs post processing after SMIS processes the outbound task. If you do not specify this field, Case Exchange does not perform any post process for outbound tasks. |
|
Attachment | Set the HTTP header |
User-defined. |
Specify additional JavaScript function to set the HTTP header for attachment. If you do not specify this field, the default HTTP header only provides Basic Authentication and Content-Type. |
Set header string for the HTTP body | User-defined. | Specify additional JavaScript function to assemble the header of the attachment request if the attachment exchange uses the multipart/form-data transfer. | |
Retrieve and parse Attachment Info |
User-defined. |
Specify additional JavaScript function to retrieve attachment information, such as attachment name, type, size, and so on. |
|
Parse response of attachment creation |
User-defined. |
Specify additional JavaScript function to parse the response body of an outbound attachment request. |
|
Update outbound Attachment Info |
User-defined. |
Specify additional JavaScript function to update the attachment information to the record in the endpoint. The information can link the attachment with the record. You do not need to specify this field if the endpoint system can automatically update the attachment information. |