Display Button
This allows you to create a Button display.
The main configuration for a button is the action to be performed when
the button is clicked.
Attributes
- Label - This is the text that the button will display.
- Description / Tooltip - This is the tooltip for the button.
It should be a short description of the function of the
button.
- Command - This is the command that clicking the button should
execute. This may specify variables which the user will be
prompted for before the command is executed.
Variables should be of the form ${NAME} where NAME will be used
when prompting the user.
- Local execution - Displays may be run on Cyflex systems or may
be run remotely and use a network connection to a Cyflex system.
When running a display on a Cyflex system there is no difference
between local and remote execution.
Consider the case where the display is being run on a Windows
system with a network connection to a Cyflex system.
It is possible to enter commands which should execute on the
Windows system, for example starting up notepad or some other
Windows application.
For this, local execution should be specified.
However if entering a Cyflex command, it should be executed
across the network and run on the Cyflex system, not on the
Windows system.
For this, remote execution should be specified.
- Wait - Whether the display should wait for the command entered
to complete and then display the completion status or just
execute the command and proceed.
Executing some commands, for example starting an editor, should
not wait for the command to complete.
However other commands, for example setting a variable, will run
quickly and on completion could show the command's output or
results.
- Output level - Different commands might need to show different
levels of output.
However this is only meaningful if "Wait" is checked.
If "Wait" is not checked, there's no status to be displayed to
the user.
If checked, output levels are:
- All - Show maximal output, standard out and standard
error.
- NONE - No output is displayed regardless of the success
or failure of the execution.
- STATUS - Always show a brief status output indicating
success or failure of the command.
- FAILURE_ONLY - If the command fails, display maximal
output. If the command succeeds, show nothing.
- Confirm before executing - If a message is entered here, the
user will be prompted with this message and asked if they want
to proceed or not.
This allows major commands to be guarded so that they won't be
activated unintentionally.
The message should be in the form of a question where a yes
response indicates that execution should proceed.
Editing Note
Presently a button may be resized but the font does not change
size, only the background changes.
This will be addressed as time permits.
There is a "Test" button below the attributes editing area.
This button may be clicked to test the command features selected.