Breadcrumbs

Add Azure

Task List

Task #

Task

Performed by

1

Prepare Azure for use with CI Sync

Azure Admin

2

Understand the CI Sync RecVer Database

SQL DBA
Infrastructure SME

3
SQL

Create a Source System Connection using the CI Sync Agent Config Utility with a SQL RecVer DB

Infrastructure SME
CI Sync Admin

3
Mongo

Or, Create a Source System Connection using the CI Sync Agent Config Utility with a MongoDB RecVer DB (if supported)

Infrastructure SME
CI Sync Admin

4

Finalise Settings in the CI Sync SaaS UI

CI Sync Admin

5

Perform Updates in ServiceNow (if required)

ServiceNow Admin

Task 1: Prepare Azure for use with CI Sync

Context Notes

In Azure ADD (AAD) an App Registration is used to define a Service Principal for the purpose of authenticating a source application to a destination system/application.

The App Registration created in this section relates to the Azure Source Connection created within the CI Sync Agent. 

This Azure specific App Registration is different (and unrelated) to the App Registration for the CI Sync Agent itself that was create in S3 - Create an Entra ID App Registration for CI Sync Agent Authentication)

  1. In the Azure Portal, navigate to Azure Active Directory -> App Registrations and click New Registration

image-20250402-055732.png

  1. On the Register an application form complete as follows:

    1. Enter the Name (Note: Syncfish recommend using “CI Sync Agent Connector for Azure”)

    2. Under Supported account types select “Accounts in this organizational directory only ({Your Domain/Tenant Name} only - Single tenant)”

    3. Click Register

image-20250403-031121.png

  1. Using the left-hand menu, navigate and select Certificates & secrets.  Select “Client secrets (0)” in the middle of the form and then click the “New client secret” button.

image-20250403-031432.png

  1. Enter a unique Description for the secret associated with this CI Sync Agent Connector for Azure App Registration (e.g. “CI Sync Agent Connector for Azure Client Secret”).

  2. Then, select a suitable Expires duration based on your organisational policy.  Finally click the Add button

image-20250403-031506.png

Guidance Note

It is recommended you set a reminder prior to the expiry date of the Secret (i.e. a reminder to regenerate and update the Secret in the CI Sync Agent configuration.


  1. The form now displays the generated secret value (shown in the Value field). Use the copy option to make a copy of the value in the Value field.

CleanShot 2025-07-02 at 09.40.49@2x-20250701-234208.png

Data Capture Note

  1. The Value is only available while you remain on this screen. You must make a copy of the Value before leaving this form.

  2. Make sure you copy the “Value” and NOT the “Secret ID”.

Make sure the secret stored securely and in a way that can be shared with the CI Sync Admin so they can use it when the follow the instructions later in this page.

  1. Return to the Overview page for the App Registration. Use the copy option to make a copy of the “Application (client) ID” GUID value and the “Directory (tenant) ID” GUID value.

image-20250403-032100.png

Data Capture Summary

As a reminder, you should have captured the following information when completing the above steps.

  1. The Secret Value (from Step 6 above). This is the Client Secret value.

  2. The Application (client) ID (from Step 7 above).

  3. The Directory (tenant) ID (also from Step 7 above).

Make sure any secrets or sensitive information is stored securely and in a way that can be shared with the CI Sync Admin.

The above information will be needed by the CI Sync Admin when they follow the instructions in Task 3 further below.


Now proceed with the remaining steps below.


Access Permisssions Context for the Subsequent Steps

Based on the preceding steps a new App Registration has been created (i.e. the new App Registration which provides authentication of the CI Sync Agent Source Connection to Azure).

The subsequent steps below are required to grant the App Registration permissions to read Azure Resources (i.e. objects such as subscriptions, resource groups, virtual networks and so on). 

The subsequent steps should be repeated for each Azure Subscription you want to grant read access to the CI Sync Agent Source Connection to Azure. 

By granting read access to a given Azure Subscription (or multiple Azure Subscriptions) you can synchronize all supported resource types within the Subscription.


  1. In the Azure Portal, navigate to Subscriptions and select/click into the particular Azure Subscription you wish to grant access to the CI Sync Agent Source Connection to Azure.

image-20250403-032349.png

  1. Select Access control (IAM) from the left hand menu, click the Add button and then select Add role assignment from the drop down menu.

image-20250403-032405.png

  1. On the Role tab, select the Reader role and click the Next button.

image-20250403-032437.png

  1. On the Members tab, click the “+ Select members” link, then use the Filter/Select box enter as sufficient amount of text to locate the App Registration created earlier (the one that represents the CI Sync Agent Connector for Azure), then the Select button (to select the App Registration) and finally the Next button.

image-20250403-032458.png

  1. On the Review + assign tab, click the Review + assign button.

image-20250403-032523.png

You have now granted the App Registration object (i.e. the CI Sync Agent Connector for Azure) read permissions to an Azure Subscription which will allow you to use the CI Sync User Interface to schedule synchronization jobs using that same Azure Subscription as a synchronization source.

Task 2: Understand the CI Sync RecVer Database

This “task” is solely about understanding the purpose of the CI Sync RecVer database and making decisions on where to host it and how the CI Sync Agent will authenticate to it.

You may also need to make a decision on which database technology to use for the RecVer Database. The CI Sync Agent supports both MS SQL and MongoDB for the RecVer database (however there are some restirctions on which database technology you can use depending on the source system itself).

Understanding the above topics and making the relevant decisions before you create the source system connection (via the CI Sync Agent Config Utility) will make it quicker/easier to execute the remaining tasks in this guide.

Click to read a comprehensive explanation of the CI Sync RecVer database (and many close related topics)

Firstly, Context about the purpose of CI Sync RecVer Database

  • The RecVer database is a small checksum database used by CI Sync to support the delta synchronization functionality (i.e. the functionality of CI Sync to only sync those records which have changed since the previous sync job). 

  • Each source connection you create (using the CI Sync Agent Configuration Utility) requires its own RecVer database.  That is, each RecVer database is specific to each individual source system connection.

Second, options for the RecVer database technology and the hosting server/VM

  • IF the source system technology is based on Microsoft SQL (such as SCCM, Lansweeper, etc) THEN the CI Sync RecVer database must be Microsoft SQL Server.  In this circumstance:

    • The RecVer database must be hosted on the same SQL Server as the source system database itself.

  • IF the source system technology is NOT based on Microsoft SQL (such as Intune, Azure, VMware, etc) THEN the CI Sync RecVer database can be hosted on either Microsoft SQL or MongoDB. In this circumstance:

    • For a SQL based RecVer SQL database, the RecVer DB can be hosted on any SQL server you chose as long as it is “nearby” the VM running the CI Sync Agent (i.e. the Windows Service) itself. Note: “Nearby” means having low latency between the CI Sync Agent VM and the SQL Server hosting the RecVer DB).

    • For a MongoDB based RecVer database, the MongoDB database and CI Sync Agent must both be hosted on the same VM.

