Define Cache Command

You can access the Define Cache Command dialog from the Object Properties window. This dialog is used to assign an action to an object's command property, giving you the ability to execute an action from within an RTView display. If you execute a cache command from a Thin Client with Direct Data Connection or any Served Data deployment, the command will execute on the server. If your command fails on a Direct Data deployment, an error dialog will popup with information on why the command failed. In other deployments, the error is only output to the console.

To open the Define Cache Command dialog, right-click on the appropriate command property in the Object Properties window and select Define Command>Cache. The Define Cache Command dialog provides a drop down menu with available commands. Argument fields vary based on the selected command type. See the “Define/Execute Command” section for information on how to execute a command.

Field Name	Description
Command	Select a command from the drop-down menu.
	Command Types	Description
	Add Cache Definition File	Loads the specified cache definition file. If the file was already loaded, all of the caches defined in that file are deleted and the file is loaded again.
	Remove Cache Definition File	Deletes all of the caches defined in the specified file.
Cache Definition File	Select a cache definition file from the drop-down menu. If an asterisk () is specified as the cache definition file for an Add Cache Definition command, the command unloads and then reloads all cache definition files. (The substitutions specified for the command, if any, are ignored). If an asterisk () is specified as the cache definition file for a Remove Cache Definition command, the command unloads all cache definition files. (The substitutions specified for the command, if any, are ignored).
Substitutions	Select a substitution from the drop-down menu. Substitutions are optional and must use the following syntax: $subname:subvalue $subname2:subvalue2 If a substitution value contains a single quote, it must be escaped using a / : $filter:Plant=/'Dallas/' If a substitution value contains a space, it must be enclosed in single quotes. Do not escape these single quotes: $subname:subvalue $subname2:'sub value 2' A substitution string cannot contain the following: : \| . tab space , ; = < > ' " & / \ { } [ ] ( ) Note: The name of the cache definition file and the substitutions, if any, to be applied when loading the file are specified when the command is defined.
Data Server	Select the Data Server on which the command is to be executed. Default - Execute the command in the Data Server you specified in Application Options>“Data Server Tab”, or locally if no Data Server was specified. None - Always execute the command locally rather than in the default Data Server. Named Data Servers - Select a Named Data Server that you configured in Application Options>Data Server. Multi-Server Command - When multiple data servers are specified, the command will be executed on each data server in the list. To configure multiple data servers, enter a semicolon (;) delimited list containing two or more Named Data Servers (e.g. ds101;ds102). Each name specified must correspond with a Named Data Server that you configured in Application Options>“Data Server Tab”. It is also possible to specify __default and __none (e.g. __default;ds101;ds102). Note: The values __default and __none begin with two underscore characters. Alternatively, a value of * can be entered to specify all data servers, including __default and __none.

Substitutions

The Substitutions feature allows you to build open-ended displays in which commands depend on values defined at the time the display is run. Generic names are used instead of arguments for specific commands. Later when the display is running, these generic values are defined by the actual arguments. In this way, a single display can be reused to issue a number of different commands. Substitutions are not applied to Drill Down or Set Substitution commands. For more information on creating displays using substitution values, see “Substitutions”.

Special Values

$value

When an actionCommand is executed $value is replaced with the value from the control. This value may be used in any field in the Define Cache Command dialog.

Note: This value may only be used for Action Commands. See “Commands” for more information.

The following describes Define Cache Command dialog commands:

Command	Description
OK	Applies values and closes the dialog.
Apply	Applies values without closing the dialog.
Reset	Resets all fields to last values applied.
Clear	Clears all fields. Detaches object from assigned message subject (once Apply or OK is selected).
Cancel	Closes the dialog with last values applied.