z/OS Utils
z/OS Utils for NodeJS developers.
This module exports two Objects:
1. ZosJob : Submit a Job and get a promise , that resolves to execution's outlist.
- Create a job from a jcl (string/ local file / pds member) :
let job = new ZosJob(jcl)
. - Submit the Job with
job.sub()
and get back a Promise. - Watch job's running status by subscribing to
'status-change'
event :job.on('status-change', newStatus => console.log(newStatus))
. - Cancel job's execution at anytime , with
job.cancel()
.
2. ZosFtp : Ftp common operations.
- Get/Put/Del a dataset or PDS member from/to mainframe, e.g. :
ZosFtp.del('U001.ZOSUTILS.FILE')
- List Directories , e.g. :
ZosFtp.list('U001.ZOSUTILS.PDS')
z/OS Utils takes advantage of the ability to submit jobs to Mainframe via ftp.
Prerequisites
NodeJS version >= v8.2.1 .
Supports both old and latest NodeJS releases (v12.4.0 passes all the tests).
Your z/OS UserId should have ftp access.
Getting Started
Install the package to your project:
npm i zos-utils --save
or
yarn add zos-utils
In your code :
const zosUtils = const config = user: 'ZOS_FTP_USERNAME' // String: REQUIRED password: 'ZOS_FTP_PASSWD' // String: REQUIRED host: 'ZOS_FTP_HOST' // String: REQUIRED, host's IP address port: ZOS_FTP_PORT // Number: OPTIONAL, defaults to 21.const ZosJob ZosFtp =
Now you have available both ZosJob & ZosFtp
Objects.
For a full list of config properties check the API section.
Try to submit a jcl that resides at mainframe , e.g. : 'U001.ZOSUTILS.PDS(TESTJCL)'
let jcl = name: 'TESTJCL' // String: REQUIRED, Assign a name to your job, used for logging and outlist save name description: 'Basic Jcl with RC=0' // String: Optional source: 'U001.ZOSUTILS.PDS(TESTJCL)' // String: REQUIRED RC: '0000' // String: REQUIRED, Maximum expected return code let job = jcltry let outlist = await job console catcherror console
API
const zosUtils = const ZosJob ZosFtp =
Initialise ZosJob and ZosFtp by providing the config object:
config
<object>:- user <string>: Required.
- password <string>: Required.
- host <string>: Required. IP address of the host.
- port <number>: Optional. Default: 21
- encoding <string>: Optional. The encoding of the host, used by iconv-lite to encode-decode z/OS's outlists and datasets. Local JCL's and datasets should always be in 'UTF8' before submitting/uploading to host . Default:
'UTF8'
- watchJobInterval <number>: Optional. Time interval (ms) used internally by ZosJob to watch Job's status during execution. If the host is not powerful enough , increase this number. Default:
1000
- deleteMainframeOutlist <boolean>: Optional. Set this to
false
if you want ZosJob to keep outlist at host, after job completion. Default:true
- loggingFunction<function>: Optional. Handle / store logs the way you want, instead of logging them at the terminal. For example you can use
test/debug.js
module , to write to a file of your choice. Default:console.log
ZosJob
const zosUtils = const ZosJob =
- Constructor :
let job = jcl
-
jcl
<object>:- name <string>: Required. Provide a name for your job. Used by ZosJob for logging and naming outlists. e.g.
'TESTJCL'
- description <string>: Optional.A description of what the job is doing so that you can have all the information attached to the
job
object. e.g.'Testing ZosJob basic functionality.'
- source <string>: Required. This can be a path of a local file , a Javascript String or a host PDS member containing valid JCL code. Examples:
-
Local File:
'C:\\local.jcl'
-
Host PDS member:
'U001.ZOSUTILS.PDS(TESTJCL)'
-
Javascript String ( has at least one newline ('\n') character ):
'//U001T JOB (BATI,U001,U001)\n' + '// EXEC PGM=IEFBR14'
-
- RC <string>: Required. The maximum RC expected by the execution of the jcl. If the returned RC is greater than the string declared here, the
job.sub()
promise will be rejected. e.g.'0004'
- outlistLocalPath<string>: Optional. The local path where to store the outlist execution results. Default:
null
- name <string>: Required. Provide a name for your job. Used by ZosJob for logging and naming outlists. e.g.
-
ZosJob
Methods- sub(): Submits the job to JES. Returned promise resolves to outlist of the execution.trylet outlist = await jobconsoleconsolecatcherrorconsole
- cancel() : Cancel job submission. Returned promise resolves to undefined.tryawait jobcatcherrorconsole
- sub(): Submits the job to JES. Returned promise resolves to outlist of the execution.
-
ZosJob
Events- 'status-change': Emitted whenever job's running status changes e.g. from
INPUT
toACTIVE
.
job // 'ACTIVE'- 'job-id': Emitted when JES assigns ID to job e.g. 'JOB19788'
job // 'JOB19788' - 'status-change': Emitted whenever job's running status changes e.g. from
ZosFtp
ZosFtp
Methods-
put ( source <string>:Required, hostFile <string>:Required, options <object>:Optional): Put the local file or the Javascript String defined by
source
, tohostFile
(it will be created if it doesn't exist). Returned promise resolves to undefined.- options
-
sourceType<string>: Optional. Can be either
'localFile'
or'string'
. Default:'localFile'
When one or more of the following keys is not provided,then the defaults from z/OS
TCPIP.SEZAINST(FTPSDATA)
server ftp configuration values will be applied. Keys are case insensitive, e.g.RECfm
andrecfm
are both valid. -
recfm<string>: Optional.
'FB' || 'VB' || 'FBA'
-
lrecl<number>: Optional. The length of 1 row of the file.
-
primary<number>: Optional. The primary cyliders that will be allocated.
-
directory<number>: Optional. If provided then a PDS library will be created(if it doesn't already exist), with the directory blocks specified
-
try// source can be a path to local fileawait ZosFtp// or a Javascript String. Pass {sourceType: 'string'} in the options Object.await ZosFtp// supply allocation parametersawait ZosFtpcatcherrorconsole - options
-
get ( hostFile <string>:Required, localFile <string>:Optional): Download the
hostFile
z/OS dataset or PDS member to alocalFile
path. IflocalFile
is omitted , then the Promise will resolve with the contents of the host file as a Javascript String.try// download hostFile to localFileawait ZosFtp// get contents of hostFile as a Javascript String.const result = await ZosFtpconsole // 'I am going to host!'catcherrorconsole -
del ( hostFile <string>:Required): Delete the
hostFile
Dataset , PDS or PDS member.tryawait ZosFtpcatcherrorconsole -
list ( hostPath <string>:Required): List dataset or PDS members defined by the
hostpath
variable.tryconst result = await ZosFtpconsole// Header fields may differ from installation to installation.// [// ' Name VV.MM Created Changed Size Init Mod Id',//'STRING 01.04 2015/02/02 2015/02/02 14:25 27 15 0 U001 ',//'BASIC 01.03 2015/02/17 2015/02/20 14:55 180 180 0 U001 ',//'TEST 01.01 2016/09/28 2016/09/28 13:04 181 180 0 U001 ',//'TRIAL 01.00 2019/11/05 2019/11/05 11:44 2 2 0 U001 '// ]catcherrorconsole
-
Running the tests
Create a .env
file at the root of the project and assign the following global variables:
ZOS_FTP_USERNAME='my_user_id'ZOS_FTP_PASSWD='my_password'ZOS_FTP_HOST='host_ip_address'ZOS_FTP_PORT='host_port'ZOS_ENCODING='host_encoding'ZOS_JOB_STATEMENT='//jobName JOB (SYSS,userId,userId)' # Minimal JOB statement needed by your z/OS installation for JCL to run
Then issue the test command:
npm run test
or
yarn test
Authors
- Christopher Chamaletsos
See also the list of contributors who participated in this project.
License
This project is licensed under the MIT License - see the LICENSE.md file for details