URIMPDEFAggregateRecordType

The name of the CSD group for this CICS resource definition. This field is ignored for BAS definitions.

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.

• For a static response file for a URIMAP resource defined by online resource definition, the file path is either fully qualified, if prefixed with a forward slash (/), or is relative to the HOME directory of the CICS region user ID.
• For a static response file for a URIMAP resource defined in a CICS bundle, the file path is relative to the root directory of the CICS bundle. The zFS file must be packaged in the CICS bundle with the URIMAP resource. The MEDIATYPE and HOSTCODEPAGE attributes must be specified, to inform CICS of the file type and the code page with which the file is encoded. When the file is defined in a CICS bundle and exported to zFS using CICS Explorer, the code page with which the file is encoded will be the same as the one used by CICS Explorer.

The analyzer program setting for the URIMAP definition. The possible values are:

• Analyzer - The analyzer associated with the TCPIPSERVICE definition is to be used in processing the HTTP request.
• Noanalyzer - The analyzer program is not to be used.

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.

The authentication and identification scheme to be used for URIMAPS.

• NO - The client is not required to send authentication or identification information. However, if the client sends a valid certificate that is already registered to the security manager, and associated with a user ID, then that user ID identifies the client.
• BASIC - HTTP Basic authentication is used to obtain a user ID and password from the client. If an invalid user ID and password are supplied, the process is repeated until valid information is supplied, or until the end user cancels the connection. When the end user has been successfully authenticated, the user ID supplied identifies the client. BASIC requires USAGE(CLIENT).

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.

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 - Resource was last changed by a CICSPlex SM API command.

The CICS release level of the agent that made the last modification.

The local date and time when the definition was last changed.

The user ID that made the last modification.

For USAGE(SERVER), the name of the character set for the static response, which can be up to 40 characters.

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.

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.

The local date and time when the definition was created.

The code page of the description field. This field is ignored for CICS CSD resource definitions.

A description of the URI map definition.

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.

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.

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.

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.

The name of the URI map definition.

The path component of the URL, which can be up to 255 characters.

For USAGE(PIPELINE), the name of the PIPELINE resource definition for the web service that handles the incoming HTTP request.

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.

For USAGE(SERVER), the name of the application program that processes the incoming HTTP request.

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:

• None - Requests are not redirected. Any URL specified by the Location option is ignored.
• Temporary - Requests are redirected on a temporary basis. The status code used for the response is 302 (Found).
• Permanent - Requests are redirected permanently. The status code used for the response is 301 (Moved Permanently).

The scheme component of the URL. The possible values are:

• HTTP - HTTP without Secure Sockets Layer (SSL).
• HTTPS - HTTP with Secure Sockets Layer (SSL).
• JMS - Liberty JMS (Message Driven Beans).
• IIOP - Liberty IIOP (Enterprise Java Beans).

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.

• 0 - 240000 - The period of time (in HHMMSS format) after which CICS is to close the socket. Specifying 000000 closes the socket immediately and does not put sockets into a pool.

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.
• Hdisabled - The URIMAP definition cannot be accessed because the virtual host of which it forms a part has been disabled. Use CEMT SET HOST to re-enable all the URIMAP definitions in the virtual host. A URIMAP definition with this status cannot be deleted.

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.

For USAGE(SERVER), the name of a CICS document template whose contents are returned as the HTTP response.

For USAGE(SERVER), USAGE(JVMSERVER), or USAGE(PIPELINE), the name of the alias transaction that processes the incoming HTTP request.

The usage for the URIMAP definition. The possible values are:

• Server - The URIMAP definition is for CICS as an HTTP server. It is used to map the URL of an incoming HTTP request from a web client, to CICS application resources.
• Client - The URIMAP definition is for CICS as an HTTP client. It is used when CICS makes a request for an HTTP resource on a remote server, so that you can avoid identifying the URL in your application program.
• Pipeline - The URIMAP definition is for a web service. It is used to specify the processing that is to be performed on a request by which a client invokes a web service in CICS.
• Atom - The URIMAP definition is for an Atom service. It is used to specify the processing that is to be performed on a request by which a client invokes an Atom service in CICS.
• JVMSERVER - The URIMAP definition is for a JVM server. It is used to specify the processing that is to be performed on a request by which a client invokes a Java service in CICS.

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.

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.

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.

For USAGE(SERVER), USAGE(JVMSERVER), or USAGE(PIPLEINE), the 8 character user ID under which the alias transaction will be attached.

The version number of the BAS resource definition, from 1 to 15. This field is ignored for CICS CSD resource definitions.

For USAGE(PIPELINE), the name of the WEBSERVICE resource definition for the web service that handles the incoming HTTP request.