S1 - Pre-Setup Checklist

Extended Page Title

Step 1 - Pre-Setup Checklist

Task List

Task 1: Make sure you have the CI Sync SaaS Instance and CI Sync Agent install input values

You will need the following:

• The URL to your company specific instance of the CI Sync SaaS application.

• The values needed during the CI Sync Agent installer are as follows:

  • Your Azure AD Tenancy ID (a GUID value from your Azure AD Administrator)

  • The Syncfish Extractor API URL (a URL provided to you by Syncfish)

  • Autentication values specific to the given source system CI Sync will be reading from (e.g. URL to the source system, a readonly and least privilidged username/password to the source system (or managed service identity GUID to the source system), etc. These requirements will differ for each source system and details of what you require can be found in the relevant appendix of this setup guide (see the parent Appendices page and the relevant sub-page/s).

Task 2: Decide on the ServiceNow authentication type

Decide which authentication type will be used from the CI Sync SaaS application to ServiceNow.

• You can use either Basic Auth or OAuth.

• The setup steps for all three types are covered in this document. Knowing which one you intend to use will make your installation process easier. 

Task 3: Identify the Server that will run the CI Sync Agent

You need to decide which Server will run the CI Sync Agent. Within this document, we refer to this as the CI Sync Agent Server. In most cases this will be an existing server in your environment (i.e. the CI Sync Agent does not require a dedicated server).

We recommend reading the following article which describes the minimum specifications for the VM and SQL server used for the CI Sync Agent: FAQ - What are the Minimum Specs for the CI Sync Multi-Source On-Prem Agent.

In a Lansweeper environment Syncfish make the following general recommendations for where to run the CI Sync Agent:

• If your Lansweeper Console and Lansweeper SQL DB are the same Server, install the CI Sync Agent on that same VM (all three can exist together).

• If your Lansweeper Console and Lansweeper SQL DB are on separate Servers, don’t install the CI Sync Agent on the SQL Server (DBAs don’t tend to like this model).  Instead, it’s fine to install the CI Sync Agent on your Lansweeper Console Server. 

Task 4: Check HTTPS access is enabled for the Server that will run the CI Sync Agent

Verify the CI Sync Agent Server has access to the Internet over HTTPS.

• You should test HTTPS access to the internet from the console of the server.  Ideally by testing as the same Windows Service Account the CI Sync Agent will be logged in as. 

• The CI Sync Agent will require HTTPS access to the following endpoints:

  • https://login.microsoftonline/com (For the Agent to access your Azure AD for authentication).

  • https://YourCo.syncfish.app/extractor (Where YourCo is the value you agreed with Syncfish when provisioning your CI Sync instance)

• You need to ensure no proxy, firewall or GPO restrictions are in place. 

Task 5: Confirm the SMEs are available to perform their individual steps in these instructions

Confirm the following SMEs are available throughout the installation.

• A ServiceNow System Administrator.

• An Azure Active Directory (AAD) Administrator.

• An infrastructure SME who can create a Windows Service Account (either local or in Active Directory) for use by the CI Sync Agent.

• An infrastructure SME who can install the CI Sync Agent onto the desired server.

• A SQL Server Database Administrator (if the person performing the CI Sync Agent installation does not have SQL sysadmin rights on the relevant SQL server).

• Make sure the SMEs have sufficient permissions to complete their tasks described in this document. 

Task 6: Review the CI Sync Default Configuration Guides

Syncfish publish “Default Configuration Guides” document specific to a given Source and Destination System.  The guides are located here: Default Configuration Guides

These guides cover various topics about the CI Sync Default Configuration rules, and in particular how the configuration rules will read, map, transform and interact with data and objects between a given Source System and Destination System.

Syncfish strongly recommend the default configuration guide is read in advance of performing your first synchronization.