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:
| 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
| 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
| 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.
|
| 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.
|
| 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.
|
| 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:
|
| 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:
|
| Installation agent | INSTALLAGENT | The install agent identifier that made the installation.
|
| 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:
|
| 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.
|
| 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:
|
| 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. |