11. Add

About this task

  • Add procedure.
  • Important.

Add Procedure

Adds the selected entity to Change Management.

Procedure

  1. Select a project folder, base configuration icon or managed file that is or belongs to the entity that will be added.
  2. Do one of the following.
    Entity Do one of the following. Adds
    • Computer project folder
    • Right-click; select Add on the Popup menu.
    • Click Computer>Manage>Add on the Workbench menu bar.
    		 Computer project
    • Proficy CIMPLICITY Project folder
    • Managed project file
    		 Right-click; select Add on the Popup menu. Selected entity.
    • Proficy CIMPLICITY Project folder
    • CIMPLICITY project base configuration entity
    • Managed project file
    		 Click Project>Manage>Add on the Workbench menu bar. The CIMPLICITY project.

    An Add or Add Files dialog box opens, based on the selected entity.

  3. Enter specifications as follows.
    • Project or base configuration
    • Managed files

    Project or Base Configuration

    Field Description
    Logon User (Read-only) Displays the Change Management user name.
    Name (Read0only) Selected entity name.
    Keep Local copy (Read-only) A copy of the entity being added is maintained on the local computer.
    Keep check out Checked

    Managed Files

    Field Description
    Logon User (Read-only) Displays the Change Management user name.
    Name (Read0only) Selected entity name.
    Keep Local copy (Read-only) A copy of the entity being adds is maintained on the local computer.
    Keep check out Checked
    Comment Description for a user to distinguish the entity version being checked in from other versions. Max Length.
  4. Click OK.

    The selected entity is added to Change Management.

    Results

    1. If an entity that can be labelled is added:

    An Apply Label dialog box opens.

  5. (Optional) Enter a Label to conform to your system standards.
  6. Click either:
    OK
    • Saves the label.
    • Closes the Apply Label dialog box.
    Cancel
    • Cancels applying a label.
    • Closes the Apply Label dialog box.
    1. The entity is added to the Change Management server.
    2. If Keep checked out was checked, Checkout icons display to the left of the added entities in the Workbench.
    Important:
    • An entity is not managed until it is added to Change Management; this includes the base configuration. If you create a managed file, e.g. a new CimEdit screen or a new alarm setup, remember to add it separately or in a full project add so it will be included in the managed set.
    • If two projects (which would be on different computers) have the same name, the first project's .gef file that is added to Change Management has precedence over the second.

    Example

    Two computers add the .gef file for projects with the same name to Change Management.

    Computer Project Name When the .gef file was Added
    Comp1 Project A July 9, 2008
    Comp2 Project A August 2, 2008

    Since Comp1 added Project A's .gef file first, Change Management gives Comp1's Project A .gef file precedence over Comp2's Project A .gef file..

    Use Case

  7.  A production version of a project is running on a production server.
  8. The project is checked out to a test project running on a test server.
  9. Once tested, the tested project is returned to Change Management where the production project can get the latest version at a break in production, e.g. the weekend.
  10. The .gef file is the file from the production version.