ServiceNow

This offering is provided through the Archer Exchange to enhance your existing Archer implementation. The Archer Exchange provides offerings to expand the use of Archer solutions into new business processes and address specific industry, geographic, regulatory, or technical requirements.

On this page

Release notes

Release Date 

Release Version 

Notes 

February 2025

2024.09

Initial Release 

About the offering

The ServiceNow Integration provides a flexible JavaScript framework that leverages APIs to configure data feeds to export data from ServiceNow to Archer. Datafeeds can be configured to export data from any table in ServiceNow and import it to any application in Archer. Additionally, data feeds can also be configured to export data from Archer to ServiceNow by updating the JSON format and mapping.

Note: Archer users may follow the Archer Help Center documentation to create and configure the data feed and update the JSON format for data mapping or contact Archer Professional Services to configure the export data feed. For additional assistance with custom use case configurations, please reach out to Archer Professional Services team.

The integration package includes three predefined data feeds for exporting data from ServiceNow and importing it into Archer:

  • Incidents

  • Findings

  • Devices

The included data feeds are designed for out-of-the-box configurations of the Archer applications and are supported by the Archer Exchange. Any custom configurations will require support from the Archer Professional Services team.

Users can follow the provided instructions to create custom data feeds not included in the package or consult with Archer Professional Services for assistance.

Key features and benefits

The ServiceNow Integration with Archer enables organizations to:

  • Create data feeds to retrieve data from ServiceNow and import it into Archer.

  • Easily set up JavaScript Transporter feeds using prebuilt JavaScript files, eliminating the need for advanced JavaScript expertise.

Prerequisites (ODA and system requirements)

Components

Prerequisites

Archer Solution Area(s)

N/A

Archer Use Case(s)

N/A

Archer Applications

The following applications are required for the out-of-the-box data feeds:

  • Incidents

  • Findings

  • Devices

Note: Users can also create and configure their own data feeds by following the provided instructions.

Uses Custom Objects

No

Requires Archer On-Demand Application (ODA)

This offering requires zero (0) Archer On-Demand Applications.

Archer Licensing

Additional licensing fees apply for the ServiceNow integration. For more information, review the Editions and Pricing tab on the Archer Exchange product listing.

Archer Requirements

Archer Platform Release 2024.09 and later

Supported Archer Environments

The following Archer environments are supported:

  • On-Premises

  • Archer SaaS

  • Archer Hosted

Partner/Vendor Requirements

Additional license fees are required for the use of ServiceNow

Compatible Use Cases and Applications

Impacted Fields

Create the fields mentioned below to import the corresponding feed:

Archer Application

Archer Target Field

(Partner/Vendor Name) Source Field

Finding

ServiceNow Id (create before importing example feed)

number

Finding

ServiceNow Global Id (create before importing example feed)

sys_id

Incidents

ServiceNow Id (create before importing example feed)

number

Incidents

ServiceNow Global Id (create before importing example feed)

sys_id

Devices

ServiceNow Global Id (create before importing example feed)

sys_id

Additional resources

The following website will provide details around the API used to create the js scripts:

Offering components

Architecture diagram

Ingest Configuration

Export Configuration

Installing the offering

Security considerations

The information in this publication is provided “as is”. Archer makes no representations or warranties of any kind with respect to the information in this publication, and specifically disclaims implied warranties of merchantability or fitness for a particular purpose. Client is solely responsible for ensuring that the installation of the application is performed in a secure manner. Archer recommends clients perform a full security evaluation prior to implementation.

Installation overview

Complete the following tasks to install the offering. There are three example data feeds in this offering.

  1. Incident Import From ServiceNow (imports the incident table from ServiceNow)

  2. Import Problems From ServiceNow (imports the problem table from ServiceNow)

  3. Import Hardware From ServiceNow (imports the alm_hardware table from ServiceNow)

Step 1: Set up data feeds

You must import and schedule each data feed that you want to use.

Task 1: Import a data feed

  1. From the menu, click Admin menu> Integration > Data Feeds.

  2. Import them following the steps below.

    1. On the data feed listing page, click .

    2. Locate and select the .dfx5 file for the data feed.

  3. Select the data feed you want to configure.

  4. On the General tab, in the General Information section, select Active.

  5. On the Source Connection tab, follow the set of steps below based on the transport type. All these feeds are JavaScript transport type.

JavaScript transport type

