Tenants

About SmartSignal Tenant Service Configuration and Runtime Engine Configuration

You can use the SmartSignal Tenant page to modify your service configuration as well as your runtime engine configuration. However, the default SmartSignal configurations are appropriate for most users in most scenarios. If you want to modify these settings, ensure that you contact APM support prior to doing so.

In the SmartSignal Tenant page, you can manage tenant memory in the Service Configuration section, and you can manage actual smoothing and adaptation settings in the Runtime Engine Configuration section.

The following table describes the components in the Runtime Engine Configuration section:

Box NameDescription
Smooth AlgorithmOne of the following algorithms used to discern significant data patterns:
Moving Average
The simplest of the available smoothing algorithms, this algorithm uses a moving window technique in which the system averages the data within each window to produce the filtered sample for each window. Although simple and computationally efficient, there is an inherent delay in the response of the algorithm that is proportional to the window size. Also, the presence of a spike in the input data will affect the output signal for the length of the window size.
Olympic
This algorithm is similar to the Moving Average algorithm, but the system does not use the maximum and minimum data samples for each window in the calculation of the average value. The resulting algorithm is computationally efficient and effective at removing spikes. However, it suffers from the same response delay as the Moving Average algorithm.
Smoothing Window (Points)The number of data points used for smoothing.
IRA Similarity ThresholdThreshold for triggering In Range Adaptation (IRA), which occurs when the current reading for a tag is significantly different from any reading for the model tag.
FSI Similarity ThresholdThreshold for triggering Fault Similarity Inhibition (FSI), which occurs when driver tags (that is, tags that are used to determine if a new operating state is occurring to trigger auto adaptation) diverge from the model more than tags that are not drivers.
Model Range Minimum InhibitionThreshold for triggering Model Range Inhibition (MRI), which occurs when tags experience rapid change. The lower the Model Range Minimum Inhibition value, the more frequently the threshold is triggered.
FSI IRA ParameterFault Similarity Inhibitor (FSI) detects changes in the behavior of non-driver sensors that may indicate a fault. The similarity factors of all driver tags and all non-driver tags are calculated and compared to each other.
Model Range Variability FactorA function of the ratio of the distance a model limit is from the corresponding Limit Value Inhibitor (LVI) and the LVI range.
Deployment Processing Status Timeouts
Not Processing: No data received in last (hours)
The number of hours that the runtime engine must wait to receive data for the analytic instance. If the runtime engine does not receive any data for the analytic instance within the specified number of hours, the processing state of the analytic instance is changed to Not Processing in the SmartSignal Deployments module.
Collection Configuration
Maximum Carry Forward Duration (minutes)
The maximum number of minutes a tag value is carried forward without being updated before it is reported as No Value.
% of updated tags required
The percentage of tags that must be updated within the specified vector wait time. If the collection type is Batch, no vector is delivered for the interval. For all other collection types, NaN is reported for all the tags that did not report a new value.
Vector wait time
The waiting period for the percentage of tags specified in the % of updated tags required box to be fulfilled before reporting NaN for the tags without a value.
Input Tag UOM Conversion

When enabled, the Runtime Engine automatically performs UOM conversion on the input tag that is read from the Predix Time Series, where the UOM configured in the Source Tag is different, yet compatible with the Standard Units configured in the SmartSignal Analytic instance.

When disabled, the Runtime Engine assumes that the input tag is already in the UOM that is configured in the SmartSignal Analytic instance.

Refer to the complete list of Input Tag UOM Conversion Categories and Names.

Configure Analytic Processing Status Notification

About This Task

This topic describes how to configure the email notification that is sent to the users who are subscribed to receive the processing summary reports for the deployed analytic instances. You can also configure the settings to generate the reports at specific intervals and send the detailed reports to the subscribed users.

