Breadcrumbs

Setup Overview (SaaS Agent for Cloud Only Customers)

Contents of this Page

  1. Intended Audience

  2. Overview Diagram

  3. Overview of the High Level Setup Steps

  4. Links to Detailed Setup documentation and SME involvement

Intended Audience

  • This page is for customers adopting the CI Sync SaaS Agent which Syncfish began releasing in the second half of 2025. The SaaS Agent is designed for cloud-to-cloud (i.e. read from a cloud source and sync to a cloud CMDB).

  • While the SaaS Agent can be run in parallel with the CI Sync On-Prem Agent, this page is for customers solely adopting the CI Sync SaaS Agent.

Overview Diagram

CI Sync SaaS Agent (only) to SN - High Level Topology (inc Step Bubbles).png

Overview of the High Level Setup Steps

Each of the high level steps reference the CI Sync Detailed Setup Instructions. After reading the High Level Steps below we recommend visiting the Detailed Setup Instructions (for cloud agent only customers) Overview page here General Overview and Pre-Read Information page here S1 - Pre-Setup Information.

#

Component

High Level Supporting Notes

1

Enterprise Application object in Entra ID

  1. The CI Sync SaaS setup process requires you to create an Enterprise Application object in your Entra ID.

    1. This object controls authentication of your users to the CI Sync Web UI (of your customer specific CI Sync instance).

  2. You will need to grant one/two users (those people who need to schedule sync jobs) to the Enterprise Application.

  3. Full details of the above are described in S2 - Enroll your CI Sync SaaS Instance to Entra ID of the Detailed Setup Instructions.

2

Cloud Source Systems
(data sources for the CI Sync SaaS Agent)

Each source system has it’s own unique requirements for authentication and API/data access.

Your SME/Admin of each source system needs to create a credential for the CI Sync SaaS Agent and perform any other configuration in the source system itself.

Syncfish provide setup instructions for each source system within S5 - Add One/More Source Systems to CI Sync. For example:

  1. For AWS: Add AWS to SaaS Agent

  2. For Azure: Add Azure to SaaS Agent

  3. For Lansweeper Cloud:Add Lansweeper Cloud to SaaS Agent

  4. For GCP: Add GCP to SaaS Agent

  5. and so on.

3

DEV/TEST ServiceNow

  1. You will need to create a user account (web service account only) for your customer specific CI Sync instance to use for authentication.  The user/web service account can use Basic Auth or OAuth.

  2. Syncfish provide a list of OOTB roles to be assigned to the account.  These are least privileged roles that allow read/write to CMDB tables and several other reference tables.

  3. For performance reasons Syncfish recommend two settings are made in ServiceNow (an API timeout value is increased, and a dictionary value is set on the CMDB). 

  4. Full details of the above are described in S3 - Configure ServiceNow for CI Sync of the Detailed Setup Instructions.

4

CI Sync Web UI
(to add ServiceNow as a destination, and add cloud data sources for the CI Sync SaaS Agent)

  1. Firstly, you will add a Destination Connection (i.e. to your ServiceNow) in your CI Sync SaaS instance using the CI Sync Web UI. 

    1. See S4 - Add ServiceNow as a Destination for CI Sync of the Detailed Setup Instructions.

  2. Next, you will add each cloud source (e.g. AWS, Azure, etc) as a source connection using the CI Sync Web UI. VisitS5 - Add One/More Source Systems to CI Sync. That page contains an index of each supported source system. For example:

    1. For AWS: Add AWS to SaaS Agent

    2. For Azure: Add Azure to SaaS Agent

    3. For Lansweeper Cloud:Add Lansweeper Cloud to SaaS Agent

    4. For GCP: Add GCP to SaaS Agent

    5. and so on.

5

CI Sync SaaS

You then do the following using your Non-Production ServiceNow Instance (e.g. ServiceNow DEV or TEST)

  1. See Run a Small Initial Sync Job (then run more) of the Detailed Setup Instructions.

  2. You will assess the resulting data in your non-Production ServiceNow instance.

  3. Once you are satisifed your non-production results/data is satisfactory you will progress to Production (see #6 below).

6

PROD ServiceNow

The transition to synchronization into your Production ServiceNow instance is very simple:

  1. You repeat the activities mentioned in #3 above.

    1. Add a User Account (with the relevant roles).

    2. Check the REST API timeout setting and check the CMDB dictionary setting.

  2. You repeat the activities mentioned in #4 above.

    1. Add a Destination Connection (i.e. to your Production ServiceNow) in your CI Sync SaaS instance using the CI Sync Web UI. 

    2. Run your first Sync job (a small one to start with), review the results/data and then run additional sync jobs.

Important Information about Non-Production vs Production Synchronization

Before sync’ing to production we recommend you inform the Syncfish Team. This ensures Syncfish are aware in case you need extra assistance and also means Syncfish can advise how to check whether any specific CI Sync configuration settings need to be promoted from your CI Sync Test Config to your CI Sync Prod Config.

Step-by-Setup Setup Process and SMEs Required

Step

SME Audience

Estimated Time to Complete the Step

Step 1 - Pre-Read Materials


General Overview

S1 - Pre-Setup Information

Project Manager
CI Sync Admin
ServiceNow Admin

10 minutes

Steps 2 thru 4 - Enroll CI Sync (in Entra ID) and prepare ServiceNow


S2 - Enroll your CI Sync SaaS Instance to Entra ID

Azure Admin

5 minutes

S3 - Configure ServiceNow for CI Sync

ServiceNow Admin

5 minutes

S4 - Add ServiceNow as a Destination for CI Sync

CI Sync Admin

5 minutes

Step 5 - Create Credentials in Source Systems and Add the Source System to CI Sync


S5 - Add One/More Source Systems to CI Sync

Source System Admins
CI Sync Admin
(Potentially) ServiceNow Admin

10 minutes per source system

Finally - Run CI Sync jobs from Source Systems to the ServiceNow CMDB


Run a Small Initial Sync Job (then run more)

Note: In addition to the instructions above, Syncfish highly recommend reading the following page before your first sync

FAQ - What are the Top Tips when first synchronizing data to my non-PROD CMDB?

Project Manager

CI Sync Admin

Source System admin/s

One or more of the following:

  • ServiceNow Admin

  • ServiceNow platform owner

  • CMDB Manager

  • IT Asset manager