HTTPOPTS

Purpose

The HTTPOPTS statement defines the options for the HTTP communications.

Format


1  HTTPOPTS?  CLNTHREADNUM (
2.1! 10
2.1 number of threads
1 )?  CONNTIMEOUT (
2.1! 15
2.1 HTTP timeout interval
1 )?  FTPROXYHOST (
2.1 hostname
1 )?  FTPROXYPORT (
2.1 HTTP port
2.1! 44444
1 )?  HOSTNAME (
2.1! local hostname
2.1 hostname
2.1 IP address
1 )?  HTTPPORTNUMBER (
2.1 HTTP port
2.1! 511
1 )?  JCLCHECKHOSTNAME (
2.1 hostname
2.1 IP address
1 )?  JCLCHECKPORT (
2.1 SSL port
2.1! 7554
1 )?  JCLCHECKTOKEN (
2.1 API ML token
1 )?  JLOGHDRTEMPL (
2.1 member name
1 )?  JLOGTHREADNUM (
2.1! 1
2.1 number of threads
1 )?  JOBLOGMAXLINES (
2.1 number of lines
2.1! 100
1 )?  JOBLOGRETRIEVAL (
2.1! ONDEMAND
2.1 ONERROR
1 )?  JOBLOGSECTION (
2.1! FIRSTLAST
2.1 FIRST
2.1 LAST
1 )?  LICENSEID (  string )?  LICENSEURL (
2.1 URL
2.1! https://hclsoftware.compliance.flexnetoperations.com
1 )?  OUTPUTCOLLECTOR (
2.1! NO
2.1 YES
1 )?  PULSEIVL (
2.1! 0
2.1 heartbeat checking interval
1 )

1?  SRVTHREADNUM (
2.1! 10
2.1 number of threads
1 )?  SSLAUTHMODE (
2.1! CAONLY
2.1 STRING
1 )?  SSLAUTHSTRING (
2.1! tws
2.1 SSL string
1 )?  SSLKEYRING (
2.1 SSL key ring db filename
1 )?  SSLKEYRINGPSW (
2.1 SSL key ring psw filename
1 )?  SSLKEYRINGTYPE (
2.1! SAF
2.1 USS
1 )?  SSLPORT (
2.1! 512
2.1 SSL port number
1 )?  TCPIPJOBNAME (
2.1! TCPIP
2.1 TCPIP started task
1 )?  TCPIPTIMEOUT (
2.1! 300
2.1 TCPIP timeout interval
1 )?  USRMEM (
2.1! USRINFO
2.1 member name
1 )?  VARFAIL (
2.1 YES
2.1! NO
1 )?  VARSUB (
2.1 YES
2.1! NO
1 )?  VARTABLES (
2.1! GLOBAL
2.1 APPL
2.1 table1,table2,...
1 )

Parameters

CLNTHREADNUM(number of threads|10)
Number of threads that are used by the HTTP client task to send more than one request at the same time. Valid values are from 1 to 100.
CONNTIMEOUT(HTTP timeout interval|15)
Time, in seconds, that an HTTP connection waits before a timeout occurs. Valid values are from 1 to 10000.
FTPROXYHOST(hostname)
The name or IP address of the host where the File Transfer proxy is installed. You can specify up to 52 alphanumeric characters.

If you set this parameter, ensure that you also set a valid SSL environment. To communicate with the Z controller, the File Transfer proxy requires an SSL connection.

FTPROXYPORT(port number|44444)
The port number used by the File Transfer proxy to communicate with the agents and Z controller. Valid values are from 1 to 65535; the default value is 44444.
HOSTNAME(hostname|IP address| local hostname)
The local host name or IP address used by the HTTP server component. To connect to z-centric agents, this parameter is required.

It can be up to 52 alphanumeric characters. It specifies a host name or IP address in IPv4 or IPv6 format. Enclose this value in single quotation marks. If you do not specify this parameter here, the system looks for the name specified for the same parameter in the TCPOPTS statement. If it finds no name there, it uses the default, which is the IP address returned by TCP/IP.

HTTPPORTNUMBER(HTTP port|511)
The port number used by the HTTP server to listen for non-SSL connections. Valid values are from 0 to 65535.
JCLCHECKHOSTNAME(hostname|IP address)
This parameter is required to invoke IBM Z JCL Expert. It is the host name or IP address used to connect to the JCL Expert utility. You can specify up to 52 alphanumeric characters. If the value that you specify is longer than one row, ensure that you always end at column 72 and begin at column 1.

If you set this parameter, the JCLCHECKTOKEN is also required.

