Configure Context for Integration Service Output
- Last UpdatedJun 04, 2026
- 3 minute read
When the gateway output is configured to use Integration Service, you can define context properties that are sent alongside the published data. Context properties allow you to attach metadata to published datasets, enabling the receiving system to apply context-specific processing or routing.
Context properties are configured in the Context section under the Integration Service output settings of the export configuration.
Context property values
Context property values support two types of references:
|
Syntax |
Description |
|---|---|
|
${Your_Configuration_Variable_Name}$ |
References a variable defined in the Variables section of the General tab. If the referenced variable does not exist (for example, because it was removed after the context property was set), the placeholder is not replaced. |
|
%{Your_Environment_Variable_Name}% |
References a system environment variable. If the referenced environment variable does not exist, the placeholder is not replaced. |
Both reference types can be combined within a single context property value.
Example:
Given the following setup:
-
A variable named ProjectName is defined in the Variables section with a PML expression that evaluates to the current project code.
-
An environment variable %ProjectName% is set to APS on the publishing machine.
Example 1 Simple environment variable reference in context:
|
Context property |
Value |
|---|---|
|
ProjectLabel |
ProjectName: %{ProjectName}% |
Result: ProjectName: APS
Example 2 Combined configuration variable and environment variable in context:
|
Context property |
Value |
|---|---|
|
ProjectLabel |
ProjectName: My project name is %{ProjectName}% and it's a great project |
Result: ProjectName: My project name is APS and it's a great project
To add a context property:
-
In the General tab, Select the Integration Service option from the Output area.
-
Expand Context to add explicit attributes.
-
Click Add
and choose the variable type (Constant, Constant hint, or PML). You can use ${VarName}$ to reference a configuration variable, or %{VarName}% to reference an environment variable while defining context property value.
-
Select the required property.
-
In the Constant property editor area, enter the following details:
-
Name: The name of the explicit attribute. This becomes the column name in the published table.
-
Value: A PML1 or PML2 expression evaluated per element to produce the column value.
-
Edit or Delete a Context property
-
To Edit a context property, select it in the Context list and modify the Name or Value source as required.
-
To remove a context property, select it in the Context list and select Delete.
Note: Removing a variable that is referenced in a context property does not automatically remove the context property. When publishing, the value of an orphaned context property (one that references a removed variable) will be null. This behaviour is intentional to preserve context structure when redefining variables.
Note: PML syntax errors in variable expressions are not validated in the configuration editor. If a PML expression contains a syntax error, the error is caught when the expression is evaluated at the start of a publish run and will stop the publish process.