Input Functions
The following table provides a list of available methods for creating user inputs. There are two ways of creating inputs – the previous way using InputType and the recommended Input Builder approach. See the InputBuilderFactory Groovy API documentation for details on all available Input Builders.
Name of the Input Builder method and Link to API Docs | InputType | Code Example | Deprecated Groovy API method (for creating inputs) |
---|---|---|---|
| Use this method to select a user. Returns the user's login name (not the full user object). if (api.isInputGenerationExecution()) {
return api.inputBuilderFactory()
.createAnyUserEntry("AnyUser")
.setLabel("AnyUser")
.getInput()
} else {
input.AnyUser
} | ||
| if (api.isInputGenerationExecution()) {
return api.inputBuilderFactory()
.createBooleanUserEntry("Boolean")
.setLabel("Boolean")
.getInput()
} else {
input.Boolean
} | ||
| if (api.isInputGenerationExecution()) {
return api.inputBuilderFactory()
.createConfiguratorInputBuilder("form", "ConfiguratorLogic", false)
.setLabel("Configurator")
.getInput()
} else {
input.form
} | ||
| not available | ||
| not available | ||
| not available | ||
| Creates an empty configurator entry object. Must be filled with inputs by calling | ||
| |||
| |||
| |||
| not available | ||
| not available | ||
| not available | ||
| |||
| |||
| |||
| |||
| not available | ||
| not available | ||
| |||
| |||
| not available | ||
| not available | ||
| not available | ||
| not available | ||
| |||
| not available | ||
| The following code snippet creates an input matrix: | ||
| |||
| It renders a list of input tuples – Target & Value. ExampleReturns
This code will multiply the values (the 2nd column) with the given numberConversion of the returned value (List of TieredValue) to MapSee the TieredValue class documentation. | ||
| |||
| |||
| |||
| This method creates an input parameter which lets the user pick an XLSX file to be used in a logic. It returns a handle that uniquely identifies the binary and its version that has been assigned to the input. The This methods works only for entities with attachments (i.e. Quotes, Agreements/Promotions, Rebate Agreements). As the upload file is stored in the database and linked there to e.g., a quote, you need to save the quote first to have an instance in the database. | ||
| |||
| not available | ||
| not available | ||
| |||
| not available | ||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
|
You can reference the inputs using input.<parameter name>
.
Example - if not in the InputGenerationExecution
mode, then retrieve the "Comments" field value:
Found an issue in documentation? Write to us.