Thickness Monitoring Deployment | Cloud APM

Deploy Thickness Monitoring 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 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.

Before you begin completing these tasks, review the system requirements for this module to identify the supported features for this module in APM.


Step	Task	Notes
1	Assign Security Users to one or more of the Security Roles used in TM.	This step is required. User must have permissions to the TM families in order to use the TM functionality.
2	Assign Resource Roles to users by performing the following steps: Access the Human Resource record for each user. In the Role box, select TM Technician.	This step is required to allow a user (typically, a TM Inspector) to enter details in an Inspection record.
3	Configure Family Preference Application Settings.	This step is required. You must configure preferences for the families that will be used to store equipment data in Thickness Monitoring. The following relationships must be defined: For the Equipment family, the Asset to Subcomponent Relationship field must be set to Has TML Group, and the Component ID field must be set to Equipment ID. The Subcomponent to Asset Relationship field should be left blank. For the TML Group family, the Subcomponent to Asset Relationship field must be set to Has TML Group, and the Component ID field must be set to TML Group ID. The Asset to Subcomponent Relationship field should be left blank.
4	Configure Global Preference Application Settings.	This step is required only if you want to use custom reading preferences and Nominal T-Min preferences. Baseline reading preferences and Nominal T-Min preferences will be used if you do not define your own. You can also define additional, optional global preferences that are not defined in the baseline APM database.
5	Define additional fields that will be displayed in the header section of the TM Measurement Data Entry.	This step is required only if default Thickness Measurement fields are displayed on the headings of these pages in the baseline APM database. You can specify that additional fields be displayed in the header section of these pages.
6	Disable the Auto Manage Tasks setting.	This step is required only if you are planning to use TM tasks.
7	Install the GE Device Service on all of the machines that will connect to devices that will be used with Thickness Monitoring.	This step is required only if you will use any device to collect data that you transfer to Thickness Monitoring. If you are using HTTPS to connect to APM, follow the instructions in HOW TO: V4 Thickness Monitoring - Devices - Dataloggers and Secure HTTPS Browsers on Windows Machines.
8	Install the drivers and supporting files for any devices on all of the machines that will connect to devices that will be used with Thickness Monitoring.	This step is required only if you will use these devices to collect data that you transfer to Thickness Monitoring.

Install the GE Device Service

Before You Begin

You need administrative access to the machine on which you want to install the service.

Important: You must repeat this procedure on every machine to which a datalogger will be connected.

About This Task

For APM to communicate with physical devices connected to your machine, the GE Device Service must be installed.

You can download the installer from KBA 000059233.

What To Do Next

If you want to use an HTTPS connection or a port number other than the default one (2014), configure the GE Device Service.

Configure the GE Device Service

Before You Begin

You need administrative access to the machine on which you want to configure the service.
Install the GE Device Service.

Important: You must repeat this procedure on every machine to which a datalogger will be connected.

About This Task

In most cases, the default configuration of the GE Device Service will suffice. However, depending on how you access APM and your computer’s port configuration, you may need to change the configuration.

This topic describes how to configure the settings, which is required only if:

Your APM connection uses HTTPS.
The default port 2014 is not available.

If using HTTP or the default port, changes to the configuration are not required.

Procedure

In Windows Explorer, navigate to C:\Program Files\Meridium\Services.
Using a text editor, open the Meridium.Service.Devices.exe.config file.
In the appSettings section:
1. If using a port other than 2014, update the entry for UrlPort with a port number that is available on your computer.
2. If using HTTPS, update the value for BaseURL with https://*.
3. On line 26, edit the timeout value in milliseconds. By default, the value for this setting is 60000, or 1 minute.
Save your changes, and restart the GE Device Service.
The GE Device Service configuration settings are updated.

Results

On initial startup, the service will attempt to install an SSL certificate required to communicate with APM when using an HTTPS connection. It will also bind the certificate with the configured port on the machine and add an entry in the hosts file in order to use the meridium.device.local URL. If you change the port number again, restarting the service will remove any current binding to the previous port and recreate a binding to the newly configured port.

Configure Thickness Monitoring 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_TM_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.
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.

TM Functional Security Privileges

APM provides the following baseline Security Groups for use with Thickness Monitoring and provides baseline family-level privileges for these groups:

MI Thickness Monitoring Administrator
MI Thickness Monitoring Inspector
MI Thickness Monitoring User

Access to certain functions in APM is determined by membership in these Security Groups. Note that in addition to the baseline family-level privileges that exist for these Security Groups, users will also need at least View privileges for all customer-defined predecessor or successor families that participate in the Thickness Monitoring relationships. Keep in mind that:

Users who will need to create new records in TM will need Insert privileges to these families.
Users who will need to modify records will need Update privileges to these families.
Any user who should be allowed to delete TM records will need Delete privileges to these families.

