IMS-COBOL Connector

CLI Commands

ol test connection

[module folder]> ol test connection --host http://192.86.32.238 --port 13200 --group-name GROUP1 --data-store-name IVP1 --ssl-properties.encryption-type WEAK --ssl-properties.key-store-fileName [path/file_name] --ssl-properties.trust-store-file-name [path/file_name] --ssl-properties.key-store-password [password_text] --ssl-properties.trust-store-password [password_text] --transaction-properties.commit-mode SEND_AND_COMMIT --ssl-properties.is-ssl-enabled false --commit-mode SEND_AND_COMMIT --code-page CP037 --username demo --password 1234

[module folder]$ ol test connection --host http://192.86.32.238 --port 13200 --group-name GROUP1 --data-store-name IVP1 --ssl-properties.encryption-type WEAK --ssl-properties.key-store-fileName [path/file_name] --ssl-properties.trust-store-file-name [path/file_name] --ssl-properties.key-store-password [password_text] --ssl-properties.trust-store-password [password_text] --transaction-properties.commit-mode SEND_AND_COMMIT --ssl-properties.is-ssl-enabled false --commit-mode SEND_AND_COMMIT --code-page CP037 --username demo --password 1234

ol add

- You only have a local COBOL source file

In this case the  --source-path option is required. 

[module-name]> ol add --source-path ./[asset-path]/[asset-source-file.cbl]

[module-name]$ ol add --source-path ./[asset-path]/[asset-source-file.cbl]

- You only have local copybooks files

In this case, use the  --program-path option to pass the location of the program on the remote CICS-COBOL host the --input and --output options to pass the local copybooks files path.  If you want the name of the asset to be different from the --program-path value, you can set the value of the --asset-name property to the new name.

[module-name]> ol add --program-path /QSYS.LIB/RMR2L1.LIB/FULLDETAIL.PGM --asset-name credit_accounts --input ../files/a/SAMPCPY1.cpy --input ../files/b/SAMPCPY2.cpy --output ../files/a/SAMPCPY1.cpy --output ../files/b/SAMPCPY2.cpy

[module-name]$ ol add --program-path /QSYS.LIB/RMR2L1.LIB/FULLDETAIL.PGM --asset-name credit_accounts --input ../files/a/SAMPCPY1.cpy --input ../files/b/SAMPCPY2.cpy --output ../files/a/SAMPCPY1.cpy --output ../files/b/SAMPCPY2.cpy

- You have a local COBOL source file and local copybook files

In this case, use the  --source-path option to pass the COBOL source file path and the --input and --output options to pass the local copybooks files path. 

[module-name]> ol add --source-path ./[asset-path]/[asset-source-file.cbl] --input ../files/a/SAMPCPY1.cpy --input ../files/b/SAMPCPY2.cpy --output ../files/a/SAMPCPY1.cpy --output ../files/b/SAMPCPY2.cpy

[module-name]$ ol add --source-path ./[asset-path]/[asset-source-file.cbl] --input ../files/a/SAMPCPY1.cpy --input ../files/b/SAMPCPY2.cpy --output ../files/a/SAMPCPY1.cpy --output ../files/b/SAMPCPY2.cpy

When your copybook data sources include a copybook superclass perform the following two steps to add it to the asset:

1. Generate from the superclass an asset-type entity using an --entity flagged ol add command.

   WindowsmacOS

   [module-name]> ol add --source-path header.cpy --entity
   

   [module-name]$ ol add --source-path header.cpy --entity
   

2. Incorporate the generated entity into the asset using the --input-super-class and --output-super-class options.

   WindowsmacOS

   [module-name]> ol add --input fininq2.cpy --output fininq2.cpy --input-super-class header --output-super-class header --program-path FININQ2
   

   [module-name]$ ol add --input fininq2.cpy --output fininq2.cpy --input-super-class header --output-super-class header --program-path FININQ2
   

Properties

--source-path

The path to a local data-source COBOL file. The path is used by the CLI ol add command to access the file and parse it to extract its metadata. The property is not required if the input, the output and the program-path properties are populated.

--source-path ../FININQ2.cbl

--program-path (required)

Path to the business operation on the remote data-source machine. The path is used:

• in design-time by the CLI ol test asset command to access the business operation on the remote machine.
• in run-time by the production application to communicate with the business operation on the remote machine.

--program-path /QSYS.LIB/RMR2L1.LIB/FULLDETAIL.PGM

--host (required)

The remote data source hostname/IP

--host http://192.86.32.238

--port (required)

The port of the IMS on the remote machine

Default: 9999

--port 9999

--asset-name

The asset name defaults to the program path. Pass a value to --asset-name only when it is different from the program path.

--asset-name credit-account

--input, -i

Input copybook file paths and directories separated by space

--input ../files/a/SAMPCPY1.cpy --input ../files/b/SAMPCPY2.cpy

--output, -o

Output copybook file paths and directories separated by space

--output ../files/a/SAMPCPY1.cpy --output ../files/b/SAMPCPY2.cpy

--entity

Generate an entity-type asset. The ol add command flagged by the --entity option adds an entity-type asset to a module. The resulting JSON provides a simple representation of business field data. Entities generated from copybook or COBOL asset source files provide the ability to support copybook superclasses. See input-super-class and output-super-class below.

ol add --source-path ../header.cpy --entity

--input-super-class

Specifies the path to an entity-type asset that will serve as an additional data source to the input copybook files. The data defined in the entity type asset represent business fields that are common to all input-related copybook files. A prior execution of an --asset flagged ol add command generates the specified entity type (see entity above).

--input-super-class header

--output-super-class

Specifies the path to an entity-type asset that will serve as an additional data source to the output copybook files. The data defined in the entity type asset represent business fields that are common to all output-related copybook files. A prior execution of an --asset flagged ol add command generates the specified entity type (see the entity property above).

--output-super-class header

--group-name

The username RACF group

--group-name GROUP1

--data-store-name

The data store name

--data-store-name IVP1

--app-name

RACF app name

--app-name TSO1234

--ssl-properties.is-ssl-enabled (required)

Enabled-true when the connection is SSL

--ssl-properties.is-ssl-enabled false

--ssl-properties.encryption-type

The SSL type [WEAK | STRONG | NONE]

--ssl-properties.ssl-encyption-type WEAK

--ssl-properties.key-store-file-name

The key-store path and file name

--ssl-properties.key-store-file-name [path/file_name]

--ssl-properties.trust-store-file-name

The trust store file name

--ssl-properties.trust-store-file-name [path/file_name]

--ssl-properties.key-store-password

The key store password

--ssl-properties.key-store-password 12345

--ssl-properties.trust-store-password

The trust store password

--ssl-properties.trust-store-password 12345

--transaction-properties.commit-mode

The commit mode [SEND_AND_COMMIT | COMMIT_AND_SEND]

--transaction-properties.commit-mode SEND_AND_COMMIT

--code-page

IMS COBOL code page

--code-page CP037

--username

The RACF user for the remote host

--username demo

--password

The RACF password for the remote host

--password 1234