Inspection Management Deployment

Deploy Inspection 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.

StepTaskNotes
1Review the Inspection 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.
2Configure APM to create Task Revision records.This step is required only if you want Task Revision records to be created every time you create or update a task. These records are used to track historical data related to a task.
3 Assign Security Users to one or more of the Security Roles used in IM.This step is required.

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

4Assign Resource Roles to users.This step is required to define the users who can perform Inspection workflows as Inspectors, supervisors, administrators, contract inspectors, and risk analysts in Inspection Management.
5Modify baseline Application Configuration settings.This step is required only if you want to modify Application Configurations. The following Application Configurations are defined in the baseline database: Asset Query Path; Associated Relationship Family; Published Query Path; Summary Query Path; Alerts Query Path; Asset Is Successor; Profile Configuration; Method Configuration; Strategy Rule Configuration.
6Define the Inspection Profile for each piece of equipment that you will inspect.This step is required only if you plan to create Inspection records in baseline families other than the Checklists subfamilies.
7Modify the baseline Asset query. This step is required only if you want Inspection records to be linked to records in a family other than the Equipment family.
8Define Event Configurations for any new Inspection families that you have created.This step is required only if you have created custom Inspection families that you want to use within Inspection Management.
9Create a Checklist Configuration Template for custom inspections.This step is optional.
10Define Taxonomy Configurations for Inspection Families and Checklist Configurations.This step is required only if you want to link Inspection Families and Checklist Configurations to assets using equipment taxonomy.
11Assign certifications to users.This step is optional.
12Group inspection work into Work Packs.This step is optional.
13Configure Inspection Management ActiveMQ settings for MIExecution ServiceConfigure 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.
14Ensure 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.
15Modify the Inspection Event preferences.This step is required to avoid creating redundant related records while creating inspection record.

Configure APM to Create Task Revisions

About This Task

You can configure APM to create records that track changes to Task record values, so that you can keep a historical record of Task data on a given date and time. Throughout this documentation, we refer to these revision-tracking records as Task Revision records. The family caption, however, is not necessarily Task Revision.

APM provides the following Task Revision families, but you can create your own:

  • Task Revision
  • Inspection Task Revision

We assume that you do not want a Task Revision record to be created when you create a new Task record or update an existing Task record. If, however, you want these Task Revision records to be created, you will need to perform the following step.

Procedure

Configure the Has Task Revision relationship to include the Task family as the predecessor and its Task Revision subfamily as the successor.

Results

When you create or modify a task, a Task Revision is created and linked to the task.

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": 100,
    	        "Retries": 5,
                   "LimitPerTenantRequired": true
    	      }
    	    ]
              }
    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. LimitPerTenantRequired indicates whether Maximum Concurrency limit per Tenant is specified in scheduler service for the queue.
  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.

Inspection 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 GroupRoles
MI Inspection

MI Mechanical Integrity Administrator

MI Mechanical Integrity Power

MI Mechanical Integrity User

MI Inspection Viewer

MI APM Viewer

MI Mechanical Integrity Viewer

The following roles can be assigned to a group or user:
  • Inspector
  • Inspection Supervisor
  • SC Recommendations Implementer
  • SC Recommendations Reviewer

These roles are used in State Management.

