Breadcrumbs

Synchronization Message Flow

Backbone sends different messages internally to synchronize issues and control some additional functionality. The messages described in this article relate to synchronizations created over email or file exchange mainly, only the synchronization messages are also valid for the other configuration types (server/data center, to cloud, local).

Messages at the creation of a synchronization

During the setup of a synchronization using the email or file exchange method, Backbone will exchange the following messages to establish a secure connection between both projects.


Action

Master Status

Slave Status

1

A user creates a master configuration - and downloads a handshake file. This handshake file contains the information how to connect to this configuration as well as the public encryption key for it.

handshake


2

A user creates the corresponding slave configuration with the handshake file.

handshake

handshake

3

The Backbone slave sends back a Handshake message via the configured communication channel (file/email) which contains the analogue information to the handshake from the master.

handshake

handshake

4

The Backbone master receives the Handshake message and initiates a connection test by sending a Ping message to the slave.

handshake

handshake

5

The Backbone slave receives the Ping message and replies with a Ping message itself.

handshake

stopped

6

The Backbone master receives the Ping message. The synchronization has finished its connection test and is ready to be configured.

stopped

stopped

Messages at configuration updates

In order to keep the configuration using email or file exchange in sync, Backbone uses these messages:


Action

Master Status

Slave Status

1

Backbone has been configured previously and is running.

running

running

2

A user updates the Backbone configuration at the master side.

waiting for slave

running

3

The Backbone master sends a Configuration message to the slave.

waiting for slave

update required

4

A user updates the the Backbone configuration at the slave side.

waiting for slave

running

5

The Backbone slave sends a Configuration Updated message to the master.

running

running

The table above is also valid for a stopped synchronization. All status which show running would be stopped instead.

Messages at issue synchronizations

Please note that the status in this table relates to the synchronization status of the single issue as you can see it in the issue panel.





1

An issue has been synchronized with Backbone earlier.

up to date

up to date

2

A user updates an issue (on the master side) which is synchronized with Backbone.

up to date

up to date

3

The Backbone master sends an Issue message to the slave.

pending

up to date

4

The Backbone slave processes the message and responds with a Confirmation message. Depending if the synchronization was successful or not, the slave issue synchronization status will be updated.

pending

up to date / error

5

The Backbone master receives the Confirmation message and displays its content in the sync info panel. Depending if the synchronization was successful or not, the master issue synchronization status will be updated.

up to date / error

up to date / error