Manage Analytic Instances

Lock an Analytic for Editing

You can view data associated with analytic instances, modes, and models without locking the analytic. However, if you want to modify an analytic, you must first lock it for editing to ensure that multiple users do not make conflicting changes.

About This Task

You must have edit permissions for SmartSignal analytics in order to lock an analytic for editing. If you only have view permissions, you can view analytic data, but you cannot lock it for editing.
Note: If you had an analytic locked for editing but your permissions were modified so that you no longer had edit permissions, you are unable to discard or deploy your changes. Another user with edit permissions can take edit control and either discard or deploy the changes.

Procedure

  1. Access a SmartSignal analytic.
    Note: Regardless of whether you access an analytic instance, mode, or model, when you lock it for editing, the entire analytic instance is locked for editing.
  2. Depending on whether the analytic is locked for editing by another user, select one of the following options:
    • If the analytic is not locked for editing by another user, select Edit.
    • If the analytic is locked for editing by another user, confirm that the user who has the analytic locked for editing is no longer editing the analytic, and then select Take Edit Control. When prompted, select Take Edit Control again.
    The table changes so that the values can be modified. If you took edit control from another user, any changes that user had in progress are transferred to you.
    Note: If you took edit control from another user and you do not want to keep the changes that user had in progress, you can select Actions > Discard Changes to remove the changes that were in progress.

Guided Setup

About This Task

Use this action to have a step by step workflow for configuring an analytic instance.

Procedure

  1. Lock for editing the analytic that you want to modify.
  2. Select Actions > Guided Setup
    The Tag Mapping page of the guided workflow appears providing the option to export the instance to an XLSX file for offline configuration using Excel. You can then use the option to import the tag settings from that file into your instance. You can also update the tags manually.
  3. After making changes, you can close the guided setup or continue by selecting the Check Tag Health button.
    If issues are detected by the tag health check, a new window is displayed containing the issues that were discovered and information that helps you to correct them. The following types of issues are identified:
    IssueRecommended Action
    Analytic tag alias not found in mapped APM tag listPerform one of the following actions:
    • Select Create APM Tag option in the Actions column.
    • Select Create All Missing Tags button in the table header to create all missing tags.

      The Create All Missing Tags button opens a window with a table containing all of the missing tags that allow you to confirm or update the tag settings that will be used.

    APM Asset Tag UOM is invalid for SmartSignal AnalyticView the recommendation provided in the Actions column.
    Analytic tag alias has a different time series link configured in the APM tagPerform one of the following actions:
    • Select Sync Source Tag option in the Actions column.
    • Select Sync Selected Source Tags button in the table header after selecting multiple tags with the issue.
    Output Tag will not be able to evaluate with the listed active input tagsPerform one of the following actions:
    • Select Deactivate Output Tag option in the Actions column.
    • Select Deactivate Selected Output tags button in the table header after selecting multiple tags to do them all at once.
    Note: The corrective actions options appear only when a specific issue is discovered, else the message Mapped tags are valid appears.

What To Do Next

The Mapped Tag page of the guided workflow appears listing any tags that were not successfully mapped due to issues with the setup. The page indicates what actions are recommended to result the issues. If there are no issues with the tag mapping, the Mapped tags are valid message appears and you can select the Train Model button to proceed with the next step.

The Model Training page of the guided workflow appears that allows you to specify the source of the training data and how the module reference data will be chosen, and which models to build. Select the Build Model button to trigger the execution of a job that performs these actions. A progress bar appears and the job results will be displayed after completion.

Based on the results of the model building, you can select Deploy Analytic to complete the guided setup. Once selected, a prompt appears for you to confirm whether you want to make the deployment active.

You can also select Close to close the guided setup return to the analytic instance grid view.

Bulk Modify Tag and Model Tag Settings Offline with Excel

About This Task

Use these steps to modify the values associated with an analytic instance tags when you want to leverage spread sheet functionality such as updating cells using copy and paste, formulas, and so on.

Procedure

  1. Lock for editing the analytic that you want to modify.
  2. Select to export the instance to an XLSX file for offline configuration using Excel. The file that is generated contains tabs for the instance, each model, constants, and a standard unit reference.
  3. Open the XLSX file and enable editing to perform your changes. The attributes that cannot be modified are greyed out in the sheet. Save your changes to the file.
  4. Select to update the tags using XLSX.
  5. When the upload completes, a grid displaying the changes that were identified will be displayed. Note that the changes are applied to the locked instance. You can use Discard Changes if you do not want to confirm the changes.
  6. Select Close to return to standard instance editing.

Modify Data in the Page for an Analytic Instance

Use these steps to modify the values associated with an analytic instance.