Third, SQL authenitcation options

If you are using a MS SQL source system (such as SCCM or Lansweeper) and therefore using MS SQL to host the RecVer database you need to decide how the CI Sync Agent will authenticate to SQL.

The CI Sync Agent (i.e. the Windows Service) requires read/write access to the RecVer database. The CI Sync Agent also requires read access to the relevant SQL based source system (e.g. SCCM, Lansweeper, etc).

When you use the CI Sync Agent Config Utility to create the source system connection (so you can ultimately run sync jobs from that source system) you have the following options for authentication between the CI Sync Agent (i.e. the Windows Service) and the RecVer DB and source system iteself:

  1. Integrated Security: This option uses the Windows User Account you created for the CI Sync Agent Windows Service.

  2. SQL Native Login: This option uses a native SQL username and password you enter into the CI SYnc Config Utility when you are creating the source system connection.

Note: In either case (Integrated Security or SQL Native Login), the account/login only needs least privileged access to the SQL DBs. Permissions are set either by your DBA (through a manual process) or the Config Utility (through the automated process) as explained further below. 

Finally, options for the SQL RecVer DB creation and setting of SQL permissions

If you are using a MS SQL source system (such as SCCM or Lansweeper) and therefore using MS SQL to host the RecVer database you have two options for for creating the SQL based RecVer DB and for setting pemissions to it (the RecVer DB) and to the source system itself.

Your options are as follows:

  1. MS SQL Setup Option 1: In this option you use the CI Sync Config Utility to automatically create the RecVer database and grant the CI Sync Agent (i.e. the Windows Service) access to the source system SQL database.

  2. MS SQL Setup Option 2: In this option you engage a SQL DBA to manually create the RecVer database and grant the CI Sync Agent (i.e. the Windows Service) access to both the RecVer DB and also to the source system SQL database. The DBA will perform these actions if you don’t have permissions to the SQL server (and therefore you aren’t able to use the CI Sync Config Utility as described in Option 1 above).

And also, have a read of Appendix A - Understand how the CI Sync Agent Authenticates to SQL Server which contains useful diagrams about SQL authentication for the CI Sync Agent.

Task 3 (SQL): Create a Source System Connection using the CI Sync Agent Config Utility with a SQL RecVer DB

As explained in the Guidance Notes above there are two options to facilitate the creation of the RecVer database and assigning permissions to it for the CI Sync (Agent). The table below elaborates the two options.

Option

Description

Details

MS SQL Setup Option 1

Automatically using the CI Sync Agent Config Utility

  • This option requires you to have the sysadmin (sa) role in the SQL Server that will host the RecVer database.

  • If you have sa credentials to the SQL Server that will host the RecVer database you can use the CI Sync Agent Config Utility to create the CI Sync RecVer database.

  • For this option use the Option 1 instructions below.

MS SQL Setup Option 2

