Rational Developer for System z

Step 5.2: Create and configure the generation properties file for CatalogOrder.seqflow

In this section you will create and configure a generation properties file for the top-level flow CatalogOrder.seqflow.

Reusing the generation properties for the invoked flow

Recall that there are two sets of generation properties for an invoked flow: (a) a set stored in the generation properties file for the invoked flow; and (b) a set stored in the generation properties file for the top-level flow (see the last column of Table 1). Recall also that the two sets of generation properties for the invoked flow must have identical values in both generation properties files (see Step A3. Create a generation properties file for each invoked flow.)
Table 1. Sets of generation properties
Type of file: Example from this tutorial: Contents:
A generation properties file for a top-level flow: CatalogOrderGP.sfgen
  • Generation properties for the top-level flow.
  • Generation properties for the invoked flow.
A generation properties file for a flow invoked by the top-level flow: CheckItemAvailabilityGP.sfgen
  • Generation properties for the invoked flow.

In the previous step you created and modified a generation properties file (CheckItemAvailabilityGP.sfgen) for the invoked flow (see Step 5.1: Create and configure the generation properties file for CheckItemAvailability.seqflow).

Now in the current step you will create a generation properties file (CatalogOrderGP.sfgen) for the top-level flow. To avoid having to manually set the generation properties for the invoked flow a second time, you will use the option Reuse properties from most recently saved generation properties files (see Create the generation properties file for CatalogOrder.seqflow).

Create the generation properties file for CatalogOrder.seqflow

In this subtopic you will use the New Generation Properties wizard to create a generation properties file for the primary flow CatalogOrder.seqflow.

To create the generation properties file:

  1. Re-save the generation properties file that you created in the previous chapter, CheckItemAvailability.sfgen:
    Note:

    It is a good idea when you intend to select the option Reuse properties from most recently saved generation properties files in the New Generation Properties wizard to first go through the process of re-saving the generation properties that you want to duplicate in the new generation properties file.

    This guarantees that when the New Generation Properties wizard copies the most recently saved values the wizard gets the values that you want it to use.

    • However, in this tutorial the action is unnecessary because there is only one generation properties file for CheckItemAvailability.seqflow.

    • If you had two generation properties files for CheckItemAvailability.seqflow (such as GP1.sfgen and GP2.sfgen) and the generation properties had different values in the two files then you would want to re-save whichever of the generation properties file (GP1.sfgen or GP2.sfgen) contained the values that you wanted to duplicate in the new generation properties file.

    1. Right-click CatalogSample > Generation > CICS SFR L2.0 > CheckItemAvailability > CheckItemAvailabilityGP.sfgen.

    2. Click Open With > Generation Properties Editor.

    3. When the generation properties editor opens save the contents of the file (Ctrl-S).

    4. Close the generation properties editor.

  2. Start the New Generation Properties wizard:

    1. In the EST Project Explorer right-click CatalogSample > Flows > CatalogOrder.seqflow.

    2. Click New > Generation Properties File.

    The New Generation Properties wizard opens.

  3. On the first page of the wizard:

    1. Set the properties shown in Table 2.
      Note: Be sure to select the check box Reuse properties from most recently saved generation properties file
      Table 2. Generation properties
      Field: Set the field to this value: Comment:
      File name CatalogOrderGP.sfgen This field specifies the name for the new generation properties file.
      Description (Blank) This field allows you to specify a description of the generation properties file.
      Destination project CatalogSample This field specifies the service flow project in which the flow file is located and in which the new generation properties file is to be created.
      Flow CatalogOrder.seqflow This field specifies the flow file for which the new generation properties file is created.
      Reuse properties from most recently saved generation properties file (see Reusing the generation properties for the invoked flow) Selected This option causes the wizard to reuse the generation properties of the generation properties file that you most recently saved in the generation properties editor.
      Validate flows against runtimes Selected See the online help.
    2. Click Next.

  4. On the second page of the wizard:

    1. Set the options shown in Table 3.
      Table 3. Target runtime
      Field: Set the field to this value: Comment:
      Radio buttons CICS Service Flow Runtime: Level 2.0 This is the target runtime for which the Generate Runtime Code wizard will create output files.
    2. Click Finish.

The wizard creates the new generation properties file and opens it in the generation properties editor. The wizard then closes.

