External Web Service Mapping

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

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: User Master creation from Client Web Service to SummitAI User Master update from Client Web Service to SummitAI 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: When the Batch Process check box is selected, a new field, No. of Records (in a Batch) appears below it. You can specify a maximum of 100 records in the No. of Records field.
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.
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 add new field mapping and to remove any existing field mapping.
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 add new field mapping and to remove any existing field mapping.
format JSON	Click to format JSON.
Original JSON	Click to revert JSON format to original format.
View/Edit JSON	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 add new field mapping and to remove any existing field mapping.
format JSON	Click icon to format JSON.
Original JSON	Click to revert JSON format to the original format.
View/Edit JSON	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. Note: If the No. of Records under the Configuration Details tab is more than 500 for Batch processing, the job will run for longer period of time to process all the records. Please increase the Job Frequency.
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

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. 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 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