Historical Alarms

The Historical Alarms page shows all alarms received for the asset, in any state. The view here is read only:

o As in the Alarms module on the Asset dashboard and the Current Alarms page, you can select the name of an alarm to view details. However, you cannot edit the details of the alarms, even if the alarms are in the states, Started, Acknowledged, or Escalated.

o In addition, you cannot delete alarms from this page. The archive process periodically will remove them from display and store them. Check with your Platform administrator to find out how often the archive process runs.

Note: By default the table shows a maximum of 1000 alarms. This value is configurable in the System Properties. See System Configuration for more information.

o Name - of the alarm. The name of the alarm is a link that you can click to display the Alarm Details page (in a separate browser window), where all the details about the alarm are available. If there are notes for the alarm, $image\alarmnotes.gif$ appears after the name; point the cursor at the icon to view an existing note.

If a single file was uploaded with the alarm, the $image\file_alarm_assoc_single.gif$ appears after the name. If multiple files were uploaded, $image\file_alarm_assoc_multiple.gif$ appears after the name. Click the single file icon to download or open the file. Click the multiple-files icon to view all uploaded files associated with this alarm.

For alarms sent by Axeda® Agents, this field shows the name of the analog or digital data item whose value triggered the alarm. If the Agent sent a custom alarm, this field shows the name assigned to the custom alarm in the Agent configuration. If the Agent forwarded an alarm that was generated by a driver running on the asset (a "dynamic" alarm), this field shows the name of the alarm as sent by the driver.

For alarms sent by Axeda® IDM Agents , the alarm name is "FaultGeneratedByAsset". To view the four components of the alarm, click the name of the alarm. The Alarm Details page appears. The Description field on this page contains the alarm components.

o Description - if provided with the alarm instance, user-defined information about this alarm. If this text is longer than the field can hold, the text is truncated to fit the field and an ellipsis is displayed. You can move the cursor over the ellipsis to view the complete text.

For an Axeda Agent, the information shown in this field depends on the main category of alarm (analog, digital, custom, or dynamic):

§ Analog alarms -- If the alarm is a Value alarm, this field shows the Description entered for the Value Level (LoLo, Low, HiHi, or High) in Axeda® Builder. If this alarm is a Deviation alarm, this field shows the Description entered for the Minor Deviation or Major Deviation in Builder.

§ Digital alarms -- This field shows the text entered for the Message in the configuration of the Digital Alarm Style in Builder.

§ Custom alarms -- This field shows the text entered for the Message in the configuration of the Custom Alarm Style in Builder.

For an Axeda IDM Agent, this field shows the four components of a fault (alarm): code, abstract, description, and detail. The following example shows how they would appear here:

§ Detail=<fault detail>

If expression rules have been written for the IDM Agents to take this alarm information and generate new alarms, using the information, then this field will show only the information provided in the Description component of the fault.

o Date - the date and time that the Platform received the alarm. For example, "11/22/10 10:58 AM".

o Severity - a numeric value assigned to this alarm, as configured for this alarm condition; this value can range from 0 to 1000 and provides a means for filtering the alarm display and for triggering other functionality (for example, rules that trigger based on alarm severity values).

o Type - type of the alarm, such as HiHi or LoLo (for example, if the related data item reached a value range defined as HiHi).

o State - the current state of the alarm. This field can show one of the following values:

§ Escalated - a user has changed the state of the alarm to "escalated"; the meaning of "escalated" is up to the individual companies using the Axeda® Connected Product Management Applications.

§ Acknowledged - a user has changed the state of the alarm to "acknowledged", which can mean that the user has seen the alarm and is working on it.

§ Closed - a user has changed the state of the alarm to "closed", meaning that the cause of the alarm has been determined and addressed. Note that this value can appear as the current state of an alarm only when you click the alarm name in the Historical Alarms page. Once an alarm is closed, it is sent to Historical Alarms in the Platform and in the application pages. This state is a terminal state, in that you cannot change the state again once an alarm is in this state.

