Configuring the Working Hours for the Asset Utilization (%) Calculation

[allen_h]

This document is part of the SystemLink Portal.

Configuring the Working Hours for the Asset Utilization (%) Calculation

The Advanced Asset Utilization Report returns utilization as a percentage, such as 75%.  The calculation for this is as follows:

Asset Utilization % = (Amount of time that the asset is marked as utilized) / (Total amount of time in Working Hours)

The default "Working Hours" has a Start Time of 09:00:00 (9am) and an End Time of 17:00:00 (5pm).

So if an asset was tracked as utilized from only 1pm to 5pm, its utilization for that day would be 50%.

Configure the Working Hours using the HTTP API Page

To update the default working hours for all asset utilization (%) calculations in Asset Manager, follow these steps:

1. Navigate to any page in Asset Manager.
2. Click the ? button in the top-right and select HTTP API.  This should bring you to a Asset Performance Management Web Service page.
   
   If not, then set the dropdown in the top-right to Asset Performance Management.
3. View the current startTime and endTime values for the Working Hours Policy.
   1. Scroll down to the GET /v1/policy item, and click it to expand it.
   2. Click the Try it out button.
   3. Click the Execute button.
   4. View the Response body section to view the startTime and endTime values.
      The example below shows the default startTime of 09:00:00 and endTime of 17:00:00.
      
4. Set your own startTime and endTime for the Working Hours Policy.
   1. Scroll down to the PATCH /v1/policy item, and click it to expand it.
   2. Click the Try it out button.
   3. Set the contents of the Request body like the following, except with your desired startTime and endTime:

      {
        "workingHoursPolicy": {
          "startTime": "07:00:00",
          "endTime": "19:00:00"
        }
      }

   4. Click the Execute button.
      The Server response section below the Execute button should now show a code of 204, if successful.
      
5. Repeat Step 3 to verify that the Working Hours Policy startTime and endTime has been updated correctly.

Create Customized "Advanced Asset Utilization" Reports Using Your Working Hours

This is a good method if you want to create multiple asset utilization reports that run with different working hours (e.g. different reports for different shifts).

Follow the instructions in the Customizing Asset Reports with JupyterHub topic, with the following notes:

• Customize the "Advanced Asset Utilization" report.
• Customize the code in the notebook (.ipynb) by changing the start time and end time variables.