Configure the way your system performs different tasks.
Before you begin, set up equipment assets and monitoring devices.
Complete the following tasks according to your customization goals.
-
Configuring Alarms— Set alarms to monitor unusual activity and configure alarms to send email alerts.
-
Learn about device communication and configuration—Review, update, and configure your devices for your condition-monitoring needs.
-
Learn about data sources—Learn which data sources InsightCM supports.
-
Modify an asset type—Modify properties, default trend alarm rules, and default fault frequency sets for all assets of a specific type.
-
Learn about operating states—Use operating states to set different collection settings and/or alarm levels for your assets.
-
Add fault frequencies—Configure fault frequencies for different assets on the Asset Configuration page and view them with spectrum data in the data viewer.
-
Assign features—Specify what features you want an asset to calculate.
-
Batch editing assets—Edit multiple assets at one time using an exported spreadsheet.
-
Validate sensor data—Ensure that sensors are returning valid data.
Set alarms to monitor unusual activity and configure alarms to send email alerts.
Before you begin, configure your asset tree, add Cutsforth monitoring devices, and acquire data.
Devices continuously evaluate alarm rules. However, some devices either do not have the ability to evaluate the alarm rule or do not take continuous measurements. With the exception of Low Rate Feature Trend Alarms, the server evaluates alarm rules wherever data is received from the device.
Configure alarms to trigger based on equipment activity.
-
Configure an alarm rule.
Monitor the condition of your equipment by configuring trend alarm rules that indicate when an asset enters a severe state.
Configure an alarm for spectral frequencies to monitor the energy level of each frequency.
-
Set up email notifications–Receive immediate notification of assets entering a severe state by directing InsightCM to send you email notifications.
-
Acknowledge trend data–Move an alarm instance from Active Trend Alarm to a log of alarm instances without clearing the instance.
-
Learn conditions for setting and clearing alarms–Familiarize yourself with when and how InsightCM sets and clears alarms and determine if you want to refine an alarm rule with hysteresis, on and off delays, custom file lengths, and pre-triggers.
Define trend alarm rules either by asset types or by auto-configuring levels.
Configure a trend alarm rule for an equipment asset.
Before you begin, assign at least one feature to the asset for which you are configuring a trend alarm rule.
A trend alarm rule is a group of settings that causes InsightCM to set an alarm based on trend behavior. In most cases, you will configure trend alarm rules for each sensor asset, but you configure trend alarm rules directly on MCSA equipment assets. To set a trend alarm rule, define levels of severity for data that will set the alarm. You can manually configure these levels or auto-configure them using a baseline of data.
-
Click the Configuration button (
) to navigate to the Asset Configuration page. -
In the right side configuration panel, select the Trend Alarms tab.
-
Click Add to display the Trend Alarm Rule dialog.
-
In the top left corner of the dialog box, use the pull-down menu to choose a feature you want to apply.
-
In the adjacent pull-down, specify whether this alarm trips for trend values that are greater than or less than the compared value.
-
Using the Operating State pull-down menu, choose whether the rule applies to all operating states or to one specific operating state.
-
Use one of the following two methods to define severity levels for the trend alarm rule.
-
If you use auto-configured levels, set a baseline.
-
Click the Calendar button to bring up the Select Date Range dialog.
-
Define a range of dates in the Start and End text fields with data you want to use to calculate a baseline. Click OK. Narrow the data set by clicking and dragging to zoom into a portion of the timeline. Double-click the graph to zoom out again.
-
Click Set Baseline.
-
Severity is a user-defined value that can be useful for setting the priority of an alarm condition. Use low severity for conditions that are outside normal operating parameters but still within acceptable limits. Use high severity for conditions where an analyst should review the data as soon as possible.
When an alarm is triggered, the server retains the data sets from that event. The server keeps track of the maximum severity for the alarm instance. Whenever a new maximum severity is tripped, the server retains the corresponding data sets. However, when an alarm transitions between severities, the server only retains the trend point data.
Use trend baselines to auto-configure severity levels for an alarm rule.
Before you begin, collect data from the asset for which you are configuring an alarm rule.
-
Click the Configuration button (
) and select a sensor-level asset. -
In the configuration pane, select the Trend Alarms tab.
-
Find and select an alarm and click Edit.
-
Select a feature and operator combination you want to auto-configure severity levels for.
-
Select an operating state using the Operating State pull-down menu.
-
Check the Auto-configure levels from baseline checkbox to activate a new Edit button.
-
Click the Edit button.
-
Choose a calculation type using the corresponding pull-down menu.
-
Add severity levels and click OK.
-
Below the table of severity levels, click the calendar button to use data collected within a certain date range as your baseline.
-
Click OK to select the date range and to activate the Set Baseline button.
-
Click Set Baseline and OK to save your changes.
The alarm you have just modified now has severity levels that InsightCM has configured based on collected data.
Determine the minimum range of data that the web application should use to calculate a baseline.
|
Option |
Description |
|---|---|
|
Minimum Trend Points |
Specifies the minimum number of trend points used to calculate a baseline. |
|
Minimum Days |
Specifies the minimum number of days over which data must be collected before calculating a baseline. |
|
Minimum Standard Deviation |
Specifies a standard deviation to replace the actual standard deviation of the baseline if the actual standard deviation goes below this value. |
Specify a threshold above or below the severity level that sets an alarm to reduce alarm instances from a noisy signal.
Before you begin, configure a trend alarm rule.
Configuring hysteresis is useful for preventing an alarm from clearing immediately after it is set. To learn more about hysteresis, refer to Conditions of Setting and Clearing Alarms. Specify an offset value from the Compare To value that clears an alarm.
The alarm rule that you have modified now clears an alarm when trend values cross the threshold for the hysteresis you specified.
If you want to refine the conditions for setting an alarm further, consider configuring an on and off delay.
Specify a time delay before InsightCM sets or clears an alarm to reduce alarm instances from a noisy signal.
Before you begin, configure a trend alarm rule. Configure hysteresis before configuring Off Delay.
On Delay specifies the amount of time that trend values must remain above the Compare To value before InsightCM sets an alarm. Off Delay specifies the amount of time that trend values must remain below or above the Compare To, or at the hysteresis value, before InsightCM clears the alarm. To learn more about On Delay and Off Delay values, refer to Conditions for Setting and Clearing Alarms.
Complete the following steps to set an On Delay or Off Delay value for an alarm.
The alarm rule that you have modified will now delay the setting and/or clearing of an alarm instance by the amount of time you specified.
Specify file lengths for data that you want your monitoring devices to collect when asset conditions set a higher severity alarm.
Before you begin, configure a trend alarm rule.
InsightCM uses the value you specify for the file length to determine the size of the data collection when asset conditions set an alarm and cross a higher severity threshold.
Complete the following steps to specify a file length for the data collected for an alarm.
-
Click the Navigation menu (
) and select Alarms > Trend Rules. -
Find and select the trend rule to configure its custom file length.
-
At the bottom of the dialog, uncheck the Use default collection length checkbox to activate the File Length text field.
-
Use the File Length text field to specify how many seconds of data InsightCM will collect when conditions set a higher severity alarm.
The alarm rule you have just modified now collects trend data files for the length of time you specified for File Length.
Delay the start of data collection when asset conditions set a higher severity alarm.
Before you begin, configure a trend alarm rule.
InsightCM uses the value you specify for the pre-trigger length to determine how long after asset conditions set an alarm and cross a higher severity threshold to wait before collecting data.
Complete the following steps to specify a pre-trigger length for an alarm.
-
Click the Navigation menu (
) and select Alarms > Trend Rules. -
Find and select the trend rule for which you want to specify a pre-trigger value.
-
At the bottom of the dialog, uncheck the Use default collection length checkbox to activate the Pre-Trigger text field.
-
Use the Pre-Trigger text field to specify how many seconds InsightCM will wait after asset conditions set a higher severity alarm before collecting data.
The alarm rule you have modified now waits the length of time you specified for the pre-trigger before collecting data.
Define a trend alarm rule for all assets of a certain type.
Edit an asset definition to configure a trend alarm rule for all assets of a certain type.
Note
The changes you make to the definition of an asset type will apply to all applicable current and future assets.
-
Click the Navigation menu (
) and select Systems > Asset Definitions. -
Select a definition to edit and click the Trend Alarm Rules tab.
-
Click Add to display the Trend Alarm Rule dialog box.
-
Choose the feature you want the rule to apply to from the pull-down menu in the dialog box.
-
In the adjacent pull-down, specify whether this alarm triggers for trend values that are greater than or less than the compare value.
-
Choose the operating state to which you want this trend alarm to apply using the Operating States pull-down menu.
-
Use one of the following two methods to set levels for the trend alarm rule.
-
If available, use the following options to override the collection settings determined by an operating state.
-
User default collection length—Uncheck this option to enable the File Length and Pre-Trigger Length options. InsightCM uses the values you set for these options when the alarm condition is triggered and when the alarm severity changes.
-
File Length—Specify how many seconds of data to collect while the alarm rule is active.
-
Pre-Trigger Length—Specify how many seconds of data to collect before the event that triggers the alarm rule.
-
Configure an alarm for spectral frequencies to monitor the energy level of each frequency.
Before you begin, ensure that you have collected data from the sensor asset you are setting a spectral alarm for.
Note
Spectral alarm rules are only calculated on the server.
A spectral alarm rule allows you to set alarms for every frequency of a spectrum to ensure that the energy level at each frequency is acceptable.
Complete the following steps to configure a spectral alarm rule for a sensor asset.
-
Click the Configuration button (
) to navigate to the Asset Configuration page. -
Select the sensor asset you want to configure a spectral alarm for.
-
Click the Spectral Alarms tab and click Add to display the Spectral Alarm Rule dialog box.
-
Choose an operating state and integration type.
-
Select a data event from the list.
-
Expand the Add Level pull-down menu and select the severity level you want to specify.
-
Draw the line representing the severity level on the graph.
-
Using the preview line, align your cursor to the g rms height with the corresponding length of the waveform and click to set the severity level.
-
For data that fluctuates along the length of the waveform, raise or lower your cursor, move it along the length of the waveform, and click to set the same severity level for another section of the waveform.
-
-
Click the checkmark button to commit the line of severity levels you have drawn.
-
In the top right corner of the dialog, click Done.
-
Repeat steps 5 through 9 to configure additional alarm levels as needed.
-
Click OK to save your changes.
Operating states set different collection settings and/or alarm levels for your assets.
For many assets, it is useful to define discrete operating states that have different collection settings and/or alarm levels. For example, if a motor is running, you may want to collect data more frequently than when the motor is idle or off. Consider the following examples of operating states turbine which has a tachometer sensor with a speed feature.
|
Operating States |
Settings |
|---|---|
|
Run-Up |
|
|
Default |
Defining an operating state for unique equipment conditions allows the device to dynamically switch between collection behaviors. As the Run-Up operating state in the previous example shows, operating states express a condition to enter the state and a condition to exit the state. While in the state, the collection settings and conditions can be configured differently than when the asset is in the default state.
The metadata pane on the Data Viewer page displays the operating state that was active when the device collected the data.
Change operating states that you can assign to an alarm.
-
Select the Navigation menu (
) and select System > Operating States. -
Select an existing operating state and click Edit.
-
Adjust the name and weight of the operating state as needed.
-
Create additional operating states by clicking the Add button and specifying the name and weight of the new operating state.
Use gating conditions to prevent data from being acquired when the condition is not met.
When you enable a gating condition for an operating state, the server evaluates each data set collected under that operating state to see if the gating condition is true. For example, you might want to store data sets only when the equipment is running as indicated by an RMS above 0.1 g. If the gating condition is true for a data set, the server stores the data set. Otherwise, the server discards the data set.
Note
The gating conditions set for an operating state do not affect burst mode data sets. Instead, burst mode data sets are evaluated for gating conditions set in the Burst Mode Collection Conditions section on the Device Properties tab of the Device Configuration page.
You can define one or more delta EU triggers that initiate an acquisition when a feature or spectral band changes by at least a specified amount. Both positive and negative changes in value cause a delta EU trigger to fire.
Note
If the device is unable to calculate the spectral bands on the device, the delta EU triggers will not fire on the bands.
This setting can be found on the Operating States Tab of the Asset Configuration page.
The following process explains how the InsightCM Server monitors delta EU triggers.
|
Device Action |
Example |
|---|---|
|
When a device starts running, it sets the current value of the feature or spectral band as the baseline EU value. |
Consider a feature whose value is 1 upon startup. The baseline EU value is therefore 1. |
|
The device monitors the feature value regularly and compares it to the baseline value to check for a difference greater than the trigger level. |
Consider a delta EU trigger with a delta level of 3. Given the baseline EU value of 1, the device checks for values less than -2 and greater than 4 to see if the trigger condition is met. |
|
If the current value increases or decreases by the delta level, the trigger fires and the device performs an acquisition. |
If the current value is 8, the device performs one acquisition. |
|
The device sets the value that caused the trigger to fire as the new baseline value. |
The new baseline EU value is 8. |
|
The device continues to calculate the feature value to see if the difference from the baseline is greater than the delta level. |
Given the new baseline of 8, the device checks for values less than 5 and greater than 11. |
Only the initial start-up value and values that cause delta EU triggers to fire can serve as the baseline EU value. In other words, when a device performs a time-, alarm-, or force-triggered acquisition, the device does not update the baseline EU value with the feature value from that acquisition.
An electric motor has discrete operating states such as On (Default), Startup, and Off. The following table lists the default operating states of MCSA devices.
Cutsforth Monitoring Devices continuously or wirelessly monitor data from equipment. However, these devices collect and log data only when initiated by one of several types of triggers.
Use one of the following triggers to collect and log data.
Either the software on the devices or the server automatically initiates a data set collection when the following triggers fire.
Use Case
|
Type |
Description |
Where to Configure |
|---|---|---|
|
Time Interval |
Collect a data set at specific times of day or intervals of time. Ensure that trends are complete enough to provide a useful display of machine conditions. |
Operating States tab on the Asset Configuration page |
|
Delta EU |
Collect a data set when a feature or spectral band value changes by a specified amount. Ensure data is collected at the time that a rapid change in measurements occurs. |
|
|
Enter Condition |
Collect a data set when the enter condition for an operating state is met. View the measurements from the time that equipment changed its status. |
|
|
Exit Condition |
Collect a data set when the exit condition for the operating state is met. View the measurements from the time that equipment changed its status. |
|
|
Alarm Set |
Collect a data set whenever an alarm condition is met. Access data from the time an alarm condition occurred. |
Alarms page |
|
Alarm Clears |
Collect a data set whenever an alarm clears. Access trend point data from the time an alarm condition ends. |
|
|
Burst Mode |
Collect high-resolution data sets at specific times of day or intervals of time. Troubleshoot equipment with data that may indicate an issue. |
Device Properties tab on a device's configuration page |
The variety of triggers available in the InsightCM Server means that devices can perform collections more frequently than the standard time-based intervals. Consider a device whose configuration includes the following settings.
What happens to the device while burst mode is active?
The device suspends normal operation and does not check for changes, such as alarms or operating states, for about 30 seconds before and after acquiring high-resolution data to allow the acquisition anti-aliasing filters to settle.
What happens to high-resolution data if the device cannot connect to the server?
By default, InsightCM discards high-resolution data if the device cannot connect to the server.
Collect data by using force trigger and view a periodic acquisition.
Complete the following steps to force trigger and view a periodic acquisition.
-
Click the Action menu (
) on the Trend viewer toolbar and select Force Trigger. -
If the Trend viewer already contains curves for the features or sensors of interest, click the Refresh trend data button (
). You might need to wait several seconds to see force-triggered data in viewers because devices must perform the periodic acquisition, and then InsightCM must receive and store the data.
To view new trend values and sensor measurements between scheduled periodic acquisitions, you can manually request that a device perform an acquisition. These requests are known as force triggers. Force triggers are useful when you want to view current asset data without waiting for the next scheduled acquisition.
You can perform a force trigger from the Action menu () on the Trend viewer toolbar on the Data Viewer page or on the Devices or Device Dashboard page.
What Is the Duration and Sampling Rate of the Acquisition?
Devices perform force-triggered acquisitions according to the sampling rate, duration, and other periodic-acquisition settings configured in the web application.
Do Force Triggers Affect Regularly Scheduled Periodic Acquisitions?
No. Force-triggered acquisitions do not affect the timing of scheduled periodic acquisitions that devices perform.
Schedule a high-resolution data acquisition on a device.
Complete the following steps to schedule high-resolution data acquisition on a device:
-
Click the Configuration pull-down (
) and select Devices. -
Double-click a device and select the Device Properties tab.
-
Select the Enable burst mode checkbox.
-
In the Burst Collection Conditions section, click Time.
-
In the Edit Condition dialog box, specify how frequently to acquire high-resolution data.
-
In the Burst Collection Settings section, specify the sample rate in Hz and acquisition length in seconds that you want InsightCM to use for the scheduled high-resolution data acquisition.
-
Update the device configuration.
Configure InsightCM to send alarm notification emails.
Before you begin, configure your role with serverSettings_edit permissions, create an address group, and create an email template. Refer to Relationships Between User Accounts and Permissions for more information about permissions.
-
On the server machine, in File Explorer, navigate to the ProgramData\Cutsforth\InsightCM\Auth folder.
-
Open the SmtpConfiguration.json file in a text file editor.
-
Modify each line category according to your server information.
"Host": "<servername>","Port": "<port number>","UseSsl": <true or false>,"RequireAuthentication": <true or false>,"Username": "<username>","Password": "Secret\\Password", "Secret\"Password"Note
If your password contains backslashes or double quotations, you must use double backslashes or a backslash and double quotations respectively as shown in the above example.
"TimeoutSeconds": <number>,"FromAddress": "yes-reply@localhost","TestMode": <true or false> -
Save the .json file and open Windows Services.
-
Find and select InsightCM <version> and click Restart.
Add an email template and address group to an alarm.
Create and maintain lists of email addresses to which InsightCM sends alarms and other notifications.
If there are several users that need to receive certain email notifications, create an address group. Use address groups to keep a diverse portfolio of users informed regarding the state of InsightCM or the equipment it is monitoring. Complete the following steps to create a new address group and assign the group to an alarm rule.
Note
To customize the email sent for a specific alarm rule, create an email template and assign it to the alarm rule. Refer to Creating Email Templates to learn how to do so.
-
Click the Navigation menu (
) and select Options. -
Navigate to the Notifications section, select Address Groups,and click the Add button.
-
Enter a name for the address group in the Name text box.
-
Enter valid user email addresses and separate each email address with a comma, new line, space, or semicolon.
-
Configure the level of visibility that individual users have regarding other recipients of the same email notification by using the various recipient text boxes.
-
Click OK to add the new address group to the Selected Group pull-down list.
Create templates for email notifications that the InsightCM Server sends when an alarm is set.
-
Click the Navigation menu (
) and select Options. -
Scroll down to the Notifications section and select Email Templates.
-
Select the default option from the Template pull-down.
-
Click the Edit button to give the email template a descriptive name and click OK.
-
Write a brief description of what information this template will send about an alarm.
-
Write an informative subject line for the email template.
-
Write the contents of the email and click OK.
Note
Define email templates independently of address groups to pair one address group with multiple email templates or one email template with multiple address groups. You may want to notify a single individual when a low-severity alarm occurs, but notify several individuals with the same message when a high-severity alarm occurs.
Assign an email template to an alarm level.
Before you begin, create an email template and create an address group.
-
Click the Navigation menu (
) and select Alarms. -
Select an alarm and click Edit.
-
Under Levels, select an alarm severity level and click Edit.
-
Select the Send Email checkbox.
-
Select an address group.
-
Select an email template.
-
Click OK.
Use the console to test whether InsightCM sends email notifications successfully.
Before you begin, set up email alarm notifications.
-
On the server computer, open Command Prompt.
-
Navigate to the folder in which InsightCM is saved using the following command:
cd C:\Program Files\Cutsforth\InsightCM
-
Execute the following commands to test email notifications:
InsightCMConsole.exe sendtestemail -grp [address group name]
-
Verify whether a test email notification is sent to those in the address group.
View the relevant data for and acknowledge a trend alarm.
-
Click the Navigation menu (
) and select Alarms > Active Trend. -
Select an alarm and click View to see the relevant Trend viewer data in the Alarm dialog.
-
Click Acknowledge.
As a result, you moved the alarm instance from the Active Trend Alarm tab to the Alarm Instances dialog, though you did not clear the instance.
Alarm states and whether you acknowledge or clear the alarm determine the notification behavior of your configured alarms.
Once you begin collecting data, define conditions that set or clear an alarm. Alarms can have a combination of the following states.
|
Set |
InsightCM detected that conditions for an alarm rule have been met and created an alarm instance. |
|
Acknowledged |
A user indicated awareness of the alarm. |
|
Clear |
InsightCM detected that the alarm rule is no longer true. A cleared alarm remains on the Active Trend Alarms tab or Active Spectral Alarms tab until you acknowledge it. |
The following table lists the different alarm states the web application displays on the Alarms page.
To demonstrate how an alarm enters a Set state, consider the following illustration where an alarm is set and cleared twice. Assume that you never acknowledged the alarm. In this example, the same alarm instance remains on the Active Trend Alarms tab or Active Spectral Alarms tab the entire time even though its status transitions to Clear twice. Since the first instance of the alarm was not acknowledged, InsightCM collects no additional data sets and issues no new notification when the alarm enters the Set state the second time.
Consider the same scenario and data as in the previous section. If you acknowledge the alarm at either time indicated by 
in the following illustration, the web application moves the first alarm instance from one of the Active Alarms tab to the Alarm Instances dialog. When the data crosses the set threshold the second time, the web application displays a new alarm instance an Active Alarms tab.
The InsightCM monitoring devices can read data using Modbus TCP or serial communication. Modbus data will be included in the trend points stored on the server and can be used in collection triggers and alarms.
-
Serial communication—The device can address one or more Modbus slaves and the Modbus slaves can communicate directly with the device.
-
Ethernet communication—The device establishes a TCP connection with a Modbus slave on a specific IP address and port. The device can support TCP connections to multiple Modbus slaves.
The device acts as an OPC UA (Open Platform Communications Unified Architecture) client and initiates queries from the OPC UA Server. The device establishes a connection with the specific URL of the OPC UA Server. The device typically connects through TCP.
The device connects through TCP to the InsightCM server to access the historian software data.
Configure a data source from external sources, such as a Modbus Register, an OPC UA Tag, or a Historian Input.
-
Click Configuration (
) and select Assets. -
Click the Action menu (
) and select Data Sources to display the Data Sources dialog box. -
Click Add and select the type of data source you want to create.
-
Specify a name for the data source and click OK.
-
Select the new data source in the asset tree and configure the appropriate properties in the configuration panel.
-
Select the Registers (for Modbus), Tags (for OPC UA), or Points (for Historian Input) tab.
-
Click Add and configure the appropriate data source item properties.
-
Click Close.
-
Click Configuration (
) and select Devices. -
Double-click a device and click the Data Sources tab in the device configuration page.
-
Click Add and select the data source you created.
-
Select the Modbus Register, OPC Tag, or Historian Input checkbox and click OK.
The Modbus register supports properties that affect how the device reads data.
The Modbus Serial data source supports configurable properties that affect how the device communicates with the Modbus slave.
Note
Modbus Serial properties are available only after you add a Modbus Serial data source.
The Modbus TCP data source supports configurable properties that affect how the device communicates with the Modbus slave.
Note
Modbus TCP properties are available only after you add a Modbus TCP data source.
|
Property Name |
Description |
|---|---|
|
IP Address |
The TCP/IP address of the Modbus slave with which you want to communicate. |
|
Port |
The TCP port of the Modbus slave with which you want to communicate. The default is 502. |
|
Interval (sec) |
How often the InsightCM device process reads the Modbus slave device, in seconds. |
|
Read Timeout (sec) |
How long the read process waits for a response from the Modbus slave device when initializing or reading from the device. If the Modbus slave device does not respond within the specified timeout, the InsightCM device attempts to re-open a connection after 30 seconds. |
Review, update, and configure your devices for your condition-monitoring needs.
Before you begin, add a Cutsforth monitoring device.
Complete any of the following tasks to customize your devices in InsightCM.
-
Change settings in device configuration–Configure device settings, such as endpoint mappings, data groups, channel mappings, sample rate, and hardware configuration.
-
Reintegrate quarantined endpoint–Re-establish communication with an endpoint without rebooting the wireless gateway.
-
Configure units of data–Allow or restrict specific units for channels with a certain measurement type.
-
Change units to metric–Change measurement type units to metric.
-
Update device software–Review the application types and versions running on each device and update the application and firmware that the device runs.
-
Review detailed device information–Review a summary of device information based on the most recently acquired sensor data.
-
Learn about device property configurations–Learn how to fine-tune file transfer and network performance for wireless and CMS devices.
-
Reset device to factory settings–Reset a device to its original application image.
Now that you have customized your devices in InsightCM, learn about and integrate a historian software.
Configure device settings, such as endpoint mappings, data groups, channel mappings, sample rate, and hardware configuration.
-
Click Configuration (
) and select Devices. -
Double-click a device to open its configuration page.
-
Configure the settings you want to modify using the tabs in this device's configuration page.
Map each sensor to a device channel and put all sensors for one asset into a data group for which you can configure data collection behaviors.
Configure a data source from external sources, such as a Modbus Register, an OPC UA Tag, or a Historian Input.
Learn how you can fine-tune file transfer and network performance for wireless and CMS devices.
Update your device's configuration in the web application, including the placement of modules within chassis slots, to match the physical device.
-
Click Back to Devices.
-
Select the device you updated and click Update Configuration to apply the changes.
Update your device's configuration in the web application, including the placement of modules within chassis slots, to match the physical device.
-
Click the Configuration pull-down (
) and select Devices. -
Double-click the device whose hardware configuration you need to update and select the Hardware tab.
-
Click Edit Hardware.
-
Configure the IP address, controller type, and module arrangement as needed in the Edit Hardware dialog box.
Re-establish communication with an endpoint without rebooting the MON-10496.
When an endpoint fails to communicate 5 times, the MON-10496 quarantines the endpoint, or ceases to attempt communication with the endpoint. Until you correct the cause of failure and re-establish communication, data is not collected from the quarantined endpoint.
Common reasons an endpoint fails to communicate:
-
The battery needs to be changed.
-
There is a significant obstruction between the endpoint and the MON-10496.
-
On the main Dashboard, click Wireless to access the Wireless Dashboard.
-
Select the quarantined endpoint.
-
Click the Action menu (
) and select Clear Quarantine. -
Confirm that the endpoint's status changes and that communication with the endpoint has been re-established.
Allow or restrict specific units for channels with a certain measurement type.
The default setting for units in the web application is imperial. Refer to Changing Measurement Type Units to Metric to switch from imperial to metric.
Note
Each sensor type can have one or more allowed units. The units you allow for a sensor type also determines in what units InsightCM calculates features.
-
Click the Navigation menu (
) and select System > Units. -
Select a sensor type.
-
Click Add Unit or Remove Unit to specify what units each sensor type can use.
See the imperial and metric units for each measurement type.
|
Measurement Type |
Imperial |
Metric |
|---|---|---|
|
Acceleration |
g |
m/s2 |
|
Current |
amp |
amp |
|
Displacement |
mil, volt, in |
m, mm, micron |
|
EMSA |
uV |
uV |
|
Resistance |
ohm |
ohm |
|
Speed |
RPM |
RPM |
|
Temperature |
F |
C |
|
Velocity |
ips |
m/s, mm/s |
|
Voltage |
volt |
volt |
Change the measurement type units to metric.
Complete the following steps to switch to metric units.
-
Open a command prompt on the server machine and change to the following directory:
<Install Drive>:\Program Files\Cutsforth\InsightCM\
-
Run the following command:
InsightCMConsole.exe importdefinition -t unit -f C:\ProgramData\Cutsforth\ InsightCM\Definitions\UnitDefinitions\MetricUnits.json
-
Check that the command prompt reports
"Success:". -
Run the following command:
InsightCMConsole.exe exportdefinition -t asset -n <sensor name> -o <full path to output definition file>
-
Open the definition file using a text editor.
-
Find the property definition where the key value is
Unitand change the value ofDefaultValueto the appropriate metric unit. -
Save the file and run the following command:
InsightCMConsole.exe importdefinition -t asset -f "<fullpath to definition file>
-
Repeat steps 4 through 7 for each sensor definition you want to update.
Review the application types and versions running on each device and update the application and firmware that the device runs.
-
Click Configuration (
) and select Devices. -
Click the Software tab and select one or more online devices.
-
Depending on your updating goal, complete one of the following steps.
Update the application on one or more devices to the latest version on InsightCM.
Click Update Application.
Verify the latest application is running on a device.
Compare the Configured Version and Latest Version columns in the device table to see if a more recent application version is available on the server.
Resolve persistent errors with the device operation. This step should only be taken with a recommendation from Cutsforth, as there may be solutions other than formatting the device.
Click the Action menu (
) and select Format Device.
Upgrade your device hardware in InsightCM to match the device types that you have while keeping existing asset mappings intact.
-
Click Configuration (
) and select Devices. -
Select a device and click Edit.
-
Select the Hardware tab and click Upgrade Hardware.
-
Specify which device type you are upgrading to using the pull-down and click OK.
Note
Since this action cannot be undone, ensure that you are upgrading the correct device before confirming the change.
The changes are applied automatically.
-
If the IP address of your upgraded device has also changed, click Edit Hardware to update that information.
Update the system image on your monitoring devices by uploading the new image versions to InsightCM and deploying the image to your devices.
Before you begin, download the version of the device image you wish to deploy.
To add or remove firmware versions from InsightCM, complete the following steps.
-
In InsightCM, click the Navigation menu (
) and select Utilities > Package Management. -
Click Upload, select the system image you wish to deploy to your devices, and click Open.
-
Select the outdated image(s) and click Remove.
-
Click Configuration (
) and select Devices to navigate to the Device Configuration page. -
Select the Software tab.
-
Select one or more devices of the same toolkit and type.
-
Click Update Application to apply the new image.
-
Verify that the Deployment Status updates to Successful.
When you update applications on a device, the device deletes log files (including the tracelog) and configuration files.
To manually retrieve any type of file from the device disk, Cutsforth recommends using WebDAV, a protocol that enables you to securely manipulate files on your target, to retrieve files. Files on the device are located at /home/lvuser/natinst/LabVIEW Data/InsightCM.
Review a summary of device information from the most recently acquired sensor data.
-
Click the Configuration pull-down (
) and select Devices. -
Watch data update while the device performs an acquisition, reboots, or you test its connection using the Action menu (
). -
Click the View menu (
) to navigate to the Device Configuration page and update settings in a device's configuration. -
Click the View menu (
) to navigate to the Device Health Dashboard page and evaluate the health of a device by viewing statistical data, including graphs of available memory, CPU usage, drive space, and the response time to pings, over a configurable time range.
You can fine-tune file transfer and network performance for wireless and CMS devices using the following features.
Burst Mode - A mode that you can configure on a device to enable the manual or scheduled acquisition of high-resolution data.
Sample Rate - You can configure the sample rate for channels on Cutsforth 923x modules only. Devices always sample from static channels on other module types at 1 Hz and for one second. For more information, refer to Frequently Asked Questions about Sample Rates and Durations .
Time Trigger Offset - An amount of time, in seconds, to delay time-based acquisitions. For example, if a device is configured to perform an acquisition daily at 1:00 PM, and the value of this property is 110 seconds, the device waits until 1:01:50 PM to perform the acquisition. This property is useful for spreading out network traffic when many devices are configured to perform acquisitions at a specific time of day.
|
Q: |
At what sample rate do devices acquire data? |
|
A: |
You can configure the sample rate for waveform channels on dynamic modules, such as the Cutsforth 9232, on the Device Configuration page by double-clicking on a device and selecting the Device Properties tab. However, devices always sample from channels that produce single-point values, such as voltage and temperature, at 1 Hz. If a device contains both types of channels, the device samples them at different rates. |
|
Q: |
Can you configure unique sample rates or acquisition durations for each channel? |
|
A: |
No: If you must sample from two nearby sensors at different rates, consider using two different devices, each with a unique sample rate. |
|
Q: |
How do devices log single-point data during a multi-second acquisition? |
|
A: |
When a device contains both waveform and single-point channels, you configure the duration of acquisitions on the Operating States tab of the Asset Configuration page for the equipment the device is monitoring. However, devices always log only the final value from single-point channels. Consider the following example where a device acquires from one waveform channel and one single-point channel for four seconds. |
|
The full, four-second acquisition. The device logs waveform data throughout the acquisition. |
|
|
The temperature value from the final second. This is the only temperature value the device logs from this acquisition. |
The Device Properties tab contains a table of properties of the device sample rate and the minimum and maximum current RMS value for the device to calculate all the configured Motor (MCSA) asset features.
The following are built-in properties:
-
Minimum Working Current (%FLA)—The minimum current RMS value of a motor for the device to calculate all the configured features (except Percent Full Load Amps) that belong to the Motor channel, as a percentage of the motor Full Load Amps. The default is 25%.
-
Maximum Working Current (%FLA)—The maximum current RMS value of a motor for the device to calculate all the configured features (except Percent Full Load Amps) that belong to the Motor channel, as a percentage of the motor Full Load Amps. The default is 200%.
If the instantaneous current RMS of a motor is below Minimum Working Current or above Maximum Working Current, the device only calculates the Percent Full Load Amps feature. The Rotor Bar Sideband feature returns a -100 dB value and other non-calculated features return a zero value.
Modify properties, default feature sets, default trend alarm rules, data validation, and default fault frequency sets for all assets of a specific type.
-
Click the Configuration button (
) and ensure that you are on the Asset Configuration page. -
Click the Action menu (
) and select Edit Asset Definitions. -
Select the asset type that you would like to edit.
-
Select the tab within the asset type editor in which you would like to make changes.
Edit how an asset type behaves in the web application.
-
Click Configuration (
) to navigate to the Asset Configuration page. -
Click the Action menu (
) and select Edit Asset Definitions.Note
The categories assigned to a definition determine which capabilities are available for that asset type.
Note
Note the kinds of measurements an asset of any type can perform are limited by the kind of channel to which the asset is assigned.
Note
When a user adds an asset of this type, the web application automatically replaces
{0}with the name of the source asset type. For example, if a user adds an asset type with a name format of{0}Double Integrated as a derived asset on an asset namedMain Accelerometer, the web application automatically generates the nameMain Accelerometer Double Integrated.
Update data collection configurations for assets according to your condition monitoring needs.
|
Task |
Description |
|---|---|
|
Select the endpoint type, set the sample rate, acquisition length, collection time(s), gate source, and sensors associated with the device. |
|
|
Configuring Collection Conditions for Thermal Imaging Devices |
Specify how often the device collects data, a delta EU trigger, or an advanced collection condition. |
|
Shut off data collection for sensors. |
|
|
Shut off data collection for an asset and all child assets. |
Configure data collection behaviors for your wirelessly monitored asset.
-
Click Configuration > Assets.
-
Select a wirelessly monitored equipment asset.
-
Select the Collection tab.
-
Select the endpoint type using the pull-down in that section.
-
Configure Sample Rate and Acquisition Length using the text fields.
-
Use the Collect At pull-down to define the time(s) you want your device to collect data.
-
To change the gate source, click the Edit button near Gate and click the Edit button within the Select Gate Source dialog box.
-
Use the Compare To spin box to configure a feature value, then click OK.
-
Choose when and how often to retry the acquisition if the gate condition is not met.
-
Under Sensors, click Add to add sensors associated with the equipment you want to monitor.
If a sensor is not listed here, you cannot map them on the sensor mapping page.
Collection conditions are evaluated on the thermal imaging device to determine when to send data sets and trend points to the server.
Complete the following steps to specify when a device collects camera data.
-
Click Configuration (
) and ensure you are on the Asset Configuration page. -
Expand the Action menu (
) and select Cameras. -
Select a camera from the list in the Cameras dialog box and select Data Collection.
-
Configure the Time, Delta EU, and/or Advanced conditions as needed.
Shut off sensor data collection to minimize the collection of erroneous data due to a faulty sensor.
Shut off data collection for assets (including child assets and sensors) to minimize the collection of erroneous data.
-
Click Configuration (
). -
Locate the asset you need to disable.
-
Right-click the asset and select Disable.
A notification pops up and the asset should have a red marking to indicate when you successfully disable an asset.
-
Repeat steps 2 and 3 as needed.
Configure the web application to note known frequencies that are problematic on the Asset Configuration page.
-
Click Configuration (
) and ensure you are on the Asset Configuration page. -
Right-click on an asset and select Add fault frequencies to add the Fault Frequencies tab to your asset's configuration panel.
-
Click Add in the Bearings section.
Select a bearing from the database.
Create a new bearing.
-
Create fault frequency groups to define a set of fault frequencies to refer to by name.
-
Click Add in the Fault Frequency Groups section.
-
Specify what features you want an asset to calculate.
-
Click Configuration (
) and select a sensor-level asset. -
Click the Features tab in the asset's configuration panel.
-
Click Add.
-
Select one or more features in the Add Features dialog box and click OK.
-
Define what feature property is calculated for an asset by selecting a feature.
-
Click Edit to display the Properties dialog box for that particular feature.
-
Configure any properties you want to and click Close.
Note
If you do not see the feature you want to add, you may need to add the feature on the Asset Definition page.
Define which features are appropriate and available by creating a default set of features for the server to automatically assign to each sensor type.
Complete the following steps to review the predefined sets of features in the web application and to make changes at the system or asset level.
Note
You can also manually assign additional features that are not part of a sensor's set of features.
-
Click Configuration (
) and ensure you are on the Asset Configuration page. -
Click the Action menu (
) and select Edit Asset Definitions. -
Select the sensor for which you want to add a feature.
-
Click the Features tab in the definition panel.
Note
Some items in the features list have Yes in the Default column to indicate the items are predefined features. Features can have their default setting toggled to Yes so that all new sensors will have that feature. Removing the toggled default setting does not remove features from existing sensors.
-
Click the Add button and a dialog box will prompt you to select from additional features you can assign to the asset definition.
-
Select one or more features to add to an asset definition and click OK.
-
To push the added feature to future instances of this sensor type, highlight the feature list and click the Toggle Default button.
-
Add to the features available in the system.
-
Click the Navigation menu.
-
Hover over System and select Features.
-
Click Add and hover over or select the type of feature you would like to add to the system.
-
Enter a name and parameters for a new feature in the resulting dialog box and click OK.
-
InsightCM allows users to edit multiple assets at one time using an exported spreadsheet.
Complete the following steps to update an exported asset spreadsheet and apply the changes to the asset tree in the web application:
-
In the navigation bar at the top of the page, click Configuration (
) to navigate to the Asset Configuration page. -
Click the Action menu (
) and select Import/Export » Export Asset Spreadsheet. You can choose to export the entire asset tree or only the section you have selected. -
Navigate to the exported spreadsheet on your computer and open it.
-
Fill out the relevant sections in the spreadsheet.
-
Save the file after you have finished making changes.
-
Back on the Asset Configuration page, click the Action menu (
) and select Import/Export » Import Asset Spreadsheet to display the Import Asset dialog box. -
Click the Browse button (
) to select the exported spreadsheet from your computer and apply your changes to the asset tree.
InsightCM allows users to edit multiple assets at one time using an exported spreadsheet.
Asset spreadsheets contain the following tabs with their respective columns:
-
AssetNodes—The settings that determine the functionality of an asset.
-
FullName—The full path to the asset in the asset tree with each level separated by pipes. For example,
Location|Equipment|Accelerometer
-
Type—The name of the asset type, such as
Accelerometer,Tachometer, ortrue. -
MeasType—Indicates whether the asset acquires data as a waveform or a single point and what type of measurement you want the asset to perform. For example,
Waveform|Tachometer
-
Categories—Categories that describe the asset type and determine what capabilities are available for the asset type, such as
Dynamic,RotatingEquipment, orAccelerometer.
-
-
AssetNodeProperties—The properties that are available for an asset.
-
FullName—The full path to the asset in the asset tree with each level separated by pipes. For example,
Location|Equipment|Accelerometer
-
PropertyName—The name that the InsightCM web application displays for the property.
-
PropertyValue—The value you want the InsightCM web application to set for the property when you import the spreadsheet.
-
-
OperatingStates—The operating states that are available for an asset.
-
OperatingStateProperties—The properties an operating state has when it is assigned to a specific asset.
-
FullName—The full path to the asset in the asset tree with each level separated by pipes. For example,
Location|Equipment|Accelerometer
-
OperatingState—The operating state to which the property defined in this row applies.
-
PropertyName—The name of the property that the InsightCM web application displays.
-
PropertyValue—The value you want the InsightCM web application to set for the property when you import the spreadsheet.
-
-
Triggers—The triggers that are available on an operating state assigned to a specific asset.
-
FullName—The full path to the asset in the asset tree with each level separated by pipes. For example,
Location|Equipment|Accelerometer
-
OperatingState—The name of the operating state to which the property applies.
-
Type—The kind of trigger you want to configure. For example,
EnterTrigger
-
Expression—The expression or combination of expressions required to activate the trigger.
-
-
TriggerConditions—The trigger conditions that are available for each trigger on an operating state assigned to a specific asset.
-
FullName—The full path to the asset in the asset tree with each level separated by pipes. For example,
Location|Equipment|Accelerometer
-
OperatingState—The name of the operating state to which the trigger condition applies.
-
Type—Specifies whether the trigger is time-based, such as-
Cron,Timespan, orTrend. -
Operator—How the InsightCM web application compares the trend value to the compare value (For example,
Greater thanorEqual to). -
CompareTo—The value that the InsightCM web application compares the trend value to.
-
DwellSeconds—How long the trigger condition must be true before the InsightCM web applications activates the trigger.
-
-
FeatureProperties—The properties a feature has when assigned to a specific asset.
-
FullName—The full path to the asset in the asset tree with each level separated by pipes. For example,
Location|Equipment|Accelerometer
-
Feature—The name of the feature to which the property applies.
-
PropertyName—The name of the property that the InsightCM web application displays.
-
PropertyValue—The value you want the InsightCM web application to set for the property when you import the spreadsheet.
-
-
TrendAlarmRules—Alarm rules for features assigned to a specific asset.
-
FullName—The full path to the asset in the asset tree with each level separated by pipes. For example,
Location|Equipment|Accelerometer
-
Id—The string that other sections of the spreadsheet use to reference the alarm rule.
-
TrendName—The name of the feature to which the alarm rule applies.
-
Operator—How the InsightCM web application compares the trend value to the compare value. For example,
Greater thanorEqual to. -
OperatingState—The operating state or states to which the alarm rule applies.
-
Hysteresis—An offset from the set point whose value causes InsightCM Server to clear the alarm when crossed.
-
OnDelaySeconds—The amount of time, in seconds, the set point must remain crossed before InsightCM Server sets the alarm.
-
OffDelaySeconds—The amount of time, in seconds, the hysteresis level must remain crossed before InsightCM Server clears the alarm.
-
AutoConfigCalc—Specifies whether to automatically configure levels from baseline values.
-
-
TrendAlarmLevels—How alarm levels are calculated for specific alarm rules.
-
AlarmActions—Specifies whether the InsightCM web application takes any action when a specific alarm is set.
-
AlarmActionProperties—The action the InsightCM web application takes when a specific alarm is set.
-
SpectralAlarmRules—Spectral alarm rules for features assigned to a specific asset.
-
FullName—The full path to the asset in the asset tree with each level separated by pipes. For example,
Location|Equipment|Accelerometer
-
Id—The string that other sections of the spreadsheet use to reference the alarm rule.
-
OperatingState—The operating state or states to which the alarm rule applies.
-
Unit—Specifies the units used to measure sensor data on the asset the sensor monitors.
-
Integration—Specifies the type of integration, if any, to apply to asset data to check for this rule.
-
Cutoff—Specifies the frequency, in Hz, for the highpass filter when performing double integration on asset data.
-
-
SpectralAlarmLevels—How alarm levels are calculated for specific spectral alarm rules.
-
SpectralAlarmActions—Specifies whether the InsightCM web application takes any action when a specific spectral alarm is set.
-
SpectralAlarmActionProperties—The action the InsightCM web application takes when a specific spectral alarm is set.
-
FaultFrequencies—Known frequencies that are problematic for an asset so that the InsightCM web application notes them on the Data Viewer page.
-
NamedGroups—The name of a group of fault frequencies assigned to an asset.
Edit batch configurations in a device spreadsheet to make updates to multiple devices that you already configured in the web application.
-
Click Configuration (
) and select Devices. -
Select the device(s) you want to update.
-
From the Action menu (
), hover over Import/Export, select Export Devices Spreadsheet, and then choose whether to export configurations for devices you selected in step 2 or all devices. -
The web application downloads a spreadsheet file to your computer. Create a copy of the downloaded file. If you introduce errors while editing the spreadsheet and then import the errors, you can then import the copy, which allows you to return device configurations to a working state.
-
Open the .xlsx device spreadsheet file.
Note
The spreadsheet contains several worksheets that define different types of device-configuration properties. The spreadsheet links related properties in separate worksheets via the names in the spreadsheet. For example, the Channels worksheet identifies which data group owns the channels by specifying the data group name as defined on the DataGroups worksheet.
-
Edit the properties of interest in the spreadsheet. For example, you might want to change the sample rate on multiple devices at the same time.
-
To apply your changes to the device configurations in the web application, return to the Device Configuration page, and select import the device spreadsheet from the Action menu (
).
Ensure that sensors are returning valid data.
Ensure that sensors are returning valid data. Review data validation errors on the Notifications page.
-
Click the Navigation menu (
) and select System > Asset Definitions. -
Choose and complete one of the tasks below for an asset type according to how you need your sensor data validated.
-
Set a rule to check that waveform values are within a specified range.
-
Use the Maximum EU and Minimum EU fields to specify a range of acceptable values. See Difference Between Range Check and Input Range for more information.
-
Set a rule to check that consecutive waveform values do not remain the same for more than the specified number of samples.
-
Set a rule to check that consecutive waveform values do not have the same sign for more than a specified amount of time.
-
Set a rule to ensure that all waveforms have a minimum percentage of unique values.
-
Set a rule to check that the ratio of the Peak feature to the Peak-Peak feature is within the range you specify.
-
Set a rule to check for a suspect amount of energy at line frequency.
The Range Check: Minimum and Range Check: Maximum properties are the minimum and maximum values you expect to measure after any scaling. These values are sometimes confused with the Input Range property. Input Range refers only to the input range of a particular device, in the pre-scaled units the device measures. For example, the Input Range for a module might be 0 to 10 V, but that module might be used with a temperature sensor that outputs 100 mV for every 1 °C. The Range Check: Minimum and Range Check: Maximum in that case could be 0 to 100 V, with 10 V corresponding to 100 °C.
In this example, you could set the Custom Scale: Slope property to 0.01 to implement the conversion from V to °C.
The server logs errors and certain events, such as when services start and when an asset is updated.
Ensure that you are on the Audit Logger tab of the System page by clicking the Navigation menu, hovering over Utilities, and selecting Audit Logger.
By default, only the last 30 days of events are retained on the server. You may filter the data events by clicking the Filter By... button, or by clicking header of each column to automatically filter in ascending order.