Procedure

  1. Lock for editing the analytic that you want to modify.
  2. Select any cell to modify the value.
  3. Optional: If you want to export the training data for the analytic instance to a .csv file, select Actions > Export Training Data To CSV.

    A .csv file containing the training data for the selected analytic instance is downloaded.

    Note: In the .csv file, for any time stamp that does not have a value for a tag, the displayed value is determined by the tag type:
    • For float, integer, boolean, and date data types, a NaN is displayed.
    • For the string data type, an empty string is displayed.

What To Do Next

When you have finished making changes, deploy the analytic instance.

Modify the Source Tag Field for a Tag in an Analytic Instance

The value in the Source Tag field for a tag in an analytic instance must match the value assigned to that tag by the time series data source. If these values do not match, complete the following steps to modify the Source Tag field value for the tag in an analytic instance.

Procedure

  1. Lock for editing the analytic that you want to modify.
  2. In the table, locate the tag for which you want to modify the Source Tag field value, and, in the Source Tag column, select .
    The Select APM Asset Tag window appears.
  3. In the window, either select a tag from the list or enter a value in the Predix Time Series Link box, and then select Select.
  4. When you have finished making changes, deploy the analytic instance.

Results

Once the changes are deployed, the source tag mappings are updated based on your modifications to the Source Tag field. You can view the deployed tag mappings for the instance in the 2. I/O Mapping section of the workspace for the analytic instance in the Analytics module.

Additionally, if you synchronize the analytic instance with its analytic template, any changes you make to tag mappings in the analytic instance are maintained.

Modify the Standard Unit of Measure for a Tag

In the SmartSignal Maintenance module, you can modify the standard unit of measure for a tag associated with an analytic instance.

Procedure

  1. Lock for editing the analytic that you want to modify.
  2. In the table, locate the tag for which you want to modify the standard unit of measure, and, in the Standard Units column, select .
    The window for modifying the standard units for the selected tag appears.

  3. In the Standard Units box, select a unit of measure.
  4. Select one of the following Convert Threshold Values toggle positions, and then select Save:
    Toggle PositionDescription
    OnUpdates the default unit of measure for threshold values for the analytic template to the unit of measure you selected. Threshold values are also rounded outward (that is, upper thresholds are rounded higher, and lower thresholds are rounded lower).
    OffDoes not update the default unit of measure for threshold values for the analytic template.

What To Do Next

When you have finished making changes, deploy the analytic instance.

Activate or Deactivate a Tag in a Deployment

In the SmartSignal Maintenance module, you can determine whether a specific tag associated with a deployment will be used in predictions and data modeling.

Procedure

  1. Lock for editing the analytic that you want to modify.
  2. In the table, locate the tag that you want to activate or deactivate, and, in the Active column, select or clear the check box to activate or deactivate the tag, respectively.
    Depending on whether you selected or cleared the check box in the Active column, the tag is activated or deactivated.

What To Do Next

When you have finished making changes, deploy the analytic instance.

Modify Constants for a SmartSignal Deployment

In the SmartSignal Maintenance module, you can modify the constants associated with a deployment.

Procedure

  1. Lock for editing the analytic that you want to modify.
  2. In the Actions box, select Settings > Edit Constants.
    The Edit Constants window appears.
  3. Modify the values as necessary.
  4. Select Close.

What To Do Next

When you have finished making changes, deploy the analytic instance.

Test an Analytic Instance

About This Task

Using the SmartSignal Maintenance module, you can test an analytic instance before deploying.

Procedure

  1. Lock for editing the analytic that you want to test.
  2. In the Actions box, select Health > Test Analytic.
    The Test Analytic window appears.

  3. Select one of the following options:
    • Analytic Output: Select this option if you want to use data that has already been processed by the analytic, and then select the date range for the test.
    • File: Select this option if you want to specify a data file that contains your test data, and then select or drop the file that must be used for the test.
  4. Select Continue.
    The progress window appears, displaying the progress of the job.
    Note: For additional information about the status of the job, you can select in the progress window.
    After the job is completed, the Test Analytic Results window appears, displaying the results of the job.
    Note: To view the results in the analysis, you can select the View Test Results in Analysis link.


  5. After you review the results, select Close.

Deploy a SmartSignal Analytic Instance

After you modify an analytic instance or model, you must deploy your changes for them to take effect.

Procedure

  1. Access a SmartSignal analytic.
  2. As needed, modify the analytic instance.
  3. When you have finished modifying the analytic instance, select Deploy.
    The Deploy window appears, displaying a box in which you can enter notes about your modifications to the analytic instance.
  4. Optional: In the Note box in the Deploy window, enter notes about your modifications to the analytic instance.
    Note: Any notes you enter appear when you view the analytic instance history.
  5. When you are ready to deploy your changes, select Deploy.

Results