Deployment

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

Deploy Inspection 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. We recommend, 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


Step	Task	Notes
1	Review 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.
2	Configure GE Digital 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.
4	Modify 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.
5	Define 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.
6	Modify 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.
7	Define 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.
8	Create a Checklist Configuration Template for custom inspections.	This step is optional.
9	Define 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.
10	Assign certifications to users .	This step is optional.
11	Group inspection work into Work Packs .	This step is optional.
12	Define Time-Based Inspection settings .	This step is optional.

Upgrade or Update Inspection Management to V4.3.0.6.0

Before you begin

The following tables outline the steps that you must complete to upgrade this module to V4.3.0.6.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.

Procedure

Upgrade from any version V4.3.0.0.0 through V4.3.0.5.2


Step	Task	Notes
1	Update the approval work process of Inspection Recommendations to use the new state management.	A new state configuration has been developed for the Inspection Recommendation approval work process. This state configuration includes some new states and the existing states are updated. This step is required only if: 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. In both the cases, you must run the Revert to Baseline utility to map the existing states to the new states.
2	Add WHERE criteria to the following queries to accommodate date filters: The Underlying Inspection Tasks query: Public\Meridium\Modules\Inspection\Overview Queries\All Tasks for Unit The Underlying Recommendations query: Public\Meridium\Modules\Inspection\Overview Queries\Open Inspection Recommendations for Unit The Overdue Inspection Recommendations query: Public\Meridium\Modules\Inspection\Overview Queries\Overdue Inspection Recommendations for Unit	This step is required only if you have previously modified the queries. You can add the WHERE criteria by following the instructions in KBA 6215. If you have not modified your queries, you do not need to follow this step. This step will be completed automatically when you upgrade the components in the basic GE Digital APM system architecture.

Upgrade from any version V4.2.0.0 through V4.2.0.9.2


Step	Task	Notes
1	Revert the My Open Inspections Query to baseline.	This step is required only if you have modified the My Open Inspections query. If you have, you will not have the ability to download inspections from the My Open Inspections section of the Inspections page until you revert the My Open Inspections query to baseline for the offline functionality to be enabled. Note: If you want to modify this query, you must have both the Inspection Lock and the Entity Key fields as selected fields in the customized query.

Upgrade from any version V4.1.0.0 through V4.1.7.4.0
This module will be upgraded to V4.3.0.6.0 automatically when you upgrade the components in the basic GE Digital APM system architecture. No additional steps are required.
Upgrade from any version V4.0.0.0 through V4.0.1.0
This module will be upgraded to V4.3.0.6.0 automatically when you upgrade the components in the basic GE Digital APM system architecture. No additional steps are required.
Upgrade from any version V3.6.1.0.0 through V3.6.1.7.1
This module will be upgraded to V4.3.0.6.0 automatically when you upgrade the components in the basic GE Digital APM system architecture. No additional steps are required.
Upgrade from any version V3.6.0.0.0 through V3.6.0.12.8
This module will be upgraded to V4.3.0.6.0 automatically when you upgrade the components in the basic GE Digital APM system architecture. No additional steps are required.
Upgrade from any version V3.5.1 through V3.5.1.12.3
This module will be upgraded to V4.3.0.6.0 automatically when you upgrade the components in the basic GE Digital APM system architecture. No additional steps are required.
Upgrade from any version V3.5.0 SP1 LP through V3.5.0.1.10.1
Step Task Notes
1 Define Time-Based Inspection settings This step is optional.
Upgrade from any version V3.5.0 through V3.5.0.0.7.1
Step Task Notes
1 Define Time-Based Inspection settings This step is optional.

Step	Task	Notes
1	Define Time-Based Inspection settings	This step is optional.

Step	Task	Notes
1	Define Time-Based Inspection settings	This step is optional.

Upgrade from any version V3.4.5 through V3.4.5.0.1.4


