Skip to main content

Wizard Quick Start Guide

Follow these steps to create a simple synchronization process between two work systems.

Step 1: Select the First System Connector

The first step in creating a sync process is selecting the first system connector. SyncNow provides two options for connecting to systems:

  1. Using an Existing Connector
  2. Creating a New Connector
Wizard Step 1

Using an Existing Connector

If you already have a connector set up for the system, click on the "Use existing system" button. This will prompt you to select from a list of previously configured connectors. Once a connector is selected, proceed to the next step by confirming your choice.

Creating a New Connector

If you need to create a new connector for the system, follow these steps:

  1. Enter a Name for the connector to identify it.
  2. Select the system Type from the dropdown menu.
  3. Once you select a system type, a new window appears, prompting you to provide additional connection details.

Configuring a New Connector

The new window displays a form specific to the selected system type. For example, if you select Azure DevOps Server, the following fields may be required:

  • URL: The server address of your Azure DevOps instance.
  • Username: The username for authentication.
  • Password: The password for the user account.
  • Access Token: (Optional) A token for secure authentication.
  • API Version: Specify the version of the API to be used.

Advanced Properties:

  • Anonymous Webhook Notifications: Toggle this option as needed.
  • Allowed IPs and IP Ranges: Define specific IP ranges to restrict access to SyncNow with webhooks if required.

Connector-Specific Project and Filter Selection

After selecting or configuring a connector in Step 1 or Step 2, if the chosen connector supports projects (e.g., Jira or Azure DevOps), a project selection dialog will appear. In this dialog, users must select the specific project within the system to be synchronized.

Additionally, the user can define field filters to narrow down the entities included in the sync process. The filter configuration includes specifying the field name, choosing an operand (e.g., equals, greater than, contains), and defining the filter value. These filters ensure that only relevant data from the selected project is synchronized, providing fine-grained control over the synchronization process.

Provide all the required details and click Save to configure the connector. Once saved, the system will validate the connection and allow you to proceed to the next step.

Notes

  • Ensure the system connection is valid before proceeding to select a project.
  • If the connection fails, double-check the provided details for accuracy.

Once the first system connector is set up or selected, the wizard will guide you to the next step: configuring the second system connector.

Step 2: Select the Second System Connector

The second step in creating a sync process is selecting the second system connector, which will be used to synchronize data with the first system. The workflow for this step mirrors the first step: you can either choose an existing connector or create a new connector.

If you opt to create a new connector, the required fields and configuration workflow are identical to those for the first system connector. Once the second connector is selected or configured, the wizard will validate the connection and guide you to the next step: mapping entities between the two systems.

Step 3: Sync Process Mapping

The third stage focuses on creating the Sync Process Mapping, where users map entities and fields between the selected systems. Users can choose from the following options:

Wizard Step 3
  1. Pre-defined Templates: Select from a library of pre-configured mapping templates for common use cases, simplifying the setup process.
  2. Custom Mapping: Create a tailored mapping by manually selecting and pairing each entity from one system to another. Users can then choose specific fields for mapping and define the entity link type mapping, allowing them to establish relationships between entities in the two systems.
  3. Import Pre-defined Mapping File: Upload an existing mapping file containing pre-configured mappings to quickly set up the synchronization.

Once the user clicks the Save button, they will be redirected to either the Sync Process page, where more advanced mapping options are available, or the Sync Process Status page, which displays the current status and progress of the synchronization.

Wizard Finish