§ Duplicate - the Platform detected that the name of this alarm instance and the name of the asset sending it matched those for a current alarm. When support for the Duplicate state is enabled, a new instance of an alarm that is determined to be a duplicate is sent to Historical Alarms, with its state set to Duplicate. Note that if the severity, data item, or value of a data item sent with the duplicate instance differs from those of the current alarm, the current alarm is NOT affected. The different information is stored with the duplicate instance of the alarm. Like Closed, Duplicate is a terminal state. Depending on how the Axeda Platform is configured, you may never see this state. For more information, refer to Duplicate Alarms.

§ Suppressed - indicates that the initial disposition of this alarm has been set to Suppressed. When the Platform detected the alarm, it sent the alarm to Historical Alarms, with the state set to Suppressed. The alarm is not available for business rules.

o Data Item Name - the name of the actual data item whose value matched the alarm criteria, thereby triggering this alarm.

Procedures from this page

From this page, you can filter the table of alarms to include only alarms that meet selected search criteria; view the details of an alarm; and view files uploaded with an alarm. Click the title of a procedure to display it; click the title again to hide the procedure:

To filter the table of alarms

1. Click Filters to show the filter boxes, if not shown.

2. To view all alarms for the asset, click Filter without typing or selecting any search values.

3. To perform a simple search of the Platform, specify one or more of the following search criteria and then click Filter:

§ In the box above the Name column, start typing the name of the alarm(s) to include in the search. This field uses Axeda Smart Suggest, so you can type a few characters and then select from a dropdown list.

§ In the box above the Severity column, type the severity of the alarm(s) to include in the search.

§ In the box above the Type column, enter the type of the alarm(s) to include in the search.

§ In the box above the Data Item Name column, type all or part of the name of the data item to use for the search. This data item is the one that triggered the alarm.

§ In the box above the Data Item Value column, type all or part of the data item value (for the alarm) you want to find.

4. To perform an advanced search of the Platform, click Advanced, do one or more of the following, and then click Filter:

§ Start Date and Time - (optional) type or use the calendar tool ( $image\calendar_icon.gif$ ) to specify the start date for the search criteria, then type a time for the date shown. If you do not specify a time, a start time of 12:00 am (or 24:00:00) is applied to the start date. If you do not specify a date, the current date is used.

§ End Date and Time - (optional) type or use the calendar tool ( $image\calendar_icon.gif$ ) to specify the end date for the search criteria, then type a time for the date shown. If you do not specify a time, an end time of 11:59:59 pm (or 23:59:59) is applied to the end date. If you do not specify a date, the current date is used.

§ From the Alarm State list, select one of the following to use for the search: All Historical Alarms (includes alarms in the states, Started, Escalated, Acknowledged), Closed Alarms, or Suppressed Alarms.

The Platform finds all alarms that contain the search value(s) defined per your criteria and shows them in the table.

To view alarm details and notes

If a general note exists for an alarm, you can view the contents of the note by pointing to the $image\alarmnotes.gif$ .

To view details and other notes about the alarm, from the Name column, select the name of the alarm. The Alarm Details window shows the properties for the alarm as well as any previously-defined notes.

To view files uploaded with an alarm

If a single file was uploaded with an alarm, you can view the contents of the file by clicking the $image\file_alarm_assoc_single.gif$ next to the alarm name. In the file dialog box for your system, select to open or download the file.

If multiple files were uploaded with an alarm, click the $image\file_alarm_assoc_multiple.gif$ icon next to the alarm name. The Uploaded Files page for this asset is displayed, where all files uploaded with an alarm display the icon, $image\icon_alarm.gif$ . Clicking the name of a file displays the file dialog box for your system. From there, you can open or download the file.

Tips

o When typing times and dates, apply the format identified per your User Preferences.

o Select an option from the Jump to list to see more information or actions for the asset. If the asset is muted, you will be restricted to viewing only those pages that do not contain functionality that will result in communications to the muted asset. If the asset is unmuted, all pages to which you have privileges are available. For example, click Available scripts to see a list of all scripts registered for this asset as well as the names of the script authors and descriptions of each script. The options in this list vary from asset to asset.

o The maximum number of rows supported for returning Platform search results for this type of table is defined in your user preferences, Items Per Page setting (Long table or Short table).

o Use $image\icon_refresh.gif$ (Refresh link) beside the table navigation tools to refresh the page with the latest Platform results. (Browser Refresh tools do not update the table.)