Overview of the parameter types for actions in edoc automate

You can define parameters with different types in actions. The different parameter types in the Edit Action dialog define the options that can be selected when developing the app and, of course, the execution of the action at runtime.

You can access the value of a parameter at runtime using the AbstractComponent::param($name) or AbstractComponent::paramList($name) methods for lists.

The following parameter types are available by default in edoc automate:

Parameter type	Function in the editor	Function at runtime
TEXT	Used to insert static text. You can also optionally insert an action whose SingleValue return value is used.	Returns a static text or the SingleValue return of an action.
SELECT	Used to select predefined values. You must select a value.	Returns a value from the defined list of values. You can define the values for the list using the options option. You can use the default option to define a default value.
COMPONENT	Used to select a component in the current view.	Returns the ID of the selected component in the view. You can use the AbstractAction::findComponent() method to access the instance of the component.
COMPONENTLIST	Used to create a list with several components of the current view. The list can also contain only one component.	Returns a list with IDs of components in the view. You can use the AbstractAction::findComponent() method to access the instance of a single component.
KEYVALUELIST	Used to create a list with any number of values with names and the corresponding value. You can also select an action as a value.	Returns a list of values as an associative array. You should query parameters of this type using the AbstractComponent::paramList($name) method so that the defined actions are executed directly.
VALUELIST	Used to create a list with any number of values without further labeling of the individual values.	Returns a list of values as an indexed array. You should query parameters of this type using the AbstractComponent::paramList($name) method so that the defined actions are executed directly.
ACTIONLIST	Used to create a list with any number of actions without further identification of the individual actions.	Returns a list as an indexed array. The array only contains the configuration of the actions with which you can create an instance with the static method AbstractAction::create().
KEYACTIONLIST	Used to create a list with any number of actions with a key to identify individual actions in the list.	Returns a list as an associative array. The array only contains the configuration of the actions with which you can create an instance with the static method AbstractAction::create().
ACTION	Used to select a single action.	Returns the configuration of a single action. You can use the static method AbstractAction::create() to create an instance of the action.
EDITOR	Is a text editor in which the syntax is highlighted.	Returns the text defined in the editor. You can use the mode option to specify a language for syntax highlighting. You can use the autocompletion option to activate (true) or deactivate (false) automatic completion for the set language.
DATASOURCE	Is a list of all data sources available in the app.	Returns the name of the selected data source.
WORKFLOW	Is a list of all the workflows available in the app.	Returns the name of the selected workflow.
VIEWROUTE	Used to select a route to a view. You specify the parameter for the route.	Returns the reference to a route of a view.