Edit the generation properties file for CatalogOrder.seqflow

In this subtopic you will use the generation properties editor to modify some of the generation properties in the new generation properties file CatalogOrderGP.sfgen.

To modify the generation properties file:

  1. If the generation properties file is not already open use the generation properties editor to open it:

    1. Right-click CatalogSample > Generation > CICS SFR L2.0 > CatalogOrder > CatalogOrderGP.sfgen.

    2. Click Open With > Generation Properties Editor.

    The generation properties editor opens.

  2. Set the generation properties for the invoke node PlaceOrder.

    1. In the hierarchical tree in the left pane of the editor area click the invoke node PlaceOrder.

      Note: Notice that an error symbol is displayed on the icon for this invoke node in the left pane of the editor area. This invoke node has an error because one of the required generation properties for it has not been set.

      The generation properties of the invoke node are displayed on the right side of the editor area.

    2. Set the generation properties for the invoke node as shown in Table 4.

      Table 4. Generation properties for the invoke node
      Field: Set the field to this value: Comment:
      Invoke type LINK with COMMAREA This field specifies the type of the invoke node. The type LINK with COMMAREA means that the Generate Runtime Code wizard will generate code to invoke the application using a LINK command with the COMMAREA option.
      Activity Name PlaceOrder For the CICS® Service Flow Runtime this field specifies the name of the CICS Business Transaction Service (BTS) activity that the Generate Runtime Code wizard creates for this invocation.
      Comment (Blank) This field allows you to enter a description of the invoke node or other notes.
      Adapter Name ADPLACEO For CICS Service Flow Runtime: Level 2.0 the CICS Service Flow Runtime uses this name to uniquely identify the Link with COMMAREA invocation.
      Adapter Transaction ID CMAS This field specifies the CICS Transaction ID under which the LINK with COMMAREA command is to be run.
      Link to Program Name DFH0XCMN This field specifies the name of the application invoked by the LINK with COMMAREA command.
      System ID (Blank) See the online help.
      Link to Transaction ID (Blank) See the online help.
      Syncpoint On Return Cleared See the online help.
      Maximum Commarea Length Generate length value This field specifies the maximum size required for the COMMAREA.

  3. Verify that the generation properties for the invoked flow CheckItemAvailability.seqflow are set to the same values in the generation properties file for the primary flow (CatalogOrderGP.sfgen) as they are in the generation properties file for the invoked flow (CheckItemAvailabilityGP.sfgen):

    1. Display the generation properties of the flow node CheckItemAvailability in the generation properties file CatalogOrderGP.sfgen:
      1. The generation properties file is already open in the generation properties editor.
      2. In the hierarchical tree in the left pane of the editor area click the node CheckItemAvailability. The generation properties of the node are displayed in the right pane.
    2. Display the generation properties of the flow node CheckItemAvailability in the generation properties file CheckItemAvailabilityGP.sfgen:
      1. Open the generation properties file CheckItemAvailabilityGP.sfgen in a separate instance of the generation properties editor.
      2. In the hierarchical tree in the left pane of the editor area click the node CheckItemAvailability. The generation properties of the node are displayed in the right pane.
    3. Compare the two sets of values for the generation properties of the flow node CheckItemAvailable by switching back and forth between the two instances of the generation properties editor.
      Note: Because you selected the option Reuse properties from most recently saved generation properties files when you created CatalogOrderGP.sfgen the generation properties for the flow node should have the same values in the generation properties file for the invoking flow as they have in the generation properties file for the invoked flow.
    4. Close the generation properties editor for CheckItemAvailabilityGP.sfgen.

  4. In the generation properties editor for CatalogOrderGP.sfgen set the generation properties for the flow node:

    1. In the hierarchical tree in the left pane of the editor area click the flow node CatalogOrder if it is not already selected.

      The generation properties for the flow node are displayed on the right side of the editor area.

      Note: Notice that an error symbol is displayed on the icon for the flow node in the left pane of the editor area. The flow node has an error because one of the required generation properties for the flow node has not been set.
    2. Set the common generation properties as shown in Table 5.

      Table 5. Common generation properties
      Field: Set the field to this value: Comment:
      Flow type NonTerminal This field specifies the type of the flow node and by implication the type of the flow that is going to be generated by the Generate Runtime Code wizard.
      Request Name SAMPCARN
      Note: This name stands for "Sample Program CatalogOrder Request Name".
      This field specifies the identifying name to be assigned to the service flow. The CICS Service Flow Runtime refers to the service flow by this name. At run time the service flow is started with this name.
      Program Name SAMPCAPN
      Note: This name stands for "Sample Program CatalogOrder Program Name".
      This field specifies the name to be assigned to the main COBOL file that is generated by the Generation Runtime Code wizard.
      Transaction ID SADP This field specifies the transaction id to be used for the new service flow in CICS.
      Run Mode SYNC This field specifies the processing mode for the transaction.
      Comment (Blank) This field allows you to enter text describing the generation properties file or make other notes.
      Persistent Cleared See the online help.
      Generate Internal Data Structures Cleared See the online help.
      Generate Web Service Files Web Services for CICS This field specifies whether additional converters and support files are to be generated for a non-SOAP deployment (such as CTG or MQ) or for a Web Services for CICS deployment.
      Host Code Page 037 United States This field specifies the host code page for either or both of the following actions:
      • Runtime XML-to-COBOL conversion
      • Uploading files to the host
    3. Set the Web Service Generation Properties as shown in Table 6.

      Note on Web Service Generation Properties:
      • In the generation properties editor, this group of properties opens immediately following the common generation properties when you select the option Web Services for CICS in the Generate Web Service Files list.
      • Recall that a completed service flow can be invoked in any of the following three ways:
        • Using a CICS-supplied interface.
        • Using the WebSphere® MQ-CICS bridge.
        • As the application program component of a Web service.
        (see Types of projects in Enterprise Service Tools)
      • When you select the option Web Services for CICS in the Generate Web Service Files list in the generation properties editor, this action indicates that you want to create a service flow that is invoked as the application program component of a Web service.

      • Here, in the Web Service Generation Properties group of the generation properties editor, you specify some of the values needed to create a service flow that is invoked as the application component program of a Web service.

      Table 6. Web Service Generation Properties group
      Field: Set the field to this value: Comment:
      Expose All CICS SFR Headers in Interface (ADVANCED) Cleared See Expose All CICS SFR Headers in Interface (ADVANCED).
      End Point URI http://system.company.- com:6182/user25/sampcapn
      where:
      • system.company.com is the address of the remote z/OS® system.
      • 6182 is the port used to connect to CICS on the remote z/OS system.
      • user25 is the user name.
      • sampcapn is the program name (see Table 5).
      This field specifies the URI that SOAP-enabled applications can use to invoke the new Web service.
      Note: Omit the '-' and line break when you type the string.
      Note: See your system administrator for the correct host address and port number to use for the End Point URI field.
      Local URI /user25/sampcapn
      where:
      • user25 is the user name.
      • sampcapn is the program name (see Table 5).
      This field specifies the portion of the URI that CICS uses 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 sampcapn This field specifies the name that the Generate Runtime Code wizard is to assign to the WSDL file that the wizard generates for the Web Services for CICS runtime environment.
      WSDL File Name sampcapn This field specifies the name that the Generate Runtime Code wizard is to assign to the WSBind file that the wizard generates for the Web Services for CICS runtime environment.
      WSDL HFS File Path /u/cicsts32/webservices/wsbind/cicssfrp This field specifies 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.
      WSDL Version 1.1 See the online help.
      SOAP Version 1.1 See the online help.
    4. For this tutorial, leave the WSDL properties set to the default values (see Table 7). These properties are set to default values when the generation properties file is created.

      Note:
      • In the generation properties editor, this group of properties is shown immediately following the Web service generation properties when you select the option Web Services for CICS in the Generate Web Service Files list.
      • These properties are used in the generated WSDL file to identify the Web service.
      Table 7. Specify WSDL properties group
      Field: Set the field to this value: Comment:
      Operation name Leave these fields set to the default values. The name of the operation that Web service provides.
      WSDL namespace The namespace for the generated WSDL file
      Request namespace The location of the request namespace document.
      Response namespace The location of the response namespace document.
  5. In the left pane of the editor area verify that an error symbol does not appear on the icon for the flow node or on the icons for any of the invoke nodes.

  6. Close the generation properties editor.


Feedback