Rational Developer for System z

The input message of a flow

The input message of a flow is a single message that describes the input parameters with which the flow is invoked.
The following steps provide an overview of how to create an input message, how to store a reference to the input message into the interface operation of a flow, and how to use the input message during the processing of the flow.
Note: Some of the same tasks are required in setting up the input message of a flow as are required in setting up the output message of a flow (see The output message of a flow). Therefore in the wizards described below, whenever a wizard page contains an option for an input message, the same page also includes a similar option for an output message.
  1. Create an input message file and an input message.

    • Basic method:

      1. Create a new message file (extension .sfmxsd) to serve as the input message file of the flow.

      2. Within the message file create a new message:
        • This message serves as the input message of the flow.
        • This message should be the only message in the input message file.

      3. Within the input message create a message element corresponding to each of the input parameters of the flow.

        Define each message element to contain the same type of data as the corresponding input parameter.
        Note: A message element can be a simple data type, a complex data type, or an array.

      See the example in Step 1.2: Define the input, output, and variable messages for the top-level flow

    • Wizards:

      See Steps 2 and 3.

  2. Create an interface operation and store a reference to the input message into the interface operation.

    Optionally you can at the same time also store into the interface operation a reference to the output message of the flow and references to any fault messages that the flow requires.

    • Basic method:

      1. Create a new operations file or open an existing operations file (extension .wsdl).

      2. Within the operations file create a new operation to serve as the interface operation of the flow.

      3. Within the new operation create references to the following messages:

        • The input message of the flow (created in Step 1).

        • The output message of the flow.
          Note: You can specify this reference later if you wish.
        • Any fault messages that the flow requires. You can specify these references later if you wish.

      See the example in Step 1.3: Create the interface operation for the top-level flow

    • Import wizards:

      The import wizards integrate and automate the tasks of creating interface messages, creating an interface operation, and storing references to the interface messages into the interface operation:

      • Import COBOL Files wizard:

        The Import COBOL Files wizard allows you either to select an operation from an existing operations file or to have the wizard create a new operation in a new operations file.

        If you have the wizard create a new operation then the wizard also allows you specify both the input message and the output message in either of the following ways:
        • Select the message from an existing message file.
        • Have the wizard create a new message and message file, using as a pattern for the message a COBOL data definition that you select from a COBOL source code file or copy book.
        The wizard then stores a reference to the specified message into the new operation.

      • Import PL/I Files wizard

        The Import PL/I Files wizard is similar to the Import COBOL Files wizard but allows you to specify PL/I data definitions as patterns for the interface messages.

      • Import Web Service Definition wizard

        The Import Web Service Definition wizard generates interface messages and an interface operation together with their respective files from a Web service definition in a WSDL file.

    • New flow wizards:

      The New Flow wizard and the New Flow Recording wizard are described in Step 3 below.

      Each of these wizards, in addition to creating a new nonterminal flow or a new terminal flow, also allows you to select or create the interface operation, the input message, and the output message, and store references to the interface messages into the interface operation.

  3. Specify the operation from Step 2 as the interface operation for a flow:

    • Using an existing flow:

      1. Open the flow in the flow editor.
      2. Select the operation from Step 2 as the interface operation for the flow.

      See the example in Associate the operation with the flow.

    • Creating a new flow:

      • New Flow wizard

        The New Flow wizard creates a new, empty nonterminal flow and associates a specified interface operation with the new flow (see Creating a flow with the New Flow wizard).

        With the New Flow wizard you can also do the following:
        • Specify a variable message for the flow (see The variable message of a flow).
        • Select or create the interface operation, the input message, and the output message.
        • Store references to the interface messages into the interface operation.

      • New Flow Recording wizard

        The New Flow Recording wizard allows you to record a new terminal flow and associates a specified interface operation with the new flow (see Creating a flow with the New Flow wizard).

        As with the New Flow wizard, you can also specify a variable message for the flow, select or create the interface operation and interface messages, and store references to the interface messages into the interface operation.

  4. Read the input parameters during the progress of the flow:

    1. After you have created the new flow, open the flow in the flow editor.

    2. In the first Assign node of the flow (if this node was created automatically its name is variableAssignInput):
      1. Get the input parameters from the input message.
      2. Store the input values into general-purpose variables so that you can use them during the flow.

    See the example in Copy data from the input message i_CatalogOrder in which the input parameters from the input message of the main flow CatalogOrder are copied into the input message of a second flow CheckItemAvailability that CatalogOrder is about to invoke.


Terms of use | Feedback

This information center is powered by Eclipse technology. (http://www.eclipse.org)