Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
maxLevel3

...

Overview

Parameters are variables that you can use to pass inputs dynamically when invoking Pipelines. Parameter values remain unchanged during Pipeline execution. When defined, these values can be accessed from any part of the Pipeline and are especially useful in parent-child Pipeline construct.  Passing Pipeline arguments as parameters allow a Pipeline to be reused in multiple situations; this reuse can especially be helpful when creating Tasks from Pipelines. You can also append a query string to the URL with the key/value pairs of the parameters defined in the Pipeline properties.

...

Pass Arguments through Pipeline Parameters

To pass arguments to the Pipeline:

...

Note
titleBest Practice

You should URL-encode the arguments that you are using in the query string.

...


Pipeline Parameters in the Semantic URL Form

You can send Pipeline parameters to Triggered Tasks in the semantic URL form. When the Parameter Key is defined in the Pipeline Settings, the Parameter Value is rendered into a variable name. For example, if the variable name is PATH_INFO, then it must be defined as a parameter value in the Pipeline itself.  In the following example, we add the following parameters:

...

  • PATH_INFO—The path elements after the Task part of the URL.
  • REMOTE_USER—The name of the user that invoked this request.
  • REMOTE_ADDR—The IP address of the host that invoked this request.
  • REQUEST_METHOD—The method used to invoke this request.
  • QUERY_STRING—The query string element of the URL that made the request.
  • REMOTE_PORT—The port of the client that made the request.
Info

We return the IP address of the client or last proxy that sent the request.

When referencing these arguments, they must be prefixed with an underscore like any other parameter.  When designing a Pipeline, you might find it easier to explicitly add these parameters with a default value.

...

For example, if you pass a tenant ID (X-TENANT-ID) in a header, add the parameter X_TENANT_ID and provide a default or leave it blank. When you configure the expression, refer to the Pipeline argument following standard convention:  _X_TENANT_ID.  In the HTTP request, you add the header X-TENANT-ID: 123abc, which results in the value 123abc being substituted for the Pipeline argument X_TENANT_ID.


Info

Custom response headers are supported for Ultra Task or Triggered tasks invoked using Ground URLs. They are not supported for Cloud invoked Triggered tasks.

Example

You can set an HTTP header in a Triggered Task by using the Mapper Snap.

To set the header, add a Mapper Snap to the end of the Pipeline.

...