Trace of history

Connected Dreams / Origin records all changes to document content and always keeps the original content, so it is always possible to go back to old versions (using the Trace History as explained in Viewing a trace of the history of a document). No explicit actions have to be performed to make snapshots, because 'snapshots are continuously made'.

Even when a user deletes content, the underlying data remains present in the database. To undelete a document, proceed as explained in Undelete document or module.

Releases can be made of both Documents (explained in Releasing documents ) and Modules (explained in Releasing modules).

Viewing a trace of the history of a document

View the history of an entire document

To view a trace of the history of the entire document:

1. In the Directory Browser, Mouse Clickon the document for which you want to view the history
2. Context Menu → Trace History → Document Text History

This will show a data grid as shown in this Figure.

As you can see from this example we have for each edit:

1. The content at that moment (in the column named Content).
2. The edit time (in the column named Edit Time).
3. The name of the user that made the change (in the column with icon ).
4. Whether to text was part of a comment (in the column with icon )
5. The releases in which the content landed (in the column named Release).

To filter the data set in the grid, clickMouse Click on the header of the data that you want to filter on (such as 'Content' or 'Edit Time'). For each filter a 'chip' will be added in the bar above the data grid. These can be removed by clicking on their crosses (or by using the Clear all filtersmenu that is hidden under the near the top right hand corner of the data grid).

To view the entire document as it was at a specific time clickMouse Click on one of the following (all have the same effect):

1. The content line
2. The version
3. The edit time

This will bring you to the version with the given timestamp. An example is shown in this Figure. Note how the timestamp is shown in the blue release selector at the top of the document.

View the history at the cursor position

To view a trace of the history of content at the cursor position:

1. In the Document Browser, place the caret in the text ('in the sentence or word') for which you want to see the text history (using the cursor keys or a Mouse Click).
2. Context Menu → Trace History → Document Text History

This will show a data grid with filtering applied as shown in this Figure

The filtering that is applied limits the content shown to 'Cursor position when navigating to history'. If you remove this filter either by using Mouse Click on the close cross () in the chip ( ) or by clearing all filters, you will end up with the document text history of the entire document as in View the history of an entire document).

Undelete document or module

Even when a user deletes content, the underlying data remains present in the database.

To undelete a document or module, proceed as follows:

1. Make the deleted items visible in the Directory Browser using: Toolbar menu → View → Show Deleted Items → [object Object]. For Recency pick one of Last hour, Last 24 hours, Date range...
2. [ If you clicked Date range you need to further select details of the starting date. ]
3. The deleted items will appear in the Directory Browser colored orange as shown in this Figure.
4. Select the document or module which you want to undelete using a Mouse Click
5. Finally, use the context menu to perform the undelete: Context Menu → Undelete

After the Undelete operation, the element will reappear with a normal text coloring (no longer orange).

BEWARE: If there was a conflict on a unique key (such as apnBase which has been re-used by another document), then an error message will be given and the document will not be undeleted. The user must then first resolve the conflict and then attempt again.

Typically you want to hide the deleted elements again after the undelete operation:

1. Toolbar menu → View → Show Deleted Items → None

Releasing documents

To release a document proceed as follows:

1. Open the document as usual from the Directory Browser using a Mouse Double Click
2. Toolbar menu → File → Release → [object Object]Where Release Type is one of Major,Minor,Patch.

To open a released document:

1. Open the document as usual from the Directory Browser using a Mouse Double ClickThis will open the latest version (referred to as HEAD)
2. Select the
3. Click on the release selector button ( ) to make the release drop down visible as shown in this Figure.
4. Hover the mouse over the release you want to view and perform a Mouse Click

Releasing modules

Creating a release of a module is a three phase process, in which we:

1. Create a release candidate for a module.
2. Select releases for the content of the module.
3. Finalize Module Release (Freeze).

Create a release candidate for a module

To create a release candidate for a module:

1. Select the module which you want to release in the Directory Browser using a Mouse Click
2. Context Menu → Create Release Candidate An open box ( ) with the text 'Fill in release number... will be shown as in this Figure
3. Now give the release a name as follows (this step can skipped for now, but must be done before finalizing the release):
1. Mouse Click on the text 'Fill in release number' (this can also been later, but must be done before finalizing the release)
2. Enter a number with two decimals such as e.g., 1.0.0

After creating a release candidate, you need to select which releases you want to use of the underlying content (the children of the module).

Select releases for the content of the module

To select the releases for the children of the module:

1. Open the 'open box' ( ) using a Mouse Click on it. The content of the module, will be shown with a release selector for every Document or sub Module as shown in this Figure.
2. Select a release for Document or sub Module using the release selector drop downs. For every Document or sub Module a release must be selected before you can proceed to Finalize Module Release (Freeze). In other words: as long as anything is still HEAD, no release of the module can be made. If a Document does not yet have a release, you must first create a release for it as described in Releasing documents. If a sub module does not yet have a release, you must first create a release for that module using the steps described in the subsection you are releasing (Select releases for the content of the module). Note that you do not have to do this immediately. You can interrupt the task and do other things (even close the Connected Dreams / Origin browser session altogether) and continue later.

After a release as been selected for each Document or sub Module, all content lines will be blue as shown in this Figure.

Finalize Module Release (Freeze)

Once a release has been selected for each Document or sub Module as shown in this Figure, you can proceed to finalize the module release (freeze) as follows:

1. Select the release candidate (by performing a Mouse Clickon the release number after the open box ( ).
2. Context Menu → Finalize Module Release (Freeze) After finalizing the module release, the box will be closed ( ) as shown in this Figure