Manually via a SQL Database Administrator (DBA)

  • If the person executing the CI Sync Agent Config utility does not have the sysadmin (sa) role in the SQL Server, you can have your SQL DBA perform a manual setup of the RecVer database.

  • For this option you should contact your DBA now and ask them to perform the manual setup tasks described in the Option 2 instructions below.

  • Once the DBA has completed their allocated tasks you will continue with the Option 2 instructions and use the CI Sync Agent Config Utility to connect to the RecVer database the DBA has created for you.

Expand the instructions below for either Option 1 or Option 2.

Option 1: Use the Config Utility to automatically create the RecVer database

Expand the instructions below if your SQL DBA will manually setup the RecVer database (and set the required permissions to the RecVer SQL DB).

Click to expand the instructions to setup the source connection with a SQL RecVer using Option 1

  1. Run the “CISynchronizerAgent Config Utility” from the Windows Start Menu.

  2. Within the CI Sync Agent Configuration Utility, navigate to the Source Systems tab, select Azure and click the Add button.

image-20250403-033420.png

  1. The “Add Connection” form is shown (specific to the source system).

CleanShot 2025-04-03 at 14.35.06@2x-20250403-033530.png

  1. In the section titled “Settings for the CI Sync Windows Service” update the values as follows:

    1. Name: Enter a friendly name that describes this source system connection.

    2. Directory (tenant) ID: Enter the value you captured in the very first task at the top of this guide.

    3. Application (client) ID: Enter the value you captured in the very first task at the top of this guide.

    4. Authentication Method: ClientSecret.

    5. Client Secret: Enter the value you captured in the very first task at the top of this guide.

For Certificate Authentication instructions skip to the Task 3 Supplement and then return here and continue setting up the source system in the CI Sync Agent.

  1. Move to section titled “RecVer DB Settings”

