Ardoq’s ServiceNow integration is a two-way integration that allows you to:
Import your data as components or references into Ardoq so you can visualize the dependencies that exist between them and other components in your architecture such as applications, departments, people, etc.
Export your modified ServiceNow data from Ardoq to ServiceNow to maintain your data up to date at all times. Learn how to here.
With Ardoq’s ServiceNow integration, you can also automate imports by setting a daily or weekly interval schedule.
Table of Contents:
How To Import Your ServiceNow Data To Ardoq
This guide shows you how to import your server data from ServiceNow to Ardoq. We'll cover the process step-by-step.
ServiceNow Setup:
1. Visit the ServiceNow Store
Navigate to the ServiceNow Store and search for "Ardoq".
2. Install the Ardoq add-on on your ServiceNow instance
You will need ServiceNow HI credentials to install add-ons. Contact your company ServiceNow admin if needed.
3. Log into your ServiceNow instance and set up an integration user
We recommend that you create dedicated users with table-permissions limited to exactly the data you want to sync with Ardoq.
*Note: Assign the role "x_ardas_ardoq_int.rest" to your integration user. Without this role, the user won’t be able to use the integration. Also, Multi-factor authentication should be disabled by default for the integration user.
Ardoq setup:
1. Navigate to “Home > Import & Integrations” and select ServiceNow.
2. You will reach the "Overview" page:
3. Click on the "Connections" tab and you'll see existing connections:
4. Click the "Create new" button and you'll get a pop-up to let you create a new connection:
Fill in the following details:
Connection name: The name of this ServiceNow connection, so it can be identified in the list
Base URL: The URL to your ServiceNow instance
Authentication: Your ServiceNow username and password
Note: Please make sure the Base URL doesn't contain /login.do at the end.
3. Search for the cmdb_ci_server and other server table(s) you want to import. Please note that the list is filtered based on the provided user's access rights. Depending on your user's roles, that might take some time.
4. Click on the name of your table from the sidebar or in the table to navigate straight to that table's field selector.
5. For each table, select the fields you want to visualize their values and potentially import.
You can use the “Search” input to filter the list of fields.
Select each field you want to fetch or click the “Select All” button to select all fields.
Reference fields will show two entries in the field list: the label of the reference, and the ServiceNow sys-id of the referenced record. This allows you to create references based on either the ID or name.
7. Select a table to configure its columns.
8. Choose the "Components" tab and select the workspace where you wish to import the table. You can either select an existing workspace or type a name to create a new one.
9. Next, select the column type that the table values should be created or updated as in the selected workspace. Leave the column type as “Ignore” if you do not wish to import a given column.
By clicking the checkbox under "Delete Settings" any existing data in the workspace that doesn't correspond to the imported data will be deleted.
Here, in the “Components”, you can also create references by selecting “Reference” in a column configuration. See the “How to create references with your ServiceNow data” KB article for a step-by-step guide.
10. Click the “Review Import” button to know if your configuration is successful or if there are any errors that need to be addressed.
11. Once the configuration is successful, click the “Import All” button to execute the import.
How To Schedule Your Import
After a successful test run, you have the option to schedule your import. You can choose to import on a daily or weekly basis.
Click the "Import and schedule" button in the "Review" page.
Next, give a name to your import and select an interval.
Click "Save schedule" to activate your schedule.
When scheduling an import, you can choose to disable manual data changes in the workspace. Enabling this ensures your workspace mirrors the source data. Please read more here.
To view all of your active schedules and manage them, navigate to the "Schedules" tab and click the three dots beside each of your scheduled imports to edit these.
ServiceNow Integration Permissions for Ardoq:
1. The ServiceNow integration is highly adaptable; there are no restrictions on the data you can import from ServiceNow. Once the Ardoq Integration user plugin is installed from the ServiceNow store, an Ardoq user account with the specific role (x_ardas_ardoq_int.rest) is required.
2. For security and efficiency, ensure the integration user has access only to necessary tables for importing and exporting data, aligning with the principle of least privilege.
3. It's critical to define Groups, Roles, and Access Control Lists (ACLs) in ServiceNow accurately. Precise ACL privileges are needed on tables for read, create, write, and delete operations. Ensure the integration user has 'canRead' privileges with the group x_ardas_ardoq_int.rest assigned to these operations. For exporting data from Ardoq to ServiceNow, 'canCreate', 'canWrite' and 'canDelete' privileges must be enabled for the integration user.
4. Verify the following to ensure secure and functional integration:
User Roles: Match ServiceNow roles with required access levels in Ardoq.
Table Level ACL Rules: Control the integration user’s access to necessary tables. Access controls within ServiceNow should be configured based on the roles assigned to tables to ensure appropriate read and write operations are maintained. Additionally, it's crucial to activate these rules to enforce the access control effectively. After setting up these role-based access permissions and activating them, the integration user should gain the necessary visibility of the table.
Field Level ACL Rules: Manage permissions at the field level within tables. Remember, field-level ACL rules can supersede table-level ACL rules.
5. When exporting from Ardoq to ServiceNow, the integration user must have the capabilities to write and delete.
Remember to double-check User Roles, Table-level, and Field-level ACL rules to maintain secure integration. Field-level ACLs can override broader ACL policies.
Please refer to the ServiceNow documentation for a complete guide on setting up ACL rules: Access Control Rules and Creating an ACL Rule.
FAQ
Does the Ardoq integration with Servicenow allow import of all tables or just CMDB tables?
As long as the integration user being utilized for ServiceNow integration has the appropriate read permissions in ServiceNow, all the tables can be retrieved.
Is it possible to specify which fields are/aren't bi-directional?
The import is a one-way update; there are no two-way fields.
What happens if the exact same field in Ardoq and Servicenow is updated at the same time? Which takes precedence?
Data from ServiceNow will override data at Ardoq side on import, because it is 1-way update.
Is it safe to assume that the Servicenow integration allows for 2-way updating but not 2-way deletion?
The ServiceNow import operates as a one-way update, excluding deletions. Data that is removed on the ServiceNow end remains unchanged in Ardoq. For managed workspaces they will be marked correspondingly. It is possible indeed to enable deletion of missing data for import, but it's currently an organization-wide feature only and will be applied to any import by any importer. When it is enabled for the org, any import will work as one-way sync, inclusive of deletions.
ServiceNow Pre-fetch filtering:
You have the flexibility to define a filter to refine the dataset before forwarding it to Ardoq. Keep in mind that you'll have to craft a filter specific to ServiceNow using the sysparm_query format.
Error when fetching tables:
Please verify the HTTP response time and size is adequate as per the number of records being imported. Please increase the limit if you get the below fetch error.
Establishing a connection using Custom domain:
Please configure the gateway on port 443 to make sure there are no egress/outgoing traffic issues or the connection will be rejected.
