### Setting up alarm actions The WebCTRL® application can perform alarm actions listed below to notify personnel of an alarm or to record information about the alarm. You can assign alarm actions to an alarm source, a category of alarm sources, alarm sources from a certain location, or a combination of these criteria. The alarm actions are: Alarm Popup Print Propagate To Server Run External Program Send Alphanumeric Page Send E-Mail Send SNMP Trap * Send Web Service Request * Write Property * Write to Database * Write to File * Available only in WebCTRL® Premium and WebCTRL® Advantage with the Advanced Alarming package. To see a report of each alarm action defined in your system and how it is configured, go to Reports > Alarms > Alarm Actions. See the following topics for a description of each alarm action.
Click for details below To assign alarm actions to alarm sources Alarm Popup Print Propagate To Server Run External Program Send Alphanumeric Page Send E-mail Send SNMP Trap Send Web Service Request Write Property Write to Database Write to File
#### To assign alarm actions to alarm sources To assign alarm actions to multiple alarm sources Although you can assign an alarm action to a single alarm source, you typically assign an action to multiple alarm sources at the area or equipment level. The alarm action applies to all instances of the alarm sources at the selected location and below. Click an action’s Edit button to make any changes. To assign an alarm action to alarm sources: On the Geographic or Network tree, select the area, equipment, or controller containing the alarm sources. On the Alarms page > Actions tab, follow the 3 steps on the screen. NOTE Use Ctrl+click, Shift+click, or both to select multiple items. Click Add. Set up the alarm action by editing the fields on the alarm action page. See the appropriate alarm action below for field descriptions. Click Accept. After you have assigned alarm actions to an alarm source, simulate the alarm to check your work. If an alarm action fails, the WebCTRL® application receives an alarm for the failed action. NOTES Click View Selected Sources to view or change settings for each alarm. You can display icons and hover text on the Geographic tree that show where alarm actions have been created. See Tree icons and hover text. To assign an alarm action to a single alarm source On the Geographic or Network tree, select the alarm source (microblock). On the Alarms page > Actions tab, click the drop-down arrow, then select an alarm action. Click Add. Set up the alarm action by editing the fields on the alarm action page. See the appropriate alarm action below for field descriptions. Click Accept.
#### Alarm Popup The Alarm Popup alarm action pops up a message on any computer with a Windows® operating system that is running the WebCTRL® Alarm Notification Client application.
Field | Notes
--- | ---
To Operator To Group | Select individual operators or operator groups who should receive alarm notification.
Generate alarm if delivery fails | Check this field to generate a System Info alarm if the popup recipient is not currently running the Alarm Notification Client application.
Message text | Use punctuation, spaces, or returns to format the text. To add live data to the text, select field codes from the Append Field Code list.
Append Field Code | Add field codes to the message text if desired.
Perform Action | By default, the WebCTRL® application performs an alarm action when the alarm source generates an alarm and when it returns to normal. Under Perform Action, you can choose to run the alarm action: Only when the alarm source generates an alarm or when it returns to normal. After a specified amount of time if the alarm has not been acknowledged or has not returned to normal. Use this option for alarm escalation. * If the alarm occurs during the occupied hours defined for a schedule group or run if the alarm occurs during the unoccupied hours defined for a schedule group. * EXAMPLE To have one alarm action performed during work hours and a different alarm action performed after work hours: Create a schedule group, but do not assign members to it. Create a schedule for the group. Set the occupied hours to be the same as the work hours. Create the alarm action that is to be performed during work hours. Under Perform Action, select If schedule group <your new group> is Occupied. Create the alarm action that is to be performed after work hours. Under Perform Action, select If schedule group <your new group> is Unoccupied. * Available only if you have the Advanced Alarming package.
Using the Alarm Notification Client application The Alarm Notification Client application must be running on each client computer (Windows only) that should receive popup notifications. Keep the application minimized to the right side of the Windows task bar. The window will pop up with a message when an alarm occurs. Select an alarm message, then click to open the WebCTRL® interface displaying the piece of equipment that generated the alarm. A grayed out alarm indicates that it was acknowledged in the WebCTRL® interface. If the Alarm Notification Client is set up to play a continuous alarm sound, you can silence an alarm by clicking Silence!, by pressing Ctrl+S, or by acknowledging the alarm in the WebCTRL® interface.
Button | Notes
--- | ---
| Opens the WebCTRL® interface displaying the equipment that generated the alarm. NOTES If WebCTRL Server is to use https (SSL), you must do the following to enable communication between the server and Alarm Notification Client. In SiteBuilder, go to Configure > Preferences > Web Server. For Enabled Web Server Ports, select Both HTTP and SSL or SSL only. In the Server Connection field described below, enter the number of the SSL port. If WebCTRL Server is v6.0 and an Alarm Notification Client is an earlier version, you will have to log in when you click .
| Copies the selected alarm information to the clipboard.
| Removes the alarm information from the alarm popup list. Removing items from this list has no effect on the alarms list in the WebCTRL® interface.
| View information about the server connection.
| On this tab... | You define...
| Server Connection | The WebCTRL® server and port, and the WebCTRL® operator name and password NOTES If you upgraded Alarm Notification Client to v6.0, you will need to reenter your operator name and password on this tab while Alarm Notification Client is connected to the WebCTRL Server application. The default port is TCP 47806. If you change this, you must also change the Port field in the WebCTRL® System Settings. See "To set up the WebCTRL Server application to support Alarm Popup clients" below.
| Browse To | The WebCTRL® page that you want to see first when browsing to the equipment
| Notification Sounds | If you want to hear a sound when an alarm occurs Which sound you want to hear for each type of alarm. NOTE A Connection Failure occurs when the Alarm Notification Client loses communication with the WebCTRL Server application. Whether you want the sound to continue until silenced NOTE If multiple types of alarms occur simultaneously, the application plays the sound of the most critical alarm (Connection Failure first, then Critical, then Normal).
To set up the WebCTRL Server application to support Alarm Popup clients On the System Configuration tree, select System Settings. On the General tab, select Enable support for Alarm Notification Clients to connect to this server. If the server has more than one network interface adapter, type in the Restrict to IP Address field the IP address that the Alarm Notification Client application will connect to. You must specify the same IP address in the Server field in the Alarm Notification Client. Use the default port or specify a different port. You must specify the same port in the Port field in the Alarm Notification Client. Click Accept. NOTE If the Alarm Notification Client application is not on the local network and will access WebCTRL® alarms through a NAT router, you must port forward the TCP port you defined in step 4 above. To install the Alarm Notification Client application Follow the steps below on each client computer that should receive alarm popups. PREREQUISITE Enable support for Alarm Popup client in System Settings. See above topic. On the System Configuration tree, click Client Installs. Select Alarm Notification Client. Click Run, then follow the on-screen instructions to install the Alarm Notification Client application. After you click Done, the application starts automatically. In the Settings dialog box, enter appropriate values. You can also click to open this box. See the table above for a description of each setting. NOTE You can lock the Settings so that a user cannot edit them. See To lock a client's Settings feature below. Click OK. Minimize the Alarm Notification Client window. To lock a client's Settings feature To prevent a user from editing the Settings : Right-click Alarm Notification Client in the Windows Start menu. Select Properties. On the Shortcut tab, type``-lockconfig`` at the end of the Target path.
#### Print The Print alarm action prints alarm information.
Field | Notes
--- | ---
Text Printing | Select to use the WebCTRL® server's local dot-matrix printer. Text Printing will not print to a network printer. In the Port Name field, type the computer port that the printer is connected to. In the Line Width field, type the number of characters to be printed per line. Prints multiple alarms per page.
Graphics Printing | Select to use the WebCTRL® server's default printer (local or network printer). Prints one alarm per page to the WebCTRL® server's default printer.
Text to Print | Use punctuation, spaces, or returns to format the text. To add live data to the text, select field codes from the Append Field Code list.
Perform Action | By default, the WebCTRL® application performs an alarm action when the alarm source generates an alarm and when it returns to normal. Under Perform Action, you can choose to run the alarm action: Only when the alarm source generates an alarm or when it returns to normal. After a specified amount of time if the alarm has not been acknowledged or has not returned to normal. Use this option for alarm escalation. * If the alarm occurs during the occupied hours defined for a schedule group or run if the alarm occurs during the unoccupied hours defined for a schedule group. * EXAMPLE To have one alarm action performed during work hours and a different alarm action performed after work hours: Create a schedule group, but do not assign members to it. Create a schedule for the group. Set the occupied hours to be the same as the work hours. Create the alarm action that is to be performed during work hours. Under Perform Action, select If schedule group <your new group> is Occupied. Create the alarm action that is to be performed after work hours. Under Perform Action, select If schedule group <your new group> is Unoccupied. * Available only if you have the Advanced Alarming package.
#### Propagate To Server The Propagate To Server alarm action sends the selected alarm to the parent server in a system with hierarchical servers.
Field | Notes
--- | ---
Message text | The alarm message that is sent to the parent server.
Append Field Code | Add field codes to include live data in the Message text field.
Perform Action | By default, the WebCTRL® application performs an alarm action when the alarm source generates an alarm and when it returns to normal. Under Perform Action, you can choose to run the alarm action: Only when the alarm source generates an alarm or when it returns to normal. After a specified amount of time if the alarm has not been acknowledged or has not returned to normal. Use this option for alarm escalation. * If the alarm occurs during the occupied hours defined for a schedule group or run if the alarm occurs during the unoccupied hours defined for a schedule group. * EXAMPLE To have one alarm action performed during work hours and a different alarm action performed after work hours: Create a schedule group, but do not assign members to it. Create a schedule for the group. Set the occupied hours to be the same as the work hours. Create the alarm action that is to be performed during work hours. Under Perform Action, select If schedule group <your new group> is Occupied. Create the alarm action that is to be performed after work hours. Under Perform Action, select If schedule group <your new group> is Unoccupied. * Available only if you have the Advanced Alarming package.
#### Run External Program The Run External Program alarm action starts a program or batch file on the server. NOTE You must be running WebCTRL Design Server to set up this alarm action.
Field | Notes
--- | ---
Command Line | The path of the executable file on the WebCTRL® server followed by the path of the output file. EXAMPLE: ``c:\windows\notepad.exe c:\WebCTRL\webroot\alarms.txt``
Append Field Code | Add field codes to the Command Line field. EXAMPLE: c:\reports\run_report.bat $Generation_time$$To_State$ This starts a batch file on the server and uses the alarm’s generation time and state as values.
Synchronize | Tells the WebCTRL® application to wait for the external program to finish running before initiating the next Run External Program alarm action.
Perform Action | By default, the WebCTRL® application performs an alarm action when the alarm source generates an alarm and when it returns to normal. Under Perform Action, you can choose to run the alarm action: Only when the alarm source generates an alarm or when it returns to normal. After a specified amount of time if the alarm has not been acknowledged or has not returned to normal. Use this option for alarm escalation. * If the alarm occurs during the occupied hours defined for a schedule group or run if the alarm occurs during the unoccupied hours defined for a schedule group. * EXAMPLE To have one alarm action performed during work hours and a different alarm action performed after work hours: Create a schedule group, but do not assign members to it. Create a schedule for the group. Set the occupied hours to be the same as the work hours. Create the alarm action that is to be performed during work hours. Under Perform Action, select If schedule group <your new group> is Occupied. Create the alarm action that is to be performed after work hours. Under Perform Action, select If schedule group <your new group> is Unoccupied. * Available only if you have the Advanced Alarming package.
#### Send Alphanumeric Page The Send Alphanumeric Page alarm action sends a page to one or more alphanumeric pagers or sends text messages to cell phones. The pager or phone must be able to accept e-mail.
Field | Notes
--- | ---
To | Type the address(es) that you want to send the alarm to. To enter multiple addresses, type a space or press Enter after each address.
From | Enter a valid address if required by your mailserver.
Mail Host | The mailserver's address. This can be an IP address or a system name, such as mail.mycompany.com.
Mail Host Port | Change this field if using a port other than the default port 25.
Mail Host Security Options | Select the type of security the mailserver uses. Cleartext – Uses the SMTP protocol to send as clear text over TCP/IP Secure SSL – Uses SSL, a communication protocol that provides data encryption Secure TLS – Uses TLS, but does not begin encryption until the WebCTRL® application issues STARTTLS command
Specify Mail User For Mail Host Authentication | Select if your mailserver requires a username and password.
Send mail as MIME attachment | Select if your mailserver allows only MIME attachments.
Message Text | Use punctuation, spaces, or returns to format the text. To add live data to the text, select field codes from the Append Field Code list.
Perform Action | By default, the WebCTRL® application performs an alarm action when the alarm source generates an alarm and when it returns to normal. Under Perform Action, you can choose to run the alarm action: Only when the alarm source generates an alarm or when it returns to normal. After a specified amount of time if the alarm has not been acknowledged or has not returned to normal. Use this option for alarm escalation. * If the alarm occurs during the occupied hours defined for a schedule group or run if the alarm occurs during the unoccupied hours defined for a schedule group. * EXAMPLE To have one alarm action performed during work hours and a different alarm action performed after work hours: Create a schedule group, but do not assign members to it. Create a schedule for the group. Set the occupied hours to be the same as the work hours. Create the alarm action that is to be performed during work hours. Under Perform Action, select If schedule group <your new group> is Occupied. Create the alarm action that is to be performed after work hours. Under Perform Action, select If schedule group <your new group> is Unoccupied. * Available only if you have the Advanced Alarming package.
NOTE You should not assign this alarm action to frequently-occurring alarms as this may cause problems on your network or the Internet. To secure mailserver communication using SSL or TLS Before the WebCTRL® application sends an email using SSL or TLS, it requests an SSL certificate from the mailserver. If the certificate that the WebCTRL® application receives is in its list of trusted certificates, it sends the email. If the certificate is not in the list, the WebCTRL® application generates a system alarm indicating that the email alarm action failed. If this occurs, you will need to add the mailserver's certificate to the WebCTRL® application's list of trusted certificates. Get a copy of the certificate file from the mailserver. Ask your Network Administrator for help. Put the file on the WebCTRL® server. On the WebCTRL® server, click the Windows® Start button. In the Search programs and files field, type the following command: C``:\WebCTRL<x.x>\bin\java\jre\bin\keytool.exe -import -trustcacerts -alias smtpserver -keystore webserver\keystores\certkeys -file <file_path>`` replacing: ``<x.x>`` with the system's version number ``<file_path>`` with the full path and file name of the certificate file The information for the smtpserver key is displayed and you are prompted to trust this certificate. Type ``yes``. NOTE If your mailserver is using SSL or TLS, the WebCTRL® server is running antivirus software, and the email alarm action fails because it cannot find an SSL certificate, do one of the following: Disable scanning of outgoing SMTP traffic in the antivirus software. See your antivirus software's Help for assistance. Obtain the antivirus software's SSL certificate and install it on the WebCTRL® server using the above procedure. To set up a dial-up networking connection The WebCTRL® application can use a dial-up internet connection through a modem to deliver e-mail for the Send E-mail or Send Alphanumeric Page alarm action. To set up the dial-up connection: Set up your modem to dial out to your Internet Service Provider. See your modem documentation. On the WebCTRL® server, open Internet Explorer®. Select Tools or > Internet Options. On the Connections tab, click Setup. Follow the instructions in the wizard. See Windows Help for assistance. In a text editor such as Windows Notepad, open WebCTRLx.x\webroot\<system>\ system.properties. At the end of the file, type the following line: ``repactions.connection.name=<name of connection>`` where <name of connection> is the ISP name you entered in the wizard in step 2. Open Internet Explorer, then select Tools > Internet Options > Connections tab. If the box under Dial-up and Virtual Private Network settings shows more than one connection, select the connection that you just created, then click Set Default. Select Always dial my default connection.
#### Send E-mail The Send E-mail alarm action sends a message to one or more e-mail accounts. The alarm action can also run a report and attach it to the e-mail as a PDF, HTML, or XLS file.
Field | Notes
--- | ---
To and CC | Type the address(es) that you want to send the alarm to. To enter multiple addresses, type a space or press Enter after each address.
Subject | Enter the text that you want to appear on the Subject line of the email. The subject can include field codes.
Use default email server configuration | Check this field to have this alarm action use the email server configuration settings defined on the System Settings > General tab. Uncheck to enter settings specific to this alarm action.
From | Enter a valid address if required by your mailserver.
Mail Host | The mailserver's address. This can be an IP address or a system name, such as mail.mycompany.com.
Mail Host Port | Change this field if using a port other than the default port 25.
Mail Host Security Options | Select the type of security the mailserver uses. Cleartext (SMTP) – Uses the SMTP protocol to send as clear text over TCP/IP Secure SSL (SMTP with SSL) – Uses SSL, a communication protocol that provides data encryption Secure TLS (STARTTLS) – Uses TLS, but does not begin encryption until the WebCTRL® application issues STARTTLS command
Specify Mail User For Mail Host Authentication | Select if your mailserver requires a username and password.
Send mail as MIME attachment | Select if your mailserver allows only MIME attachments.
Message Text | Use punctuation, spaces, or returns to format the text. To add live data to the text, select field codes from the Append Field Code list.
Attach Report | Select to attach a report to the e-mail, then select the Report and the Format. The attached report will include the date and time. For example, Alarm Sources 2017 Jan 01 1230. NOTE The Report Name field shows a custom report only if it is accessible at the current level. Run as shows the name and login name of the operator creating the alarm action. The report will be run using the privileges and report options of this operator. TIP You may want to create a new operator with limited privileges for this purpose.
Perform Action | By default, the WebCTRL® application performs an alarm action when the alarm source generates an alarm and when it returns to normal. Under Perform Action, you can choose to run the alarm action: Only when the alarm source generates an alarm or when it returns to normal. After a specified amount of time if the alarm has not been acknowledged or has not returned to normal. Use this option for alarm escalation. * If the alarm occurs during the occupied hours defined for a schedule group or run if the alarm occurs during the unoccupied hours defined for a schedule group. * EXAMPLE To have one alarm action performed during work hours and a different alarm action performed after work hours: Create a schedule group, but do not assign members to it. Create a schedule for the group. Set the occupied hours to be the same as the work hours. Create the alarm action that is to be performed during work hours. Under Perform Action, select If schedule group <your new group> is Occupied. Create the alarm action that is to be performed after work hours. Under Perform Action, select If schedule group <your new group> is Unoccupied. * Available only if you have the Advanced Alarming package.
NOTE You should not assign this alarm action to frequently-occurring alarms as this may cause problems on your network or the Internet. To secure mailserver communication using SSL or TLS Before the WebCTRL® application sends an email using SSL or TLS, it requests an SSL certificate from the mailserver. If the certificate that the WebCTRL® application receives is in its list of trusted certificates, it sends the email. If the certificate is not in the list, the WebCTRL® application generates a system alarm indicating that the email alarm action failed. If this occurs, you will need to add the mailserver's certificate to the WebCTRL® application's list of trusted certificates. Get a copy of the certificate file from the mailserver. Ask your Network Administrator for help. Put the file on the WebCTRL® server. On the WebCTRL® server, click the Windows® Start button. In the Search programs and files field, type the following command: C``:\WebCTRL<x.x>\bin\java\jre\bin\keytool.exe -import -trustcacerts -alias smtpserver -keystore webserver\keystores\certkeys -file <file_path>`` replacing: ``<x.x>`` with the system's version number ``<file_path>`` with the full path and file name of the certificate file The information for the smtpserver key is displayed and you are prompted to trust this certificate. Type ``yes``. NOTE If your mailserver is using SSL or TLS, the WebCTRL® server is running antivirus software, and the email alarm action fails because it cannot find an SSL certificate, do one of the following: Disable scanning of outgoing SMTP traffic in the antivirus software. See your antivirus software's Help for assistance. Obtain the antivirus software's SSL certificate and install it on the WebCTRL® server using the above procedure. To set up a dial-up networking connection The WebCTRL® application can use a dial-up internet connection through a modem to deliver e-mail for the Send E-mail or Send Alphanumeric Page alarm action. To set up the dial-up connection: Set up your modem to dial out to your Internet Service Provider. See your modem documentation. On the WebCTRL® server, open Internet Explorer®. Select Tools or > Internet Options. On the Connections tab, click Setup. Follow the instructions in the wizard. See Windows Help for assistance. In a text editor such as Windows Notepad, open WebCTRLx.x\webroot\<system>\ system.properties. At the end of the file, type the following line: ``repactions.connection.name=<name of connection>`` where <name of connection> is the ISP name you entered in the wizard in step 2. Open Internet Explorer, then select Tools > Internet Options > Connections tab. If the box under Dial-up and Virtual Private Network settings shows more than one connection, select the connection that you just created, then click Set Default. Select Always dial my default connection.
#### Send SNMP Trap NOTE To see if your system has this optional package, click , then select About. You have this package if Enabled Features shows Adv. Alarming. The Send SNMP Trap alarm action sends an SNMP trap in response to receiving an alarm. Traps contain the text created in the Text to send as the SNMP Trap field in the alarm action dialog box. You can configure up to five SNMP servers to receive traps. NOTES WebCTRL® supports SNMP v1. Each SNMP server you want to receive these traps must have SNMP monitoring equipment installed. If problems arise with your SNMP connection or receiving traps, contact your IS department. This alarm action uses Port 162 to send SNMP traps. To use a different port, open WebCTRL x.x\webroot\<system_name>\system.properties in a text editor such as Notepad. In the line #snmp.trap.port = 162, delete # at the beginning of the line and change 162 to the port you want to use. If you make this change while the WebCTRL Server application is running, you must restart it to have the change take effect.
Field | Notes
--- | ---
Network Address** | The network address of the SNMP server receiving the SNMP trap.
Community Name** | The community name that the SNMP server belongs to.
Comment | The physical location of the SNMP server. This field is optional.
Trap number** | If the network administrator has configured trap numbers, type a unique number from 1 to 127. NOTE The same trap number is used for all messages from this alarm action.
Text to send as the SNMP Trap | 255 character limit. Type punctuation, spaces, or returns after the entries to format the message. You can customize this text by selecting field codes from the Append Field Code list.
Perform Action | By default, the WebCTRL® application performs an alarm action when the alarm source generates an alarm and when it returns to normal. Under Perform Action, you can choose to run the alarm action: Only when the alarm source generates an alarm or when it returns to normal. After a specified amount of time if the alarm has not been acknowledged or has not returned to normal. Use this option for alarm escalation. If the alarm occurs during the occupied hours defined for a schedule group or run if the alarm occurs during the unoccupied hours defined for a schedule group. EXAMPLE To have one alarm action performed during work hours and a different alarm action performed after work hours: Create a schedule group, but do not assign members to it. Create a schedule for the group. Set the occupied hours to be the same as the work hours. Create the alarm action that is to be performed during work hours. Under Perform Action, select If schedule group <your new group> is Occupied. Create the alarm action that is to be performed after work hours. Under PerformAction, select If schedule group <your new group> is Unoccupied.
** Ask your network administrator for this information.
#### Send Web Service Request The Web Service Request alarm action sends a web service request to a third-party server when an alarm event occurs. For example, the WebCTRL® application could send a request to a work order system so it could create a work order for someone to respond to the alarm condition.
Field | Notes
--- | ---
Destination Address | The URL of the server that will receive the request. Example: https://192.168.168.102/workorder/bas
Web Service Action | Select the type of web service request required by the target server: GET or POST
Content Type | If you selected POST in the previous field, select the format required by the target server: ``Application/json`` or ``/x-www-form-urlencoded``
Web Service Request Parameters | Optional–Create a parameter for each piece of information that the target server requires. You should be able to find information about required parameters in the target server's documentation.
Parameter Name | Enter a name for the parameter. For example, Parm1 or Date. Click Add Parameter.
Value | Text required for the parameter. To add live data to the request, select a field code from the Append Field list.
Perform Action | By default, the WebCTRL® application performs an alarm action when the alarm source generates an alarm and when it returns to normal. Under Perform Action, you can choose to run the alarm action: Only when the alarm source generates an alarm or when it returns to normal. After a specified amount of time if the alarm has not been acknowledged or has not returned to normal. Use this option for alarm escalation. If the alarm occurs during the occupied hours defined for a schedule group or run if the alarm occurs during the unoccupied hours defined for a schedule group. EXAMPLE To have one alarm action performed during work hours and a different alarm action performed after work hours: Create a schedule group, but do not assign members to it. Create a schedule for the group. Set the occupied hours to be the same as the work hours. Create the alarm action that is to be performed during work hours. Under Perform Action, select If schedule group <your new group> is Occupied. Create the alarm action that is to be performed after work hours. Under PerformAction, select If schedule group <your new group> is Unoccupied.
#### Write Property NOTE To see if your system has this optional package, click , then select About. You have this package if Enabled Features shows Adv. Alarming. The Write Property alarm action writes a specified value to a BACnet property. You typically set up 2 alarm actions, the first writes a value when the alarm occurs and the other writes a value when the return-to-normal occurs.
Field | Notes
--- | ---
Expression | Type the path to the target property. To get the path, right-click the property on a Properties page, then select Global Modify. The Geographic Location field in the Advanced section shows the path. Click to copy it. NOTES A BACnet Parameter microblock's present value cannot be written to directly. However, you can change the present value by writing to the relinquish_default property, or to the priority_array/priority16 property. For example, change ``#rtu-1/vfd_ovrde/present_value`` to ``#rtu-1/vfd_ovrde/relinquish_default``, or ``#rtu-1/vfd_ovrde/priority_array/priority16.`` Do not use a BACnet address in this field.
Value to Write | Type the value you want to write to the microblock property. Type ``0`` or ``1`` for a binary property.
Append field code to value | Select field codes to add this information to the Value to Write field.
Perform Action | By default, the WebCTRL® application performs an alarm action when the alarm source generates an alarm and when it returns to normal. Under Perform Action, you can choose to run the alarm action: Only when the alarm source generates an alarm or when it returns to normal. After a specified amount of time if the alarm has not been acknowledged or has not returned to normal. Use this option for alarm escalation. If the alarm occurs during the occupied hours defined for a schedule group or run if the alarm occurs during the unoccupied hours defined for a schedule group. EXAMPLE To have one alarm action performed during work hours and a different alarm action performed after work hours: Create a schedule group, but do not assign members to it. Create a schedule for the group. Set the occupied hours to be the same as the work hours. Create the alarm action that is to be performed during work hours. Under Perform Action, select If schedule group <your new group> is Occupied. Create the alarm action that is to be performed after work hours. Under PerformAction, select If schedule group <your new group> is Unoccupied.
#### Write to Database NOTE To see if your system has this optional package, click , then select About. You have this package if Enabled Features shows Adv. Alarming. The Write to Database alarm action stores alarm information in a table in the WebCTRL® alarm database or in a custom database. Third-party applications can access the alarm information for building maintenance management or alarm analysis. For example, an application can perform actions such as triggering a stored procedure or running a report. Writing to the WebCTRL® alarm database When you add the Write to Database alarm action, by default the WebCTRL® application writes alarm information to the write_db_ra table in the WebCTRL® alarm database. The following table describes the information that is written to the database and gives the column name and data type that you will need to access the alarm information from a third-party application.
Description | Column Name | Data type
--- | --- | ---
Alarm generation time | EVENT_TIME_ | Datestamp
Path to the alarm source Example: #slm/m073 | SOURCE_PATH_ | String
Display name path to the alarm source Example: Atlanta Office/R&D Facility/Second Floor/VAV 2-1/Zone Temp | DISPLAY_NAME_ | String
Alarm state Example: OFF NORMAL, LOW LIMIT, HIGH LIMIT | EVENT_STATE_ | String
Alarm text as defined in the Text to write to the database field on the alarm action page. You can add live data to the text by selecting field codes from the Append Field Code list. | RA_TEXT_ | String
Perform Action | By default, the WebCTRL® application performs an alarm action when the alarm source generates an alarm and when it returns to normal. Under Perform Action, you can choose to run the alarm action: Only when the alarm source generates an alarm or when it returns to normal. After a specified amount of time if the alarm has not been acknowledged or has not returned to normal. Use this option for alarm escalation. If the alarm occurs during the occupied hours defined for a schedule group or run if the alarm occurs during the unoccupied hours defined for a schedule group. EXAMPLE To have one alarm action performed during work hours and a different alarm action performed after work hours: Create a schedule group, but do not assign members to it. Create a schedule for the group. Set the occupied hours to be the same as the work hours. Create the alarm action that is to be performed during work hours. Under Perform Action, select If schedule group <your new group> is Occupied. Create the alarm action that is to be performed after work hours. Under PerformAction, select If schedule group <your new group> is Unoccupied.
NOTES To keep the database table from growing too large, you must delete old entries using a third-party database application. You cannot view, edit, or delete entries in the WebCTRL® interface. If your system uses an Access or Derby database, you cannot open the database in a third-party application while the WebCTRL® or SiteBuilder application is running. Writing to a custom database The WebCTRL® application can write alarm information to the following types of custom databases. The custom database does not have to be the same type as the WebCTRL® database. SQL Server MySQL PostgreSQL Oracle You may create a table in an existing third-party database or create a new database. Using your database management tool, create a table in your custom database that includes fields for each alarm field code to be written to the table. Each field length in the table should be as long as the longest value to be written to that field. To set up writing to a custom database instead of the WebCTRL® alarm database, check Specify Custom Database on the Alarms page Actions tab, then enter information in the remaining fields. See table below.
Field | Notes |
--- | --- | ---
Text to write to the database | The text is made up of field codes that add live data to the text. You can select additional field codes from the Append Field Code list. NOTE To write the text in this field to the custom database, you must include the Report Text field code ($report_text$) in the Database Insert String field described below.
Database Connect String | For database type... SQL Server MySQL PostgreSQL Oracle | The connect string format is... jdbc:odbc:<odbc_alias> jdbc:mysql://<host>:<port>/<instance> jdbc:postgresql://<host>:<port>/<instance> jdbc:oracle:thin@<host>:<port>/<instance> where: <host> is the database server name/IP address <port> is the port number for the database <instance> is the database name in the database server <odbc_alias> is the name of the ODBC data source
Database Login and Password | The login and password to connect to the database.
Database Insert String | Use the following format: Insert into <TABLE_NAME> (<column1_name>, <column2_name> ...) values (<$field_code1$>, <$field_code2$>, ...) Example: Insert into WebCTRL_ALARMS (TIME_, LOCATION_, TO_STATE_, TEXT_) values ($generation_time$, $location_path$, $to_state$, $report_text$) NOTES You can add field codes to the Insert String using the Append Field Code list. If you add a timestamp type field code (for example, $generation_time$), you should have the data go into a timestamp data type field in the custom database. Otherwise, you must use field code formatting to format the time. You can add only one Database Insert String per alarm action.
Perform Action | By default, the WebCTRL® application performs an alarm action when the alarm source generates an alarm and when it returns to normal. Under Perform Action, you can choose to run the alarm action: Only when the alarm source generates an alarm or when it returns to normal. After a specified amount of time if the alarm has not been acknowledged or has not returned to normal. Use this option for alarm escalation. * If the alarm occurs during the occupied hours defined for a schedule group or run if the alarm occurs during the unoccupied hours defined for a schedule group. * EXAMPLE To have one alarm action performed during work hours and a different alarm action performed after work hours: Create a schedule group, but do not assign members to it. Create a schedule for the group. Set the occupied hours to be the same as the work hours. Create the alarm action that is to be performed during work hours. Under Perform Action, select If schedule group <your new group> is Occupied. Create the alarm action that is to be performed after work hours. Under Perform Action, select If schedule group <your new group> is Unoccupied. * Available only if you have the Advanced Alarming package.
#### Write to File The Write to File alarm action can do either of the following: Record alarm information in a standard ASCII text file that you can view and edit using a text editor such as Windows® Notepad. Write a WebCTRL® report to a file.
Field | Notes
--- | ---
File Name | Path to the file you want to write to such as c:\WebCTRLx.x\webroot\alarms.txt. If you do not specify a path, the file is written to the system folder. If you type a path that does not exist, the WebCTRL® application will create the necessary folders. You can write to one of the following: - a file on the server - a networked computer if you map the network drive. Use the drive mapping in the path from the server to the computer. The path name may contain field codes.
Write alarm data | Select to record alarm information in a text file. Select Append to add new alarm information to the end of the file instead of writing over existing data. NOTE Because you can append new alarm information to the end of the file, this file can become very large. You must back up and delete this file frequently if you are using this alarm action with many alarms. In the Text to write to the file, enter the information you want to record for an alarm. Use punctuation, spaces, or returns to format the text. To add live data to the text, select field codes from the Append Field Code list.
Write a report | Select to write a WebCTRL® report to a file, then select the Report and the Format. NOTE The Report Name field shows a custom report only if it is accessible at the current level. Run as shows the name and login name of the operator creating the alarm action. The report will be run using the privileges and report options of this operator. TIP You may want to create a new operator with limited privileges for this purpose.
Perform Action | By default, the WebCTRL® application performs an alarm action when the alarm source generates an alarm and when it returns to normal. Under Perform Action, you can choose to run the alarm action: Only when the alarm source generates an alarm or when it returns to normal. After a specified amount of time if the alarm has not been acknowledged or has not returned to normal. Use this option for alarm escalation. * If the alarm occurs during the occupied hours defined for a schedule group or run if the alarm occurs during the unoccupied hours defined for a schedule group. * EXAMPLE To have one alarm action performed during work hours and a different alarm action performed after work hours: Create a schedule group, but do not assign members to it. Create a schedule for the group. Set the occupied hours to be the same as the work hours. Create the alarm action that is to be performed during work hours. Under Perform Action, select If schedule group <your new group> is Occupied. Create the alarm action that is to be performed after work hours. Under Perform Action, select If schedule group <your new group> is Unoccupied. * Available only if you have the Advanced Alarming package.