URI maps - URIMAP

The URI map (URIMAP) views display information about the universal resource identifier (URI) of requests from web clients or requests to a remote server.

Supplied views

To access from the main menu, click:

CICS operations views > TCP/IP service operations views > URI maps

Table 1. Views in the supplied URI maps (URIMAP) view set
View Notes
URI maps

EYUSTARTURIMAP.DETAIL1

Detailed information about a selected URI map.
URI maps

EYUSTARTURIMAP.DETAIL2

Detailed information about a selected URI map.
URI maps

EYUSTARTURIMAP.DETAIL3

Detailed information about the resource signature.
URI maps

EYUSTARTURIMAP.DETAILED

Detailed information about a selected URI map.
URI maps

EYUSTARTURIMAP.DISABLE

Disable program access to the URIMAP definition. A URIMAP definition has to be disabled before it can be reinstalled or discarded.
URI maps

EYUSTARTURIMAP.DISCARD

Remove a URIMAP definition from the system.
URI maps

EYUSTARTURIMAP.ENABLE

Enable access to the URIMAP definition by programs.
URI maps

EYUSTARTURIMAP.SET

Set attributes according new values specified in input fields
URI maps

EYUSTARTURIMAP.TABULAR

Tabular information about currently installed URI map definitions.

Actions

Table 2. Actions available for URIMAP views
Action Description
DISABLE Disable program access to the URIMAP definition. A URIMAP definition has to be disabled before it can be reinstalled or discarded.
DISCARD Remove a URIMAP definition from the system.
ENABLE Enable access to the URIMAP definition by programs.
SET Set attributes according new values specified in input fields

Fields

Table 3. Fields in URIMAP views
Field Attribute name Description
Use an analyzer program to process HTTP request ANALYZERSTAT For USAGE(SERVER), whether or not the analyzer associated with the TCPIPSERVICE definition is called to process the request. For all other usage types, the value is forced to NOANALYZER.
  • ANALYZER - The analyzer program is to be run.
  • NOANALYZER - The analyzer program is not to be run.
Application Name APPLICATION The application name of the application for which this URIMAP resource is defined. If the OPERATION field is set, this resource is defined as an entry point.
Major Version APPLMAJORVER The major version number of the application for which this URIMAP resource is defined. If the OPERATION field is set, this resource is defined as an entry point.
Micro Version APPLMICROVER The micro version number of the application for which this URIMAP resource is defined. If the OPERATION field is set, this resource is defined as an entry point.
Minor Version APPLMINORVER The minor version number of the application for which this URIMAP resource is defined. If the OPERATION field is set, this resource is defined as an entry point.
Atomservice that will process the request. ATOMSERVICE This attribute is for USAGE(ATOM). When a client makes a request to CICS for an Atom feed using the URI specified by this URIMAP definition, ATOMSERVICE specifies the 1 - 8 character name of the ATOMSERVICE resource definition for the Atom feed. The ATOMSERVICE resource definition defines an Atom service, feed, collection, or category document, and identifies the Atom configuration file, CICS resource or application program, and Atom binding file that are used to supply the data for the feed.
Authentication level AUTHENTICATE The level of authentication used by this TCP/IP resource.
Availability status AVAILSTATUS The availability of this URIMAP resource when an application entry point is in control of the availability.
  • AVAILABLE - The application entry point controlling the availability of this URIMAP resource is available.
  • UNAVAILABLE - The application entry point controlling the availability of this URIMAP resource is enabled but has not yet been made available.
  • NONE - There are several reasons for NONE availability.
    • This URIMAP resource is not part of a CICS Application.
    • No application entry point is controlling the availability of this URIMAP resource.
    • The application entry point controlling the availability of this URIMAP resource is disabled.
    • The application entry point controlling the availability of this URIMAP resource is not resident in the same CICS bundle.
BAS resource definition version BASDEFINEVER The BAS version number of this definition.
SSL client certificate for outbound HTTPS request CERTIFICATE For USAGE(CLIENT), the label of a certificate within the key ring that is to be used as a client certificate in the SSL handshake for outbound IIOP connections.
Last modification agent CHANGEAGENT The change agent identifier that made the last modification.
  • CSDAPI - The resource was last changed by a CEDA transaction, by the programmable interface to DFHEDAP or by an EXEC CICS CSD command.
  • CSDBATCH - The resource was last changed by a DFHCSDUP job.
  • DREPAPI - The resource was last changed by a CICSPlex SM BAS API command.
  • DREPBATCH - The resource was last changed by a CICSPlex SM utility.
  • SYSTEM - The resource was last changed by the CICS or CICSPlex SM system.
  • DYNAMIC - The resource was last changed dynamically.
  • CREATESPI - The resource was last changed by an EXEC CICS CREATE command.
  • NOTAPPLIC - This is not applicable for this resource.
Last modification agent release CHANGEAGREL The CICS release level of the agent that made the last modification to the resource definition.
Last modification time CHANGETIME The local date and time when the definition was last changed.
Last modification user ID CHANGEUSRID The user ID that made the last modification to the resource definition.
Character set of CICS response to the HTTP request CHARACTERSET For USAGE(SERVER), the name of the character set for the static response, which can be up to 40 characters.
SSL cipher suite codes CIPHERS A value specifying up to 28 cipher suites, in the form of hexadecimal pairs. From CICS Transaction Server 5.1 this field can alternatively specify the name of an XML file residing on zFS which contains a list of ciphers. An XML file can be up to 28 characters.
Converter program to process request content CONVERTER For USAGE(SERVER), the name of a converter program that is used to transform the HTTP request into a form suitable for the application program specified in PROGRAM.
Source of the resource definition DEFINESOURCE The source of the definition, depending on which agent made the last change.
Creation time DEFINETIME The local date and time when the resource definition record was created on DFHCSD or EYUDREP.
Status ENABLESTATUS The status of the URIMAP definition. The possible values are:
  • Enabled - The URIMAP definition can be accessed.
  • Disabled - The URIMAP definition cannot be accessed. A URIMAP definition with this status can be deleted.
  • Disabledhost - The URIMAP definition cannot be accessed because the virtual host of which it forms a part has been disabled. Use the HOST views to re-enable all the URIMAP definitions in the virtual host. A URIMAP definition with this status cannot be deleted.
Qualified zFS file to form the static response HFSFILE For USAGE(SERVER), the fully qualified or relative name of a file in the z/OS UNIX System Services zSeries File System (zFS), whose contents are returned as the HTTP response.
Host component of the URI HOST The host name or IP address of the remote system. The HOSTTYPE option gives the format of this value as either a name, an IPv4 address or an IPv6 address. The port number is also displayed if this is a name or an IPv4 address.
Code page in which the static response is encoded HOSTCODEPAGE For USAGE(SERVER), the IBM code page (EBCDIC) in which the text document that will form the static response is encoded; this can be up to 10 characters.
The format of the host name or address HOSTTYPE The address format of the host component of the URI (HOST). These are the possible values:
  • HOSTNAME - HOST contains a character host name. The IP address that corresponds to the host name is looked up using DNS.
  • IPV4 - HOST contains an IPv4 address specified in dotted decimal address format.
  • IPV6 - HOST contains an IPv6 address specified in colon hexadecimal address format.
  • NOTAPPLIC - The HOST name or address is incorrect (HOST=0.0.0.0 or HOST=*).
Installation agent INSTALLAGENT The install agent identifier that made the installation.
  • CSDAPI - The resource was installed by a CEDA transaction, by the programmable interface to DFHEDAP or by an EXEC CICS CSD command.
  • CREATESPI - The resource was installed by an EXEC CICS CREATE command.
  • DYNAMIC - The resource was installed dynamically.
  • GRPLIST - The resource was installed by GRPLIST INSTALL.
  • BUNDLE - The resource was installed by a BUNDLE.
Installation time INSTALLTIME The local date and time when the definition was installed.
Installation user ID INSTALLUSRID The user ID that installed the resource definition.
The format of the resolved IP address IPFAMILY The format of the IP address in the IPRESOLVED option. These are the possible values:
  • IPV4 - IPRESOLVED contains an IPv4 address specified in dotted decimal address format.
  • IPV6 - IPRESOLVED contains an IPv6 address specified in colon hexadecimal address format.
  • UNKNOWN - IPRESOLVED is not yet in use, or the address cannot be resolved. This is the default when IPRESOLVED is 0.0.0.0
The resolved IP address of this URIMAP IPRESOLVED The resolved IPv4 or IPv6 address of the HOST to which this URIMAP applies, or 0.0.0.0 if it is unavailable or unknown. The format of this IP address is given by the IPFAMILY option.
URI to which to redirect the inbound HTTP request LOCATION For USAGE(SERVER), or USAGE(PIPELINE), an alternate URL to which the Web client will be redirected, if redirection is specified. REDIRECTYPE is used to define the type of redirection.
URI map reference count MAPREFCOUNT Number of times this URIMAP definition was referenced.
URI map host or path disabled MATCHDISABLD Number of times this host and path were matched, but the URIMAP definition was disabled.
URI map host or path redirect MATCHREDIREC Number of times this host and path were matched, and the request was redirected.
Media type of CICS response to the HTTP request MEDIATYPE Specifies the media type (data content) of the static response that CICS provides to the HTTP request. This is for USAGE(SERVER), where a static response is to be provided and up to 56 characters can be used. The name for each formally recognized type of data content is defined by IANA.
Name NAME The name of the URIMAP definition.
Number of SSL cipher suite codes NUMCIPHERS The count of cipher suite codes, which are specified as hexadecimal pairs
Operation Name OPERATION The name of the application operation for which this URIMAP resource is defined as an entry point. If this field is not set, this resource is not defined as an entry point but may still be part of an application.
Path component of URI to which the map applies PATH For USAGE(CLIENT), the path of the target URL to which the HTTP request is to be sent. For any other USAGE, the path on the incoming HTTP request that is used to select this URIMAP definition. The PATH may terminate in an asterisk, meaning that it is generic, and matches any path whose characters are the same up to but excluding the asterisk.
Pipeline that will process the request PIPELINE For USAGE(PIPELINE) or USAGE(JVMSERVER), the name of the PIPELINE resource definition for the Web service that handles the incoming request.
Platform Name PLATFORM The platform name of the application for which this URIMAP resource is defined. If the OPERATION field is set, this resource is defined as an entry point.
Port number for USAGE(CLIENT) PORT For USAGE(CLIENT), the PORT option displays the port number used for the client connection. The port number is also displayed in the HOST option if HOST contains a native IPv4 address or a host name. For USAGE(CLIENT), the PORT attribute always contains the port number that is being used for the communication, even if PORT(NO) is specified on the URIMAP at define time. For USAGE(JVMSERVER), the PORT option displays the port number used to receive requests to access an application that is running in a Liberty profile server. For USAGE(ATOM), USAGE(SERVER), or USAGE(PIPELINE), the PORT option is set to -1.
Application program that will process the request PROGRAM For USAGE(SERVER), the name of the application program that processes the incoming HTTP request.
Type of redirection REDIRECTTYPE Whether or not matching requests should be redirected, on a temporary or permanent basis.
  • NONE - Requests are not redirected. Any URL specified by the LOCATION field is ignored.
  • TEMPORARY - Requests are redirected on a temporary basis. The HTTP status code used for the response is 302 (Found).
  • PERMANENT - Requests are redirected permanently. The HTTP status code used for the response is 301 (Moved Permanently).
Scheme component of URI to which the map applies SCHEME The scheme for the HTTP request, HTTP with SSL (HTTPS) or without (HTTP).
Time out for pooled sockets (secs) SOCKETCLOSE The timeout value after which sockets will be closed. A value in seconds between 0 and 240000 (HHMMSS). Where 0 indicates that no connection pooling occurs.
Peak number of pooled sockets SOCKPLSZPEAK The peak size of the outbound connection socket pool.
Number of pooled sockets SOCKPOOLSIZE The current number of sockets in the connection pool.
Number of reclaimed sockets SOCKRECLAIMD The number of sockets reclaimed from the pool.
Number of timed out sockets SOCKTIMEDOUT The number of sockets that have been timed out in the pool.
Inbound TCP/IP service relating to this URI map TCPIPSERVICE For USAGE(SERVER) or USAGE(PIPELINE), the TCPIPSERVICE to which this URIMAP definition applies. Only requests received on this TCPIPSERVICE are matched to this URIMAP definition. If no TCPIPSERVICE is specified, the URIMAP definition applies to all incoming HTTP requests.
Document template to form the static response TEMPLATENAME For USAGE(SERVER), the name of a CICS document template whose contents are returned as the HTTP response.
Alias transaction to run application for response TRANSACTION For USAGE(SERVER), USAGE(JVMSERVER), or USAGE(PIPELINE), the name of the alias transaction that processes the incoming HTTP request.
URI map usage USAGE The intended use of this URIMAP:
  • SERVER - The URIMAP definition is used to locate the resources for CICS to produce an HTTP response to the request identified by HOST and PATH.
  • CLIENT - The URIMAP definition is used to specify information for making an HTTP request from CICS as an HTTP client.
  • PIPELINE - The URIMAP definition is used to locate the resources for CICS to produce an XML response to the request identified by HOST and PATH.
  • ATOM - The URIMAP definition is used to imply the use of Internatinalized Resource Identifiers (IRIs) rather then URIs, IRIs are just URIs that contain Unicode characters.
  • JVMSERVER - The URIMAP definition is used to to locate the resources for CICS to produce an XML response to the request identified by HOST and PATH for a Liberty Server.
User ID to attach the alias transaction USERID For USAGE(SERVER), USAGE(JVMSERVER), or USAGE(PIPLEINE), the 8 character user ID under which the alias transaction will be attached.
Web service that will process the request WEBSERVICE For USAGE(PIPELINE) or USAGE(JVMSERVER), the name of the WEBSERVICE resource definition for the Web service that handles the incoming request.


eyua318.html | Timestamp icon Last updated: Sunday, 4 June 2017