Understanding Upstream Interface Parameters

After the initial translation has occurred, the contents of messages sent from upstream systems are analyzed by the SRT at run time. After initial translation, the service bundle configuration enables the SRT to analyze the contents of messages from upstream. To accomplish this, you map the parameters that the messages contain to those required by the service actions that have been associated with the service bundle.

Note:

Some upstream interface parameters may not be used in the provisioning process. Upstream interface parameters can be mapped to lookups for further processing, for example to split parameters apart or to concatenate them together.

To map upstream interface parameters to service action parameters, you add the parameters to the Upstream Interface list:

  • Automatically based on service action labels. When you associate service actions with the service bundle, Design Studio asks you whether you want to use the service action labels to populate the upstream interface parameter list. If you elect to do so, Design Studio places the parameters in the parameter list on the Service Bundle editor Upstream Interface tab.

  • Manually in the Service Bundle editor. If you know what the upstream labels will be but do not have a sample XML document that can be imported, the parameters can be added in manually.

  • Import the upstream parameters from a sample upstream service request (in XML format). Using this method, Design Studio runs a transformation against the upstream XML file and extracts the interface parameters. The XSLT that implements the transformation must first be created by a technical resource such as a developer. See "Configuring Translations" for more information.

Related Topics

Defining Upstream Interface Parameters Manually

Importing Upstream Parameters

Service Bundle Editor Editor Tab

Understanding Service Bundles

Creating Service Bundles

Associating Service Actions with the Service Bundle

Understanding Service Action Spawning Conditions

Understanding Upstream Interface Parameters

Mapping Upstream Interface Parameters to Service Action Parameters

Understanding Lookups

Defining Upstream Interface Parameters Manually

In the Service Bundle editor you can manually add upstream interface parameters.

To define upstream interface parameters manually:

  1. On the Service Bundle editor, click the Upstream Interface tab, and then click Add in the Service Bundle Details area.

  2. In the Upstream Interface Details tab, enter the following information:

    • In the Name field, enter the name of the upstream parameter.

    • In the Default field, enter the default value of the upstream parameter. If the upstream parameter does not have a value, the default is supplied to ASAP.

    • In the Data Type field, enter the parameter's data type.

    • Select Multi Instance if the specified label is the stem of a series of parameters. This allows for a dynamic number of instances and possible use with ASAP's indexing capability for spawning multiple atomic actions.

    • Enable Required if this upstream parameter is required.

Related Topics

Understanding Upstream Interface Parameters

Importing Upstream Parameters

In the Service Bundle editor you can import upstream parameters from a sample upstream service request.

To import upstream parameters from a sample upstream service request:

  1. On the Service Bundle editor, click the Upstream Interface tab, and then click Import in the Service Bundle Details area.

    The Import Interface Parameter Wizard appears.

  2. In the Sample XML field, identify the XML file that represents a sample upstream service request.

  3. In the Stylesheet field, identify the XML stylesheet (XSLT) that transforms the service request into SRT format.

  4. Click OK.

    Design Studio parses the service request and adds the upstream parameters to the Upstream Interface tab.

Related Topics

Understanding Upstream Interface Parameters