Creating an import set web service
Summarize
Summary of Creating an import set web service
This guide explains how to create an import set web service in ServiceNow, which enables you to stage and transform imported data efficiently. Import set web services allow customers to define tables for incoming data and optionally create transform maps to convert that data into target tables.
Show less
Creating the Web Service
To create an import set web service, navigate to All > System Web Services > Inbound > Create New. The Name field defines the import set table name, while the Label field specifies the display label of the table. You can choose to create a transform map during this process by selecting the Create transform map checkbox and specifying the target table for data transformation. After creation, you are directed to the Table Transform Map form to define or script the transform.
Web Service Fields
Fields for the web service default to the XSD type xsd:string and appear in the WSDL by their Name. You can add, modify, or delete fields before finalizing the web service. After creation, to add more fields, locate the target table and add fields there.
Mapping Import Sets
Transform maps associated with import set web services run synchronously by default when the service is invoked. These maps define how imported data is transformed into the target table format.
Customizing Web Service Response Values
Within the transform map script, you can customize the web service response by using a response JavaScript object. This object allows you to dynamically add elements to the response sent back to the web service consumer. For example, you can add transaction identifiers or custom messages alongside standard response elements like statusmessage.
Debugging Web Service Import Sets
To troubleshoot SOAP requests, enable the system property glide.processor.debug.SOAPProcessor and set it to true. This logs all incoming SOAP requests in the System Log. Remember to disable it (set to false) after debugging to manage log size.
Create a web service import set table to define how to stage and transform imported data.
Navigate to .
The Name of the web service is the table name of the import set table whereas the Label field is the resulting table field.
If you want to create a transform map after creating the web service, check the Create transform map checkbox and choose the target table you want the data to transform into. After the Create button is selected, the web service is created and you will be immediately put into the Table Transform Map form. You may then continue to specify the transform map or script.
Web Service Fields
The fields available for this web service. All fields by default are published as the
XSD type of xsd:string. The
Name is the field that is exposed for the web service and therefore appears as
the name of the field in the WSDL. The Label is the label of the field as it
appears for the import sets table.
To add other fields after the Web Service is created, find the target table, and add the fields to that table.
Mapping web service import sets
During the creation of the web service import set, you may optionally create the transform map for it.
All transform maps are executed for the service when it is invoked and the import set mode is set as "Synchronous" (the default).
Adding Web Service Response Values
| Variable name | Type | Description |
|---|---|---|
| response | Output Object | Javascript object that holds dynamically created response elements used to customize the output response of a web service import set insert. |
Example
// create new elements called "transaction_id"
// and "hello" in the web service response
response.transaction_id="abc123";
response.hello="world";
status_message="message 1";
// this is the normal status_message variable
<soapenv:Envelopexmlns:imp="http://www.service-now.com/imp_notification"
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header/><soapenv:Body>
<insertResponse xmlns="http://www.service-now.com/imp_notification">
<sys_id>969d157c0a0a0baf008ba5770ffa798c</sys_id>
<table>incident</table>
<display_name>number</display_name>
<display_value>INC0010091</display_value>
<status>inserted</status>
<status_message>message 1</status_message>
<transaction_id>abc123</transaction_id>
<hello>world</hello>
</insertResponse>
</soapenv:Body></soapenv:Envelope>Debugging web service import sets
To debug a SOAP Request coming into the system, create the system property glide.processor.debug.SOAPProcessor.
Once you have created it, set it to true to have all SOAP requests be logged in the System Log. Set it to false when you are done to keep the size of your System Log to a managed length.