Procedure

  1. In the Applications menu, navigate to the RELIABILITY section, and then select SmartSignal Tenant.
    The TENANT INFORMATION page appears.
  2. Select Config.
    A page appears, displaying the options to configure the tenant.
  3. Select Analytic Processing Notification.
    The Analytic Processing Notification section appears.
  4. As needed, specify values in the following fields.
    Field NameAction to be Performed
    SEND ANALYTIC INSTANCE PROCESSING STATE NOTIFICATIONSelect the check box if you want to send the notifications containing the processing statuses of the analytic instances to the subscribed users.
    SUBSCRIBED USERSDisplays the number of the users who are subscribed to receive the notifications containing the processing statuses of the analytic instances.
    SEND EMAIL NOTIFICATION EVERYSelect the time interval at which you want to send the notifications to the subscribed users.
    EMAIL SUBJECTEnter a subject line for the email notification.
    MESSAGEEnter a message that you want to send to the subscribed users.
    ATTACH ANALYTIC DETAIL REPORTSelect the check box if you want to attach a detailed report containing the processing status of each analytic instance of the tenant. The following check boxes are enabled:
    • ATTACH EVENTS REPORT
    • Successfully Processing
    • Partial Processing
    • Not Processing
    • Not Loading
    ATTACH EVENTS REPORTSelect the check box if you want to attach a report containing the recent analytic processing events to the email notification.
    Note: The check box is enabled if the ATTACH ANALYTIC DETAIL REPORT check box is selected.
    INCLUDE IN THE NOTIFICATION WHEN ANALYTICAs needed, select the following check boxes:
    • Successfully Processing

      If selected, the notification will contain the analytic instances that are successfully processed.

    • Partial Processing

      If selected, the notification will contain the analytic instances that are partially processed.

    • Not Processing

      If selected, the notification will contain the analytic instances that are not processed.

    • Not Loading

      If selected, the notification will contain the analytic instances that are not loaded.

  5. Select Save.
    The analytic processing status notification is configured.

Set Up a SmartSignal Tenant

You can enter the APM Tenant Credentials for a new SmartSignal Tenant in the Tenant Management page.

Before You Begin

Procedure

  1. In the Applications menu, navigate to the RELIABILITY section, and then select SmartSignal Tenant.
  2. Select Setup Tenant.
  3. Enter the Tenant Name.

Note: If your tenant requires a SmartSignal cloud-based runtime engine, complete the following step. If your tenant does not require a SmartSignal cloud-based runtime engine, skip the following step.

  1. For tenants that require the SmartSignal cloud-based runtime engine:
    1. Ensure that the Requires SmartSignal Runtime toggle is switched to the on position.
    2. If a SmartSignal host is associated with this tenant, select a value in the SmartSignal Host box, and then enter the appropriate value for the selected host in the Asset Group ID box.
  2. For tenants that do not require the SmartSignal cloud-based runtime engine:
    1. Ensure that the Requires SmartSignal Runtime toggle is switched to the off position.
    2. Select a SmartSignal host in the drop-down list box, and then enter the Asset Group ID for the selected host.
  3. Select Add.
    The Tenant Credentials page appears.
  4. In the Tenant Credentials page, enter the necessary values, and then select Update.
  5. Select Back to return to the Tenant Management page.

Modify SmartSignal Tenant Credentials

You can modify a SmartSignal tenant in the SmartSignal Tenant Management page.

Procedure

  1. In the Applications menu, navigate to the RELIABILITY section, and then select SmartSignal Tenant.
  2. Select Config.
  3. Select Credential Configuration.
  4. As needed, modify values in the following boxes.
    Box NameDescription
    APM Token ServiceEnter the updated APM token service URL.
    Client IdEnter the updated client Id.
    Client SecretEnter the client secret.
    Grant TypeEnter the grant type password.
    User IdEnter the updated user Id.
    PasswordEnter the updated password.
    Escalated Incidents OnlySelect the check box only if this is an escalated incident.
  5. When you have finished modifying the credentials, select Validate Credential.
  6. Once the credentials are validated, select Update Credential.
    Your modifications are saved.

Associate a SmartSignal Tenant with a Host

You can associate a SmartSignal host with a SmartSignal tenant.

Procedure

  1. In the Applications menu, navigate to the RELIABILITY section, and then select SmartSignal Tenant.
  2. Select Config.
  3. Select Associate Host.
  4. In the SmartSignal Host box, select a host.
  5. Enter a value in the Asset Group ID box.
  6. Select Add.

Results

A message appears, indicating that the host is successfully associated with the tenant, and the host name is added to the Host List section in the SmartSignal Global Host Management page.

Remove a Host Association from a SmartSignal Tenant

You can remove a host that is associated with a SmartSignal tenant.

Before You Begin

Ensure there are no existing analytic instances associated with the host. If you try to delete the tenant binding when there are associated analytic instances, the delete action fails, and a failure message appears.

Procedure

  1. In the Applications menu, navigate to the RELIABILITY section, and then select SmartSignal Tenant.
  2. Select Tenant Management.
  3. In the Host List section of the Tenant Management page, next to the name of the host that you want to delete, select .
  4. When a message appears, asking you to confirm that you want to delete the host, select Yes.

Results

A message appears, indicating that the host is successfully removed from the tenant, and the host name is removed from the Host List section in the SmartSignal Global Host Management page.