Function

urlwithparameters( path, parameterNames, parameterValues )

This function allows you to build a URL from an expression, using arrays of process and constant data.

Parameters

Returns

Textpath (Text)

Usage considerations

URL format

Parameter names are encoded to form a valid URL. For example, spaces are replaced with "%20".

The return value is a fully qualified or relative URL path that is not encoded or validated.

Casting behavior for single values

Prior to Appian 23.2, if you provided second and third parameters without curly brackets {}, they were treated as URL parameter names without values. In Appian 23.2 and above, they are treated as a URL parameter name and value.

For example, urlwithparameters("https://example.com", "a", 1) returns the following prior to Appian 23.2:

https://example.com?a=&1=

In Appian 23.2 and above, it returns:

https://example.com?a=1

See Using urlwithparameters() to list parameter names without values for an example of how to achieve the old functionality.

Examples

Using urlwithparameters() in a process model

The following is how you would use urlwithparameters() in a process model using an html link and process variables.

"<a href=" & urlwithparameters("/tio/viewPayments.do", {"claimNumber"}, {pv!claimNumber}) & ">View Payments</a>"

Returns a link that is specific to a claim number and uses View Payments for the link text. For example, when pv!claimNumber is 34252, it returns /tio/viewPayments.do?claimNumber=34252.

Using urlwithparameters() in a link component

The following shows how to use urlwithparameters() in a link component.

Use the interactive editor below to test out your code:

Using urlwithparameters() to list parameter names without values

To return a list of parameter names without values, use an empty array for the third parameter. For example:

1
2
3
4
5
urlwithparameters(
  "url",
  {"a", "b", "c"},
  {}
)

Returns url?a=&b=&c=.

Feature compatibility