Start page
Start page

Start page / Advanced topics / External synchronization / Included objects

Area "Included objects"

Contents

All objects included for external synchronization are listed in this area. This view is always the view of the external directory and not that of the local project. This means, for example, that an element present in the external directory but not in the local project will be displayed in this view. The only exception to this are objects marked as “New” Icon for newly added objects (sync). These objects are only present in the local project and not in the external folder, but are nevertheless displayed under “Included objects”.

Area included objects

Explicitly and implicitly added objects

There is a distinction between explicitly and implicitly added objects. If an object is added explicitly, then all super-ordinated objects are implicitly added to the synchronization as well (see page Adding objects).

  • Explicitly added objects are shown in normal text; this indicates that they can be removed from the list again by using the Icon Remove icon.
  • Implicitly added objects are shown in text with less contrast and cannot be removed from the list.

Regardless, all objects in this view will be synchronized—including those that were implicitly added.

Information about included objects

The following information is displayed for the included objects:

  • Object type icon
  • Synchronization state: The state is indicated by an extra icon on the object type icon (for more information see table below)
  • Object name
  • Tooltip: hovering the mouse pointer over an included object will reveal a Tooltip with additional information:
    Information about the object in a tooltip
    • Element: name of the object
    • State: current state of the object
    • Action: action to be performed during the next synchronization process (for more information see table below)
    • Last change: point in time when the last change was made to the object

The following options are available only for explicitly and newly added objects (all objects with the synchronization state Icon for newly added objects (sync)):

  • Icon Remove Remove : Clicking this icon removes the selected, explicitly added object from the list along with all implicitly included child objects, after the user affirms a confirmation prompt. Higher level objects that are not used by other explicitly included objects are also removed. This function removes only objects from external synchronization and not from the project or external file system. To delete objects in the file system permanently, use the “Delete external element” context menu entry on the object (see below).
  • Required references There are unmet dependencies upon required objects: The red exclamation mark indicates that the respective object or a child object has missing required references. The objects are listed in detail in the Required missing references area.
  • There are unmet dependencies upon optional objects: The yellow exclamation mark indicates that the respective object or a child object has missing optional references. The objects are listed in detail in the Optional missing references area.
  • Object details: Clicking this icon opens a flyout menu with object-specific information (see page Detailed view for included objects). Durch nochmaliges Anklicken des Icons wird das Flyout-Menü wieder geschlossen.

Synchronization state

 

State

Description

 

unchanged

already exported object without local or external changes

Icon for newly added objects (sync)

New

object newly added locally and not previously exported

element not found

object newly added externally and not previously imported

Icon for changed objects (Sync)

local element changed

object already exported has been changed locally

path changed

object already exported has been moved locally

files changed

object already exported has been changed externally

external element changed/path changed

object already exported has been moved externally

external element changed/files changed

object already exported with external change from another FirstSpirit project

local element changed/files changed

object already exported with change made externally and locally (see page Resolving conflicts)

Icon for deleted objects (sync)

element not found, element was deleted

object already exported was deleted locally

   

Actions

A default action is linked with each synchronization state, which is carried out automatically during the next synchronization process as long as the editor does not change this preselection manually. The state and the action to be performed are displayed on the relevant object (see above) or via the flyout menu for the external synchronization.

The following actions are available:

  • Action: None
  • Action: Export (The next time synchronization is performed, this object will be exported to the external folder.)
  • Action: Import/Update (The next time synchronization is performed, this object will be imported from the external folder into the FirstSpirit project.)
  • Action: Delete (The next time synchronization is performed, the object will be deleted from the external folder.)

Default status/action combinations

State

Action

Description

Unchanged

None

If no external or internal changes have been made to an object already exported, the object remains in the list of included objects, but is not synchronized.

Icon for newly added objects (sync) New

Export

An object added for synchronization that has not yet been synchronized. This object will be exported to the external folder during the next synchronization process.

Icon for newly added objects (sync) Element not found

Import/Update

A new object from a different source (e.g. from a different FirstSpirit project) has been exported to the external folder. This external file will be reimported to the FirstSpirit project during the next synchronization process.

Icon for changed objects (Sync) Local element changed

Export

The included object has been changed locally in the FirstSpirit project since the last synchronization process. This change will be exported to the external folder during the next synchronization process.

Icon for changed objects (Sync) Local element changed, path changed

Export

The included object has been moved locally in the FirstSpirit project since the last synchronization process. These changes will be exported to the external folder during the next synchronization process.

Icon for changed objects (Sync) Files changed

Import/Update

The exported file has changed in the external folder. During the next synchronization process, the object from the external folder will be imported into the FirstSpirit project and the changed state will be applied in the project.

Icon for changed objects (Sync) External element changed/path changed

Import/Update

An object from another source (e.g. from a different FirstSpirit project) has been moved since synchronization. During the next synchronization process, the changes from the external folder will be imported into the FirstSpirit project and the changed state will be applied in the project.

Icon for changed objects (Sync) External element changed/files changed

Import/Update

An object was changed in a different source (e.g. in a different FirstSpirit project) and was exported to the external folder. The external change will be imported to the local FirstSpirit project during the next synchronization process and the changed state will be applied in the project.

Local element changed/files changed

None

Here a conflict is present, since both the exported object and the internal object have been changed in the project since the last synchronization. In this case, the user must decide which change to apply during the next synchronization process. A default action therefore does not take place (see page Resolving conflicts).

Icon for deleted objects (sync) Element not found, element deleted

None

The included and already exported object was deleted from the FirstSpirit project since the last synchronization took place. In this case, the user must decide which change to apply during the next synchronization process. A default action therefore does not take place (see page Resolving conflicts).

   

Choosing the action manually

Menu providing synchronization actions

An included object's context menu can be used to select the synchronization action that should take place the next time this object is synchronized. The context menu is available for all included objects that have already been synchronized externally (not for objects in the local project that have been newly added for external synchronization).

  • Do not synchronize element: This is the preselected default action in the case of a conflict. To prevent unintentional overwriting and deleting of objects, synchronization is prevented in the case of a conflict. The user must now decide which changes to apply in the case of a conflict (see page Resolving conflicts).
  • Export element: The next time synchronization is performed, the changed version will be exported from the project to the external directory. The changes in the external directory will be overwritten.
  • Import or update element: The next time synchronization is performed, the changed version will be imported from the external directory into the project. The internal changes in the project will be overwritten (for information about indirectly added child elements see also page Synchronizing objects, paragraph “Lost & Found”). If new objects have been added in the external directory, these objects will be imported to the local project and recreated there.
  • Delete external element: The next time synchronization is performed, the object will be deleted from the external directory and will thus also be removed from the list of included objects.

The default action can be restored by means of the icon.

Important Delete external element: Deleting external element: As long as no additional security function has been planned in the file system (e.g. connection to a version control management system), this action cannot be revoked. There is no way to undo this change using the “External synchronization” function or to restore deleted objects from the Recycle Bin.

© 2005 - 2015 e-Spirit AG | All rights reserved. | Last change: 2014-10-21