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)

Name of the Input Builder method and Link to API Docs	InputType	Code Example	Deprecated Groovy API method (for creating inputs)
createA nyUser ()	`USER`	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 }`	anyUser()
create booleanUserEntry ()	`BOOLEANUSERENTRY`	`if (api.isInputGenerationExecution()) { return api.inputBuilderFactory() .createBooleanUserEntry("Boolean") .setLabel("Boolean") .getInput() } else { input.Boolean }`	booleanUserEntry()
createConfiguratorInputBuilder()	`CONFIGURATOR` `INLINECONFIGURATOR`	`if (api.isInputGenerationExecution()) { return api.inputBuilderFactory() .createConfiguratorInputBuilder("form", "ConfiguratorLogic", false) .setLabel("Configurator") .getInput() } else { input.form }`	configurator()
createButtonEntry()	`BUTTON`		not available
createCollapseLayout()	`COLLAPSE`		not available
createConfiguratorTable()	`CONFIGURATORTABLE`		not available
createConfiguratorEntry()		Creates an empty configurator entry object. Must be filled with inputs by calling `createParameter()` on InputBuilderFactory.
createConfiguratorEntryArray()
createCustomerEntry()	`CUSTOMER`		customer(), otherCustomer()
createCustomerGroupEntry()	`CUSTOMERGROUP`		customerGroupEntry()
createCustomFormListPopup()	`CUSTOMFORMLISTPOPUP`		not available
createDashboardInputs()	`DASHBOARDINPUTS`		not available
createDashboardPopup()	`DASHBOARDPOPUP`		not available
createDateRangeUserEntry()	`DATERANGEUSERENTRY`		dateRangeUserEntry()
createDateTimeUserEntry()	`DATETIMEUSERENTRY`		dateTimeUserEntry()
createDateUserEntry()	`DATEUSERENTRY`		dateUserEntry()
			dimFilterEntry()
createDMField()	`DMFIELD`		not available
createDMFields()	`DMFIELDS`		not available
createDmFilter()	`DMDIMFILTER`
createDmFilterBuilder()	`DMFILTERBUILDER`		datamartFilterBuilderUserEntry()
createDmFilterBuilderMultiple()	`DMFILTERBUILDERMULTIPLE`		not available
createDmQueryBuilder()	`DMQUERYBUILDER`		not available
createDmQueryFilterBuilder()	`DMQUERYFILTERBUILDER`		not available
createDMSource()	`DMSOURCE`		not available
createFilterBuilder()	`FILTERBUILDER`		filterBuilderUserEntry()
createHiddenEntry()	`HIDDEN`		not available
createInputMatrix()	`INPUTMATRIX`	The following code snippet creates an input matrix:	inputMatrix()
createIntegerUserEntry()	`INTEGERUSERENTRY`		integerUserEntry()
createMultiTierEntryInputBuilder()	`MULTITIERENTRY`	It renders a list of input tuples – Target & Value. Example Returns The result value is a List of TieredValue objects, i.e., you can make certain operations on them. This code will multiply the values (the 2nd column) with the given number Conversion of the returned value (List of TieredValue) to Map See the TieredValue class documentation.	multiTierEntry()
createOptionEntry()	`OPTION`		option()
createOptionsEntry()	`OPTIONS`		options()
createProductEntry()	`PRODUCT`		otherProduct
createParsableInputTypeFile()	`PARSABLEINPUTFILE`	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 `parsableInputFileData` function opens the input data and parses the file into Groovy data structures. 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.	parsableInputFile()
createProductGroupEntry()	`PRODUCTGROUP`		productGroupEntry()
createQuoteType()	`QUOTETYPE`		not available
createRadioEntry()	`RADIO`		not available
createRebateAgreement()	`REBATEAGREEMENT`		rebateAgreementUserEntry
createResultMatrixFilterBuilder()	`RESULTMATRIXFILTER`		not available
createRowLayout()	`ROW`
createSellerEntry()	`SELLER`		seller()
createSellerGroupEntry()	`SELLERGROUP`		sellerGroupEntry()
createSliderEntry()	`SLIDER`
createStringUserEntry()	`STRINGUSERENTRY`		stringUserEntry()
createTextUserEntry()	`TEXTUSERENTRY`		textUserEntry()
createTimeUserEntry()	`TIMEUSERENTRY`		timeUserEntry
createUserEntry()	`USERENTRY`		userEntry(), decimalUserEntry()

You can reference the inputs using input.<parameter name>.
Example - if not in the InputGenerationExecution mode, then retrieve the "Comments" field value:

Input Functions

Example

This code will multiply the values (the 2nd column) with the given number

Conversion of the returned value (List of TieredValue) to Map