Option 2.4. Set Project Change Management Properties

This topic describes the Change Management tab on the Project Properties dialog box.

Change Management Tab

The Change Management section of the Project Properties dialog box has the following options:

Enable Change Management

Select the Enable Change Management check box to enable Change Management for the active CIMPLICITY project.

Clear the check box to disable Change Management for the active CIMPLICITY project. This does not affect enabling Change Management for the computer project.

Note: When Change Management is enabled for a CIMPLICITY project, the project’s Configuration Security option on the Options section is automatically selected and made read-only. Change Management can be enabled for both a running and a stopped project.

Enter the Server Name

Enter the name of the Change Management server that the user will be using to authenticate/log in to Change Management.

Test the Connection

Select Test connection to confirm that the selected Change Management server is available and can connect to the project.

A Change Management Logon dialog box opens. Enter an authorized user name and password.

One of the following will occur depending on the project/Change Management Server status:
  • The connection is successful. A message opens and reports: The change management server connection test succeeded.
  • The connection fails. A message opens and reports: Unable to connect to change management server <Change Management server> with user <User Name>. Server unreachable or not found.

If the connection failed, check with the Change Management system administrator to correct the problem.

Requirement for logging into the Change Management server depends on the following.

Change Management Logon

Logon at Workbench startup/Prompt for user name and password. If Change Management is enabled for the CIMPLICITY project, configuration security is enabled.

Other factors that determine if and when a user needs to log in to PCM include whether the following values are set to Yes or No.

  • Allow Configuration Auto Logon in the Windows Authentication dialog box.
Note: If Allow Configuration Auto Logon is not selected, logging in options/requirements are the same as if the Windows Authentication login is invalid.
  • Prompt Username/password.
  • PCM Workbench Start.

If Allow Configuration Auto Logon is selected in the Windows Authentication window options and requirements for Change Management logon are as follows.

Windows Logon for CIMPLICITY Windows Logon for PCM
Valid Valid
THEN IF TYPE WHEN
CIMPLICITY Logon
Configuration Security Yes Auto Workbench Start
PCM Logon
Prompt Username/Password Yes / No Manual / Auto
PCM Workbench Start Yes / No Workbench Start / PCM Open
Windows Logon for CIMPLICITY Windows Logon for PCM
Valid Invalid
IF TYPE WHEN
CIMPLICITY Logon
Configuration Security Yes Auto Workbench Start
PCM Logon
Prompt Username/Password Yes / No Manual / Manual
PCM Workbench Start Yes / No Workbench Start / PCM Open
Windows Logon for CIMPLICITY Windows Logon for PCM
Invalid Valid
IF TYPE WHEN
CIMPLICITY Logon
Configuration Security Yes Manual Workbench Start
PCM Logon
CIMPLICITY Login is Valid PCM Login
Prompt Username/Password Yes / No Manual / Auto
PCM Workbench Start Yes / No Workbench Start / PCM Open
CIMPLICITY Login is Invalid PCM Login
Prompt Username/Password Yes / No Manual / Manual
PCM Workbench Start Yes / No Workbench Start / PCM Open
Windows Logon for CIMPLICITY Windows Logon for PCM
Invalid Invalid
IF TYPE WHEN
CIMPLICITY Logon
Configuration Security Yes Manual Workbench Start
PCM Logon
CIMPLICITY Login is Valid PCM Login
Prompt Username/Password Yes / No Manual /Auto
PCM Workbench Start Yes / No Workbench Start / PCM Open
CIMPLICITY Login is Invalid PCM Login
Prompt Username/Password Yes /No Manual / Manual
PCM Workbench Start Yes / No Workbench Start / PCM Open

Change Management Project Name

It is strongly recommended that the Name of the project in Change Management be the same as the CIMPLICITY project name.

The default name is the name of the local project.

When you first log in, if the project does not exist in Change Management, the project is created.

No files are added to the project except when specifically requested by you.

Require Checkout Before Changes

Do one of the following.

Option Description
Select

Requires that an entity be checked out of Change Management before it can be edited.

A message reminds you that:

You are required to check out the project before you can modify it.

