Exposes a CICS application program as a Web service by generating a Web service description (WSDL) file and a Web service
bind (WSBIND) file.
Important: Before attempting to run a CICS Web Service on
Enterprise Server,
review the information in the
Configuration Requirements for CICS Web Services topic.
Syntax:
ls2ws pgmint={channel|commarea}
pgmname=program-name
reqmem=request-copy-file
uri=address
wsbind=bind-file
wsdl=wsdl-file
[ccsid=ccsid]
[contid=container-name]
[data-truncation={enabled|disabled}]
[datetime={unused|packed15}]
[logfile=logfile]
[mapping-level={3.0|4.0}]
[operation-name=operation-name]
[respmem=response-copy-file]
[synconreturn={yes|no}]
[wsdl-namespace=wsdl-namespace]
ls2ws -help
Parameters:
- pgmint={channel|commarea}
-
- channel
- Pass data via a channel container.
- commarea
- Pass data via a commarea.
- pgmname=program-name
- The name of the target application program to expose as a Web service.
- reqmem=request-copy-file
- The fully qualified name of the copybook file containing the high-level language structure for the Web service request.
- uri=address
- The relative or absolute URI to be used by a client to access the Web service.
- wsbind=bind-file
- The fully qualified name of the Web service bind file.
- wsdl=wsdl-file
- The fully qualified name of the WSDL file to contain the Web service description.
- ccsid=ccsid
- The CCSID used at run time to encode character data into the application data structure.
- contid=container-name
- The name of the container that holds the top-level data structure used to represent a SOAP message. When not specified, this
defaults to
DFHWS-DATA.
- data-truncation={enabled|disabled}
-
- enabled
- Variable-length data is tolerated in a fixed-length field structure.
- disabled
- Variable-length data is not tolerated in a fixed-length field structure.
- datetime={unused|packed15}
-
- unused
- Packed decimal fields of length 15 (8 bytes) in the data structure are not used.
- packed15
- Packed decimal fields of length 15 (8 bytes) in the data structure are treated as CICS ABSTIME fields and mapped as timestamps.
- logfile=logfile
- The fully qualified name of a logfile to contain output information generated by the
ls2ws command. When not specified, no logfile is generated.
- mapping-level={3.0|4.0}
-
- 3.0
- The OCCURS DEPENDING ON clause is not supported, and the target of the clause is mapped as a separate field.
- 4.0
- The OCCURS DEPENDING ON clause is supported, and the target of the clause is mapped together with the occurring field. Requires
data-truncation=enabled to work properly.
- operation-name=operation-name
- The operation name used in the generated WSDL file. When not specified, this defaults to the value of
program-name plus the literal value
Operation.
- respmem=response-copy-file
- The fully qualified name of the copybook file containing the high-level language structure for the Web service response.
- wsdl-namespace=wsdl-namespace
- The CICS namespace used in the generated WSDL file. When not specified, this defaults to
http://www.pgmname.comwhere
pgmname is the value passed to the
pgmname parameter.
- synconreturn={yes|no}
-
- yes
- The remote service can issue a sync point.
- no
- The remote service cannot issue a sync point.
- -help
- Displays information about
ls2ws parameters.
Examples:
- Example 1
- The following command uses the
incpy.cpy request copybook and the
outcpy.cpy response copybook to communicate with the
comml1 CICS program, and generates the
mywsdl.wsdl WSDL file and the
mywsbind.wsbind Web service bind file:
ls2ws pgmname=comml1
pgmint=channel
reqmem=incpy.cpy
respmem=outcpy.cpy
wsdl=mywsdl.wsdl
wsbind=mywsbind.wsbind
uri=/mysvc/operation
- Example 2
- The following command uses the
set1.cpy request copybook to communicate with the
set1 CICS program, and generates the
set1.wsdl WSDL file and the
set1.wsbind Web service bind file that each contain a newly defined operation named
newOperation:
ls2ws pgmname=set1
pgmint=commarea
reqmem=set1.cpy
wsdl=set1.wsdl
wsbind=set1.wsbind
uri=/mysvc/operation
operation-name=newOperation