Revision Control

Revision Control

EPLAN Training

Revision Control

Completing Projects and Pages ..................................................................3

1.1

Complete pages........................................................................................3

Generating Revisions ...................................................................................5

Generating Comparison Projects ................................................................6

3.1

Show revisioned project / comparison projects .........................................6

Comparing Projects......................................................................................8

Specifying Comparison Settings...............................................................10

Adding Revision Markers ...........................................................................12

6.1

Add revision markers after a project comparison ....................................12

Displaying or Hiding Revision Markers ....................................................14

7.1

Display revision markers.........................................................................14

7.2

Hide revision markers .............................................................................14

7.3

Find revision modifications in properties .................................................15

Removing Revision Markers ......................................................................16

Removing Write Protection ........................................................................17

This functionality is only available for certain module packages. Info

EPLAN Training

Revision Control

Completing Projects and Pages

In EPLAN, projects can be completed at any time. The project is then write-protected
and can no longer be changed. A completed project is stored in the project directory
with the extension *.elr.
Precondition:
You have opened a project.
1. Select the menu item Utilities > Revision control > Complete project.
If you have not yet completed all of the pages of the project, a message will
be displayed.

2. Click [Yes] in the message window in order to use the comments on the
revision as the description for the page modification. (If you click [No], the
process will be canceled, and you can complete the pages manually).
First, all of the pages are completed. The project is then write-protected
(i.e. it is written as an *.elr project).

1.1

Complete pages

1. Select the project or the modified pages in the page overview, and select the
menu item Utilities > Revision control > Complete pages.

2. In the Description of the page modification dialog, you can enter the
revision data (index, description, and reason for change) for the modified
pages.

3. Click [OK].
The marker on the pages as "draft" is removed.

EPLAN Training

Revision Control
The revision data is saved to the modified pages.

This functionality is only available for certain module packages. Info

EPLAN Training

Revision Control

Generating Revisions

Precondition:
You have opened a project.
Utilities > Revision control > Generate revision
1. In the Generate revision dialog, enter a name for the revision in the Revision
name field.

2. In the Comment field you can enter a short description of the revision, but the
field may also be left blank.

3. Click [OK].
EPLAN generates the revision and is then saved with the extension *.ell.
If a page is then modified, it is marked as a "draft".

This functionality is only available for certain module packages. Info

EPLAN Training

Revision Control

Generating Comparison Projects

Precondition:
You have selected a project in the page navigator.
Utilities > Revision control > Generate comparison project
1. In the Generate comparison project dialog, enter a name for the comparison
project in the Project name field.

2. In the Comment field you can enter a short description of the comparison
project, but the field may also be left blank.

3. Select the check box Generate temporary comparison project if you would
like to generate a non-write-protected project that you can delete again later.

4. Click [OK].
EPLAN generates the comparison project with the file extension *.elr.

3.1

Show revisioned project / comparison projects

In order to show revised projects or comparison projects in the page navigator,

proceed as follows:
1. Select the menu item Project > Open.

2. In the Open project dialog in the Files of type field, select the entry "Revision
of EPLAN project (*.elr)".

EPLAN Training

Revision Control
3. Select the desired project (if necessary, switch to a different directory) and
click [Open].
The selected project is shown in the page navigator.

This functionality is only available for certain module packages. Info

EPLAN Training

Revision Control

Comparing Projects

Differences between two projects are registered by comparing particular properties

with one another. In the Compare projects dialog, you can determine which projects
will be compared. The properties to be compared are determined in the Comparison
settings dialog. If the value of the properties is identical for two projects, then no
difference is registered between them.
Preconditions:
The result of the comparison is written to a MS Access database. To be able to

interpret a comparison run, you therefore need to have the program MS

Access installed on your computer.
The database for the result of the project comparison is determined in the project

settings in the Settings: Revision dialog.

1. Select the desired project in the page navigator and select the menu item
Utilities > Revision control > Compare projects.

2. In the Compare projects dialog, select the check box Show only associated
comparison projects.
Then only the comparison projects of the marked project will be shown in
the list. Otherwise, the list will show all of the projects in the project directory
(except for the one marked).

3. In the list, select Compare with to select the comparison project you would
like to compare with the currently opened project.

4. In the Comparison settings field, select the scheme which determines the
settings for the comparison. (If you have not stored your own schemes, then
only the standard scheme will be offered here. In this case create a new
scheme by Specifying comparison settings.)

EPLAN Training

Revision Control
5. In the Text field, enter the text to be used to mark the revision changes in the
properties.

6. Click [OK].
The comparison run is executed and the result of the comparison is written
to the given database.
To make the modifications visible in the project, you must generate revison
markers.

Notes:
Such a comparison run can take a relatively long time for large projects; this also

depends on the number of properties you have selected for comparison. It can
therefore make sense to execute runs overnight or on a dedicated computer.
To evaluate the results of a comparison run, you will need an external database

