Rational Developer for System z

Starting the batch processor

The batch processor is a command-line interface for generating the same types of output files as are generated by the single-service wizards.

Tip: When you run a single-service wizard it automatically creates three generation properties files that you can use with the batch processor to generate the same files that were generated by the single-service wizard (see Creation of generation properties files for the batch processor).
Important: Before you run the batch processor, close any running the IBM® Rational® Developer for System z® instance that uses the target workspace.

Start the batch processor by entering the following command from the command line or executing it from a script. There are two formats of the invocation:

Figure 1. Formats for the parameters of the batch processor invocation:
(1) xsebatch -s sourceWSDL | -f containerFile [-d workspace] -c
          [-e WS_installdir] [-verbose] [-version]

(2) xsebatch -s languageFile [-c | -w serviceName] | [-c -w serviceName]
          -f containerFile [-d workspace] [-e WS_installdir] [-verbose]
          [-version] [-overwrite=yes|no] [-annot synFile]
          [-commtypes commTypesFile] 

Format (1)

In Format (1) either the -s parameter or the -f parameter is required and the -c parameter is required. The parameters in Format(1) are:
  • -s sourceWSDL: Either this parameter or the -f parameter is required. sourceWSDL is the name of the source WSDL file. When this parameter is specified all the generation options and configuration preferences are set from default values. If the -d parameter is also present then it specifies the location of the default preferences. Otherwise the default preferences are set by the generation engines.
  •  
  • -f containerFile: In Format (1) either this parameter or the -s parameter is required. This parameter specifies the name of the Container.xml file that contains the generation options. Most of the content of items in this file are optional, but a few are required and must be specified.
  •  
  • -c containerFile: In Format (1) this parameter is required. In Format (1) -c causes the following artifacts to be generated: language structures, language converters, mapping metadata, a template program, and runtime (IMS™ Enterprise Suite SOAP Gateway) metadata.
  •  
  • -d workspace: This parameter specifies the fully qualified path of the workspace to be used for the import. If this path is not specified on the command line then the default is taken from the environment variable workspace. If that environment variable is not set then the default is set to the following:
  •     • Linux $eclipse_root/workspace
  •     • Windows %eclipse_root%\workspace
  •  
  • -e WS_installdir: This parameter specifies is the Eclipse subdirectory of the directory in which IBM Rational Developer for System z is installed. If not specified, the default is taken from an environment variable eclipse_root. If that environment variable is not set then the default is set to the default installation directory for IBM Rational Developer for System z. That directory is recorded during installation by the install process and is set in the environment variable WDZ71INSTDIR.
  •  
  •  Note on directory names for -d and -e: If a directory name contain spaces then it must be placed in double quotes:
  •     • Linux "/home/username/my workspace"
  •     • Windows "c:\my workspace"
  • Use the double quotes only when specifying values for command line parameters -d and -e. If you use environment variables, omit double quotes for these values. Do not use a trailing file separator character in the path names for the -d and -e options nor in the values of the environment variables workspace and eclipse_root.
  •  
  • verbose: This parameter causes the diagnostic messages to be printed to the console.
  •  
  • version: This parameter causes the version, release, and modification information to be printed to the console.
  •  

Format (2)

In Format (2) the following parameters are required: -s, -c or -w or both, and -f. The parameters used in Format (2) are:
  • -s languageFile: This parameter is required unless the same information is specified in the importFile element. Here languageFile is the language source file that contains the message definition. You can override this name by specifying values for the elements importDirectory and inputFile in the MessageSpec element in the ServiceSpecification.xml file.
  •  
  • (-c | (-w serviceName)) | -c -w serviceName: One or both of the -c and the -w serviceName parameters are required:
  •     • -c causes the set of language converters, the driver, and XML schemas to be generated. You can override this option by using the generateConverters and the generateSeparateXSD options in the Container.xml file and in the ServiceSpecification.xml file. The option generateSeparateXSD=true produces XSD files only if -c (or generateConverters=true) is specified.
  •     • w serviceName causes the service definition files to be generated using the specified name for the Web service. You can override this option by using the generateWSDL option in the Container.xml file and in the ServiceSpecification.xml file. The value of this parameter can be overridden by the value attribute of the EISService element in the ServiceSpecification.xml file. The default value is set to esvc.
  •  
  • -f containerFile: In Format (2) this parameter is required. It specifies the name of the Container.xml file that contains the generation options. Most of the elements in this file are optional, but a few are required and must be specified.
  •  
  • -d workspace: See Format (1).
  •  
  • -e WS_installdir: See Format (1).
  •  
  • -verbose: See Format (1).
  •  
  • -version: See Format (1).
  •  
  • -overwrite=yes|no: If set to yes then this parameter causes newly generated files to overwrite existing files of the same names. If set to no then new names are provided for generated files that would otherwise overwrite existing files. The new name of the file contains an integer number as suffix that is incremented for each duplicate file until a unique name is found (for example, myfile12o.xsd). Overwriting converters and the XSD file can be further refined by the value of the overwrite attribute of the file generation specification elements contained in the XseSpec element (see XseSpec).
  •  
  • -annot synFile: This parameter specifies the absolute path and file name of the synonym action XML file. The synonym action XML file contains the optional annotation information that can be present in the source code of the service interface data declarations. When this parameter is specified the annotation information is included with the service interface data declarations in the generated files. The information in this file is applied to all source files during the invocation of xsebatch (see Using source annotations to specify service interface).
  •  
  • -commtypes commTypesFile: This parameter specifies the absolute path and file name of the common types XML file. The common types XML file describes the common elements and types that exist among all the various elements and types that are going to be used in the generated files. When this parameter is specified the generated WSDL and XSD schema refer to the common elements and types instead of imbedding and potentially duplicating the elements and types. The information in this file is applied to all source files during the invocation of xsebatch (see Commonly Used Elements and Types).
  •  

Status messages and error messages

You can see the progress of the xsebatch command in the console along with status messages and any error messages.

Getting the output files

After the xsebatch program has finished running, restart the IBM Rational Developer for System z to view the generated files in the workspace, or browse the file system with Windows Explorer.

Related concepts

Batch processor

Related tasks

Creating and configuring generation properties files

Related references

Container.xml
PlatformProperties.xml
ServiceSpecification.xml


Terms of use | Feedback

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