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 having to edit the integration design itself or having to 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 style you are using.

Integration Style Editing Behavior
Scheduled Scheduled integrations support runtime configuration. Therefore, you can update the integration property values when the integration is active.

When the scheduled 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.
App driven orchestration App driven orchestration integrations do not support runtime configuration. Therefore, you can update the integration property values when the integration is not active. The configured property values takes effect after integration activation.

When the app driven orchestration 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.
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 values of the integration properties are shared by all minor version integrations having 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 Integrations for information about versions and identifiers.

  1. Right-click the trigger connection in an integration, and select the menu icon.
    Edit Integration Properties and View Integration Properties menu options

  2. Select Edit Integration Properties to add a property.
    The Integration Properties page is displayed.
  3. Click + to add a name, description, and value for the property. For example, enter an email address as the value. A maximum of 10 integration properties can be added.
    Integration Properties page with a table with Name, Description, and Value columns.

  4. When complete, click Close 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.
    Mapper source element tree expanded to show Integration Properties > properties > integration_property_1.

  6. Go to the Integrations page.
  7. Find the integration whose properties you want to update, and select Actions menu.
  8. Select Update Property Values.
    The Update Property Values dialog slides 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.
    Dialog with Property Name, Default Value, Current Value, and New Value fields.

    A confirmation message indicates that the property was updated.
    Properties for Integration integration_name (integration_version) updated successfully.

    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 return to the Update Property Values dialog, note that the value in the New Value field now appears in the Current Value field.

    You can also view previously configured integration properties.

  10. Return to the trigger connections and select View Integration Properties to view existing integration properties. This selection provides a read-only view of the properties. The options for adding and deleting existing properties are disabled.
    Edit Integration Properties and View Integration Properties menu options.