Important: If a project is being managed, you must add the entity and check out the entity before making any changes.

Enabling this feature provides the highest level of integration with Change Management.

If the project is not checked out, you cannot perform a configuration update when trying to start the project.

Certain managed files, e.g. CimEdit screens (*.cim) and scripts (*.bcl), may be edited even when Require checkout before changes is checked and the files are not checked out. However, the edited file can only be saved using the File>Save as option either:

  • to an unmanaged folder.
  • with a different name than the managed entity in the managed folder.

(File>Save as the managed entity name to a managed folder is not allowed.)

The new saved as version will not be managed. The managed version will be the original version before it was edited.

Note: When a new file is created, it is not managed until it is added. The unmanaged file can be edited no matter where it it located until it is added.
Clear An entity does not have to be checked out of Change Management to be edited and saved.

Allow changes when the server is not available

Do one of the following.

Option Description
Select Allows changes when the Change Management server is not available.
Clear

Does not allow changes when the Change Management server is not available.

Important: If Require Checkout before changes is selected, configuration changes will not be possible if the Change Management Server is not available.
Important: If this feature is selected, make sure a Project Compare is performed when the Change Management server is available. The report will aid you to check modified entities into the Change Management server so they will not be lost.

Example

  1. Allow changes when the server is not available is selected.
  2. A CimEdit screen, TANK750, is not checked out.
  3. TANK750 is enhanced with new graphic and text objects reporting additional point values.
  4. The following is done so these changes will be preserved:
    • TANK750 is checked out. Don't overwrite local files with managed copy is checked.
    • TANK750 is checked in.

The TANK750 screen modifications are now preserved in the PCM server.

Preserve runtime configuration data on fetch (passwords and alarm setups)

The Preserve runtime configuration data on Fetch options dictate how the runtime data will be handled.

Alarm (filter setup) and passwords.

Option Result when the base configuration is fetched
Prompt
  1. A Save Configuration Data dialog box opens with check box entries for each of the configuration data that has changed. The dialog box opens before any of the following processes are completed: Fetch, Check out, and Get latest version. Note: Currently the configuration data includes passwords and alarm setups.
  2. Select the configuration data that you want to preserve. Passwords that were specified as valid after the checkout continue to be valid. If you are logged in with a new password, you can continue the configuration with no interruptions. New or modified alarm setups are preserved.
  3. Select one or more of the following.
OK
Cancel
Select All
Clear All
Yes

Passwords that were specified as valid after the checkout continue to be valid. If you are logged in with a new password, you can continue configuration with no interruptions.

New or modified alarm setups are preserved.

When the base configuration is checked into Change Management, the file will be checked in with the current valid passwords.
No

The file with the old passwords is fetched from Change Management and overwrites the file with the new passwords.

The new passwords are no longer valid.

You will have to re-enter the old password and, in instances where a new password is required, you will have to enter the new password in order to continue configuration.

When the base configuration is checked into Change Management, the file will be checked in with the passwords that were specified as valid after the checkout..
Select OK to continue. If the project has already been added to the Change Management server, a message opens and reports: Change Management project <project name> already exists on the Server <Change Management server>. Do you want to replace the project?

Select one of the following.

Button Description
Yes

Change Management maps your CIMPLICITY project to the existing Change Management project.

The local project is now managed.

Note: The project (version) that was replaced is still on the Change Management server and can be retrieved, if necessary.
No

The local project is

Not added to the Change Management server.

Not managed.

If the project is new on the Change Management server:

  • The Change Management server maps a place for the Change Management project.
  • The project is now managed.
Note: The project or entities in the project that should be managed still need to be added to the Change Management server.

Enable Enhanced Auditing

When the enhanced auditing check box is selected, CIMPLICITY will put entries in the Change Management audit log when a point is added, modified or deleted.

The audit entries include the:

  • Point.
  • Action.
  • User who performed the action.
Important: This feature will have a performance impact when bulk operations are performed on large numbers of points so it is best to enable it after the main provisioning stage of the project and more in the maintenance stage

A global parameter, PCM_ENH_AUDIT, is added when you select Enable Enhanced Auditing.

Perform a Workbench configuration update after you select/clear the check box