Skip to content

Runtime Parameters

Runtime parameters are are placeholders for values that are passed at runtime. They can be created in context of using the WHERE Clause.

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:

  1. Open the Edit Runtime Parameters tab.
    open-edit-runtime-parameters

  2. 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.
    dd-parameters

    Tip

    Parameter0..-n is the default naming for the added parameter. You can enter a name of your choice.

  3. 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.

  4. Click [OK] to confirm.

The runtime parameters are now available in the component.

Follow the steps below to create a list runtime parameter:

  1. In the main window of the component click [Edit Parameters]. The window “Edit Runtime Parameters” opens.
    open-edit-runtime-parameters

  2. 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.
    dd-parameters

    Tip

    Parameter0..-n is the default naming for the added parameter. You can enter a name of your choice.

  3. Click [OK] to confirm.

The runtime parameters are now available in the component.

Use Runtime Parameters in the WHERE Clause Editor

  1. Navigate to the WHERE clause tab in the main window of the extraction and open the WHERE clause editor.
  2. Add a new WHERE clause criteria that uses the [Default with Parameter] template.
  3. Click the Parameter component. A drop-down list that displays all available parameters opens. Select a parameter from the list.
    WHERE-Clause-Builder-Example
  4. To test the WHERE clause, click [Load live preview]. Provide parameter values when prompted.

Pass Values at Runtime

Follow the steps below to replace runtime parameters with actual values at runtime:

  1. Create and assign runtime parameters in the Xtract Table component.
  2. Close the Xtract Table component.
  3. Define the input values for the runtime parameters , e.g., single values or lists.
    input
  4. Make sure that the data type of the input values match the data type of the corresponding runtime parameter.
  5. 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.
  6. Connect the input to the Xtract Table component using the input anchor "P" .
  7. 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.

Last update: June 20, 2024