Note: If in HTTPOPTS JCLCHECKHOSTNAME you have set the host name and not the IP address, you must edit the /etc/hosts file by adding the following line:
JclExpert_ip_instance     JclExpert_hostname_instance
where:
JclExpert_ip_instance
IP address of the system where JCL Expert is installed.
JclExpert_hostname_instance
Host name of the system where JCL Expert is installed.
JCLCHECKPORT(SSL port|7554)
The SSL port number used to communicate with the JCL Expert tool. Valid values are from 0 to 65535; the default is 7554.
JCLCHECKTOKEN(API ML token)
The API Mediation Layer token used to communicate with the JCL Expert tool (for details about how you generate this token, see Generating an API Mediation Layer Authentication token). This parameter is required if JCLCHECKHOSTNAME is set.
Note: By default, the token expiration is set to 8 hours. To modify the token expiration value, see the Zowe documentation.

If the value that you specify is longer than one row, ensure that you always end at column 72 and begin at column 1.

JLOGHDRTEMPL(member name)
Specifies the name of the member in the EQQPARM data set that contains the template for the job log header. Use this option to have a header on top of all the job logs produced in the z-centric environment. The header contains information necessary to classify the output (application name, job name, extended job name, workstation name, operation number, planned start, late start) and information about the run (job ID, return code, duration, actual start and end times). The header can be customized. The EQQPARM member is used by both the controller and the output collector. For details about how to customize the template for the job log header, see Scheduling End-to-end with z-centric Capabilities.
JLOGTHREADNUM(number of threads|1)
This parameter is valid only for HCL Workload Automation for Z agents. It specifies the number of threads that are used by the HTTP client task to manage the requests concerning the job log.

Valid values are from 0 to 100. 0 means that the job log requests are managed as all the other requests submitted by the HTTP client task.

JOBLOGMAXLINES(number of lines|100)
This parameter is valid only for HCL Workload Automation for Z agents. It specifies the maximum number of lines that the job log retriever can return for a single job log.

Valid values are from 0 to 65000 lines. To specify which section of the job log must be retrieved, set the JOBLOGSECTION keyword.

JOBLOGRETRIEVAL(ONERROR|ONDEMAND)
This parameter defines the job log retrieval policy for operations running on z-centric and dynamic workstations. The valid values are:
ONDEMAND
The default value. The user must explicitly make a request to retrieve the job log.
ONERROR
After a job runs and ends in error, the job log is automatically retrieved and sent. Manual changes to the error do not trigger the retrieval process to start.
JOBLOGSECTION(FIRST|LAST|FIRSTLAST)
The section of the job log retrieved from an HCL Workload Automation for Z agent that must be shown. The valid values are:
FIRSTLAST
The initial and last sections of the job log are retrieved. If the total number of lines to display exceeds the JOBLOGMAXLINES value, the central part is discarded and replaced with a lines of dashes.
FIRST
Only the initial section of the job log is retrieved. If the total number of lines to display exceeds the JOBLOGMAXLINES value, the last part is discarded and replaced with a lines of dashes.
LAST
Only the last section of the job log is retrieved. If the total number of lines to display exceeds the JOBLOGMAXLINES value, the first part is discarded and replaced with a lines of dashes.
LICENSEID(string)
This parameter is required to submit jobs on z-centric and dynamic agents. It is the ID of the license server that processes the information about the license usage.

When you buy HCL Workload Automation for Z, license usage is calculated based on the number of completed jobs that you run on z-centric and dynamic agents; the related information is processed on the server that you specify in this parameter. Copy and paste the ID that is provided in the mail confirming your license.

