Rational Developer for System z

Common generation properties of all three flow types

This topic describes the generation properties that all three flow types (Nonterminal, FEPI, and Link3270 Bridge) have in common.

This topic contains the following subtopics:

General information

When the flow node of a flow is selected in the hierarchical tree in the left pane of the editor area of the generation properties editor (the flow node is the top-level node in the hierarchical tree) then the generation properties editor displays on the right side of the editor area the generation properties of the selected flow node. The generation properties include:

The common generation properties are generation properties that are present in each of the three flow types. The first common generation property is the Flow Type, which you use to set the flow type of the flow to Nonterminal, FEPI, or Link3270 Bridge.

The additional generation properties are additional properties that occur only in the selected flow type. The FEPI flow type and the Link3270 Bridge flow type each have additional generation properties. The Nonterminal flow type has only the common generation properties

The Web service properties are additional generation properties that can be present in each of the three flow types. The editor displays these properties only when the list Generate Web service Files in the common generation properties is set to Web Services for CICS.

Table 1 shows which ones of these three groups of generation properties are used with each flow type:

Table 1. Overview of the generation properties of the flow types
Nonterminal flow type: FEPI flow type: Link3270 Bridge flow type:
  • Common generation properties
  • Web service generation properties

Main flow or invoked flow

You can use the generation properties editor to modify either a main flow or an invoked flow (see A flow). The generation properties editor does not distinguish between the two.

Remember: The Generate Runtime Code wizard requires that an invoked flow have a flow type of either FEPI or Link3270 Bridge (see About flow types).

Common generation properties

For more information about the common generation properties see the CICS® Service Flow Runtime User's Guide (see Supported runtime environments for each project type).

Table 2. Common generation properties for all flow types
NAME: DESCRIPTION: VALUE RANGE: DEFAULT VALUE:
Flow Type The primary type of nodes contained in the flow. Depending on the type selected, additional properties that apply to all nodes of that type appear in the editor.
  • Non Terminal: Invoke nonterminal nodes or a combination of Invoke nonterminal and Invoke screen operation nodes
  • FEPI: screen-based nodes
  • Link3270: screen-based nodes with or without associated BMS maps
Non Terminal
Request Name This is the name that you want the CICS Service Flow Runtime to use to identify the service flow. This name is used to start the service flow by name at run time.

This name is also defined in CICS as the process type for the flow.

None. This is a required field. None. This is a required field.
Program Name This is the name that you want to be given to the main COBOL file that is generated to contain the source code for the service flow. String value: 1-8 characters Derived from the flow name (see Table 3)
Transaction ID This is the transaction id that you want to be used for the new service flow in CICS. String value: 1-4 characters First 4 characters of the Program Name
Run Mode Processing mode for the transaction conducted by the flow
  • ASYNC: Processing mode in which the process and its activities are run as separate units of work
  • LINK: Processing mode in which a synchronous service flow runs as a single unit of work. This mode improves performance because it uses fewer tasks during request processing. However, a failure in any server adapter results in the entire unit of work being rolled back.
  • SYNC: Processing mode where the process is run in the same unit of work as the WebSphere® MQ-CICS bridge link task
  • SYNC ROLLBACK: Processing mode that uses synchronous processing but abends if any failure of any activity in the process occurs
SYNC
Comment Text describing the runtime code that will be generated N/A "GENERATE NAVIGATOR MODULE " + the node name
Persistent Select to have the request and session data remain if the session fails. N/A Not selected
Generate Internal Data Structures Select to generate the data structures directly into the generated COBOL source programs. This option produces a limited set of modules (JCL and CBL) required for deployment to the host. N/A Not selected
Generate Web Service Files Options to generate converters and support files for a non-SOAP deployment (such as CTG or MQ) or for a Web Services for CICS deployment
  • None
  • Web Services for CICS: Enables you to generate converters and support files or for a Web Services for CICS deployment.
None
Host code page Used for the following purposes:
  • Host code page for the runtime XML conversion process.
  • Host code page for uploading files to the host.
Select from list of code pages Current® language
The following table describes how the default program name is derived from the flow name:
Table 3. Deriving the default program name
Flow name: Default program name:
Length > 8 characters First 8 characters of the flow name
Length < 8 characters Flow name + 'P'
Length = 8 characters Last character is not 'P' First seven characters + 'P'
Last character is 'P' First seven characters + 'G'

Web service generation properties

The Web service generation properties can be present in each of the three flow types (Nonterminal, FEPI, and Link3270 Bridge) and therefore are common generation properties.

