Scoring method template for illustrative purposes only

Health 8.1 Scoring Methods

Health Application supports 3 distinct scoring methods

1.Asset Health Score

•Weight based on Drivers and Factors

•Drivers and Factors are based on formulas

<br>

2.Criticality

•Formula based

<br>

3.Risk

•Formula based

<br>

Scoring method is associated with a set of assets using Query

<br>

Manual approach to integrate Health scoring method with Digital Twin Exchange

Exporting scoring method

1.Export the scoring method from Maximo Health or create from scratch using the example payload

2.Use Digital Twin Exchange web interface to create a product and upload content exported as JSON

3.Make sure to document specifics about the scoring method

<br>

Importing scoring method

1.Download the content from Digital Twin Exchange

2.Perform any preinstallation steps to consume the contents

3.Import the scoring method into Maximo Health

4.Apply asset query and activate scoring method

<br>

Health 8.1 Scoring Methods –Exporting a Scoring Method

1.Make sure API Key is available to connect to Health. If not, go to the Maximo Health Administration app and generate a new API Key for a user

2.Install a REST API client tool like POSTMAN

3.Identify the Scoring Method Id

•Send a GET request using the following URL to figure out id used by the method. Make sure to include apikey header with the API key value

<br>

https://&#60;maximo-health-hostname&#62;:&#60;port&#62;/maximo/api/os/MXAPIAHMETHODOLOGY?lean=1&ignorekeyref=1 &oslc.where=methodname=“&#60;method-name&#62;”&oslc.select=ahmethodologyid

<br>

where &#60;maximo-health-hostname&#62;is the name of host where Maximo Health Application is running, and port is the &#60;port&#62;number and &#60;method-name&#62;is the name of the method for which content need to be extracted

•Look for the ahmethodologyid value in the response

<br>

4.Extract the Scoring Method content

•Send a GET request using the following URL. Make sure to include apikey header with the API key value

<br>

https://&#60;maximo-health-hostname&#62;:&#60;port&#62;/maximo/api/os/MXAPIAHMETHODOLOGY/&#60;method-id&#62;?lean=1 &ignorekeyref=1

<br>

where &#60;method-id&#62;is the ahmethodologyid obtained from previous step

•Copy the response into a file called &#60;method-name&#62;.json

<br>

Health 8.1 Scoring Methods –Analyzing and Documenting Scoring Method

Once the scoring content is extracted, it must be analyzed for consumption by a customer. Use the following information to analyze the content and document for customers.

1.Identify the scoring method, whether it is for Health, Risk or Criticality and indicate that in the document. Note that Health scoring method involves multiple drivers and factors and document the weightage used for the drivers.

2.Check the query associated with the scoring method. A customer may or may not have this query in their system. Either instruct the customer to create the query prior to importing or change the query to AHISAMPLEQUERY in the JSON payload

•Look for the clausename attribute value in the scoring JSON content

3.Examine all the formula definitions included in the scoring method. A formula may have been constructed to use a custom attribute that may not be present in a customer Health Application system. If there are any custom attributes used, document how a customer can create these attributes and bring data related to this attribute into the Health Application.

•Look for curvalformula or normformulaattribute values in the scoring JSON content for Health scoring method

•Look for methodformula attribute values in the scoring JSON content for Risk or Criticality scoring method

4.Set the active attribute to false to make sure it is not active by default when imported

<br>

Health 8.1 Scoring Methods –Importing a Scoring Method

1.Make sure all prerequisite requirements to consume the scoring method are met. For ex: custom attributes, asset query etc. Refer to the documentation provided by the vendor that put the product in the Digital Twin Exchange.

2.Make sure API Key is available to connect to Health. If not, go to the Maximo Health Administration app and generate a new API Key for a user

3.Install a REST API client tool like POSTMAN

4.Create the scoring method

Send a POST request using the following URL, include the downloaded JSON content as payload. Make sure to include apikey header with the API key value and set the Content-Type header to application/json

<br>

https://&#60;maximo-health-hostname&#62;:&#60;port&#62;/maximo/api/os/MXAPIAHMETHODOLOGY?lean=1

<br>

where &#60;maximo-health-hostname&#62; is the name of host where Maximo Health Application is running, and port is the &#60;port&#62; number

5.Verify that the scoring method is successfully imported

•The POST response must indicate 200 success

•The scoring method must be present when viewed from Health Application

6.Update the query on the scoring method

7.Activate the scoring method

<br>