The parameters required by a script are specified using comments in the header. These are similar in format to the JavaDoc comments used to document Java.
Note: | Starting in Release 9.3, these parameters are only available in EPM Workspace. |
The minimum that can be specified to define a parameter is the name, for example, @param sourceLanguage.
This assumes that the input is a simple string and displays an (initially empty) text box on the UI.
Optional: An @inputType line enables more specific data input methods:
file_picker_single_value—Select one file from the repository
file_picker_multi_values—Select multiple files from the repository, all of which constitute one value
file_picker_multi_values_parallel_execution—Select multiple files from the repository, all of which can be processed in parallel by separate instances of the script
dropdown—Select from a predefined set of fixed values
Input types can be given a default value using @defaultValue. For file picker input types, the default value must be the UUID of a file in the repository.
Drop-down lists require a separate @comboValues line that specifies possible choices, separated by commas.
Note: | For custom scripts, parameter values are only validated when the script is executed, not at submission time. For example, if an unacceptable value is specified for a script, the user is not informed at the time of task submission. If a script cannot recover from invalid data, it logs a message and throws an exception, causing the status to display as Fail (red) in Show Task Status, alerting the user to the problem. |