Compliance Management Deployment | On-Premises APM

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

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. We recommend, however, that the tasks be completed in the order in which they are listed.


Step	Task	Notes
1	Review 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.
2	Assign 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.
4	Create 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.
5	Design a policy to use for a Compliance Strategy Template.	This step is required. You can create this policy using the Policy Designer.
6	Create 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.
7	Create a Compliance Strategy Template using the administrative features of Compliance Management.	This step is required.
8	Link assets to the Compliance Strategy Template.	This step is required.
9	Map the Policy to the Compliance Strategy Template that you created.	This step is required.
10	Configure Inspection Management ActiveMQ settings for MIExecution Service.	This step is optional. You can perform this step if you want to modify the default retries or concurrency settings.
11	Ensure that the Meridium MIExecution Service is installed and running.	If the basic APM system architecture is already installed, the Meridium MIExecution Service is automatically installed, and the service runs automatically.

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 Group	Permissions
MI Inspection	View Insert Update Delete
MI Inspection Viewer	View
MI RBI Administrator	View
MI RBI Analyst	View
MI RBI Viewer	View
MI Thickness Monitoring Administrator	View
MI Thickness Monitoring Inspector	View
MI Thickness Monitoring User	View
MI Thickness Monitoring Viewer	View

Security Roles

Compliance Management security roles can perform the following tasks:


Task	Description
Approve	Change the state of an Inspection Plan to Approved.
Apply Templates	Apply suggested Compliance Strategy Templates to assets in the Assets without Templates section of the Compliance Management Overview page.
Create	Create an Inspection Plan or Compliance Strategy Template.
Modify	Modify Inspection Plans and Compliance Recommendations by changing States, deleting Compliance Recommendations, and implementing Compliance Recommendations as Inspection Tasks.
Suggest Templates	Suggest Compliance Strategy Templates to be linked to assets in the Assets without Templates section of the Compliance Management Overview page.
View	Access a Compliance Recommendation, Inspection Plan, or Compliance Strategy Template.

The following security roles are available in Compliance Management:


Security Role	Inspection Plan Privileges	Compliance Strategy Template Privileges	Assigned Security Group
MI Compliance Administrator	View	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

Configure Inspection Management ActiveMQ settings for MIExecution Service

The MIExecution Service, on each APM Server serves RBI, Inspection and Thickness Monitoring module queues. This service is configured to use a single shared ActiveMQ queue service across APM. Available queue configuration options include retries and concurrency limit.

Procedure

On the APM Server, access the folder that contains the MIExecution Service files.

Note: If you have installed APM in the default location, you can locate the folder in C:\Program Files\Meridium\ApplicationServer\mi-execution
Access the appsettings.json file in an application that can be used to modify JSON files (for example, Notepad++).
In the file, locate the following text:
```
"Queue_Config": {
	    "Queues": [
	      {
	        "Name": "MI_IM_Queue", 
	        "ConcurrencyLimit": 8,
	        "Retries": 5
	      }
	    ]
          }
```
Note: ConcurrencyLimit indicates the maximum number of messages that will be consumed concurrently. Retries indicates the number of times it retries to send the messages to ActiveMQ if it fails.
Update the key values as desired.
Save and close the file.
The updated settings will be applied when the MIExecution Service is stopped and restarted.