Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
First, the latest procman-X.X.XX.zip (e.g. procman-5.0.12.zip) must be downloaded from the customer portal and then it must be unzipped.
This installation package contains the components HWI (HORIZONT Web-application Interface), HWM (HORIZONT Workflow Manager), and HOS (HORIZONT Hand-Over System).
Login as an administrator on the Windows server where ProcMan shall be installed. Extract the ProcMan setup files from the package procman-5.0.X.zip in a setup directory on the server. Now open the setup directory.
To install ProcMan, it is recommended to use the setup.rsp file. This is located in the extracted directory and can be edited with any editor. Open the file and adjust the installation opens.
To install ProcMan e.g. with the JCL module (but without IWS), the following parameters should be set in setup.rsp file. Parameters, which are not listed below, must not be adjusted.
Important information
If ProcMan is installed several times on one PC/Server, the APP_URL, APP_INSTALL_NAME, SESSION_NAME etc. must be unique.
If the HDB (HORIZONT Database / PostgreSQL) should be used, the parameters for APP_DB_HOST, etc. have to be set.
To start the installation, simply run the setup.cmd as administrator. Check all settings again in the CLI. After the installation, the HORIZONT Apache Webserver service needs to be restarted.
Important: This step is only needed if you use ProcMan with a DB2 Database.
If a DB2 database is used, ProcMan needs to be able to communicate with the DB2 database. Therefore the DB2 PHP Extension needs to be activated.
To activate the extension, open the installation directory of HWF (c:/HORIZONT/hwf/php/php.d/). Open the file ibm_db2.ini with an editor. To activate the extension, row 6 must not be commented out. If you make changes to the file, the HORIZONT Apache Service needs to be restarted. See the picture below.
How to check if the extension is active:
Open (user: admin, password: <empty>), the php info window should appear which shows all information about the PHP/Apache/HWF installation. Scroll down and search for the entry ibm_db2 under the section PHP Extensions. If you can find an entry for ibm_db2, the extension is active. See the picture below.
Important: This step is only needed if you use ProcMan with a DB2 Database.
At first, the windows code page should be changed on the target system in order to make sure that the communication with a DB2 database works without problems.
The environment variable DB2CODEPAGE=1208 has to be set on the ProcMan server before the installation of ProcMan can be started. This informs DB2 Client that all strings passed to the database are already UTF-8 encoded and there is no need to encode it again, to store them into tables using UTF-8 encoding. Otherwise the strings inserted into the database tables become longer than expected and eventually cause errors because they exceed the maximal length of database table columns.
There are possible 2 options to do that:
Use the windows search bar and search for "environment". Open the "Edit environment variables" app. Now click on "environment variables", a new window should appear. In the lower window ("system variables") change the value of the variable "DB2CODEPAGE" to 1208. If the variable doesn't exist, you have to create a new one.
Open the CLI, and use the commaned set. All defined environment variables should be shown now. In order to change the value of the variable "DB2CODEPAGE" to 1208, execute
To check if the variable was successfully set, type in the command
This article describes the installation of the DB2 client on a Windows server or on a normal Windows PC. This is only needed when you use ProcMan with a DB2 database.
It is recommended to install the DB2 client first before installing HWF and ProcMan. The DB2 client is needed to connect with a DB2 database.
This document provides guidance on configuring the IBM DB2 Command Line Interface (CLI) for optimal performance and compatibility with ProcMan. The settings ensure efficient transaction handling and improved performance by adjusting the default behavior of the DB2 client.
Download the latest DB2 Client for Windows (For HORIZONT installations see v:/download/DB2_DSClient_11-1_Win_x86-64).
Run the setup.exe, select new installation, and accept the licence agreement. Start the installation.
Navigate to the installation directory (e.g. c:/program files/IBM/SQLLIB/BIN/db2cmdadmin.exe) and execute the db2cmdadmin.exe, the Command Line interface (CLI) should open now.
Execute the command db2 in the CLI, the DB2-Client CLI should start now.
Now you need to connect to the DB2 Database.
In the ProcMan Installation package, you should see a file called add_connection_example.db2 in the directory /DB2. Open that file in your preferred editor (e.g. notepad++). Copy the last 6 rows (see code below) one after another and execute them in the CLI.
Important: Do not copy the semicolons. You should get positive feedback for each command in the CLI.
To test the connection to the HORIZONT DB2 Database, execute the following two commands in the CLI.
You should get a positive response in the CLI, like in the picture below.
The following addtional configurations are recommended.
TXNIsolation
Setting: TXNIsolation=1
Meaning: Sets the transaction isolation level to Read Uncommitted
Effect: Allows dirty reads, enabling higher performance with minimal locking
DB2Optimization
Setting: DB2Optimization=5
Meaning: Enables a higher level of CLI optimization
Effect: Improves execution speed and efficiency by pre-packaging SQL statements more aggressively
This option is recommended if file access is available.
Open the following file: c:\Users\All Users\IBM\DB2\DB2COPY1\cfg\db2cli.ini
(beware that this default path of the file can be overwritten in the system variable DB2CLIINIPATH
For older DB2 Client versions the default path is:
c:\Program Files\IBM\DB2\DB2COPY1\cfg\db2cli.ini
Add the following lines under the section for your database alias:
This option is recommended if no file access is available and if your user is part of the DB2ADMIN group on the ProcMan server.
Open the DB2 Command Line Processor (db2cmd
) on the ProcMan server
Run the following commands:
Replace <DBALIAS>
with your configured database alias.
For to check if the options have been set correctly execute the following command:
The database, which shall be used by ProcMan, has to be cataloged in the DB2 Client in a way that the user authentication is done by the DB2 Server:
This ensures that DB2 Client does not try to authenticate the user used for establishing a database connection on the client system (where DB2 Client is installed), but sends the user information for authentication immediately to the DB2 Server, which leads to a better performance.
If you get an licence error while executing the command
you need to install a licence. Ask some one like Jörg/Rado for the licence file db2consv_zs.lic, place it on your PC, open the CLI, navigate to the directory where the licence file is stored and execute the command
to install the licence. To check if the licence was installled correctly, execute the command
Connect with the server with remote desktop. Go to computer management and two groups. First, create local DB2ADMNS and DB2USERS groups and add your user to that group. Then, add the Domain Account to one or both of these groups. These groups are the default groups recognized by DB2. Members of the DB2ADMNS group have SYSADMIN Authority. Members of the DB2USERS group do not have SYSADMIN Authority but are able to execute DB2 commands. Also use the CLI (as admin) and execute the command 'db2extsec'.
Next, from a Windows Command Prompt execute:
Now the db2cmdadmin CLI should open and not immediately close.
In case ProcMan is going to be installed with a DB2 database, it is required to install the DB2-Client on the target system before continuing installing HWF and ProcMan. .
This problem is described here:
ProcMan requires PHP and a Webserver, which we deliver in the so-called HORIZONT Web Framework (HWF). This document only describes how to install HWF for ProcMan.
Download the latest HWF installation package from the HORIZONT customer portal (e.g. HWF V6.0.6) and extract it somewhere on the target system.
Install/update the Microsoft Visual Studio C++ runtime (MSVC) manually. Navigate to ../hwf/contrib/
and search for all the vcredist_x64-YYYY.exe files. Run them all as administrator.
Now run the setup.cmd in the downloaded HWF package as administrator and follow the installation steps.
Important things to consider:
In step 1 set the correct installation directory of the existing HWF installation.
In step 4 choose "no" if you decided to install/update the MSVC manually.
There is no need to set the TNS_ADMIN and DB2INSTANCE options in the HWF installation dialog for ProcMan, as they are ignored. They can be left empty (which is the default).
Do not install HDB (HORIZONT Database Module) after the HWF installation, which is asked in the HWF installation dialog after HWF installation finished.
There is a light version of the DB2 Client installed with HWF. After the installation of HWF the PATH system variable contains the path to this light version of the DB2 client in the beginning, which disables the full version of the DB2 client required by ProcMan.
To correct this, after HWF installation, remove from the content of the PATH variable the following part:
After changing the content of the PATH variable you have to restart the Web Server (e.g. in Windows’s Services dialog restart the HORIZONT HTTP Server service) before the change takes effect.
For security reasons it is strongly recommended to change the user under which the by HWF installed service HORIZONT HTTP Server runs.
By default, the HORIZONT HTTP Server service runs under the Local System account, which is highly privileged—more so than a standard administrator account in certain areas. For better security and manageability, it is strongly recommended to run the service under a dedicated local or domain user account with limited privileges.
This guide walks you through:
Creating or assigning a restricted user
Granting required filesystem and DB2 access
Running the service under the new user
Configuring permissions to allow restarting the service from ProcMan
Create a local user in Windows or use an existing local/domain user.
Ensure the user has a non-expiring password.
Grant this user modify permissions on the HORIZONT installation directory (by default C:\HORIZONT
) and all its subdirectories.
If the DB2 Client was installed with Windows Authentication, it creates two local user groups:
DB2ADMNS
DB2USERS
Add the service user to the DB2USERS
group to allow DB2 access while maintaining minimal privilege.
Open the Services management console:
Control Panel → System and Security → Administrative Tools → Services
Locate the HORIZONT HTTP Server service.
Double-click to open its properties and go to the Log On tab.
Select "This account", enter the user credentials created/selected in Step 1, and confirm.
Click OK and restart the service.
By default, only administrators and system accounts can start/stop services. To allow the non-admin service user to restart the web server (e.g. via ProcMan), follow these steps using the Microsoft Management Console (MMC):
Open MMC as administrator:
Press Win + R
, type mmc
, and press Enter.
From the menu:
File → Add/Remove Snap-in…
Add the following snap-ins:
Security Templates
Click OK
In the Security Templates tree, select a directory (e.g., C:\Windows\Security\Templates
) and then:
Action → New Template
Enter a name and (optional) description for the template and click OK.
Under your new template, go to:
System Services → HORIZONT HTTP Server
Right-click and select:
Action → Properties
In the dialog:
Check: "Define this policy setting in the template"
Set Startup mode to Automatic
Click Edit Security
In the security dialog:
Add the dedicated service user
Grant the permission: Start, stop, and pause
Click OK to close all dialogs and save the template.
Again, open:
File → Add/Remove Snap-in…
Add: Security Configuration and Analysis
Click OK
In the snap-in:
Action → Open Database
Choose a name for the database file (e.g. horizont_service_config
)
When prompted, select the template you created earlier.
Then run:
Action → Configure Computer Now
After applying, restart the HORIZONT HTTP Server service once manually as an administrator to ensure new permissions take effect.
Important Notes
These permission changes are persistent and survive system restarts.
The MMC interface may vary slightly between Windows versions.
Always verify service functionality after changing its user context or security settings.
The web server switches automatically after it is started to run under a lower privileged user. So there is nothing to be done explicitly.
If it should be later possible to restart the web server by an administrator from the ProcMan dialog, the user under which the web server is running, has to be authorized to restart the web server. For this the user has to be authorized to start the httpd program as a super user using the sudo command without a tty session and without entering a password. To allow this open the file /etc/sudoers for editing. If there is a line like this
comment it out with a hash (#) in the beginning of the line. Further add a line like this
in the file /etc/sudoers. Replace <httpd_user> by the proper user name. Replace <httpd_path> by the proper path to the httpd program. For example:
To check if the HWF installation was successful, open . As user type admin with an empty password. You should now see the HWF System Info.
Important note: During the installation of ProcMan or HWM only the file hwm_db_config.php
is created automatically and correctly filled. In all other configuration files, where the database connection, alias, DB user, password etc. appear, the values must be set manually.
So the next thing to do is to adjust the hos_db_config.php
file e.g. located in c:/horizont/procman/etc/hos_db_config.php
.
This configuration file is used to define the database connection from ProcMan to e.g. the DB2 database (in addition to hwm_db_config.php).
In the 'db' section at the very bottom, the correct "prefix", "alias" and "pwd"
(see in the hwm_db_config.php
) must be set.
The configuration dialog has the following two parts: Basic configuration, Database configuration. Go through the dialog screens, fill the requested data and continue to the next screen by clicking the Continue button.
In this section the Single Sign-on authentication may be selected. Select ‘-‘, if there is none in use. Currently only the IBM Tivoli Access Manager WebSEAL is supported here.
This section of the dialog allows specifying where to write the log files and what message level shall be logged. If the dialog is started for the first time, the path of the log file is preset depending on the settings in the etc/hwi_config.php
file. The file name may contain the sequence $D$, which means that every day will be opened a new log file and the sequence is replaced in the real file name by the current date, e.g.
Following Message levels are accepted:
1
Errors, Information
2
Errors, Information, Warnings
3
Errors, Information, Warnings, Traces
This section allows configuring the feature that for long time active activities automatically change their status to pending.
The user login status interval specifies how often the information that a user is logged-in is actualized in ProcMan. The value means count of minutes. The value must be an integer greater or equal 0 (zero). If set to 0 (zero) the updating of the user login-in status as well as the automatic change of activity status from active to pending is switched off.
The activity status interval specifies that after the last update user of an active activity is not logged-in for this time, the status of the activity shall be automatically set to pending.
The value means count of minutes. The value must be an integer greater or equal 0 (zero). If set to 0 (zero) the automatic change of activity status from active to pending is switched off.
Here the SMTP server for sending alarm e-mails can be configured. If the SMTP server supports SSL encryption it can be used by specifying the SMTP server IP/DNS prefixed by ‘ssl://’ (e.g. ssl://smtp.my_company.com) and the port on which the SMTP server accepts the SSL encrypted communication (default is 465).
Put the IP address or DNS of the ProcMan Server in the Client computer for identification at the server field.
On the second page, the DB2 parameters must be set so that ProcMan/HWM can communicate with the DB2 database. The customer normally provides the DB2 database information.
The checkboxes for "Create Database", "Initialize Database", and "Only generate Scripts..." should be set.
Important note:
If you continue now, no DB2 database or tables will be created for this ProcMan installation. This can only be done by the DB2 administrator. If the User provided has no permission to create tables then the checkbox "Only generate scripts..." must be checked. The generated scripts, which contain the sql queries, then have to be given to your database administrator.
Basically HWF supports following Database system types: DB2 (z/OS), Oracle, PostgreSQL. The dialog differs slightly depending on the Database system type selected.
The current ProcMan version and HOS (JCL) supports only DB2 on z/OS,
Special parameters for DB2 are the Alias and the Table Qualifier.
Special parameters for Oracle are Host (IP address or DNS name), Port and Database Name.
Special parameters for PostgreSQL are Host (IP address or DNS name), Port, Database Name and Schema. Other parameters are the same.
Table name and Index name templates are optional and are dedicated for cases, when the Customer has special conventions for table/index names.
For example if the tables shall be named in the range ABCDT00 – ABCDT99 and indexes in the range ABCDI00 – ABCDI99, put in as the Table name template ABCDT__ and as the Index name template ABCDI__. The __ (two underscores) is then replaced by a running number in the generated SQL statements.
In User, Password and Repeat Password put in the information about the technical user which will be used by HWM for the Database access. The information about the technical user will be stored in a configuration file, the password will be encrypted.
Check the Drop database checkbox if you want to replace already existing Database.
Check the Create Database checkbox if:
you want that a new Database (schemas, tables, indexes, etc.) shall be created by the dialog
the Database already exists and you want to drop it and create newly,
you want only to generate the Database definitions in a file. The file can be reviewed and maybe send to z/OS and executed there by e.g. SPUFI or a batch job.
Check the Initialize Database checkbox if:
you want to fill a newly created Database with initial data,
you want to delete all data in the Database and initialize it newly.
Check the Migrate data checkbox if:
you want to migrate data in a newly created migration database,
you want to reinitialize the data in the current database with the data from an existing migration database.
If at least one of the Create Database and Initialize Database checkboxes is checked and the dialog is submitted, the configuration procedure generates a file DBDefinition.sql in the database subdirectory of the ProcMan installation. It contains all SQL statements needed for creation and/or initialization of the database. This file has no influence on the run of HWM.
It may be useful if you do not have database administration rights at the time of HWM configuration. In this case you can send this file to your database administrator to check, adjust and execute the SQL statements in this file.
If none of the Create Database and Initialize Database checkboxes is checked and the dialog is submitted, only the Database access settings are saved.
Check the ‘Only generate scripts checkbox’ if you only want to generate the SQL statements into the file database/DBDefinition.sql described above without creating and/or initializing the database.
If the Drop/Create Database checkbox has been checked a further dialog is being shown after submitting.
The user specified in admin user and password is being used only for the Database creation. The information about the admin user will not be stored anywhere (in opposite to the technical user on the previous screen).
The Database Name, Table Space, Database creation parameters, Tablespace creation parameters, Table creation parameters and Index creation parameters fields are shown only in the DB2 variant of the dialog. Put in meaningful parameters as they will be used for the Database creation. The Table Space name may contain a sequence of two or more underscores to specify that for every table a new table space shall be created. The sequence of underscores is in the generated SQL statements replaced by a running number like in the Table name and Index name templates in the previous dialog screen.
The Database/Tablespace/Table/Index creation parameters may contain any parameters accepted by DB2 for the respective database object type. When the dialog is running for the first time they are initialized by default values.
In the Users to be admin granted parameter database users which shall be granted to be admins of the database can be specified as a list (one user name in each line).
The Only generate scripts checkbox is the same like on the previous screen.
Because the Configuration dialog is being started via an Internet Browser it could be started later by any user of HWM from any client computer. To allow this could have fatal follow-ups because everyone could change the HWM configuration. Therefore the Configuration dialog has a built in protection. At the end of the first successful run of the dialog, it generates a file hwm_install_blocker.php in the etc subdirectory of the ProcMan installation. This file contains only one option:
If the file exists and the value of the option $hwm_install_blocker in the file is true, every try to start hwm_install.php by any user ends with an error message. If you need to start the Configuration dialog later, you have two possibilities:
delete the etc/hwm_install_blocker.php file
set the value of the option $hwm_install_blocker in the etc/hwm_install_blocker.php file to false
If you delete the etc/hwm_install_blocker.php, you will be allowed to start the Configuration dialog only once. At the end it generates the etc/hwm_install_blocker.php again and disables repeated starts.
If you change the value of the option $hwm_install_blocker in the etc/hwm_install_blocker.php file to false, you will be able to start the Configuration dialog arbitrary times. Do not forget to change the value of the $hwm_install_blocker option back to true at the end of your configuration work. Otherwise the protection is switched off and any user may start the Configuration dialog from any client computer.
With a click on "Continue" the HWM setup is completed.
The file hwm_db_config.php is overwritten after finishing the setup. All other files in case of an existing ProcMan installation are not changed.
Now there should be a DBDefinition.sql file in the installation directory, e.g. in c:/horizont/procman/database/.
This DBDefinition.sql file contains all queries to created the tables needed for the Procman installation. The file should be forwarded to the responsible DB2 administrator. He needs to execute the SQL queries contained in the file to create the tables needed for the ProcMan installation on the DB2 database.
Follow the steps below to run and execute the queries in the DBDefinition.sql file.
Start the db2cmdadmin.exe as admin. A CLI should open.
Type and execute the command db2
Connect to the database.
Execute the command "quit"
Navigate with the command cd to the directory where the DBDefinition.sql file is located.
Execute the file with the following command.
You should see a lot of successful responses that the commands have been executed successfully.
Now the HWM setup is complete. Finally, it is recommended to check the parameters contained in the hwm_db_config.php file in the installation directory (e.g. c:/horizont/procman/etc/hwm_db_config.php) to check if everything is correct (e.g. db_alias, db_name).
Additional information
As described in the article before, in the hos_config2.php
files, multiple environment files are included.
These hos_env_<module>.php
files contain environment settings that are relevant for the processes in ProcMan.
In most cases, there should also be a hos_env_general.php
file. This environment file can be seen as a fallback and contains environment settings that should be used for all clients and processes if no other environment files have been defined.
For a detailed description of all the environment parameters of the hos_config2.php file, please see:
In most installations, processes require individual environment configurations.
See the code example below which shows an example of a hos_env_jcl.php
file.
From line 3 to 51 a general environment config is set.
From line 58 to the end, the environment setting for a specific process with the name JCL_INIT_CO is set. This means that this config will "overwrite" the lines 3 to 51, because it is process specific.
To verify the installation of ProcMan, go to . The ProcMan UI should appear, but login is not yet possible because no database has been configured.
The next step is to set up HWM (HORIZONT Workflow Manager). To do this, go to
Or, if you are not opening from a remote desktop, something like
If the HWM installation has to be performed again, it may be that the call of is prevented. To unlock the page again, simply edit the file c:/horizont/procman/etc/hwm_install_blocker.php and set it to false. See the image below.
If the installation and setup of ProcMan and HWM was succesfull, you shoudl be able to open and login with the user admin and the password admin.
If the client systems (user workstations, proxies, single sign-on systems, etc.) sending client certificates to the web server along with HTTPS requests and a verification of these certificates is required following settings must be done. After this is configured all the requests sent from systems not providing valid client certificates will be rejected.
Copy the certification authority (CA) certificate file of the CA which released the client certificates into the httpd/config.d
subdirectory of the HWF installation.
Add the following lines (if they are not already there) in the section of the .conf configuration file of the Web Server of ProcMan:
Replace <ca_certificate_file> with the real name of the CA certificate file you previously copied to httpd/config.d.
Replace <client_certificate_check> with an expression for the client certificate validation.
For more information of how these expression looks like, see the Apache documentation (http://httpd.apache.org/docs/2.4/mod/mod_ssl.html#sslrequire) and the example below.
Example (.conf):
Optionally ProcMan can be configured for exchanging data with external systems. This feature is typically used to connect an external ticket system, which allows associating ProcMan processes with tickets managed by the ticket systems, filling ProcMan process dialog fields with data from tickets and reporting ProcMan process/activity status changes back to the external system. The communication is managed by a ProcMan module called HWM Universal Interface. An important prerequisite is that the external system provides an HTTP/HTTPS server interface. ProcMan can currently be configured only as a client of the communication and does not provide any server service for handling request from external systems.
As any external system provides its own communication protocol (the form of the requests/responses and security requirements), configuration of the communication in ProcMan means to set special options and implementing some callback functions. Thus the configuration of the communication always requires HORIZONT support. To be able to configure it, a precise specification of the protocol provided by the external system is required.
The specification of the protocol shall provide at least answers to following questions:
This is one of the most important configuration files in ProcMan!
In the next step, the file c:/horizont/procman/etc/hos_config2.php
must be adjusted.
This is the most important file to start with, because in this file most of the configurations for a ProcMan installation come together. E.g., in this file it is defined which systems should be connected with ProcMan and also which environment variables should be used for the processes.
Important recommandation
To simplify long-term administration, it is strongly recommended to create a new file named pm_system_settings.php
in the directory /procman/etc/
. This file serves as a central place to define variables that are used in the other configuration files. These variables have to be declared only once in this file and can be changed quickly if necessary, e.g. when deploying new processes from a DEV system to a PROD system.
If the pm_system_settings.php
has been created, it must be included in every file in which you want to use the generic variables defined in the pm_system_settings.php file by using require_once.
How the configuration files are dependent on each other is shown in the "Configuration overview" article.
In the section system_mapping systems are defined in an array that should be connected with the ProcMan installation. In this section it is defined which IP is associated with which ID.
Important: Generally, the IP addresses have to be unique! This can be "bypassed" by assigning IP addresses to names in the c:/Windows/System32/drivers/etc/hosts file on the windows server. See the picture below.
For example, at HORIZONT, the z/OS with the IP 192.168.47.14 has to be defined in the section system_mapping. Therefore, we add a variable in the pm_system_settings.php file
e.g. named $TEST_ip and assign the value 'TEST' to that variable. That means that the windows server now resolves 'TEST' to the IP 192.168.47.14 because this was set in the hosts file (as shown in the picture above).
In the following example (see picture below), we defined two systems in the hos_config2.php
file. If you check the assigned variables' values in the pm_system_settings.php
file, you can see that both systems are identical because they have equal IPs. The IP for the system DEV is directly defined in the hos_config2.php file, for the system DEMO the ip is resolved by windows through the c:/windows/system32/drivers/etc/hosts file.
In this section. it is defined which config files for environment definitions should be used. These hos_env_XXX.php
files contain environment definitions for processes in ProcMan.
It is recommended to create a seperate hos_env_<module>.php
file for every module which is used in an installation, e.g. one for the jcl_proccesses named hos_env_jcl.php
, one for IWS/AD processes named hos_env_iws_ad.php
, and one for IWS/CP processes named hos_env_iws_cp.php
. These files must then be included in the hos_config2.php
file.
Important: The definitions in those files need to start at the correct array-layer, make sure not to mess that up, otherwise this can break ProcMan.
The picture below shows an example of three env_config files placed in the directory /etc/env_configs/
. One for the JCL module, one for the IWS/AD module and one for the IWS/CP module.
Please see the next article Environment filesof a description of these files.
In this section, it is defined which z/OS user is used for which system with which password. Here it is also highly recommended to use variables defined in the pm_system_settings.php
file.
In the section rot_ini_file it is defined which system (see above section system_mapping) uses which .ini file for the communication to the z/OS systems.
Important: After a new installation most probably no .ini file was created. Therefore a new file with the name e.g. horcclnt.ini
has to be created. Use the file /procman/etc/horcclnt.ini-dist
to make a new copy for your system. If multiple z/OS systems are connected to ProcMan, create multiple files with different names like horcclnt_test.ini
or horcclnt_prod.ini
.
The example below illustrates two possible communications to a TEST and a PROD system.
The variables starting with $ are e.g. resolved from the pm_system_settings file as this:
The following adjustments have to be made in the .ini files. Row 14: Correct path Row 18: Correct path Row 26: Optional: Adjust log path Row 50: Set the correct host port from the installation of ProcMan z/OS part Row 54: Set the correct member from the installation of ProcMan z/OS part
In the section template_dsn_cntl it is defined, which dataset on the z/OS contains the skeletons for the ProcMan JCL Module.
In the section base_tmp_dsn it is defined, which dataset is used when the ProcMan JCL modules creates outputs. Those members are also defined in the installation of the z/OS part of ProcMan.
The ProcMan server certificate and key file provided by the CA (see prerequisites) has to be copied into the httpd/conf.d
subdirectory of the HWF installation. Beware that the certificate file must be in X.509 Base64 encoded PEM format.
You can verify whether this is the case by opening it in a text editor. If it is in the proper format, it must not contain any binary data and it must contain a section like this:
If the file contains binary data instead, the certificate is probably in the DER format and it has to be converted into the Base64 encoded PEM format. For the conversion you can either use the openssl command:
or (only on Windows) open the certificate file by double click from the Windows Explorer in the Windows Certificate tool and copy it into a Base64 encoded PEM file:
The names of the files set in the Web Server configuration file are by default .crt and .key where is the installation name set in the setup.rsp at the ProcMan installation. If the certificate and key file names differ from these, rename them or open the Web Server configuration file in a text file editor and change the file names in the options SSLCertificateFile and SSLCertificateKeyFile.
It is highly recommended to use HTTPS and a HTTPS certificate for ProcMan.
The default Web Server configuration created at the installation of ProcMan is for an encrypted HTTPS communication between the clients and the ProcMan server.
It is strongly recommended not to change this configuration to an unencrypted HTTP communication. However if there is some crucial reason for this it can be done in the Web Server configuration file <name>.conf by changing the port number and commenting out the options starting with SSL.
You need a .crt and a .key file which you can get from an official licensing site or from your companies certificate department.
1. Place the .crt and .key file in C:\HORIZONT\hwf\httpd\conf.d
2. Open the C:\HORIZONT\hwf\httpd\conf.d\<installationname>.conf file. In there, under the VirtualHost section, change the SSLCertificateFile path and the SSLCertficcateKeyFile path to the files added above.
If the user login shall work via encrypted secure LDAP communication (LDAPS), there have to be set some system environment variables to configure the LDAPS communication and after that the Web Server has to be restarted (e.g. in Windows’s Services dialog restart the HORIZONT HTTP Server service). On Unix/Linux the setting of the system variables works as well, but the preferred way is to set appropriate options in the ldap.conf file (see the description for this later in this chapter).
No server certificate verification required
If server certificate verification by the client is not required, set the environment variable LDAPTLS_REQCERT=never
Server certificate verification required
If server certificate verification by the client is required, copy the certificate of the server certificate’s authority provided by the customer to a file on the ProcMan server (e.g. C:\Programs\HORIZONT\ldap\server_ca.crt). If the server certificate has been issued using an intermediate authority certificate, which self has been signed by a parent authority certificate, copy all the chain of the intermediate authority certificate and all its ancestor authority certificates in arbitrary order in a single file on the ProcMan server.
Set the environment variables LDAPTLS_REQCERT=try and LDAPTLS_CACERT=<file>, where <file> is the file with its absolute path containing the certificate of the server certificate’s authority (or chain of authority certificates) previously copied to the ProcMan server.
Client certificate verification required
Beside the server certificate verification by the client, also client certificate verification by the server can be required for the secure LDAP communication in some installations. In this case a client certificate file and its private key file provided by the customer and issued by an authority known to the server has to be copied to files on the ProcMan server (e.g. C:\Programs\HORIZONT\ldap\client.crt and C:\Programs\HORIZONT\ldap\client.key). Beware that the key file has to be protected to avoid its misuse.
Set the environment variables LDAPTLS_CERT=<cert_file> and LDAPTLS_KEY=<key_file>, where <cert_file> is the client certificate file and <key_file> is the private key file, with their absolute paths, previously copied to the ProcMan server.
On Unix/Linux the preferred way is to set appropriate options in the ldap.conf file, rather than use the system variables. In a HWF installation the ldap.conf file is placed in /opt/horizont/hwf/etc/ldap.conf. The configuration options corresponding to the system variables described above are TLS_REQCERT, TLS_CACERT, TLS_CERT and TLS_KEY. The required options can be added by editing the ldap.conf file.
Example (ldap.conf):
It is strongly recommended not to change the ProcMan configuration to an unencrypted HTTP communication.
The default Web Server configuration created at the installation of ProcMan is for an encrypted HTTPS communication between the clients and the ProcMan server. It is strongly recommended not to change this configuration to an unencrypted HTTP communication. However if there is some crucial reason for this it can be done in the Web Server configuration file .conf by changing the port number and commenting out the options starting with SSL by using the '#' at the start of the row.
For example:
To be able to open ProcMan in the browser () the sections system_mapping, environment, zos_tech_user, rot_ini_file as well as base_tmp_dsn and template_dsn_cntl have to be adjusted.
The most important environment variables which take effect on the secure LDAP communication are LDAPTLS_REQCERT, LDAPTLS_CACERT, LDAPTLS_CERT and LDAPTLS_KEY. If there are also other settings required by a particular installation please refer to and search for ldap.conf for more information.