LICENSEURL(url|https://hclsoftware.compliance.flexnetoperations.com)
This parameter is required to submit jobs on z-centric and dynamic agents. It is the URL of the license server that processes the information about the license usage.

When you buy HCL Workload Automation for Z, license usage is calculated based on the number of completed jobs that you run on z-centric and dynamic agents; the related information is processed on the server that you specify in this parameter. Copy and paste the URL that is provided in the mail confirming your license. The default is https://hclsoftware.compliance.flexnetoperations.com.

OUTPUTCOLLECTOR(YES|NO)
Specifies if the logs of jobs and dynamic jobs run in a z-centric environment are to be retrieved by the output collector started task and copied to a SYSOUT in JES to be used by an output management product.

Specify YES to activate this feature since by default it is not active. If you activate it, you need to define the EQQOUCEV DD name in the controller JCL. The EQQOUCEV data set is used in the communication between the controller and the output collector (when you create the sample job JCL with EQQJOBS, a sample is generated to allocate this and other data sets).

The job log retrieval mechanism implemented by the Output collector is independent of the normal retrieval mechanism defined by the JOBLOGRETRIEVAL keyword. While Output collector retrieves all logs automatically and sends them to JES, the normal mechanism is based on user requests to the controller through one of the user interfaces.

In a sysplex configuration the Output collector started task must reside in the same image where the controller is.

For detailed information about collecting job logs from HCL Workload Automation Agents, see HCL Workload Automation for Z: Scheduling End-to-end with z-centric Capabilities.

PULSEIVL(heartbeat checking interval||0)
Defines the frequency in minutes with which the controller checks that all attached z-centric agents and dynamic domain managers are running. This keyword defines the heartbeat interval globally for all devices. To set up heartbeat intervals for specific agents or dynamic domain managers, use the pulseivl parameter in the HTTP|HTTPS(destination,...,destination) keyword of the ROUTOPTS statement.
The maximum allowed is 1440 minutes. The zero default value implies that the heartbeat checking:
  • Is not run for z-centric agents.
  • Is run for dynamic domain managers according to the policy established by the Z controller.
SRVTHREADNUM(number of threads|10)
The number of threads that are used by the HTTP Server task to process more than one request at the same time. Valid values are from 2 to 100.
SSLAUTHMODE(STRING|CAONLY)
The SSL authentication type. Valid values are:
CAONLY
The scheduler checks the certificate validity by verifying that a recognized Certification Authority has issued the peer certificate. The information contained in the certificate is not checked. This is the default value.
STRING
The scheduler checks the certificate validity as described in the CAONLY option. It also verifies that the Common Name (CN) of the Certificate Subject matches the string specified in the SSLAUTHSTRING parameter.
SSLAUTHSTRING(SSL string|tws)
The SSL string used to verify the certificate validity when you set SSLAUTHMODE to STRING. The string can be up to 64 characters.
SSLKEYRING(SSL key ring db filename)
If SSLKEYRINGTYPE is SAF, this parameter specifies the SAF key ring used to connect the security certificates.

If SSLKEYRINGTYPE is USS, this parameter specifies the database containing the keys and certificates. It consists of an SSL working directory and file name, in the format SSLworkdir/filename.kbd.

This parameter is case sensitive.

SSLKEYRINGTYPE(USS|SAF)
Specifies if the key ring file is a key database USS file or a SAF key ring. If this value is set to SAF, you can use the RACF® command to manage SSL connections.
SSLKEYRINGPSW(SSL key ring psw filename)
If SSLKEYRINGTYPE is USS, specifies the file containing the key password. It consists of an SSL working directory name and file name, in the format SSLworkdir/TWS.sth. This parameter is case-sensitive.
SSLPORT(SSL port number|512)
The SSL port number used by the HTTP server to listen for SSL-connections. Valid values are from 0 to 65535.
To disable the SSL connection, you can either:
  • Specify neither SSLKEYRING nor SSLPORT keywords.
  • Specify SSLPORT(0).
TCPIPJOBNAME(TCPIP started task|TCPIP)
The name of the TCP/IP started task running on the z/OS® system where you have the scheduler installed. If you do not specify this parameter here, the system looks for the name specified for the same parameter in the TCPOPTS statement. If it finds no name there, it uses the default started task named TCPIP.
TCPIPTIMEOUT(TCPIP timeout interval|300)
The time (in seconds) that an HTTP request waits for the response before a timeout occurs. Valid values are from 1 to 10000.
USRMEM(member name|USRINFO)
The PARMLIB member where the user definitions are stored. If you are working with fault-tolerant and z-centric end-to-end solutions at the same time, ensure that the member you set here is different from the member set in the USRMEM keyword of the fault-tolerant end-to-end environment.

This keyword is required only if you run jobs on Windows™ workstations where the user password is requested.

VARFAIL(NO|YES)
Applies to job types with advanced options defined from the Dynamic Workload Console. Set this keyword to YES so that if a variable substitution error occurs, the job results in a JCL error (OJCV). Specify NO so that the variable string remains unchanged, without substituting it with a value and does not report a JCL error (OJCV).
VARSUB(YES|NO)
Applies to job types with advanced options defined from the Dynamic Workload Console and indicates whether variable substitution should be enabled. Specify YES so that variable scanning is performed for job types with advanced options. Specify NO so that the variable string is left unchanged and is not substituted with a value.
VARTABLES(GLOBAL|APPL|table1,table2,...)
Applies to job types with advanced options defined from the Dynamic Workload Console and identifies a list of variable tables that must be searched, and the search order. APPL indicates the application variable table. GLOBAL indicates the table defined in the GTABLE keyword of the OPCOPTS controller. The maximum number of characters that can be specified for the table name is 16 and you cannot specify more than 16 tables in the list.