dp:set-dist-variable

Creates a distributed variable or overwrites the value of a distributed variable in the distributed store.

Namespace declaration

  • xmlns:dp="http://www.datapower.com/extensions"
  • extension-element-prefixes="dp"

Syntax

<dp:set-dist-variable
  name="variable"
  value="value"
  use-domain="true" | "false"
  use-org="true" | "false"
  use-catalog="true" | "false"
  set-exclusive="true" | "false"
  expire="seconds"/>

Attributes

name="variable"
The xs:string that identifies the distributed variable.
value="value"
The node set, result-tree-fragment, xs:boolean, xs:double, or xs:string that specifies the value of the distributed variable.
use-domain="true" | "false"
The xs:boolean that indicates whether to use the name of the domain for key-value isolation. The default value is "true", which uses the name of the domain. To apply to all domains, specify "false".
us-org="true" | "false"
The xs:boolean that indicates whether to use the name of the provider organization in the API collection for key-value isolation. The default value is "true", which uses the name of the provider organization. To apply to all organizations, specify "false".
use-catalog="true" | "false"
The xs:boolean that indicates whether to use the name of the catalog in the API collection for key-value isolation. The default value is "true", which uses the name of the catalog. To apply to all catalogs, specify "false".
set-exclusive="true" | "false"
The xs:boolean that indicates whether subsequent writes to variables of the same name overwrite the existing value. The default value is "false", which support the overwriting of the value. To support only the initial write, specify "true".
expire="seconds"
The xs:integer that specifies the duration in seconds to persist the variable in the distributed store. By default, variables do not expire. Alternatively, you can specify "0" to indicate that the variable does not expire.

Guidelines

The dp:set-dist-variable element creates a distributed variable or overwrites the value of a distributed variable in the distributed store. To use distributed variables in the distributed store, you must configure the gateway-peering instance for distributed variables. For more information, see Distributed variables.