Skip to main content

Get help for ARIS Process Mining functions and services

Use global and local parameters

You can add various parameters to the request URL of an endpoint. These include request, local, and global parameters.

  • Query parameters specify the parameters added to the URL. The parameters are synchronized with the URL input field. You can reference extraction parameters or global parameters here to use their values.

  • Extraction parameters (local parameters) can be created for a specific extraction and are available for all endpoints of the extraction.

  • Global parameters can be created for a data set and are available for all extractions of the data set. You can create global parameters in the Parameters section of a data set. You can use global parameters for all endpoint requests of an extraction.

You can also link the various parameters with each other, for example, to add data dynamically during the runtime of a request. Global and local parameters can be used as variables in the endpoint URL, for headers, or for query parameters (query params). A parameter is then replaced by the corresponding value at runtime.

Procedure. Procedure

  1. You can create local parameters for the current HTTP extraction. Extraction parameters are listed on the Parameters tab of an extraction. You can use them for all requests of the extraction.

    1. Click Parameters.

    2. Click Add parameter. The corresponding dialog opens.

    3. Configure the extraction parameter.

  2. Select an endpoint on the Endpoints panel of the extraction.

  3. Display the Request options. Click the Arrow or More options icon to display or hide the options.

  4. To add local or global parameters to a request URL, place the mouse pointer at the relevant place in the request URL and enter the relevant parameter.

    Example

    ${baseURL}/api/${global_parameter}/get/${local_parameter}

  5. You can also add local and global parameters as values of query parameters. To do that, create a query parameter and enter a local or global parameter as a value. This way, the query parameter dynamically receives the values of the extraction and global parameters.

    Example

    ${baseURL}/api?query_parameter1=${global_parameter}&${local_parameter}=two

You added parameters to the request URL of an HTTP extraction.