Rational Developer for System z, Version 7.6

Files created by the Generate Runtime Code wizard

This topic describes the files created by the Generate Runtime Code wizard.
Note: For a description of CICS Service Flow Runtime: Level 2.0 and CICS Service Flow Runtime: Level 1.0 see CICS® Service Flow Runtime Levels 1.0 and 2.0.
This topic contains the following information:

General information

Note: The wizard does not always generate all the types of output files that are listed in the tables in the following subtopics. The generation of a particular type of output file depends on the target runtime environment that you selected in the New Generation Properties wizard, the generation properties that you set with the generation properties editor, and the options that you selected in the Generate Runtime Code wizard.
The files generated by the wizard can be classified into five groups, which are shown in Table 1):
Table 1. Files generated by the Generate Runtime Code wizard
Types of files generated: Description: Link to subtopic below:
COBOL source files and copy books
  • Source files for your program
  • XML converters (optional)
COBOL source files and copy books
JCL files
  • JCL file to compile your source code
  • JCL file to create resource definitions
JCL files
Web service files
  • WSBind file
  • WSDL file
Web service files
XML-COBOL conversion file File containing conversion subprograms for inbound and outbound data.
  • Subprogram for converting inbound data from XML Schema to COBOL.
  • Subprogram for converting outbound data from COBOL to XML Schema.
XML-COBOL conversion file
Service flow properties file
  • Service flow properties file
Service flow properties file

COBOL source files and copy books

Table 2 shows the COBOL source files and copy books that are generated:
Note: For an WebSphere® MQ invoke node, fewer source code files are generated when the target runtime environment set in the generation properties file is CICS Service Flow Runtime: Level 2.0 (see CICS Service Flow Runtime Levels 1.0 and 2.0).
Table 2. COBOL source files and copy books
File and target runtime environments for which this file is generated: How to use this file: z/OS® destination: File names: File extensions:
Main program for the flow
Runtime environments:
  • CICS Service Flow Runtime: Level 1.0
  • CICS Service Flow Runtime: Level 2.0
Compile this program into a library allocated to DFHRPL in your CICS system.
Note: You can set options in the Generate Runtime Code wizard to have the wizard automatically create a compile JCL and submit the compile JCL to z/OS (see Step B6. The File selection page of the Generate Runtime Code wizard and Step B8. The Compilation and Installation Options page of the Generate Runtime Code wizard).
Partitioned data set that contains COBOL source. Program in the generation properties editor .cbl
Message copy books
Runtime environments:
  • CICS Service Flow Runtime: Level 1.0
  • CICS Service Flow Runtime: Level 2.0
Note: If you select the option Generate Internal Data Structures in the generation properties editor, then these copy books are inlined in the program rather than in separate files.
When the compiler compiles a COBOL file it also automatically compiles any copy book files that are included in the COBOL file. Partitioned data set that contains COBOL copy books Generated from message names .cpy

JCL files

Remember: If you have not customized the JCL templates, then you must update each of the JCL files created by the Generate Runtime Code wizard to use actual values instead of the placeholder terms (see Step B2. (Recommended) Customize the JCL templates).
Table 3 shows the JCL files that are generated:
Note: For an WebSphere MQ invoke node, fewer JCL files are generated when the target runtime environment set in the generation properties file is CICS Service Flow Runtime: Level 2.0 (see WebSphere MQ invoke type -- differences in treatment for different target runtime environments).
Table 3. JCL files
File and target runtime environments for which this file is generated: How to use this file: z/OS destination: File names: File extensions:
Compile JCL used to compile the generated COBOL source code.This file is generated only if the option Create compile JCL is selected in the Generate Runtime Code wizard.
Runtime environments:
  • CICS Service Flow Runtime: Level 1.0
  • CICS Service Flow Runtime: Level 2.0
Submit this JCL file to z/OS to compile the generated source code.
Note: You can set an option in the Generate Runtime Code wizard to have the wizard automatically submit this compile JCL to z/OS (see Step B8. The Compilation and Installation Options page of the Generate Runtime Code wizard).
Partitioned data set that contains JCL Same as program names that they compile .jcl
Compile JCL to compile the Web service XML converters and create CICS resources for those programs.
Runtime environments:
  • CICS Service Flow Runtime: Level 1.0
  • CICS Service Flow Runtime: Level 2.0
Note: The CICS resource definitions are commented out by default. You should restore them if you need that function.
Submit this JCL file to z/OS to compile the generated source code.
Note: You can set an option in the Generate Runtime Code wizard to have the wizard automatically submit this compile JCL to z/OS (see Step B8. The Compilation and Installation Options page of the Generate Runtime Code wizard).
Partitioned data set that contains JCL Same as the program name .jcl
Properties file update JCL used to update the CICS Service Flow Runtime properties file.
Runtime environments:
  • CICS Service Flow Runtime: Level 1.0
This file is always generated, if the runtime version is CICS Service Flow Runtime: Level 1.0.
Submit this JCL to z/OS to update the CICS Service Flow Runtime properties file with information about your generated program. Partitioned data set that contains JCL @ + first 7 letters of the request name specified in the generation properties editor .jcl
CICS Resource Definition job used to create resource definitions for the generated programs This file is generated only if the option Create resource definitions JCL is selected in the Generate Runtime Code wizard.
Runtime environments:
  • CICS Service Flow Runtime: Level 1.0
  • CICS Service Flow Runtime: Level 2.0
Submit this JCL file to z/OS to create the resource definitions for your generated program.
Note: You can set an option in the Generate Runtime Code wizard to have the wizard automatically submit this resource definition JCL to z/OS (see Step B8. The Compilation and Installation Options page of the Generate Runtime Code wizard).
Partitioned data set that contains JCL # + first 7 letters of the request name specified in the generation properties editor .jcl

