10. Show Master Label History

About this task

A Change Management Master Label project version enables:

  • Users to select any version of a project and/or computer (system) as its Master label.
  • The Change Management Scheduler to compare the current local version against the Master version.
Note:
  • Only one version at a time can be selected as the Master for the project and one version for the computer.
  • Before this enhancement the Change Management Scheduler could only compare (and optionally backup) the current version of a local project/computer against the last checked in project/computer version.
  • Local computer: New Master Label features.
  • Change Management Server: Required Master Label configuration.

Local Computer: New Master Label Features

The following new and enhanced Change Management features enable you to select and work with the Master Label.

  • Project/Computer New and Enhanced Manage Menu Items
  • Show History: Enhanced PCM History Window
  • Show Master Label History: New PCM (Master Label) History Window

Project/Computer New and Enhanced Manage Menu Items

Do the following to display either the Project or the Computer Manage menus.

Procedure

  1. Select the Project or Computer folder in the Workbench left-pane.
  2. Do one of the following.
    • Right-click the selection; select Manage on the Popup menu.
    • Click Project or Computer (corresponding to your selection) on the Workbench Menu bar; select Manage.

    Result: Items on the extended menus provide access to the following.

    9. Show History

    Show History: Enhanced PCM History Window

    The Show History window for the project or computer provides the following new and enhanced features.

    1 Label Master button A Label Master button has been added; when it is clicked the selected row is:
    • Identified as the Master version.
    • Used by the Change Management Scheduler  when it does comparisons.
    2 Selected Row/Detailed Label Column
    • One row only must be selected in order to enable the Label Master button.
    Note: If more than one row is highlighted, click the rows that should not be highlighted to deselect them
    • A new Detailed Label column displays the following.
    3 Master Version The Master Version row is identified as Master in the Version column.

    Show Master Label History: New PCM (Master Label) History Window

    Master Label versions are tracked as follows.

    • _config.ini file.
    • PCM (Master Label) History window columns.
    • Master version details and differences.

    _Config.ini File

    Change Management internally updates a _config.ini file as it keeps track of which project/computer version is currently selected as the Master version. Each time a different version is selected, the _config.ini file is updated.

    The Master Label identification for the Master version in the _config.ini is the same as the value that displays in the project/computer PCM History window's Detailed Label column.

    A Master Label string
    B Version label entered manually or by default.
    CAUTION: This file is updated internally. Do not change it manually.

    PCM (Master Label) History Window Columns

    The PCM (Master Label) History window displays the history of the Master Label config.ini file updates.

    Columns in the PCM (Master Label) History window provide details about the _config.ini file, as follows.

    Column Identifies
    1 Version Each time the _config.ini file was updated.
    2 Path _config.ini.
    3 User Person who selected the project/computer version to be the Master for that instance.
    4 Date/Time When the _config.ini file was updated.
    5 Action The action performed on the _config.ini file.

    Master Version Details and Differences

    Master version details and differences can be reviewed through the PCM (Master Label) History window.

    Select two _config.ini file versions; click Difference.

    Result: An HTML page opens that displays the details and differences between the two versions.

    The Master Label identification for the Master version is the same as the value that displays in the project/computer PCM History window's Detailed Label column.

    A Master Label string.
    B Version label entered manually or by default.

    Change Management Server: Required Master Label Configuration

    Change Management Server script updates are included in CIMPLICITY v8.1-000004. These updates need to be copied and pasted on the Change Management Server; once copied some minor configuration is required.

    The procedures to copy/paste the updates and required configuration are as follows.

    • Change Management Server Script File Updates
    • Change Management Scheduled Event
    • Permissions to select the Master Label

    Change Management Server Script File Updates

    Scripts on the Change Management server must be updated in order for the server to recognize the new Master Label feature.

    The updated scripts are included in the SIM and will be placed in the ..Proficy\CIMPLICITY\Extras folder.

    Do the following to update the scripts on the Change Management server.

  3. Log on to the desired Change Management server.
  4. Open Machine Edition.
  5. Right-click the Custom Project Settings>Scheduler Scripts folder.
  6. Select Check Out on the Popup menu.
  7. Right-click Scheduler Scripts again.
  8. Select Explore on the Popup menu.

    A Windows Explorer window opens with the Scheduler Scripts folder selected.

  9. Paste the updated script files in this location.

    The files are:

    • In the ..\Proficy CIMPLICITY\Extras folder on the computer where you just installed CIMPLICITY v8.1-000004.
    • Named:
    • APICompare_functions.vb
    • Cimplicity_Compare_Master.vb
    • Cimplicity_Compare_MasterLabel.vb
    • scriptdef.ini

    A message will ask if you want to overwrite the existing files.

  10. Click Yes.
  11. Right-click Scheduler Scripts again.
  12. Select Check In on the Popup menu.

    Change Management Scheduled Event

    Master Label configuration includes creating one or more scheduled event that

  13. Right-click Select Scheduler Event List in the Machine Edition window.
  14. Select Check Out Scheduler Settings on the Popup menu.
  15. Right-click Select Scheduler Event List again.
  16. Select Add Event on the Popup menu.

    A new event is added to the Scheduler Event List tree.

  17. Name the event, e.g. CIMPChnge.
  18. Select the event.
  19. Configure the following in the Inspector.
    A Event Type Select CIMPLICITY Compare with MasterLabel.
    B Project List Click the button on the Project List line; Result: A Project List for <event name> dialog box opens. Associate a project with the event, as follows.
  20. Right-click Select Scheduler Event List again.
  21. Select Check In Scheduler Settings on the Popup menu.
  22. Select ..>Machine Edition>Scheduler Engine on the Windows Start menu.

    A Scheduler icon displays on the Windows Task bar, indicating that the Scheduler has been started.

  23. Right-click the Scheduler icon.
  24. Select Maximize Scheduler on the Popup menu.

    The Change Management Scheduler dialog box opens.

  25. Do the following.
    A Right-click the event that should be started.
    B Select Run on the Popup menu.

Results

The Scheduler will now run the script to compare the Master Label project with the current project version.

Note: If the Master Label is not set through the Project List for <event name> dialog box, the script will fall back to comparing the latest version on the Change Management server with the current version.

Permissions to select the Master Label

CIMPLICITY Change Management users can select project versions as the Master version only if the feature is set to True on the Change Management Server.

Do the following.

A Select Access Control>Groups>CIMOPRGRP>Permissions>Change Management in the Machine Edition Navigator.
B Select True for Set Master Version in the Inspector.