Inspection Management Upgrade
Upgrade or Update Inspection Management to V5.1.4.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.1.0 - V5.1.2.x | V5.1.4.0.0 | |
V5.0.x | V5.1.4.0.0 | |
V4.6.2 or a later V4.6.x release | V5.1.4.0.0 | |
V4.6.1.x or earlier | V5.1.4.0.0 |
Note: For more information on upgrading to APM V4.6.2.0.0 or a later V4.6.x release, refer to the Upgrade documentation for the corresponding version.
|
Upgrade from any version V5.1.0.0.0 through V5.1.2.1.0
This module will be upgraded to V5.1.4.0.0 automatically when you upgrade the components in the basic APM system architecture. No additional steps are required.
Upgrade from any version V5.0.1.0.0 through V5.0.6.0.0
The following tables outline the steps that you must complete to upgrade this module to V5.1.4.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.
Step | Task | Notes |
---|---|---|
1 | Clear the Offline check box for Related Families of the Checklist Inspection Template family. | This step is required only if you have previously modified the Related Family settings for the Checklist Inspection Template family. This step will be completed automatically when you upgrade the components in the basic APM architecture. |
2 | Revert PRD Pop Test Checklist Datasheet to Baseline. | This step is required only if you have modified the PRD Pop Test Checklist datasheet. |
3 | Revert the following query to baseline to include the Inspection family in the All Tasks view of Integrity Mobile:
| This step is required only if you have previously modified the query. |
4 | Revert the following query to baseline to coalesce Functional Location ID into the Asset ID field within the My Inspections view of Integrity Mobile:
| This step is required only if you have previously modified the query. |
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.1.4.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:
A new Human Resource role, Contract Inspector (ID: CONTRACT INSPECTOR) is now available in MI_RESOURCE_ROLE system code table. This is to facilitate the enhancement where a Contract Inspector can now update the Status field in Inspection records to Pending Approval without being the user defined in the Inspection Report Owner field if they are also a Team Member in the associated Inspection record.
Step | Task | Notes | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
1 | Update entity key parameters from :n to :k for the following catalog queries:
|
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. | ||||||||||||||||||||||||||||||||||||
2 | Revert the following queries to baseline to remove the references to the MI_ENTITIES family that has been deprecated:
|
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. | ||||||||||||||||||||||||||||||||||||
3 | Revert the following queries to baseline to support notifications generation functionality in SAP from APM:
|
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. | ||||||||||||||||||||||||||||||||||||
4 | 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. | ||||||||||||||||||||||||||||||||||||
5 | 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. | ||||||||||||||||||||||||||||||||||||
6 | If you have previously used the following queries and want to continue to use them, you must export the queries from the previous version and import them into the current version. They are no longer used in the application and have been removed. Folder: Public/Meridium/Modules/Inspection/Document Queries
Folder: Public/Meridium/Modules/Inspection/Work Pack Queries
Folder: Public/Meridium/Modules/Inspection/Task Queries
Folder: Public/Meridium/Modules/Inspection/Resources Queries
Folder: Public/Meridium/Modules/Inspection/Manage Report Queries
Folder: Public/Meridium/Modules/Inspection/Conditional Alert Queries
Folder: Public/Meridium/Modules/Inspection/Profile Queries
Folder: Public/Meridium/Modules/Inspection/Config Queries
| This step is optional. | ||||||||||||||||||||||||||||||||||||
7 | Revert the following queries to baseline to fix the query compilation error: Folder: Public/Meridium/Modules/Inspection/Compliance/Queries
Folder: Public/Meridium/Modules/Inspection/Overview Queries
Folder: Public/Meridium/Modules/Inspection/Review Queries
|
This step is required only if you have previously modified the queries. | ||||||||||||||||||||||||||||||||||||
8 | Revert the following Inspection Management queries to baseline:
| This step is required only if you have previously modified the queries. | ||||||||||||||||||||||||||||||||||||
9 | Revert the following Inspection Management queries to baseline as the MI_SM_STATES.SMST_STAT_IND field is deprecated :
| This step is required only if you have previously modified the queries. | ||||||||||||||||||||||||||||||||||||
10 | Map the following Baseline Inspection Document Status to the respective State:
|
This step will be completed automatically, when you upgrade the components in the basic APM system architecture.
Note: Select the Revert to Baseline utility if you have a custom state machine at Inspection parent family and want to use the baseline state. You may want to skip this upgrade if you have custom statuses that you want to convert to a custom state machine. In this scenario, skip the database upgrade, configure your custom state machine, and then use the Map Inspection Status to State upgrade utility available in the Inspection Admin Preferences page. For more details on the steps to follow if you want to skip the baseline upgrade, refer to the KBA 000039706. If State Management is customized for families under the Inspection parent family (MI_INSP_001), refer to the KBA 000040189 to use the baseline state. | ||||||||||||||||||||||||||||||||||||
11 | Revert the following queries to baseline to remove the references to the Status field in Inspection family that has been replaced by State Management fields.
| 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. | ||||||||||||||||||||||||||||||||||||
12 |
Execute the Revert to Baseline utility to update the following Datasheets:
|
This step is required only if you have modified the following datasheets:
| ||||||||||||||||||||||||||||||||||||
13 | The users with Baseline Human Resource Roles will be assigned the security Roles based on the following table:
| This step will be completed automatically when you upgrade the components in the basic APM system architecture | ||||||||||||||||||||||||||||||||||||
14 | Change the following system code tables display format to Description only:
| This step is required only if you have modified the values in the system code tables. | ||||||||||||||||||||||||||||||||||||
15 | Revert the following Inspection Management dashboard to baseline as the ALL INSPECTIONS PENDING APPROVAL FOR REVIEWER widget has been removed:
| This step is required only if you have previously modified the dashboard. | ||||||||||||||||||||||||||||||||||||
16 | Clear the Offline check box for Related Families of the Checklist Inspection Template family. | This step is required only if you have previously modified the Related Family settings for the Checklist Inspection Template family. This step will be completed automatically when you upgrade the components in the basic APM architecture. |
Remove Offline Option for Related Families of Checklist Inspection Template
About This Task
Procedure
- Log in to APM as an Inspection Administrator.
- In the module navigation menu, select .
- Select .
- Select Event Configurations.
- In the Checklist Inspection Template row, select the link in the Related Families column.
- For the General Findings, Bundle Sub-Inspection, and Pressure Test Sub-Inspection families, clear the check box in the Offline column.
- Select Done.
- Select .
Revert Inspection Management Queries to Baseline
This action is required only if you have modified the Inspection Management queries.
About This Task
Procedure
Inspection Datasheets - Revert to Baseline
About This Task
Family | Family ID | Datasheet Updated (Default) |
---|---|---|
Full Inspection | MI_INSPFULL | Full Visual Inspection |
General Inspection | MI_INSP_GEN | General Inspection - Default |
API 510 External Checklist | MI_API510EXT_CHECK | API 510 External Checklist - Default |
API 510 Internal Checklist | MI_API510INT_CHECK | API 510 Internal Checklist - Default |
API 510 Internal Exchanger Checklist | MI_API510IEX_CHECK | API 510 Internal Exchanger Checklist - Default |
API 570 External Checklist | MI_API570EXT_CHECK | API 570 External Checklist - Default |
API 653 External Checklist | MI_API653EXT_CHECK | API 653 External Checklist – Default |
API 653 Internal Checklist | MI_API653INT_CHECK | API 653 Internal Checklist - Default |
External PRD Checklist | MI_EXTNL_PRD_CHECK | External PRD Checklist |
PRD Pop Test Checklist | MI_PRD_PT_CHECK | PRD Pop Test Checklist |
Checklist Inspection Template | MI_GEN_INSP_TMP | Checklist Inspection Template |
- Using Family Management, edit the default datasheet of each family. Add a new section, Download Information with the following fields:
- Downloaded
- Last Downloaded By
- Last Downloaded Date
- Last Synced Back By
- Last Synced Date
- Run Revert to Baseline for each family.
Procedure
Update the Query Parameter Type
After the database upgrade for APM, if the entity key fields are of the type string, you must modify the catalog query parameters to use the correct type by performing the following steps.
Procedure
Inspection Recommendation State Management - Revert to Baseline
About This Task
- You are using customized state configuration for the approval workflow and want to use the new state configuration.
- You have a customized state configuration for the approval workflow, but using the recommendation status for the approval workflow, and want to use the new state configuration.
Before You Begin
- You must be a super user in APM.
- The State Configuration for Inspection Recommendation must be enabled.
Procedure
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
Results
About Configuring the Has Task Revision Relationship
The Has Task Revision relationship family is used to link Task Revisions to Tasks. If a relationship definition exists between a Task family and its Task Revision subfamily, when you create a Task record in that family, the APM system will automatically create a Task Revision and link it to the Task. The Task Revision serves as a historical record of the Task data on a given date and time. If you later update the Task, a new Task Revision will be created.
We assume that you do not want a Task Revision to be created when you create a new Task or update an existing Task. If, however, you do want these Task Revisions to be created, you will need to configure the Has Task Revision relationship to include the required families. No relationship definitions are configured for this family in the baseline APM database.
The following table provides an example of a relationship definition that you might configure for the Has Task Revision relationship if you are using the root Task family.
Predecessor | Successor | Cardinality |
---|---|---|
Task | Task Revision | One to Many |
Inspection Task Revision
We assume that you do not want an Inspection Task Revision to be created when you create a new Inspection Task or update an existing Inspection Task. If, however, you do want these Inspection Task Revisions to be created, you will need to configure the Has Task Revision relationship to include the required families. No relationship definitions are configured for this family in the baseline Inspection Management product.
The following table provides an example of a relationship definition that you might configure for the Has Task Revision relationship if you are using the Inspection Task family.
Predecessor | Successor | Cardinality |
---|---|---|
Inspection Task | Inspection Task Revision | One to Many |
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
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.
Security Group | Roles |
---|---|
MI Inspection |
MI Mechanical Integrity Administrator MI Mechanical Integrity Power MI Mechanical Integrity User |
MI Inspection Viewer |
MI APM Viewer MI Mechanical Integrity Viewer |
- Inspector
- Inspection Supervisor
- SC Recommendations Implementer
- SC Recommendations Reviewer
These roles are used in State Management.
Family | MI Inspection | MI Inspection Viewer |
---|---|---|
Entity Families | ||
Alert | View, Insert, Update, Delete | View |
Certification | View, Insert, Update, Delete | View |
Checklist Finding | View, Insert, Update, Delete | View |
Conditional Alerts | View, Insert, Update, Delete | View |
Corrosion | View, Insert, Update, Delete | View |
Equipment | View, Insert, Update, Delete | View |
Event | View, Insert, Update, Delete | View |
Finding | View, Insert, Update, Delete | View |
Human Resource | View | View |
Inspection Method | View, Insert, Update, Delete | View |
Inspection Profile | View, Insert, Update, Delete | View |
Inspection Team Member | View, Insert, Update, Delete | View |
Inventory Group Configuration | View | View |
Potential Degradation Mechanisms | View | View |
RBI Degradation Mechanisms | View | View |
RBI Inspection Auto-Selection Criteria | View | View |
Recommendation | View, Insert, Update, Delete | View |
Reference Document | View, Insert, Update, Delete | View |
Resource Role | View, Insert, Update, Delete | View |
SAP System | View | View |
Security User | View | View |
Strategy | View, Update | View |
Task | View, Insert, Update, Delete | View |
Taxonomy References | View | View |
Time Based Inspection Interval | View, Insert, Update, Delete | View |
Time Based Inspection Setting | View, Insert, Update, Delete | View |
Work Pack | View, Insert, Update, Delete | View |
Relationship Families | ||
Belongs to a Unit | View, Update, Insert, Delete | View |
Checklist Has Finding | View, Insert, Update, Delete | View |
Has Certifications | View, Insert, Update, Delete | View |
Has Degradation Mechanisms | View | View |
Has Findings | View, Insert, Update, Delete | View |
Has Inspection Method | View, Insert, Update, Delete | View |
Has Inspection Profile | View, Insert, Update, Delete | View |
Has Inspection Scope | View, Insert, Update, Delete | View |
Has Inspections | View, Insert, Update, Delete | View |
Has Potential Degradation Mechanisms | View | View |
Has Recommendations | View, Insert, Update, Delete | View |
Has Reference Documents | View, Insert, Update, Delete | View |
Has Roles | View, Insert, Update, Delete | View |
Has Sub-Inspections | View, Insert, Update, Delete | View |
Has Tasks | View, Insert, Update, Delete | View |
Has Task History | View, Insert | View |
Has Task Revision | View, Insert | View |
Has Team Member | View, Insert, Update, Delete | View |
Has Taxonomy Hierarchy Element | View | View |
Has Taxonomy Mapping | View | View |
Has Time Based Inspection Interval | View, Insert, Update, Delete | View |
Has Work Pack | View, Update, Insert, Delete | View |
Is a User | View | View |
Is Planned By | View, Insert, Update, Delete | View |
Is Executed By | View, Insert, Update, Delete | View |
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.
Revert Inspection Management Dashboard to Baseline
Before You Begin
This action is required only if you have modified the Inspection Management dashboard.