Web service files

Note: You can use the Web service tester to test your Web service. Right-click the generated .wsdl file and select Web services > Test with Web Services Explorer.
Table 4 shows the Web service files that are generated:
Table 4. Web service files
File and target runtime environments for which this file is generated: How to use this file: z/OS destination: File names: File extensions:
Web service definition file used by Web service clients.
Runtime environments:
  • CICS Service Flow Runtime: Level 1.0
  • CICS Service Flow Runtime: Level 2.0
  • CICS uses this file only when you have set the option in CICS to do runtime validation of SOAP messages.
  • Typically you need this runtime validation only when you are debugging a program.
Any valid path on z/OS UNIX® System Services Specified in the generation properties editor .wsdl
WSBind file used by CICS to define the WEBSERVICE resource as a result of the PIPELINE SCAN command.
Runtime environments:
  • CICS Service Flow Runtime: Level 1.0
  • CICS Service Flow Runtime: Level 2.0
At run time, CICS uses information in the Web service binding file to perform the mapping between application data structures and SOAP messages. z/OS UNIX System Services path used by the CICS PIPELINE Specified in the generation properties editor .wsbind

XML-COBOL conversion file

By default, when the Generate Runtime Code wizard generates COBOL source code for a Web service, the generated source code uses the CICS interpretive conversion feature of Web Services for CICS (see Runtime XML conversion: compiled or interpretive).

However, in two situations the Generate Runtime Code wizard generates source code that uses the compiled conversion feature of Web Services for CICS. One of these situations is when an Arabic code page is selected in the generation properties editor, and the other situation is when you specifically tell the wizard in the generation properties editor that you want it to generate source code that uses compiled conversion.

In both of these situations, the wizard generates an additional COBOL source file that contains two subprograms to perform the actual conversions:
  • A subprogram for converting inbound data from the format of an XSD schema to the format of a COBOL data structure; and
  • A subprogram for converting outbound data from the format of a COBOL data structure to the format of an XSD schema.

To cause the Generate Runtime Code wizard to generate source code for compiled conversion, and to generate the additional COBOL source file containing the conversion subprograms, follow these steps in the generation properties editor:

  1. In the common generation properties, in the list Generate Web Service Files, select Web Services for CICS.
  2. Do one of the following:
    • In the common generation properties, in the Host Code Page list, select one of the following code pages:
      • 420 Arabic Speaking
      • 424 Hebrew (New Code)
    • Or, in the Web service generation properties group, select the option Expose ALL CICS SFR Headers in Interface (ADVANCED) (see Expose ALL CICS SFR Headers in Interface (ADVANCED).
Note: The enabling of this compiled-conversion option is not affected by the setting of the Generate Internal Data Structures check box in the common generation properties.
Note: You can select the COBOL compiler level of the generated source code (see Expose ALL CICS SFR Headers in Interface (ADVANCED)).

Table 5 describes the generated COBOL source file that contains the two XML-COBOL conversion subprograms.

Table 5. File containing the XML-COBOL conversion subprograms
File and target runtime environments for which this file is generated: How to use this file: z/OS destination: File name: File extensions:
File containing the two XML-COBOL data-format conversion subprograms.
Runtime environments:
  • CICS Service Flow Runtime: Level 1.0
  • CICS Service Flow Runtime: Level 2.0
Compile the file into a library allocated to DFHRPL in your CICS system. Partitioned data set that contains COBOL source code members Converter program name prefix1 + beginning letters of the name of the flow file + D .cbl
Table notes:
  1. The converter program name prefix is set in the Preferences window. The default value is XCNV. To modify this value:
    1. On the workbench main menu click Windows > Preferences.
    2. In the Preferences window:
      1. In the left pane select Enterprise Service Tools > COBOL XML Converters.
      2. On the Basic Options tab in the input field Converter program name prefix type the converter program name prefix that you want to use.

Service flow properties file

The service flow properties file contains properties of the generated program and is used by the CICS Service Flow Runtime. Table 6 shows this file:
Table 6. Service flow properties file
File and target runtime environments for which this file is generated: How to use this file: z/OS destination: File names: File extensions:
Service flow properties file (see the subtopic below: Service flow properties file).
Runtime environments:
  • CICS Service Flow Runtime: Level 2.0
The service flow properties file contains properties of the generated program and is used by the CICS Service Flow Runtime to configure CICS. See Service flow pickup directory. The flow name. .sfp
Important: The service flow properties file should be copied to the directory on the remote z/OS system that serves as your service flow pickup directory (see Service flow pickup directory).

This file is new in Rational® Developer for System z® Version 7.1 and replaces the properties file update JCL file.

This file's name and extension are determined as follows:
  • The file name is the name of the flow request.
  • The extension is .sfp.
This file is generated in the workstation's code page. When the file is copied to a remote z/OS system:
  • If the file is copied to a remote z/OS system by the Generate Runtime Code wizard, then the file is converted to the z/OS system's code page.
  • If you copy the file to a remote z/OS system by an external file-transfer program such as FTP, you should use text format (not binary format) to copy the file.

If the length of this file exceeds 32600 characters then the Generate Runtime Code wizard terminates with an error and displays an error message.

Service flow pickup directory

The service flow pickup directory on your remote z/OS system is the directory to which you should copy service flow properties (.sfp) files.

There is only one service flow pickup directory per CICS region.

The system administrator determines the location of the service flow pickup directory.

Important: The CICS Service Flow Runtime User's Guide refers to this directory as the "zFS deployment directory" (see Supported runtime environments for each project type).


Terms of use | Feedback

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