Analytics

Predix Edge Analytics enable you to upload the analytics runtime engine, template, and data map and deploy these to Predix Edge devices.

Analytic Engine

To successfully run analytics on the edge device, a supported analytic engine must be deployed to the device. (See Deploying Edge Apps for instructions.) Predix Edge currently supports two analytic engines – Csense and Foghorn.

Upload an Analytic Engine:
- Csense and Foghorn engines are regular Predix Edge Apps that can be uploaded to the Edge Manager repository as a Predix Edge platform application.
Deploy an Analytic Engine:
- Deploy the uploaded engine to a device or set of devices as you would for any other Predix Edge application.

Once the analytic engine is successfully deployed to a device, the Analytics tab should appear on the Device page. At this point, analytic templates and data maps can be deployed to that device.

Analytic Templates and Data Maps

Once a device has an analytic engine successfully running, analytic templates and data maps can be deployed. Templates must be uploaded and deployed before data maps, which rely on the templates.

Upload
- Analytic Template:
  1. Go to the Repository page.
  2. Click the Action drop-down menu.
  3. Select Upload.
  4. Enter a Name and Version for the analytic template package.
  5. Select Type > Analytics Template.
  6. Select Platform > Predix Edge.
  7. Capabilities is a field that defines any capabilities the package depends upon to run. In this case, analytic templates will run successfully only if there is an analytic engine on the device. The analytic engines listed above that are supported by Predix Edge will provide one of two capabilities (Predix.Edge.AnalyticEngine.CSense or Predix.Edge.AnalyticEngine.Foghorn). Add the corresponding capability in the Capabilities field when uploading the analytic template. A single template should be able to run on only one of the engines (i.e., a Foghorn template cannot run on the CSense engine and vice versa).
  8. Select the File, which is the analytic template to upload.
  9. If the analytic engine requires a handler, enter it in Package Handler.
  10. Click Upload.
- Analytic Data Map:
  1. Go to the Repository page.
  2. Click the Action drop-down menu.
  3. Select Upload.
  4. Enter a Name and Version for the analytic data map package.
  5. Select Type > Analytics Data Map.
  6. Select Platform > Predix Edge.
  7. Select the Target Template to which the data map should be tied.
  8. The Capabilities and Package Handler fields are identical to the capabilities and handler that were specified when uploading the analytic template, and therefore appear as read-only fields when uploading the analytic data map.
  9. Select the File, which is the analytic data map to upload.
  10. Click Upload.
Deploy to Multiple Devices
- Analytic Template:
  1. Go to the Device Manager page.
  2. Click the Device Operations drop-down menu.
  3. Select Deploy Template.
  4. Select Predix Edge as the platform type on the top right.
  5. Select the appropriate analytic template and version.
  6. Click Schedule.
  7. Enter the Date and Time for deployment, the desired Timeout period and select the Application ID of the analytic engine to which the template should be deployed.
  8. Click Submit.
- Analytic Data Map:
  1. Go to the Device Manager page.
  2. Click the Device Operations drop-down menu.
  3. Select Deploy Data Map.
  4. Select Predix Edge as the platform type on the top right.
  5. Select the appropriate analytic data map and version.
  6. Click Schedule.
  7. Enter the Date and Time for deployment, the desired Timeout period and select the Application ID of the analytic engine to which the data map should be deployed.
  8. Click Submit.
Deploy to a Single Device
- Analytic Template
  1. Go to Device Manager > Devices.
  2. Select the device to which the template should be deployed.
  3. On the device details page, select Analytics. If the Analytics tab does not appear, you must deploy the analytics engine for the device and ensure it is running.
  4. Click the Deploy Analytics drop-down menu.
  5. Select Deploy Template.
  6. Select the appropriate analytic template and version.
  7. Click Schedule.
  8. Enter the Date and Time for deployment, the desired Timeout period and select the Application ID of the analytic engine to which the template should be deployed.
  9. Click Submit.
- Analytic Data Map
  1. Go to Device Manager > Devices.
  2. Select the device to which the data map should be deployed.
  3. On the device details page, select Analytics. If the Analytics tab does not appear, you must deploy the analytics engine for the device and ensure it is running.
  4. Click the Deploy Analytics drop-down menu.
  5. Select Deploy Data Map.
  6. Select the appropriate analytic data map and version.
  7. Click Schedule.
  8. Enter the Date and Time for deployment, the desired Timeout period and select the Application ID of the analytic engine to which the data map should be deployed.
  9. Click Submit.

Analytic Template Status

This feature allows you to see analytic template details and control the templates.

Go to Device Manager > Devices.
Select the device.
Select Analytics. This will display a list of the analytic engines deployed to the device.
Note: If an analytic engine is running, but no analytic templates have been deployed, no information will be displayed on the Analytics tab.
Click an engine to list its deployed analytic templates.
For each template you will see:
- Template Name: the name specified when the template was uploaded.
- Version: the version specified when the template was uploaded.
- Status: will indicate if the template is Running or Stopped.
- Description: if a description of the template was specified when it was uploaded, it will appear here.
- Data Map: the data map deployed with the template on the device.
- Action: here you can Start the template; Stop the template; or Delete the template (using the trash can icon).