The generation properties editor displays these properties only when the option Web Services for CICS is selected in the Generate Web service files list (see Considerations when creating a Web service ).

  • Expose All CICS SFR Headers in Interface (ADVANCED)
    This selection controls two characteristics of the generated Web service:
    More specifically:
    • If you clear this check box, then the generated Web service uses the following:
      • Interpretive runtime XML conversion.
      • Minimal CICS Service Flow Runtime headers (containing only the request name).

      This option is simpler and is recommended. In the runtime settings, you have to specify only the request name and the user data.

    • If you select this check box, then the generated Web service uses the following:
      • Compiled runtime XML conversion.
      • Full CICS Service Flow Runtime headers.

      Also, a COBOL source code file is generated that contains subprograms to do the XML-COBOL conversion (see XML-COBOL conversion file).

      This option is available only for backwards compatibility and is not recommended otherwise. In the runtime settings, you have to specify additional runtime settings.

      Note: You can select the COBOL compiler level of the source code contained in the generated XML-COBOL conversion file. To select the COBOL compiler level:
      1. On the workbench's main menu select Window > Preferences. The Preferences window opens.

      2. In the Preferences window, in the left pane, select Enterprise Service Tools > COBOL XML Converters.

      3. In the Compiler level list select the level of the COBOL compiler that you want to use.

  • End Point URI
    Specify the location that you want SOAP-enabled applications to use to invoke your Web service. Figure 1 shows an example of a location for an endpoint URI:
    Figure 1. Example of an endpoint URI
    http://system.company.com:8181/servicedir/sfp005
    In the example URI in Figure 1:
    • http specifies the method for accessing the resource.
    • //system.company.com is the name or the IP address of the server on which the Web service is going to run.
    • 8181 is the port that CICS pipeline for the Web service is going to use.
    • /servicedir is the name of directory that the CICS pipeline uses as a working directory for active Web services.
    • /sfp005 is a directory in /servicedir that CICS pipeline is going to use to store information about the Web service when it is active.
    The Generate Runtime Code wizard uses the location that you specify in the End Point URI field to set the SOAP address of your Web service in the generated WSDL file (see Figure 2).
    Figure 2. Setting the SOAP address
    <service name="DFHMADPLService">
       <port binding="tns:DFHMADPLHTTPSoapBinding" name="DFHMADPLPort">
          <!-- This soap:address indicates the location
               of the Web service over HTTP. -->
          <soap:address location="http://system.company.com:8181/servicedir/sfp005"/>
          ...
          ...(lines omitted)
       </port>
    </service>

    To specify a location for the End Point URI field you can either:

    • Select a location from the list:

      If you have created and activated a connection to a CICS Resource Definition server (see Step B4. (Optional) Create a connection to a CICS Resource Definition server) and if a query from the connection to the remote CICS region is successful then this field is a list of directories on the remote z/OS® system from which you can select a location.

      Select a location from the list or type an entry.

    • Type a location:

      Otherwise this field is an input field.

      Type a valid location into the input field.

  • Local URI

    CICS uses this portion of the URI to resolve the resources used for the Web service. This value is derived from the End Point URI and cannot be changed within the generation properties editor.

  • WSBind File Name

    The Generate Runtime Code wizard uses the name that you specify here (for example, SFP03) for the WSBind file that it creates (for example, SFP03.wsbind) in the generation subfolder.

    The WSBind file contains information that is used to define the Web service to CICS (see Step B8. The Compilation and Installation Options page of the Generate Runtime Code wizard).

  • WSDL File Name

    The Web service definition file is used by the callers of the Web service. This file is not required by CICS but the runtime code generation facility can deploy this file to the host system, as a means of providing a known storage location for it. CICS can use this file for Web service validation.

  • WSDL HFS File Path

    The HFS stands for "hierarchical file system", as in UNIX. Here you should type the complete path of the directory in z/OS UNIX System Services in which CICS should look for the WSDL file generated by the Generate Runtime Code wizard (for example, /u/user25/cicsts32/sfp01 ) (see Step B7. The Selection of target locations page of the Generate Runtime Code wizard).

  • WSDL Version

    This option is available only when the target runtime environment is the CICS Service Flow Runtime for CICS Transaction Server for z/OS V3.2 or later.

    This option controls which version of WSDL is used as a basis for the files and other artifacts that the Generate Runtime Code wizard creates for the Web Services for CICS runtime environment:
    WSDL 1.1
    Files and other artifacts are generated using WSDL 1.1.
    WSDL 2.0
    Files and other artifacts are generated using WSDL 2.0.
    Restriction: Enterprise Service Tools supports WSDL 2.0 only to the extent that it is supported by the CICS Web Service Assistant in CICS Transaction Server for z/OS V3.2 or later. Users are subject to any limitations to support of WSDL 2.0 by the Web Services Assistant.
  • SOAP Version

    This option is available only when the target runtime environment is the CICS Service Flow Runtime for CICS Transaction Server for z/OS V3.2 or later.

    This option controls which version of SOAP is used as a basis for data bindings in files and other artifacts that the Generate Runtime Code wizard creates for the Web Services for CICS runtime environment:
    SOAP 1.1
    Data bindings are generated using SOAP 1.1.
    SOAP 1.2
    Data bindings are generated using SOAP 1.2.
    All
    Data bindings are generated in both SOAP 1.1 and in SOAP 1.2
    Restriction: Enterprise Service Tools supports SOAP 1.2 only to the extent that it is supported by the CICS Web Service Assistant in CICS Transaction Server for z/OS V3.2 or later. Users are subject to any limitations to support of SOAP 1.2 by the Web Services Assistant.


Terms of use | Feedback

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