Exposes a CICS application program as a Web service by generating one or more JavaScript Object Notation (JSON) schema files
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:
ls2js {json-schema=json-filename|
json-schema-request=request-filename
json-schema-response=response-filename}
pgmint={channel|commarea}
pgmname=program-name
reqmem=request-copy-file
uri=address
wsbind=bind-file
[bundle=folder-name]
[ccsid=ccsid]
[contid=container-name]
[data-truncation={enabled|disabled}]
[datetime={unused|packed15}]
[jsontransfrm=transform-filename]
[logfile=logfile]
[mapping-level={3.0|4.0}]
[operation-name=operation-name]
[pdsmem=pds-prefix]
[respmem=response-copy-file]
[synconreturn={yes|no}]
ls2js -help
Parameters:
- json-schema=json-filename
- The fully qualified name of the JSON schema file. linkable interfaces only.
- json-schema-request=request-filename
- The fully qualified name of the JSON schema file that contains the input data area. Must be used with
json-schema-response=response-filename. For Request-Response services only.
- json-schema-response=response-filename
- The fully qualified name of the JSON schema file that contains the output data area. Must be used with
json-schema-request=request-filename. For Request-Response services only.
- 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.
- bundle=folder-name
- The path to and name of the bundle directory and archive file (.zip or
.jar). Linkable interface only.
- 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 JSON 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.
- jsontransfrm=transform-filename
- The name to use for the JSONTRANSFRM bundle resource in CICS; also the name of the generated JSBIND file. Linkable interfaces
only.
- logfile=logfile
- The fully qualified name of a logfile to contain output information generated by the
ls2js 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 JSON file. When not specified, this defaults to the value of
program-name plus the literal value
Operation.
- pdsmem=pds-prefix
- For linkable interface only, the prefix to use for the copybook containing the generated data structure.
- respmem=response-copy-file
- The fully qualified name of the copybook file containing the high-level language structure for the Web service response.
- 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
ls2js parameters.