Basic Exalate Concepts

    Connection

    A connection between two instances specifies the synchronization behavior. Each connection includes information about two instances and describes how they are related to each other.

    Connection Statuses

    • Pending

      The connection is pending, waiting for acceptance from the other side.
    • Active

      A connection has been established and synchronization messages start to go out. You can now synchronize issues.
    • Deactivated

      Synchronization is paused, but changes are queued for a later update. Once you activate the connection, all changes will be applied.

    To know more about how Connections in Exalate work, refer to our Building a Connection guide. 

    Instance

    An Instance is a task management system that contains information that you want to synchronize. For example, Jira Cloud, Salesforce, Zendesk, etc are instances. 

    You can integrate with multiple instances using different connections. You can also synchronize between local projects within the same instance.

    Local synchronization is not supported in all task management systems.

    Whenever you set up a connection between two different task management systems, one of them will be a local instance, and the other one is a remote instance.

    For example, if you set up integration between Jira Cloud and Zendesk, you can initiate a connection from either side.

    If you choose to set up a connection on the Jira Cloud side, in this case, Jira Cloud will be your local or source instance, and Zendesk will be the remote or destination instance.

    Invitation Code

    To sync information between two task management systems, you need to set up a connection. While setting up this connection, Exalate generates an invitation code. It works as a shared secret that helps authenticate both source and destination instances. Invitation code stores encrypted connection information, such as:

    • Shared secret
    • A type of connection
    • Connection name
    • Connection initiator information
    • Exalate app version
    • Task management system and its version
    • Task management system URL
    • Exalate Node URL
    • Task management system UID - Unique instance identifier

    An invitation code is used to set up a connection with the destination instance if an initiator does not have access to both sides of the connection. The code will only apply to the instance you are inviting to synchronize.

    Invitation code is required only in Script mode configurations.

    Sync Rules

    Exalate uses synchronization rules to handle outgoing and incoming messages. We call them Sync Rules. You can find Sync Rules in a separate tab when you select the connection to edit.

    To learn more about how to create Sync Rules refer to configuring a Connection in Script Mode

    Incoming Sync Event

    The Incoming Sync Event is a registration of the changes in the remote entity. Every Outgoing Sync event on the sending side results in the Incoming sync event on the Destination side.

    Outgoing Sync Event

    The outgoing sync event is a registration of the changes in the local entity. When the outgoing sync processor sends out information, it gets registered as an Outgoing sync event.

    Replica

    A replica is a copy of the information that is getting transferred to the destination side. Exalate uses replica to extract specific data and then send it over. You can use the replica in the Outgoing rules to specify which data should be sent. On the destination side, the replica object is used to represent the remote issue. It will contain only the fields provided through the data filter on the source side.