Overview
Configuration is provided for establishing connections with the ServiceNow service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Demonstration
Quick Start
In this task, we will show you step-by-step how to create a connection to ServiceNow REST API using COZYROC's REST Connection Manager.
Step 1. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.
Step 2. From the drop-down menu Configuration select ServiceNow. Set [instance] to the desired instance in the Server host parameter.
Step 3: Provide values for parameters Name and Password in the grid below.
Step 4. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your ServiceNow instance.
In this guide, we will show how to read data from the ServiceNow service resource using the COZYROC REST Source component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open "SSIS Toolbox" and drag and drop the COZYROC "REST Source" component.
Step 3. Double-click on the "REST Source" component and select ServiceNow connection from the combo. Select from the available ServiceNow resources listed in the second combo below.
Optionally you can include extra parameters in the grid below if needed.
Step 4. Click on the "Columns tab" and select ServiceNow resource columns you want to read.
Step 5. Click Preview to make sure all necessary resource columns are included.
Bravo! You have now learned how to read data from the ServiceNow service.
In this guide, we will show how to write data to the ServiceNow service resource using the COZYROC REST Destination component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open the "SSIS Toolbox" and drag and drop the COZYROC "REST Destination" component.
Step 3. Double-click on the "REST Destination" component and select ServiceNow connection from the combo. Also, select the resource action and the ServiceNow resource you want to work on.
Step 4. Click on the "Mapping" tab and map the input columns for the process you are configuring.
If you want to provide input for other resource composite objects, change the input above and map the columns.
Done. You have now learned how to write data into the ServiceNow resource.
Configuration
Base URL address: https://[instance].service-now.com/api/now.
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- Name:
- Password:
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Basic {{=Base64.encode(connection.user.Name + ':' + connection.user.Password)}}
Documentation: https://en.wikipedia.org/wiki/Basic_access_authentication.
- [Read] action
-
Endpoint URL address:
/table/{{=resource.external.name}}.
The result is extracted from:{{=response.result}}.
The result is paginated.The following request parameters will be automatically processed:
-
sysparm_fields:
{{=parameters.fields.join()}} -
sysparm_offset:
{{=parameters.iterator}} -
sysparm_limit:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=parameters}}
Documentation: http://wiki.servicenow.com/index.php?title=Encoded_Query_Strings#gsc.tab=0.
-
sysparm_fields:
- [Create] action
-
Endpoint URL address:
/table/{{=resource.external.name}}.
The result is extracted from:{{=response.result}}.
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Update] action
-
Endpoint URL address:
/table/{{=resource.external.name + '/' + item[resource.keyField]}}.
The result is extracted from:{{=response.result}}.
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Delete] action
-
Endpoint URL address:
/table/{{=resource.external.name + '/' + item[resource.keyField]}}.
The result is extracted from:{{=response.result}}.
The action uses DELETE method.
- [External]
-
The external fields list is extracted from:
{{=ServiceNow.getExternalFields(resource)}}.- {{=external.element}}
-
Template: {{=ServiceNow.getFieldTemplate(external)}}. Data type: {{=ServiceNow.getDataType(external.internal_type.value)}} ( length {{=external.max_length || 255}} )
Documentation: http://wiki.servicenow.com/index.php?title=Introduction_to_Fields.
The external resource list is extracted from: {{=ServiceNow.getExternalResources()}}.
- ScheduleDateTime
-
Data type: DT_DBTIMESTAMP The gathered value is processed with
{{=(value && value.substring(0,4) + '-' + value.substring(4,6) + '-' + value.substring(6,8) + 'T' + value.substring(9,11) + ':' + value.substring(11,13) + ':' + value.substring(13,15)}}expression.Documentation: Sample - 20081001T045959.
- Reference
Field components:
- Contains the following components: link, value.
- Duration
Data type: DT_I4 The gathered value is processed with
{{=value && parseInt(new Date(value.replace(' ', 'T')).getTime() / 1000).toString()}}expression.
Knowledge Base
- Where can I find the documentation for the ServiceNow Connection?
- Error Message: "Name" parameter not specified.
- Error message: Resource not specified
What's New
- New: Support for OAuth client_credentials authentication.
- New: Support for reading from database views.
- New: Introduced connection.
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.