ER/Studio Synchronization

From TeamServer ER/Studio
Jump to: navigation, search

Go Up to Admin

ERStudioSynchronization.png

My Settings > Admin > ER/Studio Synchronization (super users)

From this page you can configure and perform the synchronization between ER/Studio Team Server and ER/Studio Repository.

The ER/Studio Synchronization page provides:

From this page you can synchronize ER/Studio Team Server with ER/Studio Repository and configure which content you want to synchronize.

ER/Studio Synchronization Actions

The ER/Studio Synchronization page provides the following actions:

Item Description

Refresh

Reloads the ER/Studio Synchronization page to show the latest data regarding the current state of synchronization.

Execute Synchronization Process
(only when not synchronizing)

Starts a synchronization process. See Synchronizing with ER/Studio Repository.

Stop Synchronization Process
(only when synchronizing)

Aborts the running synchronization process.

Schedule Synchronization Process

Schedules a daily synchronization process. See the Schedules page.

Synchronize Selected
(only when not synchronizing)

Starts a synchronization process that affects only those resources that you check in the tree view. See Synchronizing with ER/Studio Repository.

Apply Changes
(only when not synchronizing)

Saves any changes that you make in the table, in the Action and Images columns.

ER/Studio Synchronization Status

Below the actions at the top of the ER/Studio Synchronization page, you can see the following items:

Item Description

Synchronization Status

Indicates whether there is a synchronization process currently running ("Not Running") or not ("Running").

Latest Logs

Opens a plain text file with a synchronization log, which includes detailed information about the latest or current synchronization process. If a synchronization process is in progress, then the log contains the live log entries from the current process.

This log contain only the pre- and post-diagram synchronization information, and minimal information about the synchronized diagrams.

ER/Studio Synchronization Table

The table in the ER/Studio Synchronization page displays the status of the most recent execution of the synchronization process. The table provides the following columns:

Item Description

Selection

In this column you can find a tree view of resources available in the ER/Studio Repository and not filtered out.

You can click the + and - buttons to expand and collapse resources. The checkboxes on the left-hand side of every resource are used to synchronize specific (checked) items.

Tip: When you check or uncheck a node in the tree, the action affects all its subnodes.

Action

Determines what to do with the ER object during a synchronization process. See Configuring Which Content to Synchronize.

You can choose one of:

  • Update. Changes in ER/Studio Repository are propagated to the ER/Studio Team Server Reporting Repository. The Reporting Repository is updated.
  • Ignore. Changes in ER/Studio Repository are not synchronized back to the ER/Studio Team Server Reporting Repository. The Reporting Repository is not updated.
  • Delete. The ER object is deleted from the ER/Studio Team Server Reporting Repository. This choice is not available for deleted resources.

When you change an action for a resource, an asterisk (*) appears below the Action combo box of that resource, and stays until you click Apply Changes to save your changes.

Tip: When you select an action for a node in the tree, the same action is selected in all its subnodes.

Images

If checked, resource images are synchronized along with the rest of the resource data. Images are excluded from the synchronization process otherwise.

After you change a checkbox in this column, you must click Apply Changes to save your changes.

Status

Describes the current synchronization status of each resource.

This column provides two items:

  • An icon indicating whether or not the ER object is currently fully synchronized with the ER/Studio Repository.
    • NotSynchronized.gif The ER object is not fully synchronized. Hover the icon to see which version of the resource is in the ER/Studio Team Server Reporting Repository, and which version is in the ER/Studio Repository.
    • UnlimitedFilters.gif The ER object is fully synchronized.
  • A label with the outcome of the last synchronization process that affected the ER object, or the current synchronization process if there is one running:
    • Not Synchronized. This is the initial status of new repository ER objects until the state changes to another status. An ER object can also have this status if it is queued for synchronization but the synchronization is stopped.
    • Queued. The ER object is scheduled to be synchronized during the current synchronization process.
    • Fully Synchronized. The version in ER/Studio Team Server is the same as the version in ER/Studio Repository, and the images are also synchronized.
    • Partially Synchronized. The version in ER/Studio Team Server is the same as the version in ER/Studio Repository, but the images are not synchronized.
    • Deleted. The ER object has been successfully deleted from the Reporting Repository database, but it is still in the ER/Studio Repository database.
    • Processing. The ER object is being synchronized.
    • Success. The ER object was successfully synchronized or ignored, as specified in the Action column.
    • Error. The synchronization of the ER object finished with an error.

In addition, on the right-hand side of the label there might be links to logs generated during the last synchronization process:

OverviewOfTheSynchronizationProcess.png
  • Macro Log. Log with details about the process of exporting the diagram from ER/Studio Repository into an XML file.
  • Diagram Log. Log with details about the process of importing the XML file with the diagram data into ER/Studio Team Server.
  • Error. This log is available only when the ER object synchronization fails. It contains the error messages indicating why the synchronization failed.

Status Date

The date and time of the last synchronization process that affected the ER object.

See Also