Before you upload a JavaScript file, you must configure the JavaScript Transporter settings in the Archer Control Panel. For more information, see "JavaScript Transporter Settings" in the Archer Control Panel Help.

  1. In the Transport Configuration section, select the JavaScript file supplied with the package, all the feeds uses the same file. 

    1. From the Transport Configuration section, click

    2. In the Upload JavaScript File dialog, click Add New.

    3. Navigate to and select the servicenow JavaScript file and click Open.

    4. In the Upload JavaScript File dialog, and click OK.

  2. If the JavaScript Transporter has been set up in the Archer Control Panel to only allow digitally signed JavaScript files from trusted sources, you can only select digitally signed JavaScript files from trusted sources. For more details, see "Configuring JavaScript Transporter Settings" in the Archer Control Panel Help.

  3. In the Custom Parameters section, enter the following custom parameters you want to reference within the selected JavaScript file.

The following table lists the data feed required custom parameters for ingest configuration.

Key

Value

Description

DataFeedName

ingest

It tells the feed to import data from ServiceNow

ServiceNowUrl

https://<YourServiceNowHostName>

Provide the ServiceNow URLHostName

ServiceNowUsername

<YourServiceAccountUserName>

Provide a service account username with read right to the target table from ServiceNow

ServiceNowPassword

<ServiceAccountPassword>

Provide a service account password

ServiceNowTable

<ServiceNowTargetTable>

Provide the ServiceNowTable name to be used as source

The following table lists the data feed required custom parameters for export configuration.

Note: The Archer Professional Services team also provides services to export Archer data to populate ServiceNow data tables. Please contact your Account Representative for additional information regarding these services.

Key

Value

Description

DataFeedName

Export

It tells the feed to export data from ServiceNow

ServiceNowUrl

https://<YourServiceNowHostName>

Provide the ServiceNow URL HostName

ServiceNowUsername

<YourServiceAccountUserName>

Provide a service account username with read right to the target table from ServiceNow

ServiceNowPassword

<ServiceAccountPassword>

Provide a service account password

ArcherUrl

https://<YourBaseURL>

Provide the username Instance name and Hostname in this pattern

ArcherUserName

<ArcherServiceAccountUserName>

Provide Archer Service Account Name

ArcherInstance

<ArcherInstanceName>

Provide Archer Instance Name

ArcherPassword

<ServiceAccountPassword>

Provide a service account password

ExportReportsList

<ProvideReportGUID>

Provide Comma separated list of report GUIDs to export data from

The following table lists additional optional valid custom parameters.

Key

Value

Description

LoggerUrl

<provideUrlforLogging>

Provide URL for Logging

LoggerLevel

TRACE

Default value is TRACE other supported log levels are

  • INFO

  • WARN

  • DEBUG

  • ERROR

  • TRACEDATA

LoggerFtpUrl

ftps://<username>@<host>:<implicitPort>/<path>

 

Provide FTP URL for Logging

LoggerFtpPassword

<FTPLoggingPassword>

Provide password for FTP Logging

LoggerVerifyCerts

false

To verify SSL certificates

Default value is false

ServiceNowProxy

<ProvideProxytoConnectServiceNow>

Provide the Proxy to connect to ServiceNow if needed

ServiceNowVerifyCert

true

Default value is true

ServiceNowStartDate

<ProvideDate>

It takes the date, and feed will process data created/updated after the mentioned date. This parameter works for ingest feed. Default is blank

ServiceNowEndDate

<ProvideDate>

It takes the date, and feed will process data created/updated before the mentioned date. This parameter works for ingest feed. Default is blank

ArcherVerifyCerts

true

To verify SSL certificates

Default value is true

  1. Click the Data Map tab, then click the Field Map and Key Field Definitions tabs.

  2. The data feed might map to objects and key fields in applications that you do not have licensed. Clicking on the Field Map and Key Field Definitions tabs allows the system to resolve these mappings.

  3. Verify that the key field value is not missing from the data feed setup window:

  4. Do one of the following:

    1. To continue configuring the data feed, go to the next task.

    2. To finish setting up the feed later, click Save or Save and Close.

Task 2: Schedule a data feed

A data feed must be active and valid to successfully run. A successful data feed run processes all input data, completes all expected record updates, and does not report any failures in the Run Details Report.

Validating a data feed

The Data Feed Manager validates the information when a data feed is scheduled. If any information is invalid, the data feed displays an error message. You can save the data feed and correct the errors later, but the data feed does not process until you make corrections.

Running a data feed

You can set up data feeds to run automatically at regular intervals. This reduces the time and effort required to import data from an external file.

You can initiate data feeds at various times and configure them to run in regular increments for an indefinite period of time.

You can run the data feed immediately.

To prevent excess server load, schedule data feeds on a staggered basis. You can schedule a maximum of 10 data feeds to run at a time. If more than 10 data feeds are scheduled, each remaining data feed runs as the previous one completes.

Setting up a reference data feed

A reference feed allows you to specify another feed. This indicates to the Data Feed Service that this feed will start running as soon as the referenced feed completes successfully.

  1. Go to the Run Configuration tab > Schedule section.

  2. Do one of the following to schedule your data feed.

    • Run on Schedule. You can configure your data feed to run on a defined schedule.

    • Run After. The Data Feed Services starts the current data feed after the referenced data feed completes successfully.

    • Run Now.

  3. To save the data feed, click Save or Save and Close

