Using Commands    

After you select an action, you can select a command to execute. The commands are predefined tasks in Proficy Portal and allow you to complete specific functions without coding. The following table lists the available commands.

The command...

Lets you...

Close Digital

Close a digital tag by sending a one to the specified data source.

Close Picture

Close an open display.

Load Event Group

Load an event group.

Load Pen Group

Load a pen group.

Load Symbols Command

Load a symbols file.

NOTE: The Load Symbols command is not available for List and Combo boxes.

Login

Log into Proficy Portal. Logs out the current user and logs in the user set in the Login Command dialog box.

Logout

Log out of Proficy Portal.

Open Digital

Open a digital tag by sending a zero to the specified data source.

Open Picture

Open an analysis display or URL, or loads a symbols file.

Print

Print the current analysis display.

Print Preview

Launches a preview of the printed display. You must have Adobe Acrobat Reader (version 6.0 or later) installed to use this command.

Print Preview Report

Launches a preview of the display with expanded grids (if any exist). You must have Adobe Acrobat Reader (version 6.0 or later) installed to use this command.

Print Report

Print the display with expanded grids (if any exist).

Replace Picture

Replace the current analysis display with the specified display or URL.

Toggle Digital

Toggle the value of a digital tag.

Write Value

Send data to the specified data source. The value written can be a fixed value, obtained from the property of the current object, or from the user at run-time.

Several commands require a connection to another object. For example, if you configure the Load Event Group or Load Pen Group command for a button control, you must select the chart that the event/pen group is loaded into. When the button is clicked during run-time, the event/pen group loads into the connected chart. For some commands, however, if you want an object to interact with the result of the action performed by the source object, you must link the source object to the destination object's data source. For example, if you want a button to write a value to a database, and you want the change to appear in a grid, you must link the button command to the grid's data source. See To connect an object to a control for detailed information.

Using Commands with Grouped Objects

Commands can be set for grouped objects. For example, you may want to set a Load Symbols command on several objects in the display. Rather than set the command on each object, group the objects and set the command on the group. During run-time, the command will be executed when the user clicks in the grouped area. The MouseClicked action is the only action available for commands set on grouped objects.

Some objects cannot be used for commands set on groups of objects. For example, a grid, chart, and time component object all have run-time functionality that requires the user to click certain parts of the object. Therefore, if a user needs to be able to click a row in a grid or a Quick Time control on a chart, the MouseClicked action for the set command is inactive for these objects. Although these objects (grids, charts, and so forth) can be part of a group of objects, a command set on the group will execute only when an area outside of these objects is clicked or another object such as a shape is clicked.

See Also

Actions and Events

To configure actions and commands

Example: Opening a Display

To group and ungroup objects