Rational Developer for System z

Starting the batch processor

The batch processor is a command-line interface for creating enterprise Web services descriptions and message converters for CICS® and IMS™ applications.
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):

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] 

In this command, languageFile is the name of the language source file that contains the message definition. You can override this name by using the message specification option in the ServiceSpecification.xml file.

You specify either the -c parameter or the -w parameter or both, as follows:
  • -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 will produce 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".

The variable containerFile is the name of the Container.xml file that holds the generation options. Most of the content of items in this file are optional, but a few are required and must be specified.

The following parameters are optional:
  • -d workspace is the fully qualified path of the workspace to be used for the import . If this path is not specified, the default is taken from the environment variable called %workspace%. If that environment variable is not set, the default is set to %eclipse_root%\workspace
  • -e WS_installdir is the Eclipse subdirectory of the directory in which the IBM Rational Developer for System z is installed. If not specified, the default is taken from the environment variable %eclipse_root%. If that environment variable is not set, 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 Windows environment variable WDZ71INSTDIR."
    Note: If the directory names contain spaces (for example, c:\test one\IBM) you need to put these names in double quotes (for example, "c:\test one\IBM"). You need to 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 backslash ('\') in any of the pathnames for the -d and -e options and the %workspace% and %eclipse_root% environment variables.
  • -verbose causes the diagnostic messages to be printed to the console.
  • -version causes the version, release and modification information to be printed to the console.
  • -overwrite when set to "yes" (the default) causes the tool to write over all the generated files. If set to "no" a new file name is generated for each file that exists. The new name of the file will contain an integer number as suffix which will be 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 of the XseSpec group described in Reference: Elements in XML Schemas for batch processing.
  • -annot synFile: This can be used to specify the absolute path to location and name in the file system of the synonym action XML file (synFile). The synonym action XML file contains the optional annotation information that can be present in the source of the service interface data declarations. The information in this file is applied to all source files during the invocation of xsebatch. For more information see Using source annotations to specify service interface.
  • -commtypes commTypesFile: This can be used to specify the absolute path to location and name in the file system of the common types XML file (commTypesFile). The common types XML describes the common element and type information that is used in the generated WSDL and XSD schema to refer to instead of imbedding and potentially duplicating the types. The information in this file is applied to all source files during the invocation of xsebatch. For more information see Commonly Used Elements and Types.

All other generation options are specified in XML files (either directly in the container file or in the XML files that the container file contains).

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

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 populating 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)