In addition to the multiple new features and improvements in this latest release, GENESIS64 contains new Commanding options that can be found within both GraphWorX64 and within the AssetWorX provider in the Workbench configuration tool.
These new Commanding options help users perform wide and varied tasks throughout the GENESIS64 suite, reducing the need for specialized scripting to perform the same actions.
Setting Command Properties in GraphWorX64
Setting Command Properties in AssetWorX in the Workbench
Note: Commands can now be executed on events. Click HERE for more info.
Once you have created a new display (or are working on a display in progress), you can add a Dynamic element to the display that can be used to interact with added Controls within that display (for instance, a GraphWorX64 Viewer or a TrendWorX64 Viewer or an AlarmWorX64 Viewer, etc).
Control Options within GraphWorX64
Once you have added your desired separate elements within your GraphWorX64 display, you can enable commanding on a specific Dynamic element. In the example below, we want to create a titled button to acknowledge the alarms within an AlarmWorX64 Control within the same GraphWorX64 display.
An Example of Applying a Command to a GraphWorX64 Dynamic Element
First, create a new GraphWorX64 display, as usual.
You can add the needed elements in any order. Select the AlarmWorX64 Viewer from the Controls (for this example, we're using a sample control, but you could proceed in connecting the viewer [via the AlarmWorX64 Configuration tab once activated] to your own desired data source for the alarms), then draw a box to drop the viewer into.
Select a button from the Buttons section of the Dynamics ribbon. In our example, we selected a button where we can label it as "Acknowledge", as shown below.
With the new "Acknowledge" button selected, we can now select the appropriate Command from the Command pulldown in the Dynamics properties. (The Dynamics tab should appear on the bottom right, if not already selected).
Set the "Command" pulldown to "Acknowledge". [Notice that once you have selected a particular Command that the Command Parameters below change accordingly. For this example, we will proceed with the parameters "as is".
You can now save the display or click on "Runtime" to test the new commanding button.
An Example of Commanding in GraphWorX64
This is just a simple example of what the Commanding feature within GraphWorX64 can do.
Click HERE for an example of enabling commands through the Asset Navigator Control in GraphWorX64.
___________________________________________________________________________________________________________________________________
Here is the full list of currently available commands:
___________________________________________________________________________________________________________________________________
The Close Window command closes the GraphWorX64 display window when this pick action occurs during runtime.
Command parameters are:
TargetType is the type of window to be opened. Some of these selections are window types, some are windows hierarchy (relative paths), and some are absolute settings (such as the Root window). For more information about windows, refer to Windows Dynamics. Choices are:
Current Display opens the same GraphWorX64 display; this is a refresh of the currently open GraphWorX64 display. Not supported in a Silverlight display.
Popup Window (Display Dependent)
Popup Window (Display Dependent - Modal)
Popup Window (Window Dependent)
Popup Window (Window Dependent – Modal)
Popup Window (Independent)
Embedded Window is a window contained within another window.
Parent Window is the window from which another window was created.
Root Window is the first window shown in a display, from which all other windows are created.
New Instance (Separate Process)
Any Named Window
TargetName is the actual window to be opened. Click the ellipsis button 
to open the Data Browser so you can identify the target.
GraphWorX64 maintains a history of the last 50 displays. You can navigate through the display history using the pick commands Display Back and Display Forward. These commands work similarly to Microsoft Internet Explorer's back/forward feature.
|
|
Note: The display file history (forward/back commands) remembers the initial alias settings specified when a display is opened and will reset those aliases when you go back to that display in the file history. |
Display Back acts like the Back button in a browser, moving users through a browse sequence of GraphWorX64 displays. Using this pick action lets runtime users navigate backward through the display history.
Display Forward acts like the Forward button in a browser, moving users through a browse sequence of GraphWorX64 displays. Using this pick action lets runtime users navigate forward through the display history. Command parameters are:
Command parameters for Display Back and Display Forward are:
TargetType is the type of window to be opened. Some of these selections are window types, some are windows hierarchy (relative paths), and some are absolute settings (such as the Root window). For more information about windows, refer to Windows Dynamics. Choices are:
Current Display opens the same GraphWorX64 display; this is a refresh of the currently open GraphWorX64 display.
Popup Window (Display Dependent)
Popup Window (Display Dependent - Modal)
Popup Window (Window Dependent)
Popup Window (Window Dependent – Modal)
Popup Window (Independent)
Embedded Window is a window contained within another window.
Parent Window is the window from which another window was created.
Root Window is the first window shown in a display, from which all other windows are created.
New Instance (Separate Process) is a new instance of the same window.
Any Named Window is any window; specify the window name in the TargetName property.
TargetName is the actual window to be opened. Click the ellipsis button [...] to open the Data Browser so you can identify the target.
The Load Display command opens a GraphWorX64 display window of the type that you specify with the properties that you define. The window can be dependent or independent, modal or non-modal, independent or embedded, or it can even refer to the current display (which is a refresh operation). You can specify other parameters such what loads in the display.
For help understanding how to manage windows through commands, refer to the topic Windows Dynamics. Aliases can be used with this command; for more information, refer to Aliasing and Pick Actions.
Command parameters are:
FileName is the file name of the target window to be loaded during runtime; you can browse files or use the Data Browser.
DragDrop—True lets users move the window to a new location by dragging it there; False makes the window stationery.
TargetType is the type of window to be opened. Some of these selections are window types, some are windows hierarchy (relative paths), and some are absolute settings (such as the Root window). For more information about windows, refer to Windows Dynamics.
The TargetType parameter is used in conjunction with the TargetName parameter (see description below) to designate which display window to open into.
---
If TargetType is Self: (TargetName is unused):
Loads the display into the current window.
This is the default target type.
---
If TargetType is WindowOwnedPopup:
If TargetName is specified and there is already an open popup window that matches that name (and is owned by the current window), the display is loaded into that popup window.
If TargetName is specified and there is NOT already an open popup window that matches that name (and is owned by the current window), the display is loaded into a NEW popup window with the name specified by TargetName.
If TargetName is NOT specified, the display is loaded into a NEW unnamed popup window.
Window owned popups will always stay above the owner window and will be minimized when the owner window is minimized. Window owned popups remain open even if the display is changed in the owner window. Window owned popups will be automatically closed when the owner window exits runtime or is closed.
---
If TargetType is DisplayOwnedPopup:
Same as WindowOwnedPopup except the popup is owned by the Display (meaning, if a new display is loaded in a given window, all popups owned by the display that is being replaced, are automatically closed).
---
If TargetType is DisplayOwnedModalPopup:
Same as DisplayOwnedPopup except the popup is "modal" (disables parent window).
---
If TargetType is WindowOwnedModalPopup:
Same as WindowOwnedPopup except the popup is "modal" (disables parent window).
---
If TargetType is UnownedPopup:
Same as WindowOwnedPopup except the popup is "unowned" (they are owned by the desktop). Unowned popups will not necessarily stay above the window that opened them. Unowned popups remain open even if the display is changed in the window that opened them. Unowned popups will be automatically closed when the "root" window exits runtime or is closed.
---
If TargetType is Embedded:
Same as DisplayOwnedPopup except the window is an embedded child of its parent.
---
If TargetType is Parent:
If TargetName is specified and there is a parent window in the parent chain that matches that name, the display is loaded into that parent window.
If TargetName is specified and there is NOT a parent window in the parent chain that matches that name, the behavior is the same as Self.
If TargetName is NOT specified, the display is loaded into the first parent window (starting at the current window) in the parent chain.
If there is no parent, the behavior is the same as Self.
---
If TargetType is Root: (TargetName is unused)
The display is loaded into the topmost (root) parent window in the parent chain.
If there is no parent, the behavior is the same as Self.
TargetName is the actual window to be opened. Click the ellipsis button [...] to open the Data Browser so you can identify the target.
OverrideWindowProperties—True overrides the properties of the window into which the display is loaded; False leaves the window’s properties in place.
GlobalAliases - Click the ellipsis button [...] to open the Set Global Themes and Aliases dialog box, where you can set any global aliases that will be needed for the window.
LocalAliasCommandType - Specify how the local aliases will be set for the display to be loaded. Choose one of the following:
None - There is no local alias.
From Data - The local alias is provided by data. Specify the data in the LocalAliasCommandData property described below.
From File - The local aliases and their values are stored in a file. Specify the file in the LocalAliasCommandData property described below. For information about how and why this file is created, refer to Saving a File of Local Alias Values for Use with Pick Actions.
LocalAliasCommandData - Specify the file of local aliases and their values (if you chose From File in the LocalAliasCommandType property above), or open the Data Browser to select the data source from which the local alias values are obtained.
The Login/Logout Dialog command opens a dialog in which the runtime user can log in or log out. For more information, refer to Logging in and out of GraphWorX64. There are no command parameters for this command.
The Play Sound command allows for a selected sound to be played upon triggering of a dynamic. The parameters for this command are:
SoundSource - Enter the file name or URL of the sound file to be played.
LoopSound - Set to True to repeatedly play the sound in a loop. Set to False to play the sound only once.
StopSoundOnUnclick - Set to True to stop the currently playing sound when the checkbox is unchecked. The ExecuteOnUnchecked property must also be set to true.
StopSoundOnMouse - Set to True to stop the currently playing sound when the pointer is no longer over the associated visual object. The ExecuteOnMouseLeave property must also be set to true.
The Popup Menu command opens a popup menu. Popup menus are often used to allow runtime users to switch aliases or languages, or to open one display out of a set. They are a great way of providing user interaction so that your display can have situational logic. You can configure the size, font, and position of the popup.
Popup Menu has one command parameter. MenuPosition, determines the position of the popup menu in relation to the parent object. Select MousePoint to pop up the menu at the current mouse position at runtime. Specify Left, Right, Top, or Bottom to pop up the menu to the left or right, top or bottom of the parent graphical object.
NOTE: The Run Report command is for the 32-bit version of ReportWorX. For executing ReportWorX64 reports, see Executing Reports on a Button Press or Command.
The Run Report command executes an ICONICS ReportWorX report during runtime. For more information about ReportWorX, refer to the ReportWorX documentation on the ICONICS BizViz product CD.
Run Report's command parameters are:
ServiceURL - Specify the URL address of the ReportWorX Web Service.
AccessKey - Enter the password needed to access the ReportWorX Web Service.
ReportName - Specify the report to be executed. Click the ellipsis button [...] to select the report to be activated by the pick dynamic. In the Report Name dialog box that opens, refresh the list by the clicking the Get Reports button. Then select the report and click OK.
Parameters - Specify the parameters, if any, to be used with the selected report. For each parameter use the "@parameter" syntax (for example, @Parameter1=34). If you are using multiple parameters, separate each parameter using the pipe character " │" (for example, @ Parameter1=34│@Parameter2=128). Clicking the ellipsis button [...] opens the Data Browser.
Identity - If a user name and password are required to access the ReportWorX server, specify the user login to be used for the report. Choose either InteractiveUser (to log in using the ID of the runtime user who is logged in to GraphWorX) or ThisUser then provide the ID and password to gain access.
User - If the Identity is ThisUser, specify the ID for gaining access to the ReportWorX server. The ID is case sensitive.
Password - If the Identity is ThisUser, specify the password for gaining access to the ReportWorX server. Passwords are case sensitive.
OutputTo - Optionally, type the name of the text object the report output is to be sent to. If necessary, add the label object to the GraphWorX64 display, then return to this property and type its name here. For more information, refer to Labels.
The Run Script command runs a JScript .NET script only. There are no command parameters for this command.
The Run Transaction command executes an ICONICS BridgeWorX transaction during runtime. For more information about BridgeWorX, please refer to the BridgeWorX documentation on the ICONICS BizViz product CD. .
Command parameters for Run Transaction are:
ServiceURL - Specify the URL address of the BridgeWorX Web Service.
AccessKey - Enter the password needed to access the BridgeWorX Web Service.
Transaction -Click the ellipsis button [...] to select the transaction to be activated by the pick dynamic. In the Transaction Name dialog box that opens, refresh the list by the clicking the Get Transactions button. Then select the transaction and click OK.
Identity -If a user name and password are required to access the BridgeWorX server, specify the user login to be used for the report. Choose either InteractiveUser (to log in using the ID of the runtime user who is logged in to GraphWorX) or ThisUser then provide the ID and password to gain access.
User - If the Identity is ThisUser, specify the ID for gaining access to the BridgeWorX server. The ID is case sensitive.
Password - If the Identity is ThisUser, specify the password for gaining access to the BridgeWorX server. Passwords are case sensitive.
OutputTo - Optionally, type the name of the text object the transaction output is to be sent to. If necessary, add the label object to the GraphWorX64 display, then return to this property and type its name here. For more information, refer to Labels.
The Runtime Menu Command executes a command that is currently available on the GraphWorX64 runtime menu.
Command parameters are:
Command - Choose the runtime menu command to be used. To gain a better understanding about how some of the runtime menu commands work, refer to the Runtime Menus in GraphWorX topic. Options you can choose from include the following:
File menu: File Open Dialog, Print, Print Dialog, Print Page Setup, Print Preview, Print Toggle White Background, Print Area Current View, Print Area Entire Display, Recent Files Card View, Exit.
View menu: Zoom In, Zoom Out, Unzoom, Fit to Window, Home View, Toggle Auto Scroll Bars, Toggle Navigation Bar, Toggle Status Bar, Toggle Mail Menu, Toggle Ribbon, History Card View, History Back, History Forward.
Tools menu: Login Dialog, Select Language Dialog, Carousel, Carousel Card View, Toggle Cache Displays.
Help menu: Help Topics, About
Configuration Mode
TargetType is the type of window to be opened by the command. Some of these selections are window types, some are windows hierarchy (relative paths), and some are absolute settings (such as the Root window). For more information about windows, refer to Windows Dynamics. Choices are:
Current Display opens the same GraphWorX64 display; this is a refresh of the currently open GraphWorX64 display.
Popup Window (Display Dependent)
Popup Window (Display Dependent - Modal)
Popup Window (Window Dependent)
Popup Window (Window Dependent – Modal)
Popup Window (Independent)
Embedded Window is a window contained within another window.
Parent Window is the window from which another window was created.
Root Window is the first window shown in a display, from which all other windows are created.
New Instance (Separate Process) is a new instance of the same window.
Any Named Window is any window; specify the window name in the TargetName property.
TargetName is the actual window to be opened. Click the ellipsis button [...] to open the Data Browser so you can identify the target.
The Set Global Aliases command sets a global alias theme at runtime for the This Display object when the pick dynamic is triggered. Global aliases are stored and maintained in a SQL Server database.
This setting has one command parameter:
GlobalAliases - Click the ellipsis button [...] then select the global alias theme from the Data Browser . Refer to Global Aliasing for more information. For additional information, refer to Aliasing and Pick Actions.
The Set Language command sets the runtime language to a language of your choosing. At runtime, string substitutions (which the Language Alias System SQL database manages) translate items in the runtime display to the specified language. For example, use this command in a button that Spanish-speakers can click in order to see the runtime display in Spanish. Refer to the topic Language Aliases for more details. For additional information, refer to Aliasing and Pick Actions.
This setting has one command parameter:
Set Language—Click the ellipsis button then select the language from the Language Selector dialog box.
The Set Local Aliases command sets the value of one or more local aliases for the This Display object or for a specific object in the display. The local aliases are used for connecting to data in runtime mode. Local aliases are stored with the display in memory. Aliasing and Pick Actions describes the use of local aliases (including object-specific local aliases) with pick actions.
Command parameters for Set Local Aliases are:
LocalAliasCommandType - Specify how the alias value is to be set. The default is None (no alias values will be set). You can choose From Data (the local alias is entered directly into the LocalAliasCommandData property) or From File (the local alias is stored in a CSV or TSV delimited file). Selecting one of these options enables the LocalAliasCommandData parameter.
LocalAliasCommandData - Choose the data that will set the alias value or the file that contains alias values.
If the type is From Data, type the local alias in the format {{<<localAliasName>>}} or click the ellipsis button [...] to open the Data Browser, where you can go to the Local Alias Table tab to select or create local aliases and then assign their values.
If the type is From File, select Browse Files to select a delimited file or Data Browser to use CSV or TSV delimited files, text values, or other sources for local aliases. In a Silverlight display, this option is not supported.
TargetType is the type of window to be target of the value changes. Some of these selections are window types, some are windows hierarchy (relative paths), and some are absolute settings (such as the Root window). For more information about windows, refer to Windows Dynamics. Choices are:
Current Display (the default) opens the same GraphWorX64 display; this is a refresh of the currently open GraphWorX64 display.
Popup Window (Display Dependent)
Popup Window (Display Dependent - Modal)
Popup Window (Window Dependent)
Popup Window (Window Dependent – Modal)
Popup Window (Independent)
Embedded Window is a window contained within another window.
Parent Window is the window from which another window was created.
Root Window is the first window shown in a display, from which all other windows are created.
New Instance (Separate Process) is a new instance of the same window.
Any Named Window is any window; specify the window name in the TargetName property.
TargetName is the actual window to be target of the value changes. Click the ellipsis button [...] to open the Data Browser so you can identify the target.
ObjectName (optional) is the name of the visual object for which to set the local alias. Using this parameter sets values for local aliases for only the specified object. Type the name of the object as it appears in the Explorer. Object names are case sensitive. Also, be aware that object names can change; if they do, you must return to this dynamic to change its name here.
The Set Object Visibility command applies a hide or show dynamic to an object based on a condition and using the trigger you specify. Command parameters are:
VisibilityCommand - Specify the type of visibility command to be executed. Choose Hide to hide the object, Show to show the object, or Toggle to switch back and forth between hiding and showing the object.
ObjectName - Specify the name of the object to be hidden or shown. Type the name of the object as it appears in the Explorer. Object names are case sensitive. Also, be aware that object names can change; if they do, you must return to this dynamic to change its name here.
The Set View command sets the view. This command is useful if the display has views defined for it; for more information refer to Creating 2D Views for Runtime Users and Controlling the Runtime Behavior of 3D Views. Command parameters for Set View are listed below.
TargetType is the type of window to be target of the value changes. Some of these selections are window types, some are windows hierarchy (relative paths), and some are absolute settings (such as the Root window). For more information about windows, refer to Windows Dynamics. Choices are:
Current Display (the default) opens the same GraphWorX64 display; this is a refresh of the currently open GraphWorX64 display.
Popup Window (Display Dependent)
Popup Window (Display Dependent - Modal)
Popup Window (Window Dependent)
Popup Window (Window Dependent – Modal)
Popup Window (Independent)
Embedded Window is a window contained within another window.
Parent Window is the window from which another window was created.
Root Window is the first window shown in a display, from which all other windows are created.
New Instance (Separate Process) is a new instance of the same window.
Any Named Window is any window; specify the window name in the TargetName property.
TargetName is the actual window to be target of the value changes. Click the ellipsis button [...] to open the Data Browser so you can identify the target.
TargetName3D is the destination name of the 3D viewport, if any. The name can include wild cards. Or click the ellipsis [...] button to open the Data Browser and select the file.
ZoomType specifies how you are identifying the view:
ZoomToNamed goes to the view specified in the ViewName property.
ZoomToCustom goes to the view specified in the ViewRectangle property.
ZoomToObject zooms to the object specified in the ObjectName property.
ZoomByValue zooms to the object specified in the ObjectName property and multiplies the current magnification by the percentage specified in the ZoomValue property.
ViewName (ZoomToNamed only) is the name of the view as it is defined in the display.
ViewRectangle (ZoomToCustom only) is the 2D coordinates of the rectangle that will display as the view. Coordinates are four numbers separated by commas (,) that delimit the left, top, right, and bottom of the view. Specify the number of pixels from the left (for the left and right) and from the top (for the top and bottom) of the display.
ZoomValue (ZoomByValue only) specifies the percentage by which the view is to zoom to the object.
ObjectName (ZoomToObject and ZoomByValue only) specifies the name of the visual object the button will zoom to. Type the name of the object as it appears in the Explorer. Note that object names are case sensitive. Also, be aware that object names can change; if they do, you must return to this dynamic to change its name here.
TransitionDuration specifies, in milliseconds, how long you want it to take for the view to transition. The default, 0 (zero), provides no transition; the view changes abruptly. For the transition to take 2 seconds, enter 2000.
The Start Application command launches a file or URL and opens the specified application or document in runtime mode. In addition to launching executables, you can launch various documents, including Microsoft Word documents, Microsoft Excel spreadsheets, HTML files, and text files. The registered application is automatically started when the file is launched.
This relatively simple command action requires that you specify as command parameters the FileName of the executable or document, as well as any command line Arguments to be passed when the application starts.
|
|
Tip: You could pass the command processor CMD.exe to the Start Application command, and by doing so provide a batch file as the input, or use a command as an argument. This opens up a powerful method for controlling devices, setting environmental variables, and performing any system or management function (WMI for example) that you can from a command line. |
The Toggle Value command toggles between two or more specified values or states during runtime using an action that you specify. Make sure you specify a DataSource property (the data source the toggled value is written to) and specify True for the Data Write Confirm property. Command parameters for the Toggle Value command are:
ValueOne - The first value of the first state of the toggle.
ValueTwo - The second value of the second state of the toggle.
MoreValues - This property lets you define a list of values through which the toggle action can cycle. Click the ellipsis [...] button to open the Edit Toggle Values dialog box where you can enter additional values. The first two lines are the properties in ValueOne and ValueTwo. The toggle button toggles sequentially through this list, from top to bottom.
The Update Database command queries the database attached to the OPC UA data source with the current values of tags that you specify based on the runtime condition or action that triggers the pick action. It updates the data mining server by writing any value to a data mining tag exposed by this server. There are no command parameters for this command.
The Write Value command writes a value (one that you specify or a value of a tag) to another tag. Make sure you specify a DataSource property (the data source the value is written to) and specify True for the Data Write Confirm property. Also, make sure the Update property is set to True. Command parameters for the Write Value command are listed below.
To enable a Command Parameter property, set its corresponding property in the Execution Trigger - When section to True. Click the property's ellipsis [...] button to open the Data Browser to select a tag or file.
OnDownValue - Specify the value(s) to be written when the mouse is down-clicked (MouseDown event). Normal button only. Available only if ExecuteOnDown is True.
OnCheckedValue - Specify the value(s) to be written at the moment the check box or radio button is selected. Available only if ExecuteOnChecked is True.
WhileDownValue - Specify the value(s) to be written while the mouse is down. Normal button only. Available only if ExecuteWhileDown is True.
WhileCheckedValue - Specify the value(s) to be written while the check box or radio button is selected. Available only if ExecuteWhileChecked is True.
OnUpValue - Specify the value(s) to be written when mouse button is released (MouseUp). Normal button only. Available only if ExecuteOnUp is True.
OnUncheckedValue - Specify the value(s) to be written at the moment the check box or radio button is deselected. Available only if ExecuteOnUnchecked is True.
OnDoubleClickValue - Specify the value(s) to be written when the button is double-clicked. Available only if ExecuteOnDoubleClick is True.
OnMouseMoveValue - Specify the value(s) to be written for the duration that the cursor position over the button changes (during a MouseOver event). Available only if ExecuteOnMouseMove is True.
OnMouseEnterValue - Specify the value(s) to be written at the moment the cursor first passes over the button (for a MouseOver event). Available only if ExecuteOnMouseEnter is True.
OnMouseLeaveValue - Specify the value(s) to be written at the moment the cursor stops passing over the button (when the MouseOver event ends). Available only if ExecuteOnMouseLeave is True.
___________________________________________________________________________________________________________________________________
The Acknowledge command allows a user to acknowledge alarms in an associated AlarmWorX64 Viewer.
When an alarm requires acknowledgement, the typical steps for acknowledging the alarm are:
An alarm is triggered and is added to the alarm grid on which it is used. (Only enabled alarms are triggered. An alarm that is not enabled is considered to be an alarm that is not ready for use or an alarm that is being decommissioned. Alarms are enabled when they are added to the alarm server, using the General tab of the AlarmWorX64 Server tag form.)
A runtime operator acknowledges the alarm; this puts the alarm into an Acknowledged state.
When the alarm condition no longer exists, the alarm leaves the grid as long as its acknowledgement requirements have been met.
You can create this command within the GraphWorX64 Viewer and Asset Navigator controls. You can apply this command to the AlarmWorX64 Viewer control.
Parameters for the Acknowledge command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Alarm - Indicates whether the alarm represents a standard alarm (Condition), an operator commend (Simple), a tracking event (Tracking) or an unspecified type of alarm (None).
Acknowledge - Determines whether alarms on all objects (All), objects satisfying a certain condition (Comparison), objects satisfying a certain set of criteria (Filter), selected object only (Selection), or inactive objects only (Inactive) are acknowledged.
LowSeverity - Alarms with a severity less than the provided value are not acknowledged.
HighSeverity - Alarms with a severity greater than the provided value are not acknowledged.
VisibleOnly - Determines whether the command applies to visible elements only.
Comparison - Click here for how to use Acknowledge by Comparison. Acknowledge only the alarms that contain a value for a particular property (specified in the Field setting) satisfying the given expression. Used only when the Acknowledge parameter is set to Comparison.
Field - The property to examine when determining the objects whose alarms are acknowledged. Used only when the Acknowledge parameter is set to Comparison.
Comment - Associate the provided operator comment with each alarm that is acknowledged.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
The Add Favorite command inserts a new favorite asset in target Asset Navigator's favorites folder.
Parameters for the Add Favorite command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
FavoriteName - The name of the favorite.
FolderType - Add a favorite to a selected or specific folder, or show runtime dialog to browse the folder.
FolderName - Specific folder name.
ItemType - Add selected or specific item to favorites.
ItemName - Specific item name.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
The Add Operator command adds an operator comment for data selected in a target control. The command is supported by TrendWorX64 Viewer and the Fault Viewer.
Parameters for the Add Operator command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Comment - Enter the comment in the text entry field or click on the 
button to open the Data Browser and navigate to your selected comment.
Show Dialog - Use the pulldown menu to select from False or True to show the dialog, or click on the button to open the Data Browser..
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
The Apply Discard command performs a selected action in a target GridWorX64 Viewer control.
Parameters for the Apply Discard command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Action - Apply/Discard action.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
The Batch command defines a "mini program" to execute multiple commands using conditions and jumps, which can be based on step results.
Parameters for the Batch command are:
Steps - Click on the ellipsis button [...] to open the Configuration window. In the Configuration window, click on the plus button [+] to add a step to the Batch command. You can click on the minus [-] button to remove a step, as well as the up/down arrow buttons to reorder them within a list. Click on the 
button to duplicate a selected step.
Steps Properties
Name - Enter a name for the Step in the text entry field.
Execute Conditionally - Click this checkbox in order to execute the step under a condition based on an expression set within the step properties.
Condition - When the above checkbox is checked, you can enter an expression in the text entry field or click on the 
button to open the Expression Editor and build your preferred expression.
Action - Use the pulldown menu to select from one of the following actions. Note that the selection will display additional properties based on the action type.
None - Usable when the step is only needed to jump to some sub-chain or change the execution flow in another way.
Command - To set a command action for the batch step.
Delay - Allows setting a delay period in milliseconds.
Command - Enter the command in the text entry field or click on the 
button to open the Configure Command window, shown below, and select/configure your preferred command.
Configure Command Window
Await Result - If you selected a Command action, click this checkbox if the step should require waiting for command result(s).
Timeout - If you selected a Command action, enter a timeout period in mlliseconds.
Delay - If you selected a Delay action, enter a period for delay in milliseconds.
Depending on how a step is executed, one of three continuation paths is chosen. These include:
When all succeeded.
When the action failed (e.g., when the step tried to assign the event to an asset, but the asset wasn't found in the configuration).
When the condition failed (if the step wasn't executed conditionally).
On Success - Use the pulldown menu to select what should occur on action success for the selected step: Go to next step or Quit. See Option Definitions below.
On Fail - Use the pulldown menu to select what should occur on action fail for the selected step: Go to next step or Quit. See Option Definitions below.
On condition fail - Use the pulldown menu to select what should occur on condition fail for the selected step: Go to next step or Quit. See Option Definitions below.
Option Definitions:
Go to next step - continues with the next step in the current chain
Quit - quits processing immediately
The Call Method command calls a method or task from within Platform Services. These methods can be parameterized or not and range from simple data writing to complex calculations or actions. Due to this, the Parameters field can be filled with whatever is necessary to pass to the custom method. Methods must be coded in C# and can be used in combination with the Jscript.NET scripting engine of GraphWorX64. The ICONICS Application Note "GENESIS64 - Custom Server Methods in Platform Services" includes two examples and instructions to begin creating a custom command.
Parameters for the Call Method command are:
Name - Enter the full name of the call method, including the point path.
Parameters - Click in this box to enter Values and ValueTypes to pass via the Call Method.
The Create Pen command adds a new pen into a target TrendWorX64 Viewer using the following parameters. You can create this command within the GraphWorX64 Viewer and Asset Navigator controls. You can apply this command to a TrendWorX64 Viewer control.
Parameters for the Create Pen command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
PenName - Unique string identifier for the pen.
Line - Indicate whether the pen appears as a line graph (Line), a curved line (Spline), a step chart (Step), or a bar chart (Bars) in the containing trend viewer.
IsFilled - Determines whether the area beneath the pen is shaded within the containing trend viewer.
PointName - The data source (i.e localsim:sine) associated with the pen.
Description - The description for the pen, which appears as its title tag. May be a data source.
Parameters - A semicolon-separated series of name\value pairs that represent connection settings for the pen. May be a data source.
IsEnabled - Determines whether the pen connects to its data source when the containing trend viewer enters runtime mode. A blank/empty value indicates "false". May be a data source.
Units - The engineering units associated with the pen's sample values. May be a data source.
Format - The Microsoft numeric format string indicating how the pen's sample values should be displayed.
TimeZone - Time zone of data source (Examples: Eastern Standard Time, Central Europe Standard Time, UTC+01, UTC-0330, UTC+04:30, -06).
PreserveStringValues - Indicates whether the pen's text-based data source values should retain the string data type.
ShowInSummary - Indicates whether the pen appears in the containing trend viewer's summary pane.
ShowAnnotations - Indicates whether operator comments associated with the pen are visible.
ShowPenMarker - Determines whether the pen's indicator on the side of the plot should appear within the containing trend viewer.
PenMarkerStyle - Indicate whether the pen's indicator on the side of the plot should appear as a circle (Circle), a square (Square), a triangle (Triangle), or text information (Text). A setting of None hides the pen's indicator.
Opacity - Overall opacity of the pen (0% = fully transparent, 100% = fully opaque).
RandomColor - Indicates whether the pen's stroke and fill colors are selected randomly from a predefined palette.
StrokeThickness - The thickness of the line or bar outlines that intersect the pen's markers.
StrokeStyle - The line style of the line or bar outlines that intersect the pen's sample markers.
SampleMarkerStyle - Indicate whether the pen's markers should appear as circles (Circles), squares (Squares), triangles (Triangles), or text information (Text). A setting of None hides the pen's markers.
BadQualityAutoStyle - Indicates whether the pen used to show samples with a bad or uncertain quality should inherit from the general pen style.
InheritPlotMode - Indicates whether the pen inherits quality plot modes from the containing trend viewer.
UseRealtimeInterpolation - Determines whether intermediate samples are generated automatically when real-time data does not update during a sampling interval.
LastSampleStretch - Indicates whether the trend line ends at the most recent data point for the pen (None), the most recent data point extends to the current time (ToNow), or the most recent data point extends indefinitely along the time axis (IntoFuture).
SampleDecluttering - If the pen's samples appear visually close to one another within the containing trend viewer, indicates whether to hide some of the samples. It is strongly recommended to use the default value of "true".
MinimumMode - Determines whether the pen's minimum value shown within the containing trend viewer is calculated on the server (Default), is selected to show all data points (AutoScale), or is a specified value (Manual).
Minimum - The minimum sample value to show in the containing trend viewer.
MaximumMode - Determines whether the pen's minimum value shown within the containing trend viewer is calculated on the server (Default), is selected to show all data points (AutoScaled), or is a specified value (Manual).
ShowLimits - Determines whether the pen's alarm limits appear with the pen's sample values in the containing trend viewer.
TotalizerUnit - Indicates the interval of time used when determining how to count the number of samples for this pen. Select "None" to prevent the pen's total number of samples from being calculated.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
You can create this command within the GraphWorX64 Viewer and Asset Navigator controls. You can apply this command to third-party controls that implement the ICONICS commanding interface.
Parameters for the Custom Command command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Parameters - A string representing some input to the Custom Command representing details necessary to facilitate the desired outcome.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
The Delete Pen command will remove a pen from a TrendWorX64 Viewer. This command requires a target which can be a TrendWorX64 Viewer in GraphWorX64 or PortalWorX_SL. The name of the pen and the target viewer are the parameters for this command. You can create this command within the GraphWorX64 Viewer and Asset Navigator controls. You can apply this command to the TrendWorX64 Viewer control.
Parameters for the Delete Pen command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Delete - Indicate whether to delete a certain pen (Specific), each pen in a chart (All), or each selected pen in the containing trend viewer's legend (Selected).
PenName - Unique string identifier for the pen.
Index - The index into the list of pens for the chart containing the pen to modify. This setting is needed only when PenName is empty.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
The Edit Pen command will edit a pen within a TrendWorX64 Viewer. This command requires a target which can be a TrendWorX64 Viewer in GraphWorX64. The name of the pen and the target viewer are the parameters for this command. You can create this command within the GraphWorX64 Viewer and Asset Navigator controls. You can apply this command to the TrendWorX64 Viewer control.
Parameters for the Edit Pen command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
PenName - Unique string identifier for the pen.
Index - The index into the list of all pens for the chart containing the pen to modify. This setting is needed only when PenName is empty.
NewPenName - Assign a new unique string identifier for the pen. May be a data source. Leave this setting blank/empty to preserve the pen's current name.
SelectedProperties - A comma-separated list of pen properties to edit.
PointName - The data source associated with the pen.
Description - Description for the pen, which appears as its title tag. May be a data source.
Parameters - A semicolon-separated series of name\value pairs that represent connection settings for the pen. May be a data source.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
The Edit Trend Chart command can be used to change a wide variety of properties of an existing TrendWorX64 Viewer chart and legend, such as sampling interval and whether the legend is visible.
When configuring the Edit Trend Chart command, first edit the SelectedProperties parameter, and select the properties of the chart you would like to change. Properties that are selected will then show up as additional parameters of the command.
This powerful new command can be used along with the new batch commands and the command event support to configure your TrendWorX64 Viewer with drilldown actions.
Parameters for the Edit Trend Chart command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
SelectedProperties - You can enter selected properties in the text entry field, separated by a comma or can click on the 
button, which gives you the options of "Browse/Edit..." and "Runtime Data Value...". Clicking "Browse/Edit..." opens the "Configuration" window, shown below, which allows you to select multiple listed values (by checkbox). Within the "Select values" window, once you have completed your selections, click on the OK button. Your selections will appear in the SelectedProperties text entry field and further properties for each selected values will appear within the command properties. Clicking "Runtime Data Value.." opens the Data Browser, allowing you to navigate to your selected runtime data value(s).
Configuration Window
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
The Execute Commands command executes commands that already exist on that particular asset/equipment. The added commands can be specified in the Commands text entry field, each separated by a semicolon (with no spaces). The Execute Commands command can be made visible while the executed commands are invisible. This command is only available for AssetWorX, because GraphWorX64 has its own support for aggregating pick actions.
Parameters for the Execute Commands command are:
Commands - Enter the names of the commands to be executed, separated by a semicolon (no spaces).
The Expand Collapse command will allow users to change the levels shown in the Asset Navigator by expanding or collapsing the assets to a desired level. You can create this command within the GraphWorX64 Viewer and Asset Navigator controls. You can apply this command to the AlarmWorX64 Viewer, GridWorX64 Viewer, and Asset Navigator controls.
Parameters for the Expand Collapse command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
ExpandCollapseType - Determines whether the item specified in the ItemName or Index setting open (Expand), closes (Collapse), opens itself and the elements it contains (ExpandAll), or closes itself and the elements it contains (CollapseAll). Some controls always perform the ExpandAll or CollapseAll operation.
ItemName - The name of the element that this command modifies.
Index -The index into a collection of values containing the element that this command modifies.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
Parameters for the Export Data command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
File Name - File name of exported data.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
You can create this command within the GraphWorX64 Viewer and Asset Navigator controls. You can apply this command to the GraphWorX64 Viewer, Energy AnalytiX Viewer, and FDD Viewer controls.
Parameters for the Export Image command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
File Name - The file name or URL to which the exported image is saved.
Area - Specify whether this command affects the portion of the target control that is currently visible (CurrentView) or the whole control (EntireControl).
Unit - Determines whether the Zoom settings is interpreted as a percentage (Percentage), a positive scaling factor (Scale), or a zoom level between 1 and 21 (Level). The Zoom setting is ignored if this setting has a value of None.
Zoom - The zoom percentage, scaling factor, or level to apply to the target control.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
The Export Statistic command just shows the Export Statistics dialog using default options (no intermediate dialog is displayed). The parameter ReportName is currently unused as the report doesn’t provide a dedicated field. You can create this command within the GraphWorX64 Viewer and Asset Navigator controls. You can apply this command to the TrendWorX64 Viewer control.
The report generated by the Export Statistic command with a TrendWorX64 Viewer target has been enhanced to be more customizable. Previously, running the Export Statistic command with a target of a TrendWorX64 Viewer would perform the same action as selecting the Export Statistics button in the trend viewer toolbar, which was to display a report that then could be saved to CSV or other formats.
Now, the action taken by the command depends on the TrendWorX64 Viewer configuration. The command itself has no new parameters, but in the target TrendWorX64 Viewer, the user can select the chart, go to the Data tab, and select the Configure button next to Statistics Export. Similar to the preexisting data export configuration, the statistics export configuration presents various configurable settings for the statistics report, including which columns to include in the report and whether to export visible pens.
By default, the Export Statistic command now immediately saves the report to a CSV file, but the user can return to the legacy behavior of opening the report page by selecting Use legacy export in the statistics export settings.
This functionality of the Export Statistic command is currently only supported in desktop (WPF) and Universal Windows Platform (UWP). Equivalent functionality for the HTML5 trend viewer is planned for a future version.
Parameters for the Export Statistic command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
You can create this command within the GraphWorX64 Viewer and Asset Navigator controls. You can apply this command to the EarthWorX Viewer control.
Parameters for the Go To Location command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Latitude - The north-south coordinate that appears in the vertical center of the redrawn map control.
Longitude -The east-west coordinate that appears in the horizontal center of the redrawn map control.
Unit - Determines whether the Zoom setting is interpreted as a percentage (Percentage), a positive scaling factor (Scale), or a zoom level between 1 and 21 inclusive (Level). The Zoom is ignored if this setting has a value of None.
Zoom - The zoom percentage, scaling factor, or level to apply to the target control.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
You can create this command within the GraphWorX64 Viewer and Asset Navigator controls. You can apply this command to the AlarmWorX64 Viewer and GridWorX64 Viewer controls.
Parameters for the Group Location command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Action - Configuration action.
ItemName - The name of the element that this command modifies.
Index - The index into a collection of values containing the element that this command modifies.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
The Load Alarm Configuration command opens an AlarmWorX file of alarms inside an AlarmWorX Viewer when a runtime user selects the menu option. You can create this command within the GraphWorX64 Viewer and Asset Navigator controls. You can apply this command to the AlarmWorX64 Viewer control.
Parameters for the Load Alarm Configuration command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
File Name - File name or URL to associate with this command.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
The Load DataGrid Configuration command, used with GridWorX, will locate and load a GDXX (WPF-based) file format that contains GridWorX Configurations. Users can specify the file name and path of the file as well as any desired target.
Parameters for the Load DataGrid Configuration command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
FileName - File name or URL to associate with this command.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
The Load Energy Data command opens an Energy AnalytiX Configuration (.eav) file created using the Energy AnalytiX Web part. You can create this command within the GraphWorX64 Viewer and Asset Navigator controls. You can apply this command to the Energy AnalytiX Viewer control.
Parameters for the Load Energy Data command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Configuration Name: The name of the Energy AnalytiX configuration file to be loaded for this runtime menu item. Click on the downward arrow to select a Runtime Data Value from the Data Browser.
StartTime -The Start Time will indicate, in long format, the date and time to begin the range of energy data that is loaded. This value can be typed or selected via the Date/Time Picker located at the right of the field.
EndTime -The End Time will indicate in long format the date and time to end the range of energy data that is loaded. This value can be typed or selected via the Date/Time Picker located at the right of the field.
Asset - The Asset browse name.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
The Load Executed Reports command loads a folder of reports for viewing. Note that this command does not execute the reports, it simply displays executed reports that reside in a folder. For example, you can store energy reports in one folder and use this command to open the folder of reports for display when a runtime user selects it from the equipment's right-click menu. (Alternatively, you can use the Load Report command to open one report that has been executed.) You can create this command within the GraphWorX64 Viewer and Asset Navigator controls. You can apply this command to the ReportWorX64 Viewer control.
Parameters for the Load Executed Reports command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Server*: Click the ellipsis button [...] to choose the server where the folder or executed reports resides.
Report Folder: Select the folder whose executed reports are to be opened. After you have chosen a server, click the ellipsis button [...] to select the folder. In the Choose a Report Folder dialog box that opens, select the folder and click OK.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
The Load Execute Transactions command loads a list of data transaction reports from specific folder into a target BridgeWorX Viewer.
Parameters for the Load Executed Transactions command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
FolderName*: Select one of the available folder names or refresh to see an updated list.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
The Load Facility Data command opens an FDDWorX Configuration (.fav) file created using the FDDWorX Web part in the Workbench. You can create this command within the GraphWorX64 Viewer and Asset Navigator controls. You can apply this command to the FDD Viewer control.
Parameters for the Load Facility Data command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Configuration Name: The name of the FDDWorX configuration file to be loaded for this runtime menu item. Click on the downward arrow to select a Runtime Data Value from the Data Browser.
Start Time - The Start Time will indicate, in long format, the date and time to begin the range of facility data that is loaded. This value can be typed or selected via the Date/Time Picker located at the right of the field.
End Time - The End Time will indicate, in long format, the date and time to end the range of facility data that is loaded. This value can be typed or selected via the Date/Time Picker located at the right of the field.
Asset - The Asset browse name.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
The Load Graphics Display command opens a GraphWorX display file inside a GraphWorX Viewer when a runtime user selects the menu option. You can create this command within the GraphWorX64 Viewer and Asset Navigator controls. You can apply this command to the GraphWorX64 Viewer control.
Parameters for the Load Graphics Display command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
File Name - File name or URL to associate with this command.
Local Aliases - The local alias settings (if any) that are used for the GraphWorX display. Click on the downward arrow to Browse/Edit existing local aliases or select a Runtime Data Value from the Data Browser.
Global Aliases: The global alias settings (if any) that are used in the GraphWorX display. Click on the downward arrow to Browse/Edit existing global aliases or select a Runtime Data Value from the Data Browser.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
Parameters for the Load KPI Dashboard command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Dashboard Path - Dashboard path to load.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
Parameters for the Load Mobile Layout command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Layout Path - The path to the layout to load (separate using backslashes).
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
The Load Report command displays a report for viewing. Note that this command does not execute the report, it simply displays a report that has already been executed. For example, if a report ran over the weekend, this command can open it for display when a runtime user selects it from the equipment's right-click menu. (Alternatively, you can use the Load Executed Reports command to open an entire folder of reports.) You can create this command within the GraphWorX64 Viewer and Asset Navigator controls. You can apply this command to the ReportWorX64 Viewer control.
Parameters for the Load Report command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Server: Click the ellipsis button [...] to choose the server where the executed report resides.
Report Name: Specify the executed report to be opened. After you have chosen a server, click the ellipsis button [...] to select the executed report. In the Choose a Report dialog box that opens, select the report and click OK.
Parameters:
Global Aliases: The global alias settings to be used for running the report. Click the ellipsis button [...] to select the theme and global aliases.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
The Load Schedule Control Configuration command opens a calendar inside a Schedule Control when a runtime user selects the menu option. You can create this command within the GraphWorX64 Viewer and Asset Navigator controls. You can apply this command to the Schedule Control.
Parameters for the Load Schedule Control Configuration command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
File Name - File name or URL to associate with this command.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
The Load Transaction command loads a data transaction report by name into a target BridgeWorX Viewer.
Parameters for the Load Transaction command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
TransactionName - Enter a transaction name in the text entry field or click on the button to open the Data Browser and navigate to your selected transaction name.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
The Load Trend Configuration command opens a TrendWorX trend file inside a TrendWorX Viewer when a runtime user selects the menu option. You can create this command within the GraphWorX64 Viewer and Asset Navigator controls. You can apply this command to the TrendWorX64 Viewer control.
Parameters for the Load Trend Configuration command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
File Name - File name or URL to associate with this command.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
The Load URL command loads a URL when a runtime user selects the menu option. You can use this command to load a frequently-used online tool, a corporate Web site, a vendor's page for placing an order, or an interactive page for requesting service.
Parameters for the Load URL Command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Url - The URL to open.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
The Log Event command allows for logging custom simple or tracking events.
Parameters for the Log Event Command are:
MessageType - Simple or tracking message type.
Severity - Severity of the event.
Message - Message to log.
Comment - Additional comment.
Source - Event source name.
Parameter - If Tracking MessageType selected.
OldValue - If Tracking MessageType selected.
NewValue - If Tracking MessageType selected.
The Login Dialog command will pop up the Security Login Dialog when triggered. There are no parameters to configure for the Login Dialog in GraphWorX64.
You can create this command within the GraphWorX64 Viewer and Asset Navigator controls. You can apply this command to the GraphWorX64 Viewer, TrendWorX64 Viewer, AlarmWorX64 Viewer, GridWorX64 Viewer, Energy AnalytiX Viewer, and FDD Viewer controls. Note that you can apply only the Back and Forward navigation types to a GraphWorX64 Viewer control, and you need to apply this command to grids within the Energy AnalytiX Viewer and FDD Viewer controls.
Parameters for the Navigate command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Navigation - Navigation destination.
Steps - Number of iterations.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
The Open URL command opens a URL when a runtime user selects the menu option. You can use this command to go to a frequently-used online tool, a corporate Web site, a vendor's page for placing an order, or an interactive page for requesting service.
Parameters for the Open URL command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Url - The URL to open.
TargetType - The Open URL target type (Target Window or New Window).
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
You can create this command within the GraphWorX64 Viewer and Asset Navigator controls. You can apply this command to the GraphWorX64 Viewer control. Parameters for the Print command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Area - Specify whether this command affects the portion of the target control that is currently visible (CurrentView) or the whole control (EntireControl).
WhiteBackground - Print with white background.
ShowPrintDialog - Set to True to show the print dialog UI prior to printing. Set to False to directly start printing without showing the print dialog.
PrinterName - The name of the printer to print to. If not specified, the default printer will be used.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
This command can be invoked by right-clicking on a recipe item in the Recipe Navigator and choosing “Copy Recipe Item” from the context menu. It can also be configured as a Pick action command in GraphWorX64. The command copies a selected recipe item from the Tree Explorer. Parameters for the Recipe: Copy command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
This command can be invoked by right-clicking on a recipe item in the Recipe Navigator and choosing “Delete Recipe Item” from the context menu. It can also be configured as a Pick action command in GraphWorX64. It deletes the selected recipe item from the Tree Explorer. Parameters for the Recipe: Delete command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
This command can be invoked by right-clicking on a recipe item in the Recipe Navigator and choosing “Download Recipe” from the context menu. It can also be configured as a Pick action command in GraphWorX64. It downloads the values of the selected recipe item to the OPC tags. Parameters for the Recipe: Download command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
This command can be invoked by right-clicking on a recipe item in the Recipe Navigator and choosing “Load Recipe” from the context menu. It can also be configured as a Pick action command in GraphWorX64. It loads the recipe item selected in the Recipe Navigator into the Recipe Grid control. Parameters for the Recipe: Load command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
This command can be invoked by right-clicking on a recipe in the Recipe Navigator and choosing “New Recipe Item” from the context menu. It can also be configured as a Pick action command in GraphWorX64. It creates a new child recipe item under the selected recipe in the Tree Explorer. Parameters for the Recipe: New command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
This command can be invoked by right-clicking on a recipe item in the Recipe Navigator and choosing “Save Recipe” from the context menu. It can also be configured as a Pick action command in GraphWorX64. It applies changes to the dataset that is loaded into the Recipe Grid control. Parameters for the Recipe: Save command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
This command can be invoked by right-clicking on a recipe item in the Recipe Navigator and choosing “Upload Recipe” from the context menu. It can also be configured as a Pick action command in GraphWorX64. It uploads the values from the OPC tags and updates those values in the database for the selected recipe item. Parameters for the Recipe: Upload command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
You can use this command to refresh a display requiring an updated view. You can apply this command to the GraphWorX64 Viewer control.
Parameters for the Refresh command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Area - Specify whether this command affects the portion of the target control that is currently visible (CurrentView) or the whole control (EntireControl).
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
The Remove Favorite Command removes a specific or selected favorite in a target Asset Navigator.
Parameters for the Remove Favorite command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
ItemType - Remove selected or specific item from favorites.
ItemName - Specific item name.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
The Run Report command executes a report using ICONICS ReportWorX when a runtime user selects the menu option.
For more information about ReportWorX, refer to the ReportWorX documentation on the ICONICS BizViz product CD.
Parameters for the Run Report command are:
ServiceUrl - Enter the URL where the report to execute resides.
AccessKey - Enter the password needed to access the service.
Report Name - Specify the report to be executed. After you have chosen a server, click the ellipsis button [...] to select the report to execute. In the Choose a Report dialog box that opens, select the report and click OK.
Parameters - Reports often require parameters like a start and end time or date. These parameters can be entered in the web interface normally, but when using commands must be pre-populated. Dynamic data sources like Unified Data Manager Registers or GraphWorX64 Local Simulations can be used to store this data temporarily if users are prompted to enter it elsewhere in order to run the report. Each report is different, but using string concatenation in GraphWorX64 can allow the parameters to be generated from user input.
GlobalAliases - Click the downward arrow to Browse/Edit local global aliases or select a Runtime Data Value from the Data Browser.
SpecificUser - Use different user name and password.
The parameters for the Run Script command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Name - The fully-qualified name of the method to execute.
Area - Specify whether this command affects the portion of the target control that is currently visible (CurrentView) or the whole control (EntireControl).
Parameters - Click on ellipsis button [...] to select parameters to associate to this script command.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
The Run Transaction command executes an ICONICS BridgeWorX transaction when a runtime user selects the menu option. For example, if you use BridgeWorX to populate a database table for us in reports, you can use this command to launch that service.
Parameters for the Run Transaction command are:
Service URL - The URL address of the BridgeWorX Web Service.
Access Key - The password needed to access the BridgeWorX Web Service.
Transaction Name - Click the ellipsis button [...] to select the transaction to be activated when a runtime user clicks this command. In the Transaction Name dialog box that opens, refresh the list by the clicking the Get Transactions button. Then select the transaction and click OK.
Parameters - Click on the ellipsis button [...] to select parameters for this transaction command.
GlobalAliases - Click the downward arrow to Browse/Edit local global aliases or select a Runtime Data Value from the Data Browser.
SpecificUser - Use different user name and password.
You can create this command within the GraphWorX64 Viewer and Asset Navigator controls. You can apply this command to the TrendWorX64 Viewer, AlarmWorX64 Viewer, GridWorX64 Viewer, Energy AnalytiX Viewer, and FDD Viewer controls. Parameters for the Save Configuration command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
File Name - File name or URL to associate with this command.
Overwrite - Overwrite existing file.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
The Scan command
Parameters for the Scan command are:
Action - Use the pulldown menu to select from On, Off, or Toggle, as far as scanning state.
The Schedule Clear Override command allows you to Clear an Override to an existing Schedule, similar to that set via Runtime Tab in the Schedule Control in GraphWorX64.
Parameters for the Schedule Clear Override command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
The Schedule Override command allows users to perform common scheduling actions for the ScheduleWorX64 Viewer control. The command can be used to create, edit, and delete events. The Action parameter determines which of the three subcommands (Create, Delete, or Edit) is executed.
Parameters for the Schedule Event command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Action - Schedule event action. Select from Create, Delete, or Edit).
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
The Schedule Override command allows you to activate an Override for an existing Schedule, similar to that set via the Runtime Tab in the Schedule Control in GraphWorX64.
Parameters for the Schedule Override command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
You can create this command within the GraphWorX64 Viewer and Asset Navigator controls. You can apply this command to the Energy AnalytiX Viewer, FDD Viewer, and Asset Navigator controls.
Parameters for the Select Asset command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
ExecuteCommands - Specifies command set to execute.
Asset - Asset browse name.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
You can create this command within the GraphWorX64 Viewer and Asset Navigator controls. You can apply this command to the GraphWorX64 Viewer, TrendWorX64 Viewer, AlarmWorX64 Viewer, GridWorX64 Viewer, Energy AnalytiX Viewer, and FDD Viewer controls. Note that the element types you can select with this command depend on the control to which you are applying the command:
GraphWorX64 Viewer - Supports View and Object element types.
TrendWorX64 Viewer - Supports Tab and View element types.
AlarmWorX64 Viewer - Supports Tab, View, and Row element types.
GridWorX64 Viewer - Supports Tab, View, and Row element types.
Energy AnalytiX Viewer - Supports the Row element type.
FDD Viewer - Supports the Row element type.
Parameters for the Select Element command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Element - Use the pulldown menu to select from Tab, View, Row or Object.
ElementName - The ElementName should reflect which Element Type is selected. Enter the name of the Tab, View, Row or Object or click on the ellipsis button [...] to open the Data Browser and navigate to your selected ElementName.
Index - The index into a collection of values containing the element that this command modifies.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
Parameters for the Select View command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
View - View name or identifier.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
Parameters for the Send Alert Email command are:
Destination - Enter a destination for the alert email.
Subject - Enter the subject for the alert email.
Message - Enter the message body for the alert email.
Parameters for the Send Alert Page command are:
Destination - Enter a destination for the alert page.
Subject - Enter the subject for the alert page.
Message - Enter the message body for the alert page.
The Send Notification command can be used to send new push notifications to to clients subscribed to specific topic(s).
Parameters for the Send Notification command are:
Platform - Target platform. Select from wms, apns, or fcm.
Content - Formatted text with the notification message.
Topics - Click on the ellipsis button (...) to open the SendNotificationTopic Collection Editor, where you can set Members and Properties.
The Set Fault Incident State Command changes the state of all, specific, or selected faults in a target Fault Viewer. Can optionally show a runtime dialog to confirm or fine-tune the parameters.
Parameters for the Set Fault Incident State command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
State -New state.
Incidents - Fault incidents that will change state.
Comment - Operator comment to associate with selected event.
ShowDialog -Show runtime dialog to set all properties.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
You can create this command within the GraphWorX64 Viewer and Asset Navigator controls. You can apply this command to the AlarmWorX64 Viewer and GridWorX64 Viewer controls. Parameters for the Set Filter command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Action - Filter action. Select Set or Reset.
Filter Name -The name of the filter to execute the action on. This should match configured filters in the AlarmWorX64 Viewer for example.
Filter Expression -Similar to the option available in the Filter creation dialog, the filter Expression can be a complex combination of dynamic and static values. To better understand and easily build an expression try using the dialog and click the Expression Editor button on the right of the Expression option in the Filter dialog to create a sample.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
You can create this command within the GraphWorX64 Viewer and Asset Navigator controls. You can apply this command to the TrendWorX64 Viewer control. Parameters for the Set Freeze Mode command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Action - Freeze mode of target control. Set as Freeze, Unfreeze or Toggle.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
The Set Global Aliases command sets a global alias theme when a runtime user selects the menu option. This is helpful for runtime users who must review GENESIS64 displays or reports for different locations for which unique global aliases are set. You can create this command within the GraphWorX64 Viewer, GridWorX64 Viewer, and Asset Navigator controls. You can apply this command to the GraphWorX64 Viewer control.
Parameters for the Set Global Aliases command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
GlobalAliases - Click the downward arrow to Browse/Edit a global alias or to select a Runtime Data Value from the Data Browser.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
Parameters for the Set Global Color Theme command are:
Theme Name - The name of the global color theme to set as active.
Theme Scope - The scope for which to set the active global color theme (Machine or Process).
Parameters for the Set Language command are:
Culture - Enter the language (culture) here. Click on the ellipsis [...] button to open the Data Browser to select a language.
You can create this command within the GraphWorX64 Viewer and Asset Navigator controls. You can apply this command to the TrendWorX64 Viewer control. Parameters for the Set Period command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Alignment - Aligned time unit. Final time range vary for months and longer time units. Avoid using Custom alignment.
Period - Custom period. Aligned time is preferred to custom period.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
You can create this command within the GraphWorX64 Viewer, GridWorX64 Viewer, and Asset Navigator controls. You can apply this command to the TrendWorX64 Viewer, AlarmWorX64 Viewer, Energy AnalytiX Viewer, and FDD Viewer controls. Parameters for the Set Time Range command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
TimeRangeType - Select from StartTimeEndTime, StartTimeInterval, EndTimeInterval, StartTime or EndTime.
Start Time - Enter in the desired Start Time to the Time Range.
End Time - Enter in the desired End Time to the Time Range.
Alignment - Aligned time unit. Final time range vary for months and longer time units. Avoid using Custom alignment.
Period - Custom period. Aligned time is preferred to custom period.
Value - Multiplier of selected time unit.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
You can create this command within the GraphWorX64 Viewer and Asset Navigator controls. You can apply this command to the GraphWorX64 Viewer, TrendWorX64 Viewer, AlarmWorX64 Viewer, GridWorX64 Viewer, Energy AnalytiX Viewer, and FDD Viewer controls. Note that you can apply this command only to grid elements of the Energy AnalytiX Viewer and FDD Viewer controls and that the object type for which you can toggle the visibility with this command depends on the control to which you are applying the command:
GraphWorX64 Viewer - Supports the Visual object type.
TrendWorX64 Viewer - Supports the Pen object type.
AlarmWorX64 Viewer - Supports the Column object type.
GridWorX64 Viewer - Supports the Column object type.
Energy AnalytiX Viewer - Supports the Column object type.
FDD Viewer - Supports the Column object type.
Parameters for the Set Visibility command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Object Type -Use the pulldown menu to select from Visual, Pen or Column.
Object Name -The name of the Object, Pen or Column to Show, Hide or Toggle the visibility of.
Index - The index into a collection of values containing the element that this command modifies.
VisibilityType - Use the pulldown menu to select from Show, Hide or Toggle.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
The parameters for the Show Details command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Description - Description for the pen, which appears as its title tag. May be a data source.
ShowCustomDisplay - Load custom display instead of default details display.
StartTime - Enter a start time.
EndTime - Enter an end time.
Datasources - Click the ellipsis button [...] to open the ShowDetailsDatasource Collection Editor window, which will allow you to add Members and Properties.
FileName - File name or URL to associate with this command.
LocalAliases - Click the downward arrow to Browse/Edit local aliases or select a Runtime Data Value from the Data Browser.
GlobalAliases - Click the downward arrow to Browse/Edit global aliases or select a Runtime Data Value from the Data Browser.
TargetType - If this command should open a new window, specify the type of the window that will be opened.
TargetName - If this command should open a new window, specify the name of the window. You an use wildcards. If a window with matching name already exists, it is reused when executing this command.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
You can create this command within the GraphWorX64 Viewer and Asset Navigator controls. You can apply this command to the AlarmWorX64 Viewer and GridWorX64 Viewer controls.
Parameters for the Sort command are:
DragDrop - Determines whether applying a drag-and-drop action on this dynamic causes the command to be associated with the object where the dynamic is dropped.
Action - Configuration action.
ColumnName - The name of the Column to sort. This can be seen in the header of each data grid or this can be a dynamic value by using the […] to select a value.
Index -The index into a collection of values containing the element that this command modifies.
Direction - Use the pulldown to select from either Ascending or Descending.
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
The Switch Layout Command is available through the WebHMI platform. You can configure a dynamic (button, etc.) to switch a display's layout based on the following parameters.
The Write Value command writes a value to another tag, a global alias, a language alias, or a conversion value, when a runtime user selects the menu option. For example, you might use this command to give runtime users the ability to switch a machine "off" or to set a thermostat to a specified temperature.
Parameters for the Write Value command are:
Point Name: The path of the OPC tag point to be written to. Click the ellipsis button [...] to open the Data Browser, the navigate to the OPC tag, global alias, language alias, or conversion value to be written to.
Value Type: The value type of the data point to be written to. Your choices are:
Value: The value to be written to the data point when the user clicks this menu option. Make sure the value type is suitable for the value in this field.
Parameters for the Zoom command are:
Target - The commanding name of target control that will handle this command. See CommandingName property on target control. You can use wildcards.
The TrendWorX Viewer is the only type of control that currently supports this command. In order for a TrendWorX Viewer to "accept" the command properly in GraphWorX64, you need to:
The Unit and Zoom parameters work in tandem to set a desired zoom level. To zoom to a desired percentage relative to the original zoom level, set Unit to "Percentage" and "Zoom" to the desired zoom level percentage (e.g. "100" reverts the viewer to its original zoom level, "50" causes the viewer to zoom in by a factor of 2). To zoom to a desired scale factor relative to the original zoom level, set Unit to "Scale" and "Zoom" to a positive number (e.g. "1" reverts the viewer to its original zoom level, "2" causes the viewer to zoom out by a factor of 2). The "None" and "Level" values of the Unit parameter currently have no effect on the target TrendWorX Viewer.
It's possible to scale only the time (horizontal) or value (vertical) axis of the TrendWorX Viewer by setting the Axis parameter to "Time" or "Value," respectively. To scale both axes by the same amount, leave the parameter at its default value of "Both." Note that it is currently not possible to scale the two axes by different scale factors at the same time with only one pick action (though strategic use of two pick actions should allow you to accomplish this task when needed).
