Override Design-Time Properties in an Integration

You can configure integration properties outside of the regular integration design. At runtime, these integration properties take effect and override the values you configured at design time. For example, you can specify an email address to use in the To field of a notification action during runtime that overrides the email address specified at design-time. This feature enables you to configure the value without the need to edit the integration design or pass the value at runtime.

You can configure all types of properties, including file path, database properties, server properties, credentials, and any constant property that changes at regular intervals.

When you can edit the integration properties is based on the type of integration pattern you are using.

Integration Pattern Editing Behavior
Schedule Runtime configuration is supported. You can update the integration property values when the integration is active.

When the integration is invoked:

  • If the integration property value is not updated, the default value is used.
  • If the integration property value is updated with a new value, the new value becomes the current value and is used.
Application Runtime configuration is not supported. You can update the integration property values when the integration is not active. The configured property values takes effect after integration activation.
  • If the integration property value is not updated, the default value is used.
  • If the integration property value is updated with a new value, the new value becomes the current value and is used.
Note the following behavior regarding integration properties and major versions (for example, 01.00.0000) and minor versions (for example, 01.10.0000) of an integration.
  • The current integration property values are shared by all minor version integrations with the same major version and identifier.
  • Updating the current value for an integration property is reflected in all other minor version integrations if they have an integration property with the same name.
  • Deleting an integration property from an integration does not remove its current value if there are other minor version integrations with the same major version and identifier.

See Create an Integration for information about versions and identifiers.

  1. Click Global Variables Global variables icon.
  2. Click the Integration Properties tab.
  3. Click + to add a name, description, and value for the property. For example, enter an email address as the value. You can add a maximum of 10 integration properties.

    The Global Variables and Integration Properties tabs are shown. Integration Properties is selected. Below are the Parameter Name, Description, and Value fields.

  4. When complete, click Save to save your changes and return to the integration canvas.

    Note:

    The integration property value can’t be updated within the integration. For example, you cannot update the integration property in an assign action.
  5. In the mapper, map the integration property (named integration_property_1 for this example) visible under Integration Properties in the Sources element tree to an appropriate element in the Target tree.

    The Sources tree, Mapping Canvas, and Target tree are shown. Three icons appear above the Sources tree. Developer, XSLT, and six icons appear above the Target tree. A Validate button appears in the upper right.

  6. Go to the Integrations page.
  7. Hover over the integration whose properties you want to update.
  8. Click Actions icon, then select Update property values.
    The Update property values panel open on the right side of the page.
  9. Click the integration property to update, then enter a value in the New Value field and click Submit.

    The Update Property Values panel shows the currently defined property, along with fields for Property Name, Default Value, Current Value, and New Value.

    A confirmation message indicates that the property was updated.

    The new value is used for a new run of the integration. For this example, the email address you specified in the New Value field is used as the To field email address of the notification action in the integration.

    If you select Update property values again to reopen the Update property values panel, the value in the New Value field now appears in the Current Value field.

    You can also view previously configured integration properties.