The following table summarizes the functional privileges associated with each group.


Function	Can be done by members of the MI Thickness Monitoring Administrator Group?	Can be done by members of the MI Thickness Monitoring Inspector Group?	Can be done by members of the MI Thickness Monitoring User Group?
Configure Global Preferences	Yes	No	No
Configure Family Preferences	Yes	No	No
Use the T-Min Calculator	No	Yes	No
Archive Corrosion Rates	No	Yes	No
Reset the Maximum Historical Corrosion Rate	Yes	No	No
Exclude TMLs	No	Yes	No
Renew TMLs	No	Yes	No
Reset User Preferences	Yes	No	No

APM provides the following baseline Security Groups for use with Thickness Monitoring and provides baseline family-level privileges for these groups:

MI Thickness Monitoring Administrator
MI Thickness Monitoring Inspector
MI Thickness Monitoring User

Access to certain functions in APM is determined by membership in these Security Groups. Note that in addition to the baseline family-level privileges that exist for these Security Groups, users will also need at least View privileges for all customer-defined predecessor or successor families that participate in the Thickness Monitoring relationships. Keep in mind that:

Users who will need to create new records in TM will need Insert privileges to these families.
Users who will need to modify records will need Update privileges to these families.
Any user who should be allowed to delete TM records will need Delete privileges to these families.

The following table summarizes the functional privileges associated with each group.


Function	Can be done by members of the MI Thickness Monitoring Administrator Group?	Can be done by members of the MI Thickness Monitoring Inspector Group?	Can be done by members of the MI Thickness Monitoring User Group?
Configure Global Preferences	Yes	No	No
Configure Family Preferences	Yes	No	No
Use the T-Min Calculator	No	Yes	No
Archive Corrosion Rates	No	Yes	No
Reset the Maximum Historical Corrosion Rate	Yes	No	No
Exclude TMLs	No	Yes	No
Renew TMLs	No	Yes	No
Reset User Preferences	Yes	No	No

TM Security Groups

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. In Cloud APM, Roles are assigned to Security Users through permission sets.

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.


Security Group	Roles
MI Thickness Monitoring Administrator	MI Mechanical Integrity Administrator
MI Thickness Monitoring Inspector	MI Mechanical Integrity Administrator MI Mechanical Integrity Power MI Mechanical Integrity User
MI Thickness Monitoring User	MI Mechanical Integrity Administrator MI Mechanical Integrity Power MI Mechanical Integrity User
MI Thickness Monitoring Viewer	MI APM Viewer MI Mechanical Integrity Viewer

The baseline family-level privileges that exist for these Security Groups are summarized in the following table.


Family	MI Thickness Monitoring Administrator	MI Thickness Monitoring Inspector	MI Thickness Monitoring User	MI Thickness Monitoring Viewer
Entity Families
Corrosion	View, Update, Insert	View, Update, Insert	View, Update, Insert	View
Datapoint	View, Update, Insert	View, Update, Insert	View, Update, Insert	View
Datapoint Measurement	View, Update, Insert, Delete	View, Update, Insert, Delete	View, Update, Insert	View
Equipment	View	View	View	View
Human Resource	View, Update, Insert, Delete	View	View	View
Inspection Task	View	View, Update	View	View
Inventory Group Configuration	View	View	View	View
Materials of Construction	View	View	View	View
Meridium Reference Tables	View, Update, Insert, Delete	View	View	View
RBI Inspection Auto-Selection Criteria	View	View	View	View
Resource Role	View, Update, Insert, Delete	View	View	View
Security Group	View	View	View	View
Security User	View	View	View	View
Settings	View, Update, Insert	View, Update, Insert	View	View
Task Execution	View, Insert	View, Insert	View	View
Thickness Monitoring Task	View, Update, Insert, Delete	View, Update, Insert	View, Update, Insert	View
TML Group	View, Update, Insert, Delete	View, Update, Insert, Delete	View	View
Relationship Families
Belongs to a Unit	View, Update, Insert, Delete	View, Update, Insert	View, Update, Insert	View
Equipment Has Equipment	View	View	View	View
Group Assignment	View	View	View	View
Has Archived Corrosion Analyses	View, Update, Insert, Delete	View, Update, Insert, Delete	View, Update, Insert, Delete	View
Has Archived Corrosion Analysis Settings	View, Update, Insert, Delete	View, Update, Insert, Delete	View, Update, Insert, Delete	View
Has Archived Subcomponent Analysis Settings	View, Update, Insert, Delete	View, Update, Insert, Delete	View, Update, Insert, Delete	View
Has Archived Subcomponent Corrosion Analyses	View, Update, Insert, Delete	View, Update, Insert, Delete	View, Update, Insert, Delete	View
Has Corrosion Analyses	View, Update, Insert, Delete	View, Update, Insert, Delete	View, Update, Insert, Delete	View
Has Corrosion Analysis Settings	View, Update, Insert, Delete	View, Update, Insert, Delete	View, Update, Insert, Delete	View
Has Datapoints	View, Update, Insert, Delete	View, Update, Insert, Delete	View, Update, Insert, Delete	View
Has Inspections	None	None	None	View
Has Measurements	View, Update, Insert, Delete	View, Update, Insert, Delete	View, Update, Insert, Delete	View
Has Roles	View, Update, Insert, Delete	View	View	View
Has Task Execution	View, Insert	View, Insert	View	View
Has Task Revision	View, Insert	View, Insert	View	View
Has Tasks	View, Insert	View, Insert	View, Insert	View
Has TML Group	View, Update, Insert, Delete	View, Update, Insert, Delete	View	View
Is a User	View	View	View	View
User Assignment	View	View	View	View

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. In Cloud APM, Roles are assigned to Security Users through permission sets.

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.


