Overview

About Application Analytics

In this section, analytic users such as data scientist and process engineer can find an overview of the Application Analytics.

The Application Analytics provides a cloud-based distributed computation application suite to provide a single place to package, configure, validate, deploy, schedule, and monitor analytics. It provides a framework to deploy and run analytics on the respective runtime environments such as Apache Spark, SmartSignal, and Predix .

The application provides services that can be extended to perform the following tasks:

  • Ingest a pre-configured analytic template to the catalog for the supported runtime environments.
  • Create the analytic template and upload the developed analytics for the supported runtime environments into the analytic catalog.
  • Search, sort, and filter analytic templates and deployments.
  • Configure analytic templates to add supporting documents, inputs, outputs, constants, and output events.
  • Create and configure asset filters for defining asset applicability.
  • Add deployment configuration using an existing analytic template.
  • Orchestrate analytic data flows using existing analytic templates.
  • Apply the deployment configuration to applicable assets. Then map inputs and outputs to the tags in the selected assets.
  • Schedule deployment jobs to automatically run in the configured runtime environment.

Architecture and Components

In this section, you will learn about the functional architecture and various components within the Application Analytics.

The different components of Application Analytics are shown in the following functional architecture diagram:



Application Analytics consists of the following primary components:
UI Widgets and Apps
The suite of visualization apps that enable you to add analytic templates to the framework's analytic catalog, configure the templates, reuse templates in orchestrations and deployments, configure and schedule deployment jobs to run in the selected analytic runtime.
Services
A suite of services that provides a standardized approach to upload analytic to deploy to various supported analytic runtimes. These services enable to get asset data for mapping your analytic inputs/outputs to applicable asset tags. They also provide the connectivity to the data providers such as Predix and Predix Essentials times-series, and Predix Essentials asset data for running analytics on applicable asset data and write back the generated outputs back into time-series and asset when needed.
Runtime
The environment for running the deployed analytic jobs. The runtimes currently supported are Predix, Apache Spark, and SmartSignal.

Prerequisites for Getting Started with Application Analytics

The getting started instructions for Application Analytics assumes that the following preconditions are met.

Tenancy Prerequisites

Before users can access the application analytics and services the system administrator must set up the tenant structure.

Your tenant must have access to the following services and features:

Predix Services

  • predix-timeseries
  • predix-analytics-framework
  • predix-event-hub
  • predix-insights

Features

Note: Refer to the respective runtime pre-requisites sections for enabling features related to each runtime.
  • Alerts > Manage Alerts
  • Analysis > Analytics-Create and Analysis-View
  • Analytics

    Following are the list of features for the supported runtime environments. You must select the ones that apply to your tenant. Access to runtimes depends on the initial tenant setup:

    • PowerDataFabric
    • Spark
    • SmartSignal
    • SOAR
    • AIR
    • Predix

    Default Permission Set Definitions

  • Asset > all
  • Audit Logs
  • Dashboard > Dashboard View, Update, Create
  • Templates > Alert Templates
  • Timeseries > all

Set Up the Analytics Functional User

Because of security considerations, prior to accessing analytic modules and apps, the tenant administrator must set up the analytics functional user. Without assigning the password for the functional user, the app modules and functionality will not be accessible.

Before You Begin

You have access to the newly setup tenant.

About This Task

You are required to do this the very first time you login. To set up the password, do the following:

Procedure

  1. Login to your tenant with the tenant administrator credentials.
  2. Select Setup to access the Setup page.
    Note: If you are setting up the password for the first time, you will be presented with a password setup boxes in the Analytics section of the page.
  3. Enter a new password, and then re-enter the password to confirm.
  4. Select Submit to save your changes.

Results

The analytics module and apps should be accessible within a few minutes after the functional user has been set up.

Analytic Development Prerequisites

As a data scientist or analytic developer, make sure you refer to the Developer section for analytic samples and understanding the computation logic provided there.

You may also need the following:

  • Access to Application Analytics samples in GitHub. Contact support if you need access to the sample analytics in GitHub.
  • Environment conducive to developing and testing analytics locally. The requirements may vary based on the runtime and programming language used to code.

Runtime Specific Reference Documentation

For more information on the analytic runtimes, refer to the documentation of the following runtime environments:
  • SmartSignal
  • Predix Analytics Runtime
    Tip: In the Predix Services documentation, access the Analytic Framework Service help, and then navigate to the Analytic Development Process topic.
  • Spark Analytics
    Tip: In the Operations Performance Management documentation, access the Developer Documentation, and then navigate to the Analytics Development in Java topic.