HTTPOPTS

| |

HTTPOPTS

Purpose

The HTTPOPTS statement defines the options for tracking jobs and |for retrieving job execution logs that are issued on Tivoli Workload Scheduler for z/OS agents.

Format

|>>-HTTPOPTS--+---------------------------------------+---------->
|             |               .-10----------------.   |
|             '-CLNTHREADNUM(-+-number of threads-+-)-'
| 
|>--+------------------------------------------+----------------->
|   |              .-15--------------------.   |
|   '-CONNTIMEOUT(-+-HTTP timeout interval-+-)-'
| 
|>--+----------------------------------------+------------------->
|   |                .-1-----------------.   |
|   '-JLOGTHREADNUM(-+-number of threads-+-)-'
| 
|>--+---------------------------------------+-------------------->
|   |                 .-100-------------.   |
|   '-JOBLOGMAXLINES(-+-number of lines-+-)-'
| 
|>--+---------------------------------+-------------------------->
|   |                  .-|ONDEMAND|-.   |
|   '-|JOBLOGRETRIEVAL||(|-+-|ONERROR|--+-|)|-'
| 
|>--+--------------------------------+--------------------------->
|   |                .-FIRSTLAST-.   |
|   '-JOBLOGSECTION(-+-FIRST-----+-)-'
|                    '-LAST------'
| 
|>--+--------------------------------+--------------------------->
|   |           .-local hostname-.   |
|   '-HOSTNAME(-+-hostname-------+-)-'
|               '-IP address-----'
| 
|>--+---------------------------------+-------------------------->
|   '-HTTPPORTNUMBER(---HTTP port---)-'
| 
|>--+---------------------------------------+-------------------->
|   |               .-10----------------.   |
|   '-SRVTHREADNUM(-+-number of threads-+-)-'
| 
|>--+---------------------------+-------------------------------->
|   |              .-CAONLY-.   |
|   '-SSLAUTHMODE(-+-STRING-+-)-'
| 
|>--+---------------------------------+-------------------------->
|   |                .-tws--------.   |
|   '-SSLAUTHSTRING(-+-SSL string-+-)-'
| 
|>--+--------------------------------------------+--------------->
|   '-SSLKEYRING(---SSL key ring db filename---)-'
| 
|>--+------------------------------------------------+----------->
|   '-SSLKEYRINGPSW(---SSL key ring psw filename---)-'
| 
|>--+---------------------------+-------------------------------->
|   |                 .-SAF-.   |
|   '-SSLKEYRINGTYPE(-+-USS-+-)-'
| 
|>--+--------------------------------+--------------------------->
|   |          .-512-------------.   |
|   '-SSLPORT(-+-SSL port number-+-)-'
| 
|>--+----------------------------------------+------------------->
|   |               .-TCPIP--------------.   |
|   '-TCPIPJOBNAME(-+-TCPIP started task-+-)-'
| 
|>--+--------------------------------------------+--------------->
|   |               .-300--------------------.   |
|   '-TCPIPTIMEOUT(-+-TCPIP timeout interval-+-)-'
| 
|>--+---------------------------+-------------------------------->
|   |         .-USRINFO-----.   |
|   '-USRMEM(-+-member name-+-)-'
| 
|>--+------------------------------------+----------------------->
|   |            .-|GLOBAL|------------.   |
|   '-|VARTABLES||(|-+-|APPL|--------------+-|)|-'
|                '-|table1,table2,...|-'
| 
|>--+--------------------+--+-------------------+---------------><
|   |          .-|YES|-.   |  |         .-|YES|-.   |
|   '-|VARFAIL||(|-+-|NO|--+-|)|-'  '-|VARSUB||(|-+-|NO|--+-|)|-'
|

| |

Parameters

CLNTHREADNUM(number of threads|10)

||The 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 |5 to 100. |

CONNTIMEOUT(HTTP timeout interval|15)

||The time (in seconds) that an HTTP connection waits before a |timeout occurs. Valid values are from 1 to 10000. |

JLOGTHREADNUM(number of threads|1)

||The number of threads that are used by the HTTP client task |to manage the requests concerning the job log. This parameter is valid |only for Tivoli® Workload |Scheduler for z/OS® agents. |

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)

||The maximum number of lines that the job log retriever can return |for a single job log. This parameter is valid only for Tivoli Workload Scheduler for z/OS agents. |

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 joblog 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 joblog. |
ONERROR: After a job runs and ends in error, the joblog 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 a Tivoli Workload Scheduler for z/OS 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. |

HOSTNAME(hostname|IP |address| local hostname)

||The local host name or IP address used by the HTTP server component. |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. |

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 keys and |certificates. It consists of an SSL working directory name and file |name, in the format SSLworkdir/TWS.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. |

If you want 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.

|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. |

|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(NO|YES)|

|||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.| |

| |