External Web Service Mapping helps Administrators to configure data flow from SummitAI to Client Web Services and vice versa. You can configure the following configurations:
Incident creation from SummitAI to Client Web Service
Incident creation from Client Web Service to SummitAI
Incident update from SummitAI to Client Web Service
Incident update from Client Web Service to SummitAI
Service Request creation from SummitAI to Client Web Service
Service Request creation from Client Web Service to SummitAI
Service Request update from SummitAI to Client Web Service
Service Request update from Client Web Service to SummitAI
Word Order creation from SummitAI to Client Web service
Word Order creation from Client Web Service to SummitAI
Word Order update from SummitAI to Client Web Service
Word Order update from Client Web Service to SummitAI
User Master creation from Client Web Service to SummitAI
User Master update from Client Web Service to SummitAI
To Configure External Web Service Mapping:
- Select Admin > Basic > Infrastructure > External Web Service Mapping.
- The EXTERNAL WEB SERVICE MAPPING LIST page is displayed. Click ADD NEW on the ACTIONS panel.
On the EXTERNAL WEB SERVICE MAPPING page, fill in all the required information and click SUBMIT.
Figure: External Web Service Configuration page
The following three tabs are available on the EXTERNAL WEB SERVICE CONFIGURATION page:
The CONFIGURATION tab has the following sections:
- CONFIGURATION DETAILS
- WEB SERVICE DETAILS
- ATTACHMENT DETAILS
- JOB DETAILS
CONFIGURATION DETAILS
Under this section, configuration details, such as Configuration Name, Configuration Description, etc., are specified. For more information about the fields on the CONFIGURATION DETAILS section, see Field Description.
WEB SERVICE DETAILS
Under this section, Web Service details for both the Source and the Target fields are specified. For more information about the fields on the WEB SERVICE DETAILS section, see Field Description.
ATTACHMENT DETAILS
Under this section, the attachment configurations for Incidents, Service Requests, and Work Orders are specified. For more information about the fields on the ATTACHMENT DETAILS section, see Field Description.
Note:
The ATTACHMENT DETAILS section is only available when the Include Attachment check box is selected under the CONFIGURATION DETAILS section.
JOB DETAILS
Job details, such as Job schedule, Frequency, and universal time can be specified under this section. For more information about the fields on the JOB DETAILS section, see Field Description.
Note:
The JOB DETAILS fields are disabled on the edit page. You can revise these fields for an existing configuration from the CUSTOM SCHEDULER page (see: Configuring Custom Scheduler).
Figure: Configuration tab
Field Description
The following table describes the fields under the CONFIGURATION tab:
Field | Description |
|---|---|
| CONFIGURATION DETAILS | |
| Configuration Name | Specify the configuration name. |
| Description | Specify the description of the configuration. |
| SummitAI as Source | Select this check box when you want to configure the data flow from SummitAI to the Client web services. |
| Batch Process | Select this check box when you want to configure the data flow from Client Web Services to SummitAI. The Batch Process only applies in the following two scenarios:
Note: When the SummitAI as Source check box is not selected, the Batch Process check box appears below it. |
| No. of Records (in a Batch) | Specify the number of records you want to create or update in a single batch. Note:
|
| Include Attachment | Select this check box if you want to include attachment of Incident/ Service Request/ Work Order for the data flow configuration. Upon selecting Include Attachment check box, a separate ATTACHMENT DETAILS section is displayed below the WEB SERVICE DETAILS section. |
| WEB SERVICE DETAILS | |
| Service URL | Specify the Web Service URL for both the Source and the Target. |
| Service Description | Specify the Web Service description for both the Source and the Target. |
Configure API Authentication | Select the pre-defined authentication values of the list. The listed values are:
|
| Authorization Key/ Token | Provide Authorization details to authenticate API for both the Source and the Target. |
| Headers | Select the Web Service type from the drop-down list for both the Source and the Target. |
| Request Body | Provide the Input data for both the Source and the Target. |
| Response JSON Key | Specify the JSON path from where want to consume the response. |
| Get Response | Click Get Response button to get the response for specified JSON key. |
| Response Template | Response for specified JSON key gets auto filled in this field after clicking on Get Response button. |
| Map Data | Select this check box to configure columns and their values to exchange the data between the two web services. |
| View/Edit Data Mapping | Click View/Edit Data Mapping button to configure the Column Names and their values to exchange the data between two Web Services. Upon clicking the View/Edit Data Mapping button, the MAP DATA pop-up page is displayed. Note: The View/Edit Data Mapping button is displayed while editing only when the Map Data check box is selected. |
| MAP DATA | The MAP DATA pop-up page consists of four sections, namely, FILTERS, IMPORT/EXPORT, CONFIGURATION, and LIST. |
| FILTERS | The FILTERS section contains the following fields. |
| Search By | Select one of the Search By criteria that are Source Column Name, Source Column Value, Target Column Name, or Target Column Value. |
| Search Value | Specify the Search Value based on selected search by criteria. |
| IMPORT/EXPORT | The IMPORT/EXPORT section contains the following fields. |
| Import/Export Option | Select the Import/Export option, that is, either JSON or XML |
| Download Template | Click the Download Template button to download the JSON or XML template for import configure columns and their values to exchange data between the two web services. |
| Upload Web Service Mapping | Browse a Web Service mapping and click Upload to import the columns and their values to exchange data between the two Web Services. |
| CONFIGURATION | The CONFIGURATION section contains the following fields. |
| Source Column Name | Select a Source Column Name from drop-down list. |
| Source Column Value | Specify the Source Column Value based on the selected Source Column Name. |
| Target Column Name | Select a Target Column Name from drop-down list. |
| Target Column Value | Specify the Target Column Value based on the selected Target Column Name. |
| LIST | The LIST section contains the following fields. |
| Source Column Name | The Source Column Name column displays list of configured Source Column Names. |
| Source Column Value | The Source Column Value column displays list of configured Source Column Values. |
| Target Column Name | The Target Column Name column displays list of configured Target Column Names. |
| Target Column Value | The Target Column Value column displays list of configured Target Column Values. |
| Action | Click |
| View/Edit Fields Mapping | Click View/Edit Fields Mapping button to map request and response fields accordingly. Upon clicking the View/Edit Fields Mapping button, the MAPPING FIELD pop-up page is displayed. |
| MAPPING FIELD | The MAPPING FIELD pop-up page contains the following fields. |
| Source Response Field | Specify a Source Response field. |
| Target Input Field | Specify a Target Input Field to which you want to map the Source Field. |
| Action | Click |
| Click to format JSON. |
| Click to revert JSON format to original format. |
| Click to view/Edit JSON. |
ATTACHMENT DETAILS Note: ATTACHMENT DETAILS section displayed only after selecting Include Attachment check box on the CONFIGURATION DETAILS section. Configure ATTACHMENT DETAILS section to include attachment of Incident/ Service Request/ Work Order for the data flow configuration. | |
| Service URL | Specify the Web Service URL for both the Source and the Target. |
| Headers | Select the Web Service type from the drop-down list for both the Source and the Target. |
| Request Body | Provide the Input data for both the Source and the Target. |
| Response JSON Key | Specify the JSON path from where you want to consume the response. |
| Response Template | Provide a sample output data. |
| File Data Type | Select a file data type under the File Data Type drop-down field.
|
| Response Data | Specify the Response Data. |
| View/Edit Fields Mapping | Click View/Edit Fields Mapping button to map request and response fields accordingly. Upon clicking the View/Edit Fields Mapping button the MAPPING FIELD pop-up page is displayed. |
| MAPPING FIELD | The MAPPING FIELD pop-up page contains the following fields. |
| Source Response Field | Specify the Source Response Field. |
| Target Input Field | Specify the target input field to which you want to map the Source Field. |
| Action | Click |
| Click icon to format JSON. |
| Click to revert JSON format to the original format. |
| Click icon to view/edit JSON. |
| JOB DETAILS | |
| Run At | Selected the Server type under the drop-down field. Following two servers types are available under the Run At drop-down field: Summit Server and Proxy Server. |
| Schedule Start Date (UTC) | Specify a start date and time according to UTC zone for the Web Service configuration. |
| Frequency (In Mins) | Specify a time interval in minutes. |
| Active | If selected, the configuration becomes active. |
The SUCCESS tab configuration is optional. You can configure the Success tab to capture information about the successful data flow of data from SummitAI to client web services and vice versa. If configured, the success details are recorded in the SummitAI or client database accordingly. For more information about the fields under the SUCCESS tab, see Field Description.
Figure: Success tab - No Action Required
Figure: Success tab - Action Required
Field Description
The following table describes the fields under the SUCCESS tab:
Field | Description |
|---|---|
| Actions Required | Select actions required as Yes or No |
| RESPONSE DETAILS | The RESPONSE DETAILS section contains the following fields. |
| Service URL | Specify the Web Service URL for both the Source and the Target. |
| Service Description | Specify the Web Service description for both the Source and the Target. |
| Authorization Key/ Token | Provide Authorization details to authenticate API for both the Source and the Target. |
| Headers | Select the Web Service type from the drop-down list for both the Source and the Target. |
| Request Body | Provide the Input data for both the Source and the Target. |
| Response JSON Key | Specify the JSON path from where you want to consume the response. |
| Response Template | Provide a sample output data. |
| Map Data | Select this check box to configure columns and their values to exchange the data between the two Web Services. |
| View/Edit Data Mapping | Click View/Edit Data Mapping button to configure the Column Names and their values to exchange the data between two Web Services. Upon clicking the View/Edit Data Mapping button, the MAP DATA pop-up page is displayed. |
| MAP DATA | The MAP DATA pop-up page consists of four sections namely FILTERS, IMPORT/EXPORT, CONFIGURATION, and LIST. |
| FILTERS | The FILTERS section contains the following fields. |
| Search By | Select one of the Search By criteria that are Source Column Name, Source Column Value, Target Column Name, or Target Column Value |
| Search Value | Specify the Search Value based on the selected search by criteria. |
| IMPORT/EXPORT | The IMPORT/EXPORT section contains the following fields. |
| Import/Export Option | Select Import/Export Option, that is either JSON or XML |
| Download Template | Click the Download Template button to download the JSON or XML template for import configure columns and their values to exchange data between the two web services. |
| Upload Web Service Mapping | Browse a Web Service mapping and click Upload to import configure columns and their values to exchange data between the two web services. |
| CONFIGURATION | The CONFIGURATION section contains the following fields. |
| Source Column Name | Select a Source Column Name from drop-down list. |
| Source Column Value | Specify the Source Column Value based on the selected Source Column Name. |
| Target Column Name | Select the Target Column Name from drop-down list. |
| Target Column Value | Specify the Target Column Value based on the selected Target Column Name. |
| LIST | The LIST section contains the following fields. |
| Source Column Name | Source Column Name column displays list of configured Source Column Names. |
| Source Column Value | Source Column Value column displays list of configured Source Column Values. |
| Target Column Name | Target Column Name column displays list of configured Target Column Names. |
| Target Column Value | Target Column Value column displays list of configured Target Column Values. |
| Action | Click |
| View/Edit Fields Mapping | Click View/Edit Fields Mapping button to map request and response fields accordingly. Upon clicking the View/Edit Fields Mapping button, the MAPPING FIELD pop-up page is displayed. |
| MAPPING FIELD | The MAPPING FIELD pop-up page contains the following fields. |
| Source Response Field | Specify a Source Response Field. |
| Target Input Field | Specify a Target Input Field to which you want to map the source field. |
| Action | Click |
| Click icon to format JSON. |
| Click to revert JSON format to the original format. |
| Click icon to view/edit JSON. |
The Failure configuration is the system-created configuration when SummitAI is the target and few tickets (Incidents, Service Requests, and Work Orders) failed to process. All the failed tickets are picked up for re-processing based on the FAILURE tab configuration. Also, you can configure e-mail notification for failed tickets (Incidents, Service Requests, and Work Orders). For more information about the fields under the FAILURE tab, see Field Description.
Figure: Failure tab
Field Description
The following table describes the fields under the FAILURE tab:
Field | Description |
|---|---|
| Retry Count | Select retry count to process the Job again when tickets (Incidents, Service Requests, and Work Orders) are failed. Note:
|
| Failure Configuration | If selected, all the failed tickets are picked up for re-processing. Note:
|
| Attempts for (in hrs) | Specify the attempts (in time) to process the failed tickets (Incidents, Service Requests, and Work Orders). Note: The Attempts for (in hrs) field appears only when SummitAI as Source check box is not selected on the CONFIGURATION tab. |
| NOTIFICATION | The NOTIFICATION section contains the following fields. |
| Set Notification | If selected, you can configure an e-mail template to notify the user about ticket failure. |
| To List | Specify the e-mail recipients for the notification related to ticket failure. |
| CC List | Specify the Cc e-mail recipients for the notification related to ticket failure. |
| Subject | Specify the subject for the e-mail notification. |
| Body | Specify the e-mail body of the e-mail notification. |
Quick Help
Click Quick Help 
icon to open the QUICK HELP pop-up page. The QUICK HELP pop-up page consists of four different tabs, namely, Incident, Service Request, Work Order, Name, and User Master along with the search text box .
You can search for a particular key word under search box and the respective results are displayed on the related tab.
Figure: QUICK HELP pop-up page
ACTIONS
This section explains all the icons displayed on the ACTIONS panel of the EXTERNAL WEB SERVICE CONFIGURATION page.
ADD NEW
Click ADD NEW to configure a new External Web Service.
Following icons displayed on the ACTIONS panel of the new External Web Service configuration page:
SHOW LIST
Click SHOW LIST to display the LIST table showing all the EXTERNAL WEB SERVICES that are configured in the SummitAI application.
IMPORT CONFIGURATION
Click IMPORT CONFIGURATION to import configuration from JSON/XML file.
Following icons are displayed on the ACTIONS panel while editing External Web Service configuration:
SHOW LIST
Click SHOW LIST to display the LIST table showing all the EXTERNAL WEB SERVICES that are configured in the SummitAI application.
IN QUEUE
Click IN QUEUE to display the list of records in queue for data syncing between the two Web Services.
SYNCED RECORDS
Click SYNCED RECORDS to view the list of records that are synced up between the two Web Services.
RETRY
Click RETRY to sync up the records that failed to sync up between the two Web Services.
EXPORT CONFIGURATION
Click EXPORT CONFIGURATION to export the configuration to a JSON/XML file.
COPY CONFIGURATION
Click COPY CONFIGURATION to copy details from this configuration to a new configuration.