Work with the SyncConfigurator

Start the SyncConfigurator and log in, using your personal aqua user.

 

 

Enter your credentials and your server name or IP. Enter the port and decide whether to use HTTPs or not. If everything is correct, click 'Ok' or press Enter.

 

 

The SyncConfigurator will open. Here you see existing syncs with basic information. You can activate or deactivate syncs, edit them, delete them, create new syncs or show the sync errors of the sync.

 

To activate or deactivate existing syncs, you can either click on the switch symbol next to the name of the sync, or select a sync and click on 'Activate'.

 

 

To view the Sync Log, click on Sync Log. Here you can find all the logs about performed syncs of items as well as error messages about failed sync attempts and you have the possibility to fix them.

 

 

A new window opens with a list of sync errors. Per default the checkbox for Only failed items is checked. Thus, only errors will be shown. If you uncheck the box, an entry is displayed for each sync operation, including the successful syncs. To apply this you have to click on Refresh. You can change the value for 'Number of entries'. If you type '0', all sync errors will be listed.

 

 

To see the full exception message, click in the cell of it. You can now expand the message, and analyze, where the error comes from.

 

 

In this example, a user is missing. To fix this error, you can now add the Jira user with the mail and username. Afterwards you can select this error in the Sync Errors view and click on Fix Errors. Thus, the error will be fixed automatically and the item will be pushed again. Learn more about common sync errors in this topic.

 

In the Remote Key column, a link to the item in Jira is displayed, which can be used to open the item directly, if the it exists in Jira.

 

The Archive button allows you to archive selected error messages. With Show archived items the archived messages are displayed again and can be fixed with Fix Errors. To apply this you have to click on Refresh.

 

With Export you can export all messages from the view as an xlsx file.

 

You can edit an existing sync if something has changed. For example, if you have new field values, you can add them by editing the sync.

 

 

A window will open where you can change everything you did when creating the sync.

 

If you do not need your sync anymore, you can delete it.

 

 

Deleted syncs can not be restored. Please only delete a sync when you are sure you will not need it later on.

 

In aqua, the sync status is displayed in the path bar in the lower right corner of items that are synced with Jira. If you then click on the respective icon, you will be redirected to the history of the item where you can see the detailed error message.