program, such as MS Access.

This functionality is only available for certain module packages. Info

EPLAN Training

Revision Control

Specifying Comparison Settings

In the Comparison settings dialog, you have the option of determining in detail
which properties should be compared with one another. The settings are stored in a
scheme. You can create different schemes for different tasks, and retrieve settings
together whenever needed.
1. In the Compare projects dialog, click [...] beside the Comparison settings
field.

2. From the drop-down list in the Comparison settings dialog, select a user(New) to create a
defined scheme that you would like to change, or use
new scheme.

3. In the tabs in the lower part of the dialog, you can determine the properties of
the different objects which should be compared. These tabs are all structured
in the same way: In the Do not compare field, all of the properties are initially
selected that can be compared. The properties in the Compare field are those
which have been selected for comparison.

4. In the field Do not compare, select the desired properties, and move them
using the arrow button into the Compare field.

5. To undo the selection, if necessary, use the second arrow button to move the
property selected in the Compare field back into the Do not compare field.

6. Click [OK].
Your settings are saved in the scheme selected, and then you are returned
to the Compare projects dialog.

EPLAN Training

10

Revision Control
This functionality is only available for certain module packages. Info

EPLAN Training

11

Revision Control

Adding Revision Markers

Revision markers can be generated in two ways:

If you have created a revision and are still working in it, changes are

automatically marked ("change tracking").

If you have compared two projects, you must first generate the revision markers

in order to show the changes in the project.

Revision changes in the schematic are shown with graphical markers. Under the
project settings in the Settings: Revision dialog, define the appearance and size of
this graphic.
Changes in properties are shown with marker text entered into the "Revision marker
(change tracking)" or "Revision marker (project comparison)" properties. In addition,
the modified object is shown with a graphical marker.
In change tracking, this text is generated automatically, but it can be changed.
Formatting is determined in the project settings in the Settings: Revision dialog.
In a project comparison, you enter this text in the Compare projects dialog.

6.1

Add revision markers after a project comparison

Preconditions:
You have already executed a comparison run, so that changed information is

present in the database for the comparison result.

The project into which you would like to write the revision markers is open.

Utilities > Revision control > Add revision markers

1. In the Open dialog, select the database in which the results of the comparison
run are stored. By default, the database Revision.mdb is set in the
..\Projects directory.

2. Click [OK].
EPLAN writes the revision markers into the project.

EPLAN Training

12

Revision Control
This functionality is only available for certain module packages. Info

EPLAN Training

13

Revision Control

Displaying or Hiding Revision Markers

The revision markers can be displayed or hidden as needed. This is independent of

whether they were generated through change tracking or by project comparison.

7.1

Display revision markers

Precondition:
You have generated revision markers in the project.
1. Select the menu item View > Revision markers.
A check mark before the menu item signifies that the item is activated.
The revision markers are displayed in the project.

2. If necessary, update the display using the menu item View > Redraw.

7.2

Hide revision markers

Precondition:
The display of revision markers is activated.
1. Select the menu item View > Revision markers.
The revision markers will be hidden.

2. If necessary, update the display using the menu item View > Redraw.

EPLAN Training

14

Revision Control

7.3

Find revision modifications in properties

Modified objects (even the objects to where their hidden properties have been
changed) are shown on the page with a graphical marker.
If you move the mouse pointer over a changed object in a revision, then a tooltip is
displayed containing information about the revision.
To make it easier to find changes in the properties of objects, you can use the Find
function.
Find > Find
1. In the Find function in the Find what field, enter the text that you provided for
the idenfication of revision changes in the Compare revision dialog.

2. In the Search in group box, select the All properties of all components
check box.

3. In the Search location group box, determine whether the entire project or only
the current page should be searched, and then select the Logic pages check
box.

4. Click [OK].
The results of the search are displayed in the Search results dialog.

This functionality is only available for certain module packages. Info

EPLAN Training

15

Revision Control

Removing Revision Markers

You can remove revision markers created via change tracking or a project
comparison from the project separately.
Precondition:
You have opened a project containing revision markers.
Utilities > Revision control > Delete revision markers
1. In the Delete revision markers dialog, select which markers you would like to
delete: Check the corresponding check boxes.

2. Click [OK].
The selected revision markers will be deleted from the current revision.

This functionality is only available for certain module packages. Info

EPLAN Training

16

Revision Control

Removing Write Protection

Completed projects and comparison project are always write-protected. Only

temporary comparison projects are not write-protected. However, it is possible to
remove the write protection if necessary.
Precondition:
You have opened a write-protected project.
Utilities > Revision control > Remove write protection
EPLAN removes the write protection from the project.
Note:
You can reactivate the write protection by completing the project.

EPLAN Training

17

Revision Control

EPLAN Training

18