Deployment

Deploy Compliance Management

The checklists in this section of the documentation contain all the steps necessary for deploying and configuring this module whether you are deploying the module for the first time or upgrading from a previous version.
Important: You must have an active license in Compliance Management, Inspection Management, and Policy Designer to use this module.

Deploy Compliance Management for the First Time

Before You Begin

The following table outlines the steps that you must complete to deploy and configure this module for the first time. These instructions assume that you have completed the steps for deploying the basic system architecture.

These tasks may be completed by multiple people in your organization. GE Digital recommends, however, that the tasks be completed in the order in which they are listed.

If you are deploying this module in APM Now, before you begin completing these tasks, review the system requirements for this module to identify the supported features for this module in APM Now. Unless noted, all deployment tasks in the following table are applicable for the deployment of this module in APM Now.

Results

StepTaskNotes
1Review the Compliance Management data model to determine which relationship definitions you will need to modify to include your custom equipment and location families. Via Configuration Manager, modify the relationship definitions as needed. This step is required only if you store equipment and location information in families other than the baseline Equipment and Functional Location families.
2Assign users to the MI Inspection Security Group to provide privileges to the Compliance Management families.This step is required.
3

Assign Security Users to one or more of the Security Roles used in Compliance Management.

This step is required.

Security Users will need permissions to the Compliance Management families before they can use the Compliance Management features.

4Create Inspection Strategy records using Record Manager. This step is required. You should create Compliance Strategy records that adhere to the compliance standards of a regulatory body that requires inspections.
5Design a policy to use for a Compliance Strategy Template.This step is required. You can create this policy using the Policy Designer.
6Create a query that will return the assets that you want to link to the Compliance Strategy Template.This step is optional. You can also add assets to the Compliance Strategy Template by individual asset.
7Create a Compliance Strategy Template using the administrative features of Compliance Management. This step is required.
8Link assets to the Compliance Strategy Template.This step is required.
9Map the Policy to the Compliance Strategy Template that you created.This step is required.

Upgrade or Update Compliance Management to V4.3.1.0.0

Before You Begin

The following tables outline the steps that you must complete to upgrade this module to V4.3.1.0.0. These instructions assume that you have completed the steps for upgrading the basic GE Digital APM system architecture.

These tasks may be completed by multiple people in your organization. We recommend, however, that the tasks be completed in the order in which they are listed.

After you upgrade to the latest version of GE Digital APM, following updates are automatically available:

  • The MI Compliance Approver security role caption will be updated to MI Inspection Plan Approver.
  • All security users who belong to the MI RBI Analyst security group will belong to the MI Inspection Plan Approver security role.
  • The MI Inspection Plan Approver security role will have the MI ASM Analyst security group assigned.
  • Compliance Recommendation Revision family will be renamed to Recommendation Revision. The datasheet for this family will be renamed to Recommendation Revision.
  • The query Compliance Recommendation by Plan for Compliance will be renamed to Recommendation by Plan.
  • The relationship family caption Has Compliance Recommendation will be updated to Inspection Plan Has Recommendation.

Procedure

Upgrade from any version V4.3.0.0.0 through V4.3.0.7.7
StepTaskNotes
1Execute the Revert to Baseline utility to update State Machine for Compliance Recommendation.

Following new states and operations have been added:

State IDCaption
MI_ACCEPTEDApproved
Operation IDCaptionPredecessorSuccessor
MI_PROMOTEApproveProposedApproved
MI_IMPLEMENTImplementApprovedImplemented
MI_UNIMPLEMENTUnimplementImplementedApproved
This step is required only if:
  • You have previously used Compliance Management and have created Compliance Recommendation records, or
  • You have previously modified the state management for the Compliance Recommendation family.
2Execute the database script to update the state for all Compliance Recommendations related to an Inspection Plan to the Approved state.

To complete this step, follow the instructions in Article 000034385: Compliance Management - How to Configure State Management After Upgrade .

3To facilitate workflows in Compliance Management in the latest version of GE Digital APM, several queries have been modified. If you have made any modifications to these queries, you may need to review the respective query in the Baseline folder to determine if any change to the Public query is required.

Alternatively, you may also execute the Revert to Baseline utility to acquire the changes to queries in the latest version of GE Digital APM.

This step is required if you have modified any of the following queries:
  • Public\Meridium\Modules\Inspection\Compliance\Queries
    • Compliance Recommendations by Plan
    • Compliance Recommendations to Supersede
    • Compliance Superseded Recommendation Counts
    • Compliance Superseded Recommendations
    • Assets with Inspection Plans
    • Compliance Recommendation Revisions for Inspection Plan
    • Inspection Tasks Available to Implement
  • Public\Meridium\Modules\Asset Strategy\Queries
    • Inspection Task Link Existing Query

Compliance Management Security Groups and Roles

The following table lists the baseline Security Groups available for users within this module, as well as the baseline Roles to which those Security Groups are assigned.

Important: Assigning a Security User to a Role grants that user the privileges associated with all of the Security Groups that are assigned to that Role. To avoid granting a Security User unintended privileges, before assigning a Security User to a Role, be sure to review all of the privileges associated with the Security Groups assigned to that Role. Also, be aware that additional Roles, as well as Security Groups assigned to existing Roles, can be added via Security Manager.

Security Groups

The following families adhere to the security groups listed in the table below:
  • Asset Has Compliance Template
  • Asset Has Inspection Plan
  • Compliance Recommendation
  • Recommendation Revision
  • Compliance Policy Mapping
  • Compliance Strategy
  • Compliance Strategy Template
  • Compliance Template Has Mapping
  • Inspection Plan Has Recommendations
  • Has Inspection Plan Revision
  • Implements Compliance Recommendation
  • Inspection Plan
  • Inspection Plan Revision
  • Suggested Compliance Templates
Security GroupPermissions
MI Inspection
  • View
  • Insert
  • Update
  • Delete
MI Inspection ViewerView
MI RBI AdministratorView
MI RBI AnalystView
MI RBI ViewerView
MI Thickness Monitoring AdministratorView
MI Thickness Monitoring InspectorView
MI Thickness Monitoring UserView
MI Thickness Monitoring ViewerView

Security Roles

Compliance Management security roles can perform the following tasks:
TaskDescription
ApproveChange the state of an Inspection Plan to Approved.
Apply TemplatesApply suggested Compliance Strategy Templates to assets in the Assets without Templates section of the Compliance Management Overview page.
CreateCreate an Inspection Plan or Compliance Strategy Template.
ModifyModify Inspection Plans and Compliance Recommendations by changing States, deleting Compliance Recommendations, and implementing Compliance Recommendations as Inspection Tasks.
Suggest TemplatesSuggest Compliance Strategy Templates to be linked to assets in the Assets without Templates section of the Compliance Management Overview page.
ViewAccess a Compliance Recommendation, Inspection Plan, or Compliance Strategy Template.
The following security roles are available in Compliance Management:
Security RoleInspection Plan PrivilegesCompliance Strategy Template PrivilegesAssigned Security Group
MI Compliance AdministratorView
  • Apply Templates
  • Create
  • Modify
  • Suggest Templates
MI Compliance Analyst
  • Create
  • Modify
  • Apply Templates
  • Suggest Templates
  • View
MI Inspection Plan Approver
  • Create
  • Modify
  • Approve
  • Apply Templates
  • Suggest Templates
  • View
  • MI ASM Analyst