Attribute
Attributes are used to group and connect entries to a specific program or command.
The configuration which program should be executed for an attribute has to be configured in the clients. You can also hide attributes if they aren't relevant for a specific client or shouldn't be shown in the UI.
Properties
In addition to the executing program, specific behaviors can also be defined for each attribute. Because of the configuration complexity, this can only be done with our Web app. We will take a look at each property below.
Parameter
The most important configuration for attributes are the parameters. In an exeuction view these are the arguments, that can be provided from the client dynamically. You can configure up to six parameters. The data types text, numeric and boolean are supported to validate the values and make the input from the client easier.
You can also configure predefined presets with a custom value for a parameter, that can be selected from the client via a combo box or radio buttons. This is especially usefull if the program expects fixed values for the parameter.
Execute always (EA)
With the property execute always you can make sure, that all entries for this attribute are always executed - even if the entry is already past.
A use case for this would be a simple notification system. An entry would appear as a notification. Especially for mobile phones it is likely, that the device had no internet connection when the entry should be executed. With EA, the entry is still executed when the device comes online again. Without setting this property, the entry would be in the past and wouldn't be executed anymore.
Local
In some cases, it is not worth saving the entries persistently in our database. With this property, entries won't be saved anywhere on our site. Therefore, only clients that were connected to the WebSocket at the moment of the entries' creation will receive it.
Warning
Only the Java clients are storing these kind of entries in a local file. When using the native console application, the entries will be lost on a restart.
Execution Response
If the execution response is enabled, you will receive a response from the first client which executed the program after the creation of an entry. The response includes the exit code and the output from the execution. You can configure how long the client should wait for a response.
Info
Both the executing program and the creator must be connected to the WebSocket.
By default, the entry has to be created "now" when using the execution response (because otherwise no response could be displayed in the client). If you enable delayed execution, it is also possible to create an entry in the future. But keep in mind that the creator won't receive a response in that case.
Here are some commands that my help Linux users when you are using this feature.
# Execute a command in the background AFTER returning the response
(sleep 10 && service stop httpd ) <&- >&- 2>&- &
# Don't include the output from the command
echo "This won't be shown" 2>&1 > /dev/null