Security Group	Roles
MI Thickness Monitoring Administrator	MI Mechanical Integrity Administrator
MI Thickness Monitoring Inspector	MI Mechanical Integrity Administrator MI Mechanical Integrity Power MI Mechanical Integrity User
MI Thickness Monitoring User	MI Mechanical Integrity Administrator MI Mechanical Integrity Power MI Mechanical Integrity User
MI Thickness Monitoring Viewer	MI APM Viewer MI Mechanical Integrity Viewer

The baseline family-level privileges that exist for these Security Groups are summarized in the following table.


Family	MI Thickness Monitoring Administrator	MI Thickness Monitoring Inspector	MI Thickness Monitoring User	MI Thickness Monitoring Viewer
Entity Families
Corrosion	View, Update, Insert	View, Update, Insert	View, Update, Insert	View
Datapoint	View, Update, Insert	View, Update, Insert	View, Update, Insert	View
Datapoint Measurement	View, Update, Insert, Delete	View, Update, Insert, Delete	View, Update, Insert	View
Equipment	View	View	View	View
Human Resource	View, Update, Insert, Delete	View	View	View
Inspection Task	View	View, Update	View	View
Inventory Group Configuration	View	View	View	View
Materials of Construction	View	View	View	View
Meridium Reference Tables	View, Update, Insert, Delete	View	View	View
RBI Inspection Auto-Selection Criteria	View	View	View	View
Resource Role	View, Update, Insert, Delete	View	View	View
Security Group	View	View	View	View
Security User	View	View	View	View
Settings	View, Update, Insert	View, Update, Insert	View	View
Task Execution	View, Insert	View, Insert	View	View
Thickness Monitoring Task	View, Update, Insert, Delete	View, Update, Insert	View, Update, Insert	View
TML Group	View, Update, Insert, Delete	View, Update, Insert, Delete	View	View
Relationship Families
Belongs to a Unit	View, Update, Insert, Delete	View, Update, Insert	View, Update, Insert	View
Equipment Has Equipment	View	View	View	View
Group Assignment	View	View	View	View
Has Archived Corrosion Analyses	View, Update, Insert, Delete	View, Update, Insert, Delete	View, Update, Insert, Delete	View
Has Archived Corrosion Analysis Settings	View, Update, Insert, Delete	View, Update, Insert, Delete	View, Update, Insert, Delete	View
Has Archived Subcomponent Analysis Settings	View, Update, Insert, Delete	View, Update, Insert, Delete	View, Update, Insert, Delete	View
Has Archived Subcomponent Corrosion Analyses	View, Update, Insert, Delete	View, Update, Insert, Delete	View, Update, Insert, Delete	View
Has Corrosion Analyses	View, Update, Insert, Delete	View, Update, Insert, Delete	View, Update, Insert, Delete	View
Has Corrosion Analysis Settings	View, Update, Insert, Delete	View, Update, Insert, Delete	View, Update, Insert, Delete	View
Has Datapoints	View, Update, Insert, Delete	View, Update, Insert, Delete	View, Update, Insert, Delete	View
Has Inspections	None	None	None	View
Has Measurements	View, Update, Insert, Delete	View, Update, Insert, Delete	View, Update, Insert, Delete	View
Has Roles	View, Update, Insert, Delete	View	View	View
Has Task Execution	View, Insert	View, Insert	View	View
Has Task Revision	View, Insert	View, Insert	View	View
Has Tasks	View, Insert	View, Insert	View, Insert	View
Has TML Group	View, Update, Insert, Delete	View, Update, Insert, Delete	View	View
Is a User	View	View	View	View
User Assignment	View	View	View	View