This guide is intended to provide a brief overview of the core client-side configuration and usage of Sync.

Overview Sync is designed to link services with specific entities, or "nodes," from your data source. 

The node tree will differ depending on the type of source the nodes originated from. 

For example, if the source were a Broadworks switch, the node tree would include nodes like Broadworks Enterprises, Broadworks Users, and Broadworks Hunt Groups. These nodes would be structured in a Broadworks-specific way, such as by having Groups display as children of Enterprises.


Using the Sync dictionary, you can define which source node types and fields correspond to which service types and fields. To view the dictionary, go to Activity > Provisioning > Sync and click on the Dictionary tab.

Mapping types

Once has set up your source, you can map your source node types to your service types.

  1. Select your source type from the Provider drop-down list.

    Provider list, showing "Broadworks," "Metaswitch," and "NetSapiens".
  2. Select a source Node Type and a corresponding Service Type, then click Add.

You can map the same node type to multiple service types, and vice versa.

Mapping fields

Once you've set up a type mapping, you can map individual fields between the types.

  1. Find the type mapping for the types whose fields you would like to map.
  2. Select a node type field (under the Source Field heading) and a corresponding service type field (under Field) and click Add Field Mapping.

    A type mapping, with the field drop-down lists highlighted.
  3. Continue mapping all fields you are interested in. You can only map each field once.

If you're missing a field, you may not have added that field to the service type in question. You can do this by going to Settings > Custom Fields > Service Types, clicking Edit on the appropriate service type, and adding the necessary field(s). 

If you add a service type field, it will be added to any existing services of that type.

Source view

From the Sync dashboard, under the Sources tab, click the name of a source to view its nodes.

Linking nodes to services

Once you have setup your dictionary field mappings, you can begin to link source nodes to services. 

You can link source nodes to existing services, or you can create new customers and services directly within Sync.

Linking to an existing service 

  1. Find a node to link. There are a few ways to do this:
    • Search with the search bar in the top left of the screen.
    • Drill down into individual nodes until you find a node to link.
      The node tree, with some nodes expanded to show child nodes.
  2. Click on the name of the node to view it. You see either:
    • A recommended service to link to.
      Detail screen of an unlinked node, showing a recommended service to link to.
    • "No match found," meaning no recommended service is available.Detail screen of an unlinked node, without a recommended service to link to.
  3. If the recommended service looks correct, link to it by clicking Use Recommendation.Alternatively, link to a different service:
    1. Click Link to Existing Service.
      An unlinked node's detail screen, with the Link to Existing Service button highlighted.
    2. Search for the appropriate service, select it, and click Save.
      Searching for a service.
  4. Once the node is linked, its entry in the node tree shows a green check mark. The Details section of the page shows information about the linked service.
    Detail screen of a linked node, showing a populated Details section.

Linking to a new service

If a node doesn't have a corresponding service that already exists in, you can create a new service within Sync.

Existing customer

If you know the right customer already exists, you can create a new service for that customer.

NOTE: The package selected will be at the standard pricing defined in the package setup. If you would like to adjust the pricing for individual product within the package, you will need to navigate to the customer profile after creating the new service and adjust the pricing there

  1. In the detail pane of an unlinked node, click Create New Service.
    The Create New Service button.
  2. Search for the appropriate Customer, select a Package if applicable, a Service Type and Provider, and choose an Effective Date for the new service.
    Creating a new service.
  3. Click Save.

New customer

If no appropriate customer exists in, you can create a new customer through the Requests system.

  1. In the detail pane of an unlinked node, click Create Customer.
  2. You are redirected to the Create a Customer workflow to create a request. See: Create New (Creating a New Customer)

  3. Once you have created and completed the request, return to Sync and view the unlinked node.
  4. Click Create New Service or Link to Existing Service to link to a service of your new customer.

Syncing fields

Once a node is linked to a service, you can sync the service's fields with the node's fields. This copies the values from the node's fields into the service.

  1. In the detail pane of a linked node, find the Fields section.
  2. Click Sync Fields. All fields that are successfully synced now show a green check mark on the left.

Some fields may not sync depending on restrictions of the fields.

Unlinking a node

Once you have linked a node to a service, you can unlink them.

  1. In the detail view of a linked node, click Unlink Service.
    The Change Service button.
  2. When asked to confirm whether to change the service, click Yes.
    Confirming you want to unlink the service.
  3. Now that the node is unlinked, its icon in the node tree is a gray checkmark.