FamilyMI Inspection MI Inspection Viewer
Entity Families
AlertView, Insert, Update, DeleteView
CertificationView, Insert, Update, DeleteView
Checklist FindingView, Insert, Update, DeleteView
Conditional AlertsView, Insert, Update, DeleteView
CorrosionView, Insert, Update, DeleteView
EquipmentView, Insert, Update, DeleteView
EventView, Insert, Update, DeleteView
FindingView, Insert, Update, DeleteView
Human ResourceViewView
Inspection MethodView, Insert, Update, DeleteView
Inspection ProfileView, Insert, Update, DeleteView
Inspection Team MemberView, Insert, Update, DeleteView
Inventory Group ConfigurationViewView
Potential Degradation MechanismsViewView
RBI Degradation MechanismsViewView
RBI Inspection Auto-Selection CriteriaViewView
RecommendationView, Insert, Update, DeleteView
Reference DocumentView, Insert, Update, DeleteView
Resource RoleView, Insert, Update, DeleteView
SAP SystemViewView
Security UserViewView
StrategyView, UpdateView
TaskView, Insert, Update, DeleteView
Taxonomy ReferencesViewView
Time Based Inspection IntervalView, Insert, Update, DeleteView
Time Based Inspection SettingView, Insert, Update, DeleteView
Work PackView, Insert, Update, DeleteView
Relationship Families
Belongs to a UnitView, Update, Insert, DeleteView
Checklist Has FindingView, Insert, Update, DeleteView
Has CertificationsView, Insert, Update, DeleteView
Has Degradation MechanismsViewView
Has FindingsView, Insert, Update, DeleteView
Has Inspection MethodView, Insert, Update, DeleteView
Has Inspection ProfileView, Insert, Update, DeleteView
Has Inspection ScopeView, Insert, Update, DeleteView
Has InspectionsView, Insert, Update, DeleteView
Has Potential Degradation MechanismsViewView
Has RecommendationsView, Insert, Update, DeleteView
Has Reference DocumentsView, Insert, Update, DeleteView
Has RolesView, Insert, Update, DeleteView
Has Sub-InspectionsView, Insert, Update, DeleteView
Has TasksView, Insert, Update, DeleteView
Has Task HistoryView, InsertView
Has Task RevisionView, InsertView
Has Team MemberView, Insert, Update, DeleteView
Has Taxonomy Hierarchy ElementViewView
Has Taxonomy MappingViewView
Has Time Based Inspection IntervalView, Insert, Update, DeleteView
Has Work PackView, Update, Insert, DeleteView
Is a UserViewView
Is Planned ByView, Insert, Update, DeleteView
Is Executed ByView, Insert, Update, DeleteView
Note: Security privileges for all modules and catalog folders can be found in the APM documentation.

Note that:

  • The family-level privileges granted to the following families are also spread to all of their subfamilies:
    • Event
    • Taxonomy References
  • The Has Task History relationship family is inactive in the baseline APM database.
  • In addition to the families listed in the preceding table, members of the MI Inspection Security Group have View privileges to additional families to facilitate integration with the Risk Based Inspection module. Since these families are not used elsewhere in Inspection Management, they are not listed in this table.
Note: As part of implementing Inspection Management, you will decide whether you want to link Inspection records to Equipment records, Functional Location records, or both. If you want to link Inspection records to Functional Location records, you will need to grant members of the MI Inspection Security Group at least View privileges to the Functional Location family and the Functional Location Has Equipment relationship family. All new users are automatically assigned to the Everyone user group.

Modify the Inspection Event Preferences

Procedure

  1. Access the Inspection Configuration workspace.
  2. Select the Event Configurations tab.
    The Event Configurations section appears, displaying a list of the Event Configurations currently applied to the Inspection Configuration.
  3. In the upper-right corner of the workspace, select .
    The grid in the Event Configurations section can now be modified.
  4. In the Event Configurations section, select the Related Families links corresponding to the Inspection families as listed in the following table:
    The Related Families window appears.
    RelationshipFamilyInspection families
    • HAS FINDINGS
    • HAS SUB-INSPECTION
    • HAS SUB-INSPECTION
    • GENERAL FINDING
    • BUNDLE SUB-INSPECTION
    • PRESSURE TEST SUB-INSPECTION
    • API 510 External Checklist
    • API 510 Internal Checklist
    • API 510 Internal Exchanger Checklist
    • API 570 External Checklist
    • API 653 External Checklist
    • API 653 Internal Checklist
    • Checklist Inspection Template
    • External PRD Checklist
    • ILI Checklist
    • PRD Pop Test Checklist
    • Third Party Damage Checklist
  5. Select the check boxes corresponding to Relationship and Family as mentioned in the above table.
  6. In the upper-right corner of the workspace, select .
    A message appears, confirming that you want to delete the family preferences.
  7. Select Yes.
    The selected family preferences are deleted.
  8. For each Inspection family that has General Finding as an available related family, deselect the Link and Unlink check boxes.
  9. Select Done.
    One or more related families are modified.
  10. For each Inspection family that has Asset Corrosion Analysis as an available related family, deselect the Delete check box.
  11. Select Done.
    One or more related families are modified.
  12. In the upper-right corner of the workspace, select .
    The Related Family preferences are modified.