# Syncro Asset Management integration

_[Image: MSP Software: PSA + RMM + Remote Platform – SyncroMSP]_

Domotz [network management software](https://www.domotz.com/) includes integration with Syncro [Asset Management](https://syncromsp.com/).

The Domotz Syncro Integration streamlines the Asset Management of networks by automatically sending the device and network details discovered by Domotz to Syncro, and vice-versa.

Note: due to the nature of this type of integration (bi-directional integration with data streaming from Domotz to Syncro and vice-versa), Domotz users are only allowed to configure one single integration with external documentation and Asset Management systems (such as IT Glue, ConnectWise PSA, Synchro).

Domotz will discover devices including device details like model, MAC address, location, zone, software version, IP addresses and more and automatically send these details directly to Syncro.

This integration allows you to synchronize the following data:

- **Domotz Collectors and Devices** – When using the _Selection Mode (per device plan)_, only devices listed as _Managed_ will be pushed and kept in sync.
- **Syncro Assets**

## 1. On Syncro: How to set-up the integration

Before starting to connect an integration, you need to generate an API Token on to Syncro.
To do that go to https://[yourcompany].syncromsp.com/api_tokens

Then click on "+ New Token" on the upper right side of your screen:

Select “Domotz Asset Management” as the “Prebuilt App Permissions” schema:

Creating a New Token for Domotz Asset Management

1. Navigate to the "New Token" page in your software interface.
2. Review the information under "TOKEN TYPES" and "API INTEGRATION TOKENS DISCLAIMER" to understand the terms and obligations associated with token creation.
3. Go to the "Prebuilt App Permissions" section under the "App Integration" tab.
4. Locate "Domotz Asset Management" in the list.
5. Click the "Create Token" button next to "Domotz Asset Management" to generate a new token.

It will basically create a token with the necessary permissions to allow the integration to work:

- Assets - View Details
- Assets - List/Search
- Assets - Edit
- Customers – List/Search
- Customers - View Detail

Confirming API Permissions for Domotz Asset Management

1. The interface shows a field labeled "Name" with the value "Domotz Asset Management."
2. Under "Edit API Permissions," several permissions are listed with checkboxes:
   - "Assets - View Details"
   - "Assets - List/Search"
   - "Assets - Edit"
   - "Assets - Create"
   - "Customers - List/Search"
   - "Customers - View Detail"
3. Each permission has its corresponding checkbox marked, indicating they are selected.
4. There is an option labeled "Show all permissions" to view additional permissions.
5. A button labeled "Create API Token" is present at the bottom, allowing the user to create an API token once permissions are confirmed.

Once the API Token has been created, copy it to your clipboard. You will use it in Domotz:

New Custom API Token Details

1. A warning message prompts users to copy the API token immediately, as it will not be displayed again.
2. The token field contains the newly generated token that needs to be copied and stored securely.
3. Information is displayed about the token, including the owner, creation date and time, type (Custom), and the expiration status, which is marked as "Indefinite."
4. A button labeled "Done" allows users to exit the token creation screen once the token is copied.

**Important Note:** Domotz cloud will connect to the Syncro cloud from the following IP addresses:
– 52.71.132.221 for all the users based in North America
– 52.48.78.120 for all the users based on Europe, APAC and Rest of World
Make sure you add the above to "IP Allow List" under the "Employees" section in the admin page.

IP Allow List Configuration Steps

1. Navigate to the "IP Allow List" under the "EMPLOYEES" section from the side menu.

2. In the "IP Allow List" settings, review the options available for controlling access:
   - Enable "Enabled for Users" to restrict user access based on IP addresses.
   - Enable "Enabled for APIs" to restrict API access based on IP addresses.

3. In the "Allowed IP Address List" field, ensure the correct IP addresses are entered. Use IPv4 and/or IPv6 formats with or without CIDR notation. To add an IP address, type it in the "Add IP address" field.

4. Confirm the list to selectively prevent access to your Syncro account for any other IP address not listed.

## 2. On Domotz: How to set-up integration

1. Login to your Domotz system
2. Select the menu Services under the Account Settings section
3. Select Syncro from the list of available documentation services you would see on your screen

Accessing Documentation and Data Aggregation Platforms

1. Navigate to the Services & Drivers section. Select the icon resembling a speech bubble from the left-hand menu to open the 'Connect and Manage' section.

2. Under 'Documentation and Data Aggregation Platforms,' choose 'Syncro MSP.' This platform offers a comprehensive solution for organizing your information effectively.

4. Insert the API url and the Token you did generate on Syncro MSP and then click on the Connect button:

How to connect to Syncro MSP.

1. Enter the API URL in the designated field. Use the format `https://[yourcompany].syncromsp.com/`.
2. In the Bearer Token field, input the token you generated previously.
3. Click the Connect button to complete the process.

**Important note:** a Syncro Asset type named "Domotz Device" should exist in Syncro to make the integration work correctly.
To create it: [https://help.syncromsp.com/hc/en-us/articles/115002529873-Individual-Asset-Types](https://help.syncromsp.com/hc/en-us/articles/115002529873-Individual-Asset-Types)
You should create the asset type with the following fields (type: Text field) : mac_address, ip_address, device_type, current_status, model, position, hostname, manufacturer, notes
Once completed the Domotz Devices Asset type will look exactly like the one below:

Custom Fields Configuration in Domotz

1. The table displays custom fields for devices in Domotz.
2. Each row consists of three columns: Name, Type, and Required.
3. The "Name" column lists field names such as Asset Name, Asset Serial, mac_address, ip_address, device_type, current_status, model, position, hostname, manufacturer, and notes.
4. The "Type" column indicates that all fields are "Text field," with Asset Name and Asset Serial also labeled as "System field."
5. The "Required" column shows that all fields are marked as "Not Required."

Even if you do not have this asset type Domotz will still try to match a device to an existing asset, but some data may be missing.

**Note:** if the device serial is not defined in Domotz, the device MAC address will be used for the Syncro MSP Asset serial field.

## 3. How to associate Domotz and Syncro Items

### a. How to link a Domotz Agent to Syncro Customers

To link a **Domotz Agent** to a **Syncro MSP Customers**, click on the **+** button:

Associating Domotz Agents with Syncro MSP Customers

1. Use the "Search for agents" bar at the top to find specific agents if needed.
2. Select the "All Agents" button to view all available Domotz agents, with the current count displayed next to it.
3. The "Linked" and "Unlinked" options allow filtering based on association status.
4. In the main table, each row represents a Domotz agent and its potential Syncro MSP customer link.
5. For "Draper Office - Lab," click the "Link Customer" button to initiate linking with a Syncro MSP customer.
6. The "Sync" toggle allows enabling or disabling synchronization between the Domotz agent and Syncro MSP customer.

A pop-up window will appear allowing you to search and choose the **Syncro MSP Customer** to link to the specific **Domotz Agent**:

Syncro MSP Customer Selection Dialog

1. Open the "Syncro MSP Customers" dialog to select a customer.
2. Use the search bar labeled "Filter Items" to find a specific customer by name or email.
3. Browse through the list of available customers, which shows names and associated email addresses.
4. Select a customer by clicking the radio button next to their name.
5. Click "Link Customer" to proceed with linking the selected customer.
6. If you wish to cancel the operation, click the "Cancel" button.

**Note:** The automatic match between **Domotz Devices** and** Syncro Asset** is based on the following information (in order of priority), based on the data available on the systems:
- Serial Number (when available in Domotz and Syncro)
- MAC Address (when available in Syncro)
- IP Address (when available in Syncro)

### b. How to manage the matching between Domotz Devices and Syncro Assets

To manually match a Domotz device with a specific**Asset,** click on the number of matched devices:

Connecting Domotz Agents to Synchro MSP Customers

1. Review the list of Domotz Agents on the left. Each agent has a label like "Atanas Test Lab(GNS3)" with a sublabel indicating "Important Devices."

2. On the right, corresponding to each agent, there is a Synchro MSP Customer with details such as "Domotz Corp | sofia@domotz.com." This area provides the last sync status, e.g., "Last Sync: 5 days ago."

3. Below the customer details, check the "Synchro MSP Assets" to see how many assets are matched. In this instance, it shows "3 Matched." Click on the matched assets link for more details.

To link an asset to a **Domotz Device** that has no match, click on the **+** **Match Asset**button:

Matching a Syncro MSP Asset with a Domotz Device

1. Open the "Match Asset" section to choose a Syncro MSP asset from the provided list.
2. Use the search bar to find specific devices or navigate through categories like "Important Devices" or "Unmatched."
3. View device details such as names, icons, and IP addresses listed on the left.
4. To match an asset, click the "Match Asset" button next to the desired device. This will begin the pairing process with a Domotz device in the designated test lab.
5. Optionally, use the "Select All" checkbox at the top right to perform batch operations on multiple devices.

A pop-up window will appear where you will be able to Create a new Asset or select an existing one and to link it to the Domotz device:

- To allow Domotz to link a **domotz device** to a new **Syncro Asset** (created by Domotz itself), select **Create New** **Asset** and then click on **Save**.
- To link a **domotz device** to an existing ****Syncro MSP Asset****, select it from the list and then click on **Save**:

Match or create a Syncro MSP asset.

1. In the "Syncro MSP Asset" dialog, choose how to match an asset to "domotzbox1."
2. Select "Create a new Asset" to add a new asset.
3. Alternatively, select an existing asset, for example, "raspberrypi."
4. Click "Save" to confirm your selection, or "Cancel" to exit without saving.

### c. **Bulk creation of Syncro MSP Assets**

In case more than one**MSP Asset** has to be created at once, (ex. if Domotz is used to set up an**MSP Customer** from scratch), you can use the select multiple rows and press the **Pick an action** button.

Managing and Creating Assets

1. Check the boxes next to the assets you want to manage. These boxes are located on the right side of each asset row.
2. Click "Pick an action" to reveal a dropdown menu of options.
3. In the Manage Assets dialog that appears, click "Create 2 Assets" to create new assets from the selected items. Use the "Remove Match" or "Cancel" options if needed to adjust the action.

### d. Unlink the asset

To manually unlink already matched **Asset**:

- Click on the link with the matched devices number (ex. 4 Matched - see screenshot below):

Syncro MSP Customers Management Interface

1. The interface displays a list of customers, each with synchronization status and options.
2. Each customer entry shows the email, with synchronization details, including the last sync time.
3. Links labeled "Matched" indicate the number of assets associated with each customer. Clicking these links provides further details about the matched assets.
4. Toggle switches are present next to each customer to enable or disable synchronization.
5. Additional options to "Link Customer" or "Unlink" are available beside each customer entry.
6. The "Sync now" button at the top allows for immediate synchronization of selected customers.

- Then click on the **x**  button next to the asset shown in the screenshot below:

Matching an Asset in the Domotz Interface

1. Locate the asset list under "Important Devices." Each row represents a separate asset entry.
2. Find assets labeled with their names, such as "API Asset Name" or "Domotz."
3. Identify the network details included in each entry, like "VMware 192.168.18.2" or "QNAP Systems 192.168.18.135."
4. To match an asset, click the "Match Asset" button in the same row as the desired Domotz entry.
5. Use the interface at the top for filtering options to view "Unmatched" or "Matched" devices.

**Important note:** There is no confirmation request before unlinking the Asset.

### e. How to set up the synchronization (automatic or manual)

##### **Manual Synchronization**

To start the manual synchronization, select the desired Agent and then click on the **Sync now** button:

Sync MSP Customers

1. To sync a specific customer, locate the customer's name under "Syncro MSP Customers" and ensure the toggle switch in the "Sync" column is set to the right and highlighted in green. This indicates the customer is ready for syncing.

2. To start the synchronization process for all selected customers, click the "Sync now" button at the top right.

**Please note that**only a **Domotz Agent** already linked to a****Syncro MSP Customer**** can be selected.

After pressing the "Sync Now" button, a pop-up window will appear and the user will be able to select the synchronization mode:

- Synchronization from Domotz to Syncro MSP: the information stored on the **Domotz Devices** will override the information on the** **Syncro MSP**** **Asset**.
- Synchronization from Syncro MSP to Domotz: the information stored on the******Syncro MSP**** **Asset**** will override the information on the **Domotz Devices**.
- Customized synchronization: you can choose the synchronization direction for every single field from the **Custom Match Fields Configuration** window.

Dialog for Synchronizing Fields Between Domotz and Syncro MSP

1. Choose the direction for synchronization:
   - Select "Domotz > Syncro MSP" to sync fields from Domotz to Syncro MSP.
   - Select "Syncro MSP > Domotz" to sync fields from Syncro MSP to Domotz.
   - Select "Fields Custom Direction" for custom sync settings.

2. To exit without making changes, click "Cancel."

As soon as the user chooses an option for the synchronization, a message** In progress** will appear next to the **Customer name**:

Managing Syncro MSP Customer Sync Status

1. Locate the customer entry under "Syncro MSP Customers." The entry shows customer details, including the name and email address.
2. The status labeled "In progress" indicates that synchronization is currently underway.
3. On the right, there is a green toggle switch indicating that syncing is enabled for this customer. To disable syncing, toggle it off.
4. Below the customer information, there is a link labeled "4 Matched," showing the number of synced assets. Click to view more details about the matched assets.

- In case of success of the synchronization, the system will display **Last Sync** time:

Status of Synced Assets

1. View the asset status, which indicates that it has not been synced in the last three days.
2. To perform a manual sync, toggle the switch on the right to initiate synchronization.
3. Check the left side for the option to remove the asset by selecting the red X button.

- In case of an error during the synchronization, the system will display a message**Failed Sync**and the time of the last successful synchronization.

**Note:** In case of an error, please contact our Support team via email at [support@domotz.com](mailto:support@domotz.com)

##### **Automatic Synchronization**

Automatic synchronization occurs every 12 hours. To enable it, please toggle the **Sync** widget:

Syncro MSP Customers Sync Toggle

1. Locate the "Syncro MSP Customers" section.
2. Find the customer entry with the email address, partially visible, indicating its synchronization status as "In progress."
3. Identify the toggle switch under the "Sync" column.
4. The green toggle indicates synchronization is active. Click to disable if needed.

As soon as the sync toggle is enabled, the sync, will occur in the next 5 minutes.

**Note:** In case of an error during the automatic synchronization, the system will display a message **Failed Sync** next to the organization name and the automatic synchronization will be disabled.

**Note:** In case of an error, please contact our Support team via email at [support@domotz.com](mailto:support@domotz.com)

### f. Match Fields Asset

The automatic synchronization is only based on the direction specified for each field between Domotz and Syncro MSP.

The user can define the direction of the automatic synchronization from the **Match Fields** asset section.

- To define or change the synchronization direction of a field, click on the button under the **Direction** column, for example, **Domotz to Syncro MSP >>**.
- To disable the synchronization between the Domotz and **Syncro MSP** fields, click on the toggle on the right side of a desired field to switch it off.

However, some of the fields have their **mandatory synchronization direction** from Domotz to the integration: Current Status, MAC Address, IP Address (First IP), Hostname, which cannot be changed:

Matching Domotz Agents with Syncro Organizations

1. In the "Match Domotz & Syncro Fields" section, there are columns for Domotz Fields, Direction, and Syncro Fields.
2. For each field, choose the direction of syncing:
   - "Name," "Type," "Make," "Current Status," "MAC Address," "IP Address (First IP)," "Hostname," "Location," and "Notes" are set to sync from Domotz to Syncro.
   - "Model" and "Serial Number" are set to sync from Syncro to Domotz.
3. Toggle switches next to each field indicate whether syncing is enabled:
   - Enabled fields have switches toggled on.
   - Disabled fields have switches toggled off.

Adjust these settings as needed to manage the data synchronization between Domotz and Syncro.

**Important Note: **The match Domotz & Syncro asset displayed on this page, will be the one used for every automatic synchronization in terms of the selected synchronization direction.