Installing and configuring the pax format

The following checklist summarizes the key configuration steps for a successful installation.

Notes:

The Program Directory for the product details specific installation requirements and instructions in Chapter 5 and Chapter 6.
For a complete list of releases, refreshes, and fix packs (also known as PTFs) for the product, see Fix list for IBM Open Enterprise SDK for Node.js

Hardware prerequisites

IBM z15™
IBM z14®, IBM z14 Model ZR1
IBM z13®, IBM z13s®
IBM zEnterprise® EC12, IBM zEnterprise BC12 (supports z/OS 2.4 only)

Software prerequisites

z/OS® UNIX System Services enabled on any of following operating systems:
- z/OS 2.5 with all the following PTFs installed:
  - UI64830
  - UI64837
  - UI64940
- z/OS 2.4 with all the following PTFs installed:
  - UI64830
  - UI64837
  - UI64839
  - UI64940
  - UI65567
Integrated Cryptographic Services Facility (ICSF) must be enabled on systems where Open Enterprise SDK for Node.js is run. For details, see ICSF System Programmer's Guide and ICSF Administrator's Guide.
Python 3.8.2 or later 3.x releases are required to compile native add-ons. It must also be defined in your PATH environment variable.
Make 4.1 or later is required to compile native add-ons. It must also be defined in your PATH environment variable.

Note:

To obtain IBM® Open Enterprise SDK for Python, visit IBM Open Enterprise SDK for Python product page.
To obtain Make, visit the Make for z/OS download page.
The recommended shell is Bash. To download bash, visit Bash for z/OS on the Rocket website.

Storage requirements

The pax archive installable file contains an updated C/C++ runtime and compiler, which has the following storage requirements:

2 GB free space on HFS.
400 MB free space for the MVS™ dataset under the high-level qualifier (HLQ) where the compiler will be installed. The default HLQ will be your user ID.

Configuring

Open Enterprise SDK for Node.js is an OMVS-based application, which requires certain configuration on the z/OS UNIX System Services file system to ensure proper operation.

Validate that /usr/bin/env exists. If not configured, see the instructions in Verifying the env command path.
Ensure that /tmp has at least 1 GB or more of disk space configured. To use an alternative file system, set the TMPDIR environment variable to a directory that has sufficient space.

Installing

Follow these steps to install Open Enterprise SDK for Node.js:

Download the pax archive installable file from the pax edition download page to a z/OS machine.
Unpax the downloaded pax file using the following command:
```
$ pax -p p -r -f <downloaded_pax_file>
```
This command creates the installation directory <nodejs_dir> under the current directory.
Run setup.sh to validate system prerequisites, setup environment variables, and optionally install the njsc C/C++ compiler:
```
$ cd <nodejs_dir>
$ ./setup.sh
```
In order for Node.js to operate correctly, specific environment variables must be set. Run the .nodeenv script that is generated by setup.sh to set the required environment variables in the current shell using the dot command (.):
```
$ . <nodejs_dir>/.nodeenv
```
This command also adds <nodejs_dir>/bin to your PATH, where the node binary is located.
Run the node and npm commands from the command line.

Uninstalling

To uninstall Open Enterprise SDK for Node.js, delete the installation directory.

Related reference

Node.js v16 API reference documentation