Event commands

Select a command under a category to perform when an event triggers:
Category
Command
Description
Alarm History
Cancel Alarm History Export
Cancels the export of the alarm history.
Clear Alarm History
Removes all alarm events stored on the HMI device.
Export Alarm History
Exports a .csv file for the alarm history in the project to a .zip file and places the .zip file on a USB drive or SD card to review the alarm history on a computer.
Certificates
Delete Certificate
Deletes a digital certificate stored on the HMI device. This command requires entering the fingerprint of a specific certificate.
Import Certificate
Imports a digital certificate with a specified file name.
Data Log
Cancel Data Log Export
Cancels the export of the data log.
Clear Data Log
Clears the contents of all data logs or selected data logs.
Export Data Log
Exports a .csv file for each data log in the project to a .zip file and places the .zip file on a USB drive or SD card to review the data log on a computer.
File transfer
Upload to Server
Uploads folders or files from a USB drive or SD card connected to an HMI device, to a file transfer server over a configured file transfer connection.
Download to HMI Device
Downloads folders or files from a file transfer server to a USB drive or SD card connected to an HMI device, over a configured file transfer connection.
Verify File Transfer Connection
Verifies that the file transfer connection is configured correctly, allowing for upload and download of folders and files.
HMI Device Configuration
Calibrate Touch Screen
Calibrates the HMI device screen for touch. This command displays a red target on the screen. Press and hold the center of the target until the target turns white and another red target appears. Continue pressing and holding the centers of all remaining targets as they appear. All processed targets are replaced with white targets. A green circle with a check indicates successful calibration. A red circle with an X indicates a failed calibration.
If a red circle with an X appears, perform the event again to calibrate the screen.
Load Application
Loads the specified runtime application file to the HMI device from either a USB storage or an SD card.
Reboot Terminal
Reboots the HMI device immediately.
Safely Remove Media
Prepares the SD card for safe removal from the HMI device so the files do not become corrupt or read-only.
Language
Switch Language
Changes the language that displays on the HMI device.
Tip:
Import the desired languages before changing the language that displays on the HMI device.
Navigation
Navigate Backward
Navigates back in history to the screen opened using the
Navigation
menu or a
Screen Navigate
command.
Logging off the HMI device erases the navigation history.
Navigate Forward
Navigates forward in history to the screen openedusing the
Navigation
menu or a
Screen Navigate
command.
Logging off the HMI device erases the navigation history.
Open web browser
Opens the web browser in a new window.
Close web browser
Closes the web browser.
Popup Close
Closes the popup on the HMI device when the event occurs. Only one popup can be open on the HMI device at a time.
Popup Open
Opens a specific popup when the event occurs. Only one popup can be open on the HMI device at a time.
In the
Open Popup
box, navigate to and select the popup the event is to open. If the selected popup has a user-defined data type property, bind the value in the
Property Configuration
box to the user-defined data type property of the popup. This passes the value to the popup when it opens on the HMI device.
If a graphic element on the popup to open has an aliased property with a value, the Popup Open command can read the value from a referenced graphic element and apply it to the alias. In the
Property Configuration
box at the bottom of the command, enter the name of the graphic element and the property that has the value to apply to the aliased property. Use the format ElementName.PropertyName. When the event triggers, the graphic element on the popup with the aliased property shows the property value of the graphic element that is referenced in the
Property Configuration
box. The
Property Configuration
box appears for the command only if there is an aliased property or user-defined property on the target popup.
Screen Navigate
Opens the specified shortcut or screen when the event occurs.
In the
Navigate To
box, select the screen or shortcut that the event is to open. If the selected screen or shortcut has a user-defined data type property, bind the value in the
Property Configuration
box to the user-defined data type property of the screen or shortcut. This passes the value to the screen when it opens on the HMI device.
If a graphic element on the screen to open has an aliased property with a value, the Screen Navigate command can read the value from a referenced graphic element and apply it to the alias. In the
Property Configuration
box at the bottom of the command, enter the name of the graphic element and the property that has the value to apply to the aliased property. Use the format ElementName.PropertyName. When the event triggers, the graphic element on the screen with the aliased property shows the property value of the graphic element that is referenced in the
Property Configuration
box. The
Property Configuration
box appears for the command only if there is an aliased property or user-defined property on the target screen.
Show Navigation Menu
Opens the
Navigation
menu on the HMI device screen when the event occurs.
Notification
Send Email
Sends an email with a configurable subject and message to one or more recipients. First configure the email server connection from the Settings screen on the HMI device.
PDF
Previous Page
Navigates to the previous page in a PDF document.
Next Page
Navigates to the next page in a PDF document.
Go To Page
Navigates to a specified page in a PDF document.
Zoom in
Increases the document magnification by a percentage of the preset level in a PDF document.
Zoom out
Decreases the document magnification by a percentage of the preset level in a PDF document.
Zoom to
Adjusts the magnification to fit the page, fit the width of the page, or display the page at 100% magnification.
Security
Logon
Opens the
Log On
dialog box when the event occurs. When the
Log On
dialog box opens, any open popup closes.
Logoff
Logs you off the project. If the Guest user role has security access to the current screen, the screen remains open. If the Guest user role does not have security access to the current screen, the
Home
screen opens.
State
State Previous
Applies the previous state in the selected State Table to the graphic element when the event occurs. To configure this command, in the box in the command card, select the name of the desired State Table. Select
Wrap Around
to continue to apply states when the event occurs, even if the beginning or end of the State Table is reached.
If you create a
State
event with a
State Previous
command with
Wrap Around
selected, the graphic element loops through states in the State Table as the event occurs.
State Next
Applies the next state in the selected State Table to the graphic element when the event occurs. To configure this command, in the box in the command card, select the name of the desired State Table. Select
Wrap Around
to continue to apply states when the event occurs, even if the beginning or end of the State Table is reached.
If you create a
State
event with a
State Next
command with
Wrap Around
selected, the graphic element loops through states in the State Table as the event occurs.
Value
Increment
Increments the value of the selected tag when the event occurs. Specify the value with a number, a tag, an expression, an element property, or the property of a screen or Add-On Graphic.
In the
Increment
box, enter or browse to select the tag or property of a screen or Add-On Graphic. In the
By
box, create the expression value by which to increment the tag when the event occurs. The increment can be either negative or positive.
Toggle
Toggles the value of the selected tag from 0 to 1, or from 1 to 0, when the event occurs.
In the
Tag
box, enter or browse to select the tag or property of a screen or Add-On Graphic.
Write
Writes a value to the selected tag when the event occurs. Specify the value with a number, a tag, an expression, an element property, or the property of a screen or Add-On Graphic.
In the
Write To
box, enter or browse to select the tag or property of a screen or Add-On Graphic. In the Expression
box, create the expression value to write to the tag when the event occurs.
Windows
Open Program or File
Opens the specified application or file in the Emulator or View 5000 Client for a View 5000 Server HMI device. PanelView 5000 HMI devices do not support opening programs and files.
Open Logix Designer
Opens the Logix Designer application and go to a specific program, routine, and rung. PanelView 5000 HMI devices do not support opening programs and files.
TIP:
Tips:
  • For best performance, create commands which evaluate no more than 20 tags.
For example, it is best for a Write command to have an expression containing no more than 20 tags or a Send Email command to embed no more than 20 tags in the message.
  • For commands with expressions using many tags in a reference, have 10 or fewer such commands in an event for best performance.
  • Using larger numbers of tag references in many commands may cause slow screen performance while those commands evaluate.
  • Reference 1000 or fewer tags across all the project events. Using a larger number of tag references may cause delays in
    PanelView
    5000 recovery from controller disconnects.
  • If the HMI device processes a large number of background tasks, like multiple triggered alarms, you may need to repeat a button press to execute the button commands.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal