URIMAP definitions are resource definitions that match the URIs of HTTP or Web service requests, and provide information on how to process the requests.
The URIMAP definitions are used to provide these different Web-related facilities in CICS:
Analyzer Specifies whether an analyzer program is to be used in processing the HTTP request. The analyzer that can be run using this attribute is the analyzer associated with the TCPIPSERVICE definition or definitions to which this URIMAP definition relates. An analyzer program must be in the local CICS region. These are the values:
Certificate Is the label of the certificate that is to be used as the SSL client certificate for the HTTP request by CICS as an HTTP client. It specifies the label of the X'509' certificate that is to be used as the SSL client certificate during the SSL handshake. Certificate labels can be up to 32 characters long. This attribute is only used when the URI specified by the URIMAP definition is to be used for an HTTPS request made by CICS as a client. It is up to the server to request a SSL client certificate, and if this happens, CICS supplies the certificate label which is specified in the URIMAP definition. If this attribute is omitted, the default certificate defined in the key ring for the CICS region user ID is used. The certificate must be stored in a key ring in the external security manager's database.
Ciphers Is the list of cipher suite codes specified for the URIMAP. Specifies a string of up to 56 hexadecimal digits that is interpreted as a list of up to 28 2-digit cipher suite codes. When you use CEDA is to define the resource, CICS automatically initializes the attribute with a default list of acceptable codes, depending on the level of encryption that is specified by the ENCRYPTION system initialization parameter.
Character Set Is the name of the character set to be used for the static response. It specifies the 1-40 character name of the character set into which CICS converts the entity body of the response that is sent to the Web client. CICS does not support all the character sets named by IANA. HTML-coded character sets list the IANA character sets that are supported by CICS.
CICS Region Name Indicates the job name or modify ID of the CICS region being monitored. Each CICS region in a z/OS operating system has a unique name. This name is an alphanumeric string, with a maximum of eight characters, and case-sensitive. CICS region names are always in uppercase characters.
Converter program Is the name of the URIMAP converter program. It specifies the one thru eight character name of a converter program that is to be run to perform conversion or other processing on the request and response. Typically, a converter program transforms the HTTP request into a COMMAREA that can be used by an application program, and transforms the output into an HTTP response. The converter program can be any converter program that is available in the local CICS region.
Disable count Is the number of times the URIMAP host or path match has been disabled.
Enable status Specifies whether the URIMAP definition is to be installed in an enabled or disabled state. The default value is Enabled. These are the valid values: Enabled, Disabled, and Disabled host.
HFS File name Is the name of the HFS file associated with this URIMAP. It specifies the fully qualified (absolute) or relative name of a z/OS UNIX System Services HFS file that forms the body of the static response which is sent to the HTTP request from the Web client.
Host Codepage Is the 1-10 character name of the IBM code page (EBCDIC) in which the text document that forms the static response is encoded.
Host name Is the name of the host component of the URI to which the URIMAP definition applies. It can be up to 116 characters.
Location Specifies a URL of up to 255 characters to which the client's request must be redirected. This must be a complete URL, including scheme, host, and path components, and appropriate de limiters. CICS does not check that the URL is valid, so you must ensure that the destination exists and that the URL is specified correctly.
Media Type Specifies the media type (data content) of the static response that CICS provides to the HTTP request. For example, image/jpg, text/html or text/xml. Up to 56 characters can be used for this attribute.
Number of Ciphers Is the number of cipher codes in the CIPHERS list.
Origin Node Is the combination of z/OS System ID (SMFID) and CICS region name. The value format is an alphanumeric string, maximum 32 bytes, and case-sensitive.
When a situation is true, the system compares the origin node name in the attribute to the names of managed systems assigned to the item. If the origin node name matches the name of a managed system, the status of the item changes accordingly. If the names of the origin node and the managed systems do not match, the status of the item remains unchanged.
Path name Specifies the path component of the URI to which the URIMAP definition applies. It can be up to 255 characters. An example of a path is software/htp/cics/index.html.
Pipeline name Specifies the one thru eight character name of the PIPELINE resource definition for the Web service. The PIPELINE resource definition provides information about the message handlers which act on the service request from the client.
Program name Specifies the one thru eight character name of the user application program that composes the HTTP response. For CICS as an HTTP server, this attribute is required unless an analyzer or converter program is specified, or a template name or HFS file is specified, or redirection is specified.
Redirect count Is the number of times the URIMAP's host or path was redirected.
Redirection Specifies the type of redirection for requests that match this URIMAP definition. The URL specified by the LOCATION attribute is used for redirection when required. These are the values:
Reference count Is the number of times a search for a matching URIMAP definition was made.
Scheme Specifies the scheme component of the URI to which the URIMAP definition applies. These are the values:
System ID Indicates the four character name that uniquely identifies an active z/OS operating system within a given CICSplex. The value format is an alphanumeric string, maximum four characters, and case-sensitive. z/OS System IDs are always in uppercase characters.
TCP/IP Service Is the name of the TCPIPSERVICE resource definition. It can be a 1- to 8-character name of a TCPIPSERVICE resource definition, with PROTOCOL(HTTP), that defines an inbound port to which this URIMAP definition relates. If this attribute is not specified, the URIMAP definition applies to a request on any inbound ports.
Template name Specifies the 1-48 character name of a CICS document template that forms the body of the static response that is sent to the HTTP request from the Web client.
Trans Id Specifies the 1-4 character name of an alias transaction that is to be used to run the user application that composes the HTTP response, or to start the pipeline.
URIMAP Name Specifies the name of this URIMAP definition. The name can be up to eight characters in length. The attribute is specified in mixed case, and the case is preserved in the URIMAP definition.
Usage Specifies whether this URIMAP definition is for CICS an HTTP server, an HTTP client, or a Web service. These are the values:
User Name Is the user ID under which the alias transaction is attached. It can be a 1–8 character name. A user ID that you specify in the URIMAP definition is overridden by any user ID that is obtained directly from the client, using authentication procedures which are specified by the AUTHENTICATE attribute of the TCPIPSERVICE definition for the connection.
Webservice name Specifies the 1–8 character name of a WEBSERVICE resource definition. It can also be a name up to 32 characters (in mixed case) representing a Web service generated by the CICS Web services assistant.