Step 2: Test the installation

Run The feed to check if data is being populated or not.

Configuring the data feeds

The ServiceNow integration includes three predefined data feeds for importing data from ServiceNow into the following Archer applications:

  • Incidents

  • Findings

  • Devices

Note: The included data feeds are designed for out-of-the-box configurations of the Archer applications.  Custom application configurations will require services support from the Archer Professional Services team.

Clients may create and configure their own data feeds to transfer data between ServiceNow and Archer.

Note: Archer makes no representations or warranties of any kind with respect to the information in this publication, and specifically disclaims implied warranties of merchantability or fitness for a particular purpose. Client is solely responsible for ensuring that the configuration of the data feed is performed in a secure manner. Archer recommends clients perform a full test prior to implementation.

Configure Data Export from ServiceNow to Archer

To create a data feed to export data from any ServiceNow table to any application in Archer, complete the steps below.

Ingest Configuration:

  1. Create data feed.

  2. Follow the steps as mentioned above. (Do not upload edited JS file that will disrupt the signature)

  3. To get the xml structure to set up the source definition do the following:

    1. Copy the js file provided in the package.

    2. Open the file in text editor.

    3. Set generateFieldDefinitions to true line number 10074.

    4. Set the filePathand filename to fieldDefinitionFilePath line number 10075.

    5. Set ServiceNowUrl, ServiceNowUsername, ServiceNowPassword,ServiceNowTable in line 10135 to 10138.

    6. Uncomment Line number 3, 4 and 6172.

    7. Run the code in NodeJs.

  1. Once the field definition generated use that to populate the field definition Tab.

  2. Map the data according to your need and schedule the feed.

Configure Data Export from Archer to ServiceNow

To create a data feed to export data from any Archer application to any table in ServiceNow, complete the steps below. Please note the additional step to update JSON in the report description for data mapping to ServiceNow.

Note: The Archer Professional Services team also provides services to export Archer data to populate ServiceNow data tables. Please contact your Account Representative for additional information regarding these services.

Export Configuration:

  1. Create data feed.

  2. Follow the steps to set up data Feed.

  3. The description of the reports used as source needs to update with a specific JSON format as detailed below:

{

        "ExportMode": "Update",

        "ArcherSysIDField": "ServiceNow_Global_Id",

        "ServiceNowTable": "incident",

        "SerivceNowIncludeRefs":"false",

        "FieldMap": {

            "impact": {

                "FieldName": "impact",

                "FieldType": "Static",

                "StaticValue": "3"

            },

            "urgency": {

                "FieldName": "urgency",

                "FieldType": "Static",

                "StaticValue": "1"

            },

            "Description": {

                "FieldName": "description"

            }

        }

    }

JSON Configuration Information

Key

Description

ExportMode

Sets the export mode for the data in the report

    - Either of 'CreateUpdate', 'Update', 'Create'

ArcherSysIDField

The Archer Field Alias that will contain the service now sys_id. This is required for any update operation. This field must be present in the report. This field should be written to the Archer Record upon completion of the datafeed by mapping the sys_id field in the datafeed.

ServiceNowTable

The service now table name where data should be written.

SerivceNowIncludeRefs

Optional True/False, Default: False

When a record is written to Service Now, the datafeed will read-back the record to get the contents. Upon reading the record back, we have the option to either read references or not read references. This indicates whether or not references will be captured on the read-back. The record will be captured in the datafeed output so its contents can be used to write data back to Archer, if needed.

FieldMap

The field map configuration which informs the datafeed which Archer fields should be mapped to which Service Now fields.

The keys in the field mapping should match the Archer field aliases.

The 'FieldName' property should match the service now back-end field names. These are the field names that are used in the API.

JSON Field Map Description

Key

Description

FieldName

Name of the Service Now Field to write data to, using the back-end field name for use in the API

FieldType

One of 'Static', 'Text', 'Lookup', or 'Numeric'Default: Text

StripHtml

 

True/False whether to strip HTML data in the field. Only used for text fields.

LookupTable

Name of Service Now Table to lookup the value in Lookup the values coming from Archer in a Service Now lookup table first, then use that value for writing.Only used for FieldType 'Lookup'

LookupFilterField

 

Field name in Service Now Lookup table to filter against Only used for FieldType 'Lookup'

LookupResponseField

Field from the lookup object that should be used for writing into Service Now only used for FieldType 'Lookup'  - Example: 'sys_id'

StaticValue

Static value of any type that will be written to Service Now only used for FieldType 'Static'

Certification environment

Date tested: January 2025

Product Name

Version Information

Operating System

Archer

2024.09

Virtual Appliance