Compliance Management Upgrade

Upgrade or Update Compliance Management to V5.0.6.0.0

Upgrading or updating to the V5.0.6.0.0 is a two-step process. You need to first upgrade to APM V4.6.2.0.0 or later and then follow the steps to upgrade or update to V5.0.6.0.0.

The following table provides you the reference to procedures to upgrade from an earlier APM version to the latest version.

Upgrade from Upgrade to Procedure
V5.0.0.0.0 through V5.0.5.0.0V5.0.6.0.0Upgrade from any version V5.0.0.0.0 through V5.0.5.0.0
V4.6.2.0.0 through V4.6.10.0.0V5.0.6.0.0Upgrade from any version V4.6.2.0.0 through V4.6.10.0.0

Upgrade from any version V5.0.0.0.0 through V5.0.5.0.0

This module will be upgraded to V5.0.6.0.0 automatically when you upgrade the components in the basic APM system architecture. No additional steps are required.

Upgrade from any version V4.6.2.0.0 through V4.6.10.0.0

The following tables outline the steps that you must complete to upgrade this module to V5.0.6.0.0. These instructions assume that you have completed the steps for upgrading the basic 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 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.
StepTaskNotes
1Configure 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.
2Ensure 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.
3 Revert the following queries to baseline to remove the references to the MI_ENTITIES family that has been deprecated:
  • Public/Meridium/Modules/Inspection/Compliance/Queries folder.
    • Inspection Tasks Available to Implement
    • Recommendations by Inspection Plan
    • Inspection Tasks for Asset
    • Assets without Templates
    • Compliance Template Assets

This step is required only if you have previously modified the queries.

This step will be completed automatically when you upgrade the components in the basic APM system architecture.

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

  1. 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
  2. Access the appsettings.json file in an application that can be used to modify JSON files (for example, Notepad++).
  3. 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.
  4. Update the key values as desired.
  5. Save and close the file.
    The updated settings will be applied when the MIExecution Service is stopped and restarted.

Revert the Compliance Management Query to Baseline

This action is required only if you want to use the RBI Inspection Grouping functionality.

About This Task

If you have modified the Recommended Actions by Selected Plans query, perform the following steps to revert the query to baseline:

Procedure

  1. Access the Catalog page.
  2. Navigate to the following Public folder:
    Public/Meridium/Modules/Inspection/Compliance/Queries/
  3. Select the check box next to the Recommended Actions by Selected Plans query, and then select .
    The Confirm Delete window appears, asking you to confirm if you want to delete the selected query.
  4. Select OK.
    The selected query is deleted.
  5. Navigate to the following Baseline folder.
    Baseline/Meridium/Modules/Inspection/Compliance/Queries/
  6. Select the check box next to the Recommended Actions by Selected Plans query, and then select .
    The Catalog Folder Browser window appears.
  7. Navigate to the Public folder containing the query that you deleted in step 3.
  8. Select OK.
    A success message appears indicating that the selected item has been copied successfully.

Compliance Recommendation - Revert to Baseline

About This Task

The default datasheet for Compliance Recommendation family has been updated and it includes the Certification and the Chamber fields.
FamilyFamily IDDatasheet Updated (Default)
Compliance RecommendationMI_COMP_RECOMMCompliance Recommendation
If you have customized the default datasheet for the Compliance Recommendation family, and want to view Certification and Chamber-related data, then you must do one of the following:
  • Using Family Management, edit the default datasheet for the Compliance Recommendation family. Next, add the Certification, Chamber, and Applicable Regulation fields in the datasheet.
  • Run Revert to Baseline for each family.
Important: Running this utility overwrites your current datasheet and replaces it with the baseline version. You must be a super user in APM to run the Revert to Baseline utility.

Procedure

  1. Log in to the server where APM is installed.
  2. Navigate to <Installation Directory>\Meridium\Upgrade\DBUpgrade.
  3. Run the RevertToBaselineApp.exe file as administrator.
    The Revert To Baseline Login window appears.

  4. In the Meridium Data Source box, enter the data source name that you want to access.
  5. Enter your login credentials, and then select Next.
    The available families that can be reverted to baseline appear.
  6. Select the Compliance Recommendation family, and then select Revert to Baseline.
    The Various Options For Revert window appears.

  7. Select Datasheets.
    Select the Default Datasheet from the drop-down list, and then select Ok.

Compliance Strategy Template Datasheet - Revert to Baseline

About This Task

The default datasheet for Compliance Strategy Template family has been updated. The field Policy Name is included and the deprecated field Policy Key is removed from the datasheet.
FamilyFamily IDDatasheet Updated (Default)
Compliance Strategy TemplateMI_COMP_STRAT_TEMPCompliance Strategy Template
If you have customized the default datasheet for Compliance Strategy Template family, then you must do one of the following:
  • Using Family Management, edit the default datasheet for the Compliance Strategy Template family. Replace the Policy field to Policy Name field in the datasheet.
  • Run Revert to Baseline for each family.
Important: Running this utility overwrites your current datasheet and replaces it with the baseline version. You must be a super user in APM to run the Revert to Baseline utility.

Procedure

  1. Log in to the server where APM is installed.
  2. Navigate to <Installation Directory>\Meridium\Upgrade\DBUpgrade.
  3. Run the RevertToBaselineApp.exe file as administrator.
    The Revert To Baseline Login window appears.

  4. In the Meridium Data Source box, enter the data source name that you want to access.
  5. Enter your login credentials, and then select Next.
    The available families that can be reverted to baseline appear.
  6. Select the Compliance Strategy Template family, and then select Revert to Baseline.
    The Various Options For Revert window appears.

  7. Select Datasheets.
    Select the Default Datasheet from the drop-down list, and then select Ok.