CleanShot 2025-04-03 at 14.36.19@2x-20250403-033625.png

  1. Update the “RecVer DB Settings” values as follows:

    1. RecVer Type: Set this to SQL Server.

  2. In the sub-section titled “SQL Server RecVer Settings” update the values as follows:

    1. SQL Server: Enter the SQL Server path in the format: server\instance.

    2. Integrated Security:

      1. Check this checkbox if you want the CI Sync Agent to authenticate to the SQL Server using the Windows User Account you setup for the CI Sync Agent Windows Service (i.e. the account you setup in Task 1: Create Windows Service Account for the CI Sync Agent to use during S4 - Install the On-Prem Multi-Source Agent.

      2. Otherwise, uncheck this checkbox and enter the User ID and Password for a Native SQL Login provided to you by the DBA. (Note: Syncfish do not recommend the SQL Login have sysadmin rights).
        Note: These authentication settings control how the CI Sync Agent Windows Service authenticates with your SQL Server during ongoing operation of the agent (I.e. when sync jobs are running).

    3. Bypass setup, I have manually setup the databases: Do NOT check this checkbox (because the Config Utility will be creating the RecVer database for you).

    4. Existing RecVer Database: Do NOT check this checkbox (as the Config Utility will create the RecVer database for you).
      Note: These RecVer tick boxes (Bypass setup and Existing RecVer) control whether the CI Sync Config UI initiates the setup of the RecVer database (or not if your DBA is doing the SQL setup manually).

    5. RecVer Database: Greyed out so can be ignored.

    6. DB Timeout (Secs):  Sets the connection and statement execution timeouts. Syncfish recommend 60.

  3. Locate the “Setup & Test” button

Unknown Attachment

  1. Do the following:

    1. Click the “Setup & Test” button.

    2. When the button “Setup & Test” is pressed, the CI Configuration utility will prompt if the user running the utility wants to use Integrated Security or SQL Server security to perform the automated SQL setup and configuration steps.

image-20250402-053601.png

Informational Note

  • The above values do not control the ongoing running of the CI Sync Agent, they are solely used by the CI Sync Config UI to perform the RecVer setup.

  • The user will be required to have admin role in SQL Server to be able to setup the RecVer

Guidance Notes

In the background the Config Utility performs the following SQL setup and configuration steps:

  1. The utility creates a SQL Login for the Windows User Account you setup for the CI Sync Agent Windows Service if you selected “Integrated Security” in the section “Settings for the CI Sync Windows Service”, the Config Utility. Or, if instead you are using Native SQL Login (instead of “Integrated Security”) then Config Utility uses the Native SQL Login details you have supplied and performs the following step to grant the Login access to the relevant databases with the permissions noted below.

  2. The utility creates the RecVer database, creates a SQL user in the RecVer database for the Login used by the CI Sync Agent and grants the SQL user the agent_role role.
    Note: Depending on whether you selected “Integrated Security” or not, the SQL user is either (a) the Windows User/Service Account (created as a SQL Login in point 1 above) or (b) the native SQL login account.

Note: If you are using a Native SQL Login (not Integrated Security) with higher privileges than noted above (e.g. if the account had SQL sysadmin) then the Config Utility will not be able to set the SQL roles noted above.  Instead, the Config Utility will not touch the permissions and instead will leave the existing/higher privileges as is.  This is not required and not recommended by Syncfish.

  1. If all is setup correctly you will see “Ok” against each of the setup tasks.  If you see errors recheck the values you entered on the form.

Unknown Attachment

  1. After a successful test has been completed, click the Save button.

  2. Finally, click Yes to register this new connection (via your CI Sync Agent) with your customer specific CI Sync SaaS instance.

image-20250403-033927.png

  1. Assuming no errors you will see a confirmation message. Click OK and the new connection will appear in the Connections List of the CI Sync Agent.

  2. You have now completed the setup of the source connection in the CI Sync Configuration Utility and registered it as a source connection in the CI Sync SaaS application. 

Option 2: Use your SQL Database Administrator (DBA) to manually create the RecVer database in advance

Expand the instructions below if your SQL DBA will manually setup the RecVer database (and set the required permissions to the RecVer SQL DB).

Click to expand the instructions to setup the source connection with a SQL RecVer using Option 2

  1. Ask you SQL DBA to perform the tasks listed in the table below.

Task

DBA Task (in SQL Server)

Additional Notes

Task 1

Either register a Login (which represents the Windows User Account used by the CI Sync Agent Windows Service)

Or create a SQL Login (for the CI Sync Agent to use).

If you are using Windows “Integrated Security” between the CI Sync Agent and the SQL Server, then the CI Sync Agent Windows Service account needs to be registered within SQL Server as a Login. 

Note: The CI Sync Agent Windows Service account you setup in Task 1: Create Windows Service Account for the CI Sync Agent to use during S4 - Install the On-Prem Multi-Source Agent.

Alternatively, if you are using Native SQL authentication between the CI Sync Agent and the SQL Server, then a Login will need to be created. In this case your DBA will need to provide you with the SQL User ID and password details so you can enter them into the Config Utility UI as explained further below.

Task 2

Edit then Execute the SQL Create Script provided by Syncfish located here. The script creates the Syncfish RecVer database.

The script is: cisee-recver-create-script.sql

Notes for the DBA when running the script:

  • The script has a placeholder called $(recver_database_name) as the replacement for the RecVer database name.

  • For Azure as the source system Syncfish recommend “cisee_recver_azure” as the RecVer database name.

To run the setup script using the sqlcmd utility, the recver_database_name parameter needs to be passed in using the -v switch:

> sqlcmd -I -S localhost -v recver_database_name=" cisee_recver_azure" -i "cisee-recver-create-script.sql"

Or, if running the script in SSMS, the value $(recver_database_name) (including the $ and brackets) needs to be replaced in the .sql file with the name for the recver database.

The DBA may notice the script includes has a placeholder called $(source_database_name) which is only required when Lansweeper is the source system. This placeholder can be ignored for all other (non-Lansweeper) source systems.

Task 3

Edit then Execute the SQL Upgrade Script provided by Syncfish located here. The script creates the Syncfish RecVer database.

The script is: cisee-recver-upgrade-script-3.1.1.sql

Notes for the DBA when running the script:

  • The script has a placeholder called $(recver_database_name) as the replacement for the RecVer database name.

  • For Azure Syncfish recommend “cisee_recver_azure” as the RecVer database name.

To run the setup script using the sqlcmd utility, the database_name parameter needs to be passed in using the -v switch:

> sqlcmd -I -S localhost -v recver_database_name=" cisee_recver_azure" -i "cisee-recver-upgrade-script-3.1.1.sql"

Or, if running the script in SSMS, the value $(recver_database_name) (including the $ and brackets) needs to be replaced with the name for the recver database.

Task 4

Map the Login as a user in the RecVer database and grant the user the role_agent role.

Map the user and grant the role to the RecVer database created by the SQL script above.

Once your DBA has completed the steps in the table above, use the CI Sync Agent Configuration Utility to setup the source connection and pointing to the RecVer database created by the DBA. See below for instructions on using the CI Sync Agent Configuration Utility.

  1. Run the “CISynchronizerAgent Config Utility” from the Windows Start Menu.

  2. Within the CI Sync Agent Configuration Utility, navigate to the Source Systems tab, select Azure and click the Add button.

image-20250403-033420.png

  1. The “Add Connection” form is shown (specific to the source system).

CleanShot 2025-04-03 at 14.35.06@2x-20250403-033530.png

  1. In the section titled “Settings for the CI Sync Windows Service” update the values as follows:

    1. Name: Enter a friendly name that describes this source system connection.

    2. Directory (tenant) ID: Enter the value you captured in the very first task at the top of this guide.

    3. Application (client) ID: Enter the value you captured in the very first task at the top of this guide.

    4. Authentication Method: ClientSecret.

    5. Client Secret: Enter the value you captured in the very first task at the top of this guide.

For Certificate Authentication instructions skip to the Task 3 Supplement and then return here and continue setting up the source system in the CI Sync Agent.

  1. Move to section titled “RecVer DB Settings”

image-20250403-034145.png

  1. Update the “RecVer DB Settings” values as follows:

    1. RecVer Type: Set this to SQL Server.

  2. In the sub-section titled “SQL Server RecVer Settings” update the values as follows:

    1. SQL Server: Enter the SQL Server path in the format: server\instance.

    2. Integrated Security:

      1. Check this checkbox if you want the CI Sync Agent to authenticate to the SQL Server using the Windows User Account you setup for the CI Sync Agent Windows Service (i.e. the account you setup in Task 1: Create Windows Service Account for the CI Sync Agent to use during S4 - Install the On-Prem Multi-Source Agent.

      2. Otherwise, uncheck this checkbox and enter the User ID and Password for a Native SQL Login provided to you by the DBA. (Note: Syncfish do not recommend the SQL Login have sysadmin rights).
        Note: These authentication settings control how the CI Sync Agent Windows Service authenticates with your SQL Server during ongoing operation of the agent (I.e. when sync jobs are running).

    3. Bypass setup, I have manually setup the databases: Check this checkbox (because your SQL DBA has already manually created the RecVer database and set the relevant permissions for you).

    4. Existing RecVer Database: Check this checkbox (because your SQL DBA has already manually created the RecVer database for you
      Note: These RecVer tick boxes (Bypass setup and Existing RecVer) control whether the CI Sync Config UI initiates the setup of the RecVer database (or not if your DBA is doing the SQL setup manually).

    5. RecVer Database: Enter the name of the RecVer database your DBA created. If your DBA used the suggested name (described on the previous page) it will be called cisee_recver_azure.

    6. DB Timeout (Secs):  Sets the connection and statement execution timeouts. Syncfish recommend 60.

  3. Locate the “Setup & Test” button

Unknown Attachment

  1. Do the following:

    1. Click the “Setup & Test” button.

    2. If all is setup correctly you will see “Ok” against each of the setup tasks.  If you see errors recheck the values you entered on the form.

Unknown Attachment

  1. After a successful test has been completed, click the Save button.

  2. Finally, click Yes to register this new connection (via your CI Sync Agent) with your customer specific CI Sync SaaS instance.

image-20250403-034237.png

  1. Assuming no errors you will see a confirmation message. Click OK and the new connection will appear in the Connections List of the CI Sync Agent.

  2. You have now completed the setup of the source connection in the CI Sync Configuration Utility and registered it as a source connection in the CI Sync SaaS application. 

Task 3 (Mongo): Or, Create a Source System Connection using the CI Sync Agent Config Utility with a MongoDB RecVer DB (if supported)

Click to expand the instructions to setup the source connection with a MongoDB RecVer

  1. Run the “CISynchronizerAgent Config Utility” from the Windows Start Menu.

  2. Within the CI Sync Agent Configuration Utility, navigate to the Source Systems tab, select Azure and click the Add button.

image-20250403-033420.png

  1. The “Add Connection” form is shown (specific to the source system).

CleanShot 2025-04-03 at 14.35.06@2x-20250403-033530.png

  1. In the section titled “Settings for the CI Sync Windows Service” update the values as follows:

    1. Name: Enter a friendly name that describes this source system connection.

    2. Directory (tenant) ID: Enter the value you captured in the very first task at the top of this guide.

    3. Application (client) ID: Enter the value you captured in the very first task at the top of this guide.

    4. Authentication Method: ClientSecret.

    5. Client Secret: Enter the value you captured in the very first task at the top of this guide.

For Certificate Authentication instructions skip to the Task 3 Supplement and then return here and continue setting up the source system in the CI Sync Agent.

  1. Move to section titled “RecVer DB Settings”

image-20250402-071759.png

  1. Update the “RecVer DB Settings” values as follows:

    1. RecVer Type: Set this to Mongo Db.

  2. In the sub-section titled “SQL Server RecVer Settings” update the values as follows:

    1. MongoDb Connection: Enter the Mongo Db instance path in the format: mongodb://server. 

    2. Bypass setup: Do NOT check this checkbox unless you have been asked to do so by Syncfish (in most cases the Config Utility will be creating the RecVer database for you). 

    3. Existing RecVer Database: Do NOT check this checkbox unless you have been asked to do so by Syncfish (in most cases the Config Utility will be creating the RecVer database for you).

    4. RecVer Database:  This field will be greyed out in most cases (unless one of the above two options have been ticked).  In most cases there is no existing RecVer database and therefore the Config Utility will automatically generate the name of the database when you click the “Setup & Text” button as part the next step in these instructions. 

  3. Locate the “Setup & Test” button

image-20250402-053546.png

  1. Do the following:

    1. Click the “Setup & Test” button.

  2. If all is setup correctly you will see “Ok” against each of the setup tasks.  If you see errors recheck the values you entered on the form.

image-20250402-053914.png

  1. After a successful test has been completed, click the Save button.

  2. Finally, click Yes to register this new connection (via your CI Sync Agent) with your customer specific CI Sync SaaS instance.

image-20250403-034237.png

  1. Assuming no errors you will see a confirmation message. Click OK and the new connection will appear in the Connections List of the CI Sync Agent.

  2. You have now completed the setup of the the source connection in the CI Sync Configuration Utility and registered it as a source connection in the CI Sync SaaS application. 

Task 3 (Optional): Supplementary Instructions for Certificate Based Authentication

Click to expand the instructions on setting up Certificate Based Authentication in the CI Sync Agent

Some source systems support Certificate authentication for the authentication principal created in the first step of this guide. In this case, you can configure the CI Sync Agent to use Certificate based authentication rather than Client Secret.

The screen shot/s and instructions below explain how to configure the CI Sync Agent for Certificate Authentication for a given source system. Once you have completed these steps jump back to the relevant task above to finish the steps for setting up your source system connection in the CI Sync Agent Config Utility.

The instructions below replace the Client Secret screen shots and instructions provided in the tasks above. You do NOT need to following the instructions below if you have decided to use Client Secret authentication between the CI Sync Agent and the source system.

Part A - Import your certificate to the Windows Certificate Store on the VM running the CI Sync Agent

Guidance Notes

  • These instructions assume the organization has a certificate management solution in place and the certificate related to this activity is available to the Windows Server being used to install/run the CI Sync Agent (i.e. the Windows Service).

  • The Digital Certificate itself is the provided to you by the person who created the certificate based authentication principle during the first step of this guide.

  • When importing the certificate, it is recommended you import to the Local Machine Certificate Store. If you import it to the Current User you will almost certainly strike errors when the CI Sync Agent user account (i.e. the user account used by the Windows Service) tries to access the certificate.

  • Only consider importing to the Current User Certificate if you are running the CI Sync Config Utility with “Run As” in the context of the CI Sync Agent user account (i.e. the user account used by the Windows Service).

  1. Import the Digital Certificate into the Windows Local Machine Certificate Store.  It is recommended you do not import into the Current User Certificate Store (see Guidance Notes above).

  2. Ensure the CI Sync Agent user account (i.e. the user account used by the Windows Service) has sufficient permissions to read the Digital Certificate you imported.  The following steps explain how to check/set the right permissions.

  3. Open Microsoft Management Console.

  4. Navigate to Certificates - Local Computer → Personal → Certificates

  5. Right-click on the relevant certificate (the one you imported) and select All Tasks → Manage Private Keys

CleanShot 2025-04-03 at 15.48.58@2x-20250403-044903.png

  1. On the permissions window, click the Add button.

CleanShot 2025-04-03 at 15.49.18@2x-20250403-044923.png

  1. Search for Users, locate the CI Sync Agent User (e.g. svc-cisync-agent), press Check Names, then press the OK button.

CleanShot 2025-04-03 at 15.49.36@2x-20250403-044939.png

  1. Back on the permissions window, make sure Full control and Read are ticked.  Then click Apply and then Ok.

CleanShot 2025-04-03 at 15.49.50@2x-20250403-044953.png

Part B - Use the CI Sync Agent Config Utility to Reference the Imported Certificate

  1. Using the CI Sync Agent Configuration Utility, use the drop down list to set the Authentication Method to Certificate in the Connection Settings section of the Add Connection form.

CleanShot 2025-04-04 at 17.34.23@2x-20250404-063437.png

  1. Set the Certificate Location using the following instructions:

    1. The options are as follows (these are the standard values provided by Microsoft):

      1. LocalMachine

      2. CurrentUser

    2. Syncfish Recommendation:

      1. It is strongly recommended you use LocalMachine, as the current user account (the person installing/running the CI Sync Agent Config Utility) is not the same as the CI Sync Agent user account (i.e. the user account used by the Windows Service). 

      2. If you have saved the certificate in the CurrentUser context, rather than the LocalMachine context (of the Windows Certificate Store) it will cause an error when the CI Sync Agent user account (i.e. the user account used by the Windows Service) tries (and fails) to read the certificate from the Windows Certificate Store.

  2. Set the Certificate Store using the following instructions:

    1. The options are as follows (these are a standard values provided by the Microsoft and correspond to the folders in the Windows certificate store):

      1. AddressBook

      2. AuthRoot

      3. CertificateAuthority

      4. My

      5. Root

      6. TrustedPeople

      7. TrustedPublisher

    2. Syncfish Recommendation: It is recommended this value be set to the “My” store (this translates to the “Personal/Certificates” path in the Windows Certificate Store).

  3. Enter the Certificate Name / Thumbprint value: Enter the subject of the certificate related to the authentication principal created in the first step of this guide.

  4. Finally, jump back to the relevant task above to finish the steps for setting up your source system connection in the CI Sync Agent Config Utility.

Setting up certificate based authentication can be somewhat fiddly to get right. Syncfish have published a number of troubleshooting articles in our knowledge base. Search for “certificate” in our support portal at https://support.syncfish.com.au.

Task 4: Finalise Settings in the CI Sync SaaS UI

  1. Login to your CI Sync SaaS instance at https://YourCo.syncfish.app

  2. In the CI Sync UI, navigate to Settings > Connections.

CleanShot 2025-04-07 at 11.27.20@2x-20250407-012911.png

  1. Find the new source system connection you just added in the list of Source Connections (the screen shot above is a sample only).

  2. Find your specific Source System Connection in the list and click the Update hyperlink (on the right hand side of the screen).

  3. The connection Settings Form is presented. Update as follows:

    1. Enter an Alias (optional) - the alias is only used in the CI Sync SaaS UI to show a friendly name in various UI forms.

    2. Set the Environment/s the new source connection can be used for. 

      1. In most cases a Source System Connection is used for both Test and Production sync jobs (as distinct from the Destination Connections which can only be either Test or Production).

      2. The Environment value is used to filter the connections dropdown list when you are creating a sync job.

image-20250403-032733.png

  1. While you are on this page you can/should check whether there are any connection specific settings you may want to adjust either now or at some point in the future. Connection specific settings (or just Connection Settings) allow you to override the default data sync rules for your CI Sync instance.

  2. Read the following details to understand more about CI Sync Connection Settings:

    1. Scroll further down to the Additional Settings section on the page to see any available Connection Settings. Below is an example of the sorts of settings you might notice.

    2. The settings are specific to each source connection so the screen shot is an example only.

      CleanShot 2025-07-18 at 17.33.13@2x-20250718-073337.png


    3. Syncfish recommend you read the following documentation before overriding any of the default settings:

      1. Read the CI SyncDefault Configuration Guides. The pages in that tree provide comprehensive information about the default behaviour of the CI Sync data sync rules, the options available for overriding those rules and typical reasons why you might want to do this.

      2. Read Understanding the use of CI Sync Connection Settings. This page explains how the Connection Settings should be used, how to modify settings via the CI Sync UI and how to test any setting changes in non-production prior to production.

    4. Finally, if you are ready to modify any of the Connection Settings, visit Connection Setting Guides and locate the specific Source System page/s in that tree. The individual pages in that tree provide detailed information about each setting.

      CleanShot 2025-07-22 at 15.47.19@2x-20250722-054753.png

  3. After making any changes on this page, scroll to the bottom of the page, Check the consent checkbox and Click the Save connection button.

You have now completed all tasks to add your new Source Connection in the CI Sync Agent. 

Please do one of the following:

Task 5: Perform Updates in ServiceNow (if required)

In this section your ServiceNow SME will assess various updates to ServiceNow to support this CI Sync connector:

  • Task 5a: Assess if the CMDB CI Class Models plug-in is required

  • Task 5b: Assess if additional permissions are required

  • Task 5c: (Optional though recommended) Assess your ServiceNow CI forms and update to include additional Related Lists

Guidance Note

Syncfish recommend the person setting up the source system described in this guide discusses this particular task with their ServiceNow system administrator. 

A ServiceNow administrator will need to perform these steps.

Syncfish recommend following these instructions in your non-production ServiceNow environment for testing synchronization jobs.

Only once exhaustive testing in non-production is complete, repeat this process in your ServiceNow production environment.

Task 5a: Assess if the CMDB CI Class Models plug-in is required

Context

A number of record sets (asset types/resource types) available to sync using the Azure Connector rely upon CMDB CI Classes that are only available via the CMDB CI Class Models plug-in. 

You therefore need to install the CMDB CI Class Models plug-in to your ServiceNow instance.

If you already have the plug-in you may want to upgrade it to the latest version (as ServiceNow occasionally updates the plug-in to include extra CI Classes/tables).

Source System

Specific Record Sets that require the CMDB CI Class Models plug-in

Azure

  • Many/most Azure resources supported by CI Sync.

  • Synchronizing of Azure Tags into the cmdb_key_value table.

Instructions

Follow these steps to add this plug-in (and similar steps to locate it and upgrade it if required):

  1. Assess the use/inclusion of this plug-in within your ServiceNow (ensure you are comfortable installing this plug-in).

  2. Search for Plugins via the ServiceNow navigation menu.

  3. Locate the CMDB CI Class Models plug-in.

  4. Click Add -> Install and follow the instructions provided.

image-20250328-005325.png

Task 5b: Assess if additional permissions are required

Use Case #1 - If you are planning to use CI Sync to write Azure Tags to the CMDB

Context

CI Sync writes Azure Tags to the cmdb_key_value table in ServiceNow.

The standard/out-of-the-box roles provided by ServiceNow (and recommended by Syncfish during S6 - Configure your ServiceNow for CI Sync) do not provide access to the cmdb_key_value table. Therefore, the CI Sync Integration User account created during S6 - Configure your ServiceNow for CI Sync requires additional permissions to write to the cmdb_key_value table.

Syncfish provides a ServiceNow updateset to prepare your ServiceNow instance for CI Sync. The updateset does the following:

  • Creates a read/write ACL on the cmdb_key_value table.

  • Applies the ACL on the cmdb_key_value table and assigns the ACL to the ServiceNow role called “Asset” (which is one of the roles granted to the CI Sync Integration Account created during S6 - Configure your ServiceNow for CI Sync).

Instructions

Follow these steps to apply the updateset provided by Syncfish:

  1. Download the update set from Syncfish at the below URL:
    https://downloads.syncfish.app/servicenow/cisync-cmdb-key-value.xml

  2. Login to your ServiceNow instance with Admin permissions.

  3. Open a browser and navigate to your ServiceNow instance

  4. In the left nav menu search for “Retrieved Update Sets” and click to open

  5. Right click on the column heading row and select “Import XML”

CleanShot 2025-06-10 at 18.34.18@2x-20250610-083554.png

  1. Select “Choose File”

  2. Select the downloaded file “cisync-cmdb-key-value.xml”

  3. Click to open the Update Set

CleanShot 2025-08-04 at 18.45.24@2x-20250804-084545.png

  1. Click “Preview Update Set”

  2. If there are no preview errors, Click “Close”.

  3. Click “Commit Update Set”.

  4. Your ServiceNow instance is now ready to receive Tag data from Azure via sync jobs from CI Sync.

Use Case #2 - If you are planning to use CI Sync to create Application Service Mapping relationships in ServiceNow

Context

CI Sync needs additional permissions to create/update Application Service relationships in ServiceNow.

The ServiceNow out-of-the-box role described in the instructions below provides the required permissions and therefore this role needs to be applied to your CI Sync Integration User if you intended to use CI Sync’s Application Service Mapping feature.

Please contact Syncfish if a custom role is preferred over this out-of-the-box role.

Instructions

  1. Navigate to the cisync user account (e.g. “cisync.integration” or the name you used earlier in this page).

  2. Select the Roles tab and click the Edit… button

  3. Filter/Select the roles below and click the Save button

    1. app_service_admin

  4. Click Save. Then use the “Roles” tab to check the above role has been applied.

Context

CI Sync populates various child tables (related lists) associated with parent CIs. The following table shows the Related Lists (per CI Class) populated by the CI Sync Azure Connector.

CI Class

Related List
(i.e. friendly name)

Related List Name as it appears in the ServiceNow UI when adding it to a CI Form

Subscription

Key Values (Tags)

Key Value → Configuration Item

Resource Group

Key Values (Tags)

Key Value → Configuration Item

Cosmosdb (Mongodb)

Key Values (Tags)

Key Value → Configuration Item

DNS Zone

Key Values (Tags)

Key Value → Configuration Item

Frontdoor

Key Values (Tags)

Key Value → Configuration Item

Load Balancer

Key Values (Tags)

Key Value → Configuration Item

NAT Gateway

Key Values (Tags)

Key Value → Configuration Item

Network Security Group

Key Values (Tags)

Key Value → Configuration Item

Private DNS Zone

Key Values (Tags)

Key Value → Configuration Item

Private Endpoint

Key Values (Tags)

Key Value → Configuration Item

Public IP Address

Key Values (Tags)

Key Value → Configuration Item

Virtual Network

Key Values (Tags)

Key Value → Configuration Item

Virtual Machine

Key Values (Tags)

Key Value → Configuration Item

Virtual Machine Scale Set

Key Values (Tags)

Key Value → Configuration Item

Storage Account

Key Values (Tags)

Key Value → Configuration Item

Application Service

Key Values (Tags)

Key Value → Configuration Item

Application Service Plan

Key Values (Tags)

Key Value → Configuration Item

CDN Profile

Key Values (Tags)

Key Value → Configuration Item

Kubernetes Service

Key Values (Tags)

Key Value → Configuration Item

Logic App

Key Values (Tags)

Key Value → Configuration Item

Event Hub

Key Values (Tags)

Key Value → Configuration Item

Application Gateway

Key Values (Tags)

Key Value → Configuration Item

Key Vault

Key Values (Tags)

Key Value → Configuration Item

API Management Service

Key Values (Tags)

Key Value → Configuration Item

CI Sync populates a number of additional relationships/related record sets for Azure. Please contact Syncfish support for further information on exposing these additional records in the ServiceNow UI.

  • A-Records (as related records of DNS Records)

  • CNAMEs (as related records of DNS Zones)

  • Frontends/Cloud Load Balancer IP Addresses (as related records of Frontdoors)

  • A-Records (as related records of Private DNS Records)

  • CNAMEs (as related records of Private DNS Records)

  • Subnets (as related records of Virtual Networks)

  • Subnets (as related records of Virtual Machines)

  • Storage Account Endpoints (as related records of Storage Accounts)

  • CDN Endpoints (as related records of CDN Profiles)

  • Backend IP Addresses (as related records of Application Gateways)

  • Routing Rules (as related records of Application Gateways)

Instructions

Below are the steps to modify a ServiceNow CI form to expose a new Related List.

  1. Login to your ServiceNow instance with Admin permissions.

  2. Navigate to any CI in the relevant CI Class (i.e. one/all of those listed in the table in the Context section above). For example, navigate to a Windows Server CI).

  3. Right-click in the heading area of the form, then click Configure and then Related Lists from the sub-menus.

image-20250402-073451.png


  1. Identify the Related List you want to expose on the CI form using the table in the Context section above.

  2. Find the Related List in the left hand column which lists all Available Related Lists.

  3. Click the Related List and then click add (the selection arrow) to move the item to the Selected column and then click Save.

image-20250402-073539.png

  1. Repeat for each additional CI Class listed in the table in the Context section above.