URI mapping definitions - URIMPDEF
The URI map definition (URIMPDEF) views display information about the URIs of HTTP or web service requests.
Supplied views
To access from the main menu, click:
| View | Notes |
|---|---|
| URI map definitions EYUSTARTURIMPDEF.ADDTOGRP |
Add one or more URI map definitions to a resource group. |
| URI map definitions EYUSTARTURIMPDEF.CREATE |
Create a URI map definition and add it to the data repository. |
| URI map definitions EYUSTARTURIMPDEF.DETAILED |
Detailed information about a selected URI mapping definition. |
| URI map definitions EYUSTARTURIMPDEF.INSTALL |
Install a URI map definition in an active system. |
| URI map definitions EYUSTARTURIMPDEF.REMOVE |
Remove a URI map definition from the data repository. |
| URI map definitions EYUSTARTURIMPDEF.TABULAR |
Tabular information about all URI mapping definitions for the current context. |
Actions
| Action | Description |
|---|---|
| ADDTOGRP | Add one or more URI map definitions to a resource group. |
| CREATE | Create a URI map definition and add it to the data repository. |
| CSDCOPY | Copy a CICS CSD resource definition. |
| CSDINSTALL | Install a CICS CSD resource definition into an active system. |
| INSTALL | Install a URI map definition in an active system. |
| REMOVE | Remove a URI map definition from the data repository. |
| UPDATE | Update a URI map definition in the data repository. |
Fields
| Field | Attribute name | Description |
|---|---|---|
| Use an analyzer program to process HTTP request | ANALYZER | The analyzer program setting for the URIMAP definition. The possible values are:
|
| 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 authentication and identification scheme to be used for URIMAPS.
|
| 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. |
| 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. |
| 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. |
| Cipher suite codes to be used for outbound SSL | CIPHERS | 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 define the resource, CICS automatically initializes the attribute with a default list of acceptable codes. You can reorder the cipher codes or remove them from the initial list. However, you cannot add cipher codes that are not in the default list for the specified encryption level. To reset the value to the default list of codes, delete all the cipher suite codes; the field is automatically repopulated with the default list. 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 name 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. |
| Time created | CREATETIME | The local date and time when the definition was created. |
| CSD group | CSDGROUP | The name of the CSD group for this CICS resource definition. This field is ignored for BAS definitions. |
| Version | DEFVER | The version number of the BAS resource definition, from 1 to 15. This field is ignored for CICS CSD resource definitions. |
| Description code page | DESCCODEPAGE | The code page of the description field. This field is ignored for CICS CSD resource definitions. |
| Description | DESCRIPTION | A description of the URI map definition. |
| 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 URI to which the map applies | HOST | The up to 116-character host name of the URI to which the map applies (for example, www.example.com), or its dotted decimal IPv4 address (for example, 9.20.181.3), or its colon hexadecimal IPv6 address (for example ABCD:EF01::2345:6789). If an IPv4 address is entered as an IPv4 compatible IPv6 address (deprecated) or an IPv4 mapped IPv6 address (for example ::FFFF:1.2.3.4) it is converted to a standard IPv4 dotted decimal address. The host name can be entered in any case, but if a character host name is specified instead of an IP address, the host name is converted to lowercase. If an IPV6 address is specified it will be converted to uppercase. If the definition is going to be used on CICS Transaction Server for z/OS, Version 3 Release 2 and earlier releases, IPv6 address formats should not be specified, and for USAGE(CLIENT) a non-standard port number for the SCHEME may be specified by following the name or address with a colon (:) and the port number, for example 'www.example.com:1234'. Otherwise, the PORT field is now the prefered method of specifying a non-standard port number. For a USAGE other than USAGE(CLIENT), a port number should not be specified, and an asterisk (*) may be used to make the URIMAP definition match any host name. |
| 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. |
| 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. |
| 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 URI map definition. |
| Path component of URI to which the map applies | PATH | The path component of the URL, which can be up to 255 characters. |
| Pipeline that will process the request | PIPELINE | For USAGE(PIPELINE), the name of the PIPELINE resource definition for the web service that handles the incoming HTTP request. |
| Port number | PORT | For USAGE(CLIENT) or USAGE(JVMSERVER) the decimal number of the port on which the remote CICS system is listening for incoming client requests in the range 1 through 65535. The well-known ports are those from 1 through 1023. It is advisable to use well known port numbers only for those services to which they are normally assigned. PORT need not be specified if the default port number for the SCHEME is to be used in which case it is set to NO. If a port number is optionally specified in the HOST field, the PORT field must either contain the same port number, or be set or allowed to default to NO. In this case the port number from the HOST field will be used when the URIMAP is installed. For a USAGE other than USAGE(CLIENT)or USAGE(JVMSERVER), PORT should not be specified and will be set to NO in any case. |
| 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 | The type of redirection for requests that match this URIMAP definition. The URL for redirection is specified by the Location
option. The possible values are:
|
| Scheme component of URI to which the map applies | SCHEME | The scheme component of the URL. The possible values are:
|
| Time out for pooled sockets (HHMMSS) | SOCKETCLOSE | This attribute is for USAGE (CLIENT). SOCKETCLOSE specifies if, and for how long, CICS keeps a client HTTP connection open
after the CICS application has finished using it. After use, CICS checks the state of the connection and then places
it in a pool in a dormant state. A dormant connection can be reused by the same application or by
another application that connects to the same host and port.
|
| Enabled status | STATUS | The status of the URIMAP definition. The possible values are:
|
| 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 type | USAGE | The usage for the URIMAP definition. The possible values are:
|
| User data area 1 | USERDATA1 | Optional string of up to 8 characters that allows you to provide additional site-specific data related to the BAS resource definition. This field is ignored for CICS CSD resource definitions. |
| User data area 2 | USERDATA2 | Optional string of up to 8 characters that allows you to provide additional site-specific data related to the BAS resource definition. This field is ignored for CICS CSD resource definitions. |
| User data area 3 | USERDATA3 | Optional string of up to 8 characters that allows you to provide additional site-specific data related to the BAS resource definition. This field is ignored for CICS CSD resource definitions. |
| The 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), the name of the WEBSERVICE resource definition for the web service that handles the incoming HTTP request. |