The Tasktop Sync Web UI

Web UI Configuration

The Tasktop Sync Web UI provides access to remote monitoring facilities for a Tasktop Sync installation. To enable the monitoring web UI you must configure the web username and password in the Tasktop Sync dashboard.

  1. Start Tasktop Sync.
  2. Click on the pull-down menu to the right of the globe icon in the toolbar and select Configure....
  3. Enter the username and password to the dialog that pops up.

Web UI set password

Web UI password settings

For full details on configuring the Tasktop Sync Web UI see the section on Web Container Configuration.

Once configured, see the next section for instructions on accessing the Web UI.

Accessing the Web UI

Tasktop Sync includes a remote monitoring interface that is accessible from any standard web browser. To access this UI you must be on a machine that can connect to the web services port and you must know the username and password. The Web Container Configuration section describes how to set the port and configure the username and password. The default port is 8080. You will also need to know the hostname or IP address of the machine running Sync. For the purposes of this example, we’ll assume that the hostname of the machine running Sync is “sync.example.com” and the port is 8080.

To access the monitoring interface, enter the hostname, port and “/sync” into your web browser (i.e. http://sync.example.com:8080/sync).
This will load the login page.

Web UI login page

Enter the username and password and click Login. This will load the Sync Dashboard page.

Web UI dashboard

The header of each page in the web UI contains links to five sections of the website:

Reviewing Synchronizations in the Web UI

All synchronizations, including those in error, are visible and manageable from the Tasktop Sync web UI under the “Syncs” tab. The list of synchronizations can be filtered to those of a specific status by clicking on the desired status on the left hand side of the page. For example clicking “Error” will cause only synchronizations in error to be shown. Additional filtering by mapping, or text search, can be performed on the left hand side of the page.

Web UI Error Queue

When synchronizations are selected by clicking the checkboxes in the rightmost column of the list of synchronizations, a menu can be opened by clicking on the gear in the top right corner of the screen. This menu contains actions that can be taken with the selected synchronizations. The three possible actions are “Retry”, “Clear Errors”, and “Clear Errors and Ignore Changes”.

Web UI Error Menu

Clicking “Retry” will queue the selected synchronizations to be processed by Tasktop Sync. Clicking “Clear Errors” will remove the selected synchronizations in error from the error queue and not mark them for processing. When an error is cleared the tasks will not be synchronized, and if the cause of the error is not addressed then it may occur again the next time one of the synchronized tasks is processed. For more details on Tasktop Sync errors see the documentation for Error State. Clicking “Clear Errors and Ignore Changes” will perform the same action as well as ignoring new changes for the selected synchronizations.

The “Clear Errors” and “Clear Errors and Ignore Changes” options are only available when synchronizations in error are selected. If the selected synchronizations include at least one synchronization not in error, only the “Retry” option will be available.

The details of a synchronization can be viewed by clicking on the information icon in the leftmost column of the list of synchronizations. This will open a page with details on the synchronization including the last time the synchronization was processed, what mapping was used in processing the synchronization, links to the tasks being synchronized, as well as all logs for the synchronization.

Web UI Synchronization Error

When viewing a specific synchronization it may be retried by clicking the gear icon in the top right corner of the screen, and clicking “Retry”. Similarly if the synchronization being viewed is in error there will be the “Clear Error” and “Clear Error and Ignore Changes” options in the menu. Clicking “Clear Error” will remove the synchronization in error from Tasktop Sync’s error queue. Clicking “Clear Error and Ignore Changes” will perform the same action as well as ignoring new changes for the selected synchronization.

Usage Metrics

Visibility into the synchronization usage occurring in your organization’s integrations is key to being able to manage those integrations well. Understanding things like high-volume time periods, repositories that have the most artifacts being synced, and integrations that produce the highest load of synchronizations allows you to properly plan and manage your entire integrations landscape. To allow you to better understand this information, Tasktop Sync provides macro views and statistics that are dynamic and interactive through the web UI’s Metrics tab. Here you will find an overview of the number of created and updated synchronizations for the current user-specified period, as well as a comparison of these statistics to those from the previous period. The length, start date, and end date of the period can all be modified in the panel on the left. For example, in the picture below we have chosen the period to start on October 27, 2013, and have a length of one month (31 days).

Metrics Bar Chart

By default, the Metrics page will display the information as a bar chart describing the number of synchronizations (either total or created) that occurred per day for the selected period. By clicking on the “Grouped” tab, you can display this information as a bubble chart of synchronizations grouped per time period. For example, the graph in the picture below plots the current period’s synchronizations by time of day for each day of the week.

Metrics Bubble Chart