Runtime Parameters
Runtime parameters are are placeholders for values that are passed at runtime. They can be created in context of Selections.
Create Runtime Parameters
There are two types of runtime parameters:
- Scalar runtime parameters represent a single value.
- List runtime parameters represent multiple values.
Follow the steps below to create a scalar runtime parameter:
- In the main window of the component click [Edit Parameters]. The window “Edit Runtime Parameters” opens.
-
Click [Add Scalar] to define scalar parameters to be used as placeholders for actual values. The placeholders need to be populated with actual values at runtime.
Tip
Parameter0..-n is the default naming for the added parameter. You can enter a name of your choice.
-
Select one of the following data types from the drop-down menu. The data types may correlate to SAP data types.
Type Description Text Can be used for any type of SAP selection field. Number Can be used for numeric SAP selection fields. Flag Can only be used for SAP selection fields THAT require an ‘X’ (true) or a blank ‘‘ (false) as input value. -
Click [OK] to confirm.
The runtime parameters are now available in the component.
Follow the steps below to create a list runtime parameter:
- In the main window of the component click [Edit Parameters]. The window “Edit Runtime Parameters” opens.
-
Click [Add List] to define list parameters that contain multiple values separated by commas e.g., 1,10 or “1”, “10”. The placeholders need to be populated with actual values at runtime.
Tip
Parameter0..-n is the default naming for the added parameter. You can enter a name of your choice.
-
Click [OK] to confirm.
The runtime parameters are now available in the component.
Assign Runtime Parameters
Follow the steps below to assign the runtime parameters to selections.
- In the main window of the component, click the [Edit] button next to the selection you want to parameterize. The window "Edit Selections" opens.
- Add a filter to the selection, see Edit Selections.
- Click the icon button next to the input field to switch between static values ( ) and runtime parameters ( ). If no icon button is available, create a runtime parameter.
- Select a runtime parameter from the dropdown-list.
- Click [OK] to confirm the input.
Pass Values at Runtime
Follow the steps below to replace runtime parameters with actual values at runtime:
- Create and assign runtime parameters in the Xtract Query component.
- Close the Xtract Query component.
- Define the input values for the runtime parameters , e.g., single values or lists.
- Make sure that the data type of the input values match the data type of the corresponding runtime parameter.
- Make sure that the name of the input matches the name of the corresponding runtime parameter. The values in the input are automatically assigned to a runtime parameter by the same name.
- Connect the input to the Xtract Query component using the input anchor "P" .
- Run the workflow to test if the runtime parameters are assigned correctly.
Note
Parameterization via input anchors is supported as of Xtract for Alteryx version 1.19. When using an older version of Xtract for Alteryx, parameterize Xtract components using batch macros, see Parameterizing via Batch Macros.