Technologies / Innovative Solutions / Integrations - BMS

Integrating with Clockworks BMS: Set-Up Procedure

Sample Data

If you wish to explore this feature by first working with sample data, use Data Transfer to import the sample data in the : …./public/dt/26.3.001/sample-data/clockworks/ folder.

The sample data includes:

• BMS analyses configured to import equipment diagnostics and auto-create work requests

• Sample SLAs (The sample SLAs govern how the automatically-created work requests are processed.)

• Sample Equipment Standard and Equipment records that exist in Clockworks but not in Archibus.

Set-up Procedure

1. Configure the environment to connect to the Clockworks BMS external system, so that Archibus APIs can retrieve diagnostics. Contact Clockworks Analytics for the access token and complete the options in %archibus folder%/WEB-INF/config/clockworks.properties.

   • If you cannot configure your environment to connect to Clockworks, use Data Transfer to import the sample diagnostics and work requests in the prefixed order: They are also available in the sample data folder, referenced above.

2. Run Technologies / Innovative Solutions / Integrations - BMS / Configure BMS Analysis to configure each specific diagnostic. For example, for each diagnostic you can set the priority level at which Archibus will generate a work request and the Problem Type for the generated work request. See Configure BMS Analysis.

3. Enable the integration, which activates the connection to the Daily Clockworks API, by running System / Archibus Administrator - Application Configuration / Configure Application Parameters and setting these parameters:

   AbSolutionsWorkflow.ClockworksEnableBMSIntegration

   Set to 1 to activate the integration

   AbSolutionsWorkflow.ClockworksDaysToProcessDiagnostics

   The number represents how many days in the past the workflow rule should look for diagnostics and evaluate if it needs to generate a new work request. For example: you have scheduled to import diagnostics once a month (ex. 30 days), then this should most probably be set to a value <= 30 days to make sure you evaluate all the imported diagnostics from the past 30 days. However, you could exceptionally decide to evaluate more or less than 30 days if you know there may be some inconsistencies in the data; for example, you just deployed Clockworks and there might be some false/test data coming in initially.

4. Run System /Add-In Manager /Scheduled Workflow Rules and set the following workflow rules. You can set these workflow rules to run daily, weekly, or monthly at the desired time, depending how often you plan to import diagnostics.

   AbSolutionsViewExamples.bmsImportDiagnostics	Imports the data from Clockworks via an Archibus API connection
   AbSolutionsViewExamples.bmsCreateWorkRequests	Instructs the system to automatically create work requests. The exact criteria which determines if work requests are generated are determined in Step 2

Next Steps

• Once the workflow rule runs, view the imported diagnostics in Technologies / Innovative Solutions / Integrations - BMS / View Equipment Diagnostics History. See Equipment Diagnostic History Report

• Review the work requests generated from diagnostics.