Step	Task	Notes
1	Create Task Types records representing those task types, and then set the value in the Reference field to Inspection.	This step is required only if you have added System Codes to the MI_INSPECTION_TYPE System Code table.
2	Define Time-Based Inspection settings	This step is optional.

Inspection Recommendation State Management - Revert to Baseline

About this task

The Inspection Recommendation state management is now available with a new state configuration for the approval workflow. This state configuration allows Inspection Recommendation approval workflow to use the State field, instead of the Status field. For more information about the new state configuration, refer to the About State Management topic. If you are using a customized state configuration for the approval workflow and want to use the functionality of the new state management without impacting the current approval workflow, you must map the existing states to the new states using the Revert to Baseline utility. You can run this utility in any of the following conditions:

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.

Important: Running this utility overrites your current state configuration. After you transition to the new state configuration, you cannot revert to the old state configuration.

Before you begin

You must be a super user in GE Digital APM.
The State Configuration for Inspection Recommendation must be enabled.

Procedure

Log in to the server where GE Digital APM is installed.
Navigate to <Installation Directory>\Meridium\Upgrade\DBUpgrade.
Run the RevertToBaselineApp.exe file as administrator.
The Revert To Baseline Login window appears.
In the Meridium Data Source box, enter the data source name that you want to access.
Enter your login credentials, and then select Next.
The available families that can be reverted to baseline appear.
Select the Inspection Recommendation family, and then select Revert to Baseline.
The Various Options For Revert window appears.
Select State Management, and then select Ok.
The State Management Mapper window appears.
In the Entity Families pane, select Inspection Recommendation.
The State Management Baseline Mapping table appears and contains the following columns:
- Custom Source: Contains all the existing states that are available for mapping to the new states.
- Select Target: Allows you to select the new states that you want to map to the existing states.
- Baseline Target: Displays the newly mapped states corresponding to the existing states.
Using the Select Target column, select the state that you want to map to the existing state.

Note: You can use the Auto Map button to automatically map the existing states to the new states based on the state name.
Repeat step 9 for all the existing states.
Select Save Mapping.
Browse for the path where you want to save the mapping file, and then select Save.
A .xml file containing the state mappings is saved.
Select Revert Single Family.
Select the state mapping file that you saved in step 12, and then select OK.
The mapping operation starts. After the operation is successfully completed, a success message appears.
Select Exit.
The Revert to Baseline utility is closed.

Configure GE Digital APM to Create Task Revisions

About this task

You can configure GE Digital 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.

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

Task Revision
Calibration 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.

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 GE Digital 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 GE Digital APM database.

The following table provides examples of relationship definitions that you might configure for the Has Task Revision relationship if you are using the root Task family or a customer-defined Task family.


Predecessor	Successor	Cardinality
Task	Task Revision	One to Many
Customer-defined Task family	Customer-defined Task Revision family (which must be a subfamily of the customer-defined Task family)	One to Many

Calibration Task Revision

We assume that you do not want a Calibration Task Revision to be created when you create a new Calibration Task or update an existing Calibration Task. If, however, you do want these Calibration Task Revisions to be created, you will need to configure the Has Task Revision relationship to include the desired families. No relationship definitions are configured for this family in the baseline Calibration Management database module.

The following table provides examples of relationship definitions that you might configure for the Has Task Revision relationship if you are using the Calibration Task family or a customer-defined Calibration Task family.


Predecessor	Successor	Cardinality
Calibration Task	Calibration Task Revision	One to Many
Customer-defined Calibration Task family	Customer-defined Calibration Task Revision family (which must be a subfamily of the customer-defined Calibration Task family)	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 examples of relationship definitions that you might configure for the Has Task Revision relationship if you are using the Inspection Task family or a customer-defined Inspection Task family.


Predecessor	Successor	Cardinality
Inspection Task	Inspection Task Revision	One to Many
Customer-defined Inspection Task family	Customer-defined Inspection Task Revision family (which must be a subfamily of the customer-defined Inspection Task family)	One to Many

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 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


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: 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 GE Digital 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.

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


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: 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 GE Digital 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.