Installing Products

Owned by David Russo
Last updated: Aug 16, 2023 by Jessica Tomkins
4 min read

 

To install a new product instance, click the Install New Instance button on the Instances panel:

Then, select the product (either Profound.js or Profound API), the desired version, and whether to install on the local or a remote system.

If installing on the local system, click the Select Installation Directory button to browse for and select a directory to install the product into.

The installation directory must be empty. You can create a new directory by clicking the New Folder button on the selection dialog:

If installing on a remote system, enter the host name, user, password, and directory to install the product into.

The remote installation directory must be specified as an absolute path, such as /profoundjs or C:\profoundjs. The special value $HOME can be specified at the start of the path name. If present, it will will be replaced with your home directory (also called user profile directory on Windows). The installation directory specified must be either non-existent (in which case it will be created by the install process), or empty.


The SSH Port field should normally be left at the default 22, but can be used to specify an alternate port if the target SSH server is configured to use a non-standard port.

Click Next to continue to the product configuration panel:

When installing on IBM i make sure to choose a unique IBM i Connector Library and Server Instance Name, to avoid overwriting components used by other instances on the same system.

The configuration options will vary, depending on the product, version, and target platform:

  • Server port: The server listen port. Make sure to choose a port that is not already in use on the target system.


  • Install with Git Integration (Windows/Linux/Mac): Enables Git integration in the IDE. Answer “no” if you don’t want or need Git integration.


  • Install IBM i Connector (IBM i): Installs IBM i Connector components needed to access IBM i data and objects. You’ll want to answer “yes” in most cases.


    • IBM i Connector Library: The library to install the Connector components into. If you have multiple product instances running on the same IBM i system, make sure to choose a unique library name, to avoid overwriting the library used by other instances.

    • IBM i Connector Library IASP: By default, the Connector library is installed in the system ASP (*SYSBAS). Enter an ASP device name to install on an IASP.


  • Control Instance with STRTCPSVR/ENDTCPSVR (IBM i): Selecting “yes” allows you to manage the product instance with the system’s STRTCPSVR and ENDTCPSVR commands. This also allows the instance to be started automatically when the system starts after an IPL. You’ll want to answer “yes” in most cases.


    • Server Instance Name: Specify the instance name for STRTCPSVR. If you have multiple product instances running on the same IBM I, make sure to choose a unique instance name, to avoid overwriting configuration used by another instance.

    • Server Instance CCSID: Controls the CCSID for the IBM i server job. You should use the same CCSID that you use with your other IBM i applications.

    • Node.js Version: Controls the version of Node.js that will be used to run the server. You can select from any compatible versions that were found on IBM i. You should always use the most up-to-date compatible version, unless your applications require an older version for some reason.

    • Autostart Server Instance: Controls whether or not the server will start up when TCP/IP is started, such as after an IPL or system backup run.


  • Integrate with Separate Profound UI Instance (Profound.js / IBM i): This setting used for optional integration with Profound UI. If you are not using Profound UI you should answer “no”. If you are using Profound UI and plan to call Profound.js applications from Profound UI, answer “yes”.


    • Profound UI Instance Name:  Enter the name of the Profound UI instance you want to integrate with.

Click Install to begin the installation process.

If installation is successful, you’ll be returned to the Instances panel.

If any unexpected errors occur during installation, the following dialog will appear:

If this happens, click the View Log button to see a detailed installation log. If the problem/solution are not obvious from viewing the log, please open a ticket with Profound Logic technical support and attach the installation log.

Link