URIMAP definition attributes

Read syntax diagramSkip visual syntax diagram
>>-URIMAP(name)--GROUP(groupname)--+-------------------+-------->
                                   '-DESCRIPTION(text)-'   

   .-STATUS(ENABLED)--.              .-SCHEME(HTTP)--.   
>--+------------------+--PATH(path)--+---------------+---------->
   '-STATUS(DISABLED)-'              '-SCHEME(HTTPS)-'   

   .-USAGE(SERVER)-| SERVER attributes  |----.   
>--+-----------------------------------------+-----------------><
   +-USAGE(CLIENT)-| CLIENT attributes  |----+   
   '-USAGE(PIPELINE)-| PIPELINE attributes |-'   

SERVER attributes

|--+-HOST(hostname)-+--+--------------------+------------------->
   '-HOST(*)--------'  '-TCPIPSERVICE(name)-'   

>--+--------------------------------------------------------------------------------------------------+-->
   +-MEDIATYPE(type)--CHARACTERSET(characterset)--HOSTCODEPAGE(codepage)--+-TEMPLATENAME(name)-+------+   
   |                                                                      '-HFSFILE(name)------'      |   
   | .-ANALYZER(YES)-.                                                                                |   
   '-+---------------+--+-----------------+--+-------------------+--+---------------+--+------------+-'   
     '-ANALYZER(NO)--'  '-CONVERTER(name)-'  '-TRANSACTION(name)-'  '-PROGRAM(name)-'  '-USERID(id)-'     

>--+--------------------------------------------+---------------|
   | .-REDIRECTTYPE(NONE)------.                |   
   '-+-------------------------+--LOCATION(url)-'   
     +-REDIRECTTYPE(TEMPORARY)-+                    
     '-REDIRECTTYPE(PERMANENT)-'                    

CLIENT attributes

|--HOST(hostname)--+--------------------+--+----------------+---|
                   '-CERTIFICATE(label)-'  '-CIPHERS(value)-'   

PIPELINE attributes

|--+-HOST(hostname)-+--PIPELINE(name)--+------------------+----->
   '-HOST(*)--------'                  '-WEBSERVICE(name)-'   

>--+--------------------+--+-------------------+---------------->
   '-TCPIPSERVICE(name)-'  '-TRANSACTION(name)-'   

>--+------------+----------------------------------------------->
   '-USERID(id)-'   

>--+--------------------------------------------+---------------|
   | .-REDIRECTTYPE(NONE)------.                |   
   '-+-------------------------+--LOCATION(url)-'   
     +-REDIRECTTYPE(TEMPORARY)-+                    
     '-REDIRECTTYPE(PERMANENT)-'                    

ANALYZER({NO|YES})
This attribute is for USAGE(SERVER), where an application-generated response is to be provided. (For USAGE(CLIENT) or USAGE(PIPELINE), the attribute is forced to NO.) It 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.) YES runs the analyzer. NO means that the analyzer is not used.
Acceptable characters:
A-Z 0-9 $ @ #
Unless you are using the CREATE command, any lowercase characters you enter are converted to uppercase.
Note: As supplied, the CICS-supplied default analyzer DFHWBAAX and sample analyzer DFHWBADX do not perform any analysis of a request when a matching URIMAP definition has been found for the request, even if the URIMAP specifies ANALYZER(YES).

If an analyzer program is used, you can still specify the CONVERTER, TRANSACTION, USERID, and PROGRAM attributes. The values that you specify for these attributes are used as input to the analyzer program, but they can be overridden by it. Alternatively, you can leave these attributes blank and let the analyzer program specify them.

CERTIFICATE(label)
This attribute is for USAGE(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. Building a key ring manually tells you how to do this.
CIPHERS(value)
This attribute is for USAGE(CLIENT).
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 the CEDA transaction to define the resource, CICS automatically initializes the attribute with a default list of acceptable codes. Start of changeFor CICS to initialize the attribute, the KEYRING system initialization parameter must be specified in the CICS region where you are running CEDA. If KEYRING is not set, CICS does not initialize the attribute.End of change The default list of codes depends on the level of encryption that is specified by the ENCRYPTION system initialization parameter.
  • For ENCRYPTION=WEAK, the default value is 03060102
  • For ENCRYPTION=MEDIUM, the initial value is 0903060102
  • For ENCRYPTION=STRONG, the initial value is 0504352F0A0903060102

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 of the cipher suite codes and the field will automatically repopulate with the default list.

See Cipher suites for more information.

CHARACTERSET(characterset)
This attribute is for USAGE(SERVER), where a static response is to be provided. 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 lists the IANA character sets that are supported by CICS. Note that where a CICS document is used (TEMPLATENAME attribute), the UTF-8 and UTF-16 character encodings are not supported. The value of this attribute is included in the Content-Type header of the response.

CHARACTERSET must be specified if a static response is being provided and the MEDIATYPE attribute specifies a text type.

CONVERTER(name)
This attribute is for USAGE(SERVER), where an application-generated response is to be provided. It specifies the 1-8 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.
Acceptable characters:
A-Z 0-9 $ @ #
Unless you are using the CREATE command, any lowercase characters you enter are converted to uppercase.
There is no association between the converter program and the TCPIPSERVICE definition, as there is for the analyzer program.

If the ANALYZER attribute is specified as YES, the CONVERTER attribute is used as input to the analyzer program, but it can be overridden by the analyzer program. If a converter program is used, you can still specify the PROGRAM attribute of the URIMAP definition, but the values that you specify for this attribute can be overridden by the converter program. Alternatively, you can leave this attribute blank and let the converter program specify it.

DESCRIPTION(text)
You can provide a description of the resource you are defining in this field. The description text can be up to 58 characters in length. There are no restrictions on the characters that you can use. However, if you use parentheses, ensure that for each left parenthesis there is a matching right one. If you use the CREATE command, for each single apostrophe in the text, code two apostrophes.
GROUP(groupname)
Every resource definition must have a GROUP name. The resource definition becomes a member of the group and is installed in the CICS system when the group is installed.
Acceptable characters:
A-Z 0-9 $ @ #
Any lower case characters you enter are converted to upper case.

The GROUP name can be up to eight characters in length. Lowercase characters are treated as uppercase characters. Do not use group names beginning with DFH, because these characters are reserved for use by CICS.

HFSFILE(name)
This attribute is for USAGE(SERVER), where a static response is to be provided. 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. The name can be specified as an absolute path including all directories and beginning with a slash, for example, /u/facts/images/bluefish.jpg. Alternatively, it can be specified as a path relative to the HOME directory of the CICS region userid, for example, facts/images/bluefish.jpg. Up to 255 characters can be used. Start of change
Acceptable characters:
A-Z a-z 0-9 . / _ # @
For information about entering mixed case information, see Entering mixed case attributes.
End of change
The value specified must be a valid name for an HFS file:
  • The name must not contain imbedded space characters
  • The name must not contain consecutive instances of the / character
The name is case-sensitive.
Note: Resource level security is not applied to items delivered as a static response. If you need to apply access controls based on a user ID to an item delivered in this way, you need to deliver the material as an application-generated response instead.

If TEMPLATENAME or HFSFILE is specified, ANALYZER must be set to NO, and the other attributes relating to application-generated responses (TRANSACTION, CONVERTER, PROGRAM, and USERID) must be left blank.

If you want to use path matching, include an asterisk as a wildcard character at the end of the path for the HFS file, and also at the end of the path specified by the PATH attribute. CICS takes the portion of each HTTP request's path that is covered by the wildcard character, and substitutes this as the last part of the file path.

For example, you could create a URIMAP definition with the PATH attribute specified as:
findout/pictures/*
and the HFSFILE attribute specified as:
/u/facts/images/*
The URIMAP definition is used to process an incoming HTTP request
http://www.example.com/findout/pictures/bluefish.jpg
CICS appends bluefish.jpg to the HFS file path specified in the URIMAP definition in place of the asterisk, so that the HFS file
/u/facts/images/bluefish.jpg
is used as the static response.
Note: You cannot use an asterisk alone in the HFSFILE specification. At least one level of the directory structure must be specified.

A query string cannot be substituted into an HFS file (unless you define the HFS file as a CICS document template, and specify it using the TEMPLATENAME option instead of the HFSFILE option).

HOST(hostname|Start of change*End of change)
This attribute is for all USAGE options. It specifies the host component of the URI to which the URIMAP definition applies, which can be up to 116 characters. An example of a host name is www.example.com. The components of a URL explains each of the components and how they are delimited.

The HOST attribute must be present, and must contain only alphanumeric characters, hyphens (-) or periods (.). Hexadecimal escape sequences cannot be used in a host name. CICS validates this at define time. The host name can be entered in any case, but it is converted to lower case in the URIMAP definition.

An IPv4 address can be used as a host name, but IPv6 addresses are not supported.

Start of changeWhen USAGE(SERVER) or USAGE(PIPELINE) is specified, a single asterisk can be used as the HOST attribute. This makes the URIMAP definition match any host name. An asterisk cannot be used as a wildcard in the HOST attribute along with any other characters.End of change

For URIMAP definitions relating to CICS as an HTTP client, USAGE(CLIENT), if you need to specify a port number in the URL for the request to the server, include it in the HOST attribute, together with the colon preceding it. You only need to specify the port number if it is other than the default for the scheme (80 for HTTP without SSL, or 443 for HTTPS, HTTP with SSL).

HOSTCODEPAGE(codepage)
This attribute is for USAGE(SERVER), where a static response is to be provided. It specifies the 1-10 character name of the IBM code page (EBCDIC) in which the text document that forms the static response is encoded. This information is needed by CICS to perform code page conversion for the entity body of the static response.

HOSTCODEPAGE must be specified if a static response is being provided and the MEDIATYPE attribute specifies a text type.

LOCATION(url)
This attribute is for USAGE(SERVER) and USAGE(PIPELINE). It specifies a URL of up to 255 characters to which the client's request should be redirected. This must be a complete URL, including scheme, host, and path components, and appropriate delimiters. CICS does not check that the URL is valid, so you must ensure that the destination exists and that the URL is specified correctly.

Start of changeThe description for the PATH attribute lists the characters that should be excluded from a URL. These characters must not be used in the LOCATION attribute. The exception is the # character, which can be used in the LOCATION attribute as a separator before a fragment identifier which follows the URL.End of change

The REDIRECTTYPE attribute is used to specify the type of redirection. If temporary or permanent redirection is specified, the URL in the LOCATION attribute is used for redirection. If no redirection is specified, the URL in the LOCATION attribute is ignored. You can use the SET URIMAP command to change the REDIRECTTYPE attribute and the LOCATION attribute.

MEDIATYPE(type)
This attribute is for USAGE(SERVER), where a static response is to be provided. It 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. The media type must contain exactly one forward slash (/). The media type can be entered in any case, but it is converted to lower case in the URIMAP definition.

The name for each formally recognized type of data content is defined by IANA. A list is available at http://www.iana.org/assignments/media-types/. CICS creates a Content-Type header for the response using the value of this attribute.

There is no default for this attribute, and it must be specified. If the MEDIATYPE attribute specifies a text type (such as a type that begins with text/, or a type that contains +xml), the CHARACTERSET and HOSTCODEPAGE attributes must also be specified so that code page conversion can take place. Text media types are identified by RFC 3023, which is available at http://www.ietf.org/rfc/rfc3023.txt.

For a dynamic (application-generated) response, this attribute is not used. The media type for the response is specified by the WEB SEND command.

PATH(path)
This attribute is for all USAGE options. It specifies the path component of the URI to which the URIMAP definition applies, which can be up to 255 characters. An example of a path is software/htp/cics/index.html. The components of a URL explains each of the components and how they are delimited. The minimum possible path is a / (forward slash), which represents the root of the URL structure for the specified host name. For paths that have content beyond this minimum, the forward slash at the beginning of the path component can either be included or omitted. If you omit it, CICS adds it at runtime.

The PATH attribute is specified in mixed case, and the case is preserved in the URIMAP definition. The PATH attribute must contain only the characters allowed in URIs. Specifically, the characters < > # % “ { } | \ ^ [ ] ` and imbedded blanks should be excluded (except that % should be allowed when it introduces a valid hexadecimal escape sequence: that is, when it is followed by two valid hexadecimal digits in upper or lower case). The tilde character (~) cannot be specified in CICS and must be replaced by the corresponding hexadecimal escape sequence (%7E). CICS validates the use of characters at define time.

For URIMAP definitions relating to CICS as an HTTP server and Web services, if you want the URIMAP definition to match more than one path, you can use an asterisk as a wildcard character at the end of the path. For example, specifying the path /software/htp/cics/* would make the URIMAP definition match all requests whose path begins with the string to the left of the asterisk. Specifying a path of /* makes the URIMAP definition match any requests directed to the host named in the HOST attribute. If an HTTP request is matched by more than one URIMAP definition, the most specific match is taken.

If a query component is present, and you want to apply the URIMAP definition to that specific query alone, you can include this as part of the path component. Include the question mark at the beginning of the string. The query string must contain only the characters allowed in URIs. A query string may not itself include an asterisk as a wildcard, but it may follow a path that includes an asterisk as a wildcard. If you do not include a query string in the URIMAP definition, any query string that is present in the HTTP request is automatically ignored for matching purposes.

For URIMAP definitions for CICS as an HTTP client, you cannot use an asterisk as a wildcard; you must specify the complete path for the request. If the URIMAP definition is referenced on a WEB OPEN command, this path becomes the default path for WEB SEND commands relating to that connection. If the URIMAP definition is referenced on a WEB SEND command, the path is used for that WEB SEND command, but note that the host attribute for that URIMAP definition must match the host specified on the WEB OPEN command for the connection.

PIPELINE(name)
This attribute is for USAGE(PIPELINE). When a client makes an inbound Web service request to CICS with the URI specified by this URIMAP definition, PIPELINE specifies the 1-8 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. PIPELINE resource definitions describes these resource definitions.
Acceptable characters:
A-Z 0-9 $ @ #
Unless you are using the CREATE command, any lowercase characters you enter are converted to uppercase.
PROGRAM(name)
This attribute is for USAGE(SERVER), where an application-generated response is to be provided. It specifies the 1-8 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.
Acceptable characters:
A-Z 0-9 $ @ #
Unless you are using the CREATE command, any lowercase characters you enter are converted to uppercase.

If the ANALYZER attribute is specified as YES, or a converter program is specified using the CONVERTER attribute, the PROGRAM attribute is used as input to the analyzer or converter program, but it can be overridden by those programs. Alternatively, you can leave this attribute blank and let the analyzer or converter program specify it.

REDIRECTTYPE({NONE|TEMPORARY|PERMANENT})
This attribute is for USAGE(SERVER) and USAGE(PIPELINE). It 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.
  • NONE means that requests are not redirected. Any URL specified by the LOCATION attribute is ignored.
  • TEMPORARY means that requests are redirected on a temporary basis. The URL specified by the LOCATION attribute is used for redirection, and the status code used for the response is 302 (Found).
  • PERMANENT means that requests are redirected permanently. The URL specified by the LOCATION attribute is used for redirection, and the status code used for the response is 301 (Moved Permanently).

You can use the SET URIMAP command to change the REDIRECTTYPE attribute and the LOCATION attribute.

If REDIRECTTYPE(TEMPORARY) or REDIRECTTYPE(PERMANENT) is specified when creating a URIMAP definition, the following attributes are optional: ANALYZER, CONVERTER, HFSFILE, PIPELINE, PROGRAM, TEMPLATENAME, TRANSACTION, USERID, and WEBSERVICE. If you use a CEMT or EXEC CICS command to set the REDIRECTTYPE attribute to NONE after the URIMAP definition is installed, any of the listed attributes that were specified in the URIMAP definition are activated.

SCHEME({HTTP|HTTPS})
This attribute is for all USAGE options. It specifies the scheme component of the URI to which the URIMAP definition applies, which is either HTTP (without SSL) or HTTPS (with SSL). Do not include the delimiters :// (colon and two forward slashes) that follow the scheme component in the URI.
Note: A URIMAP specifying the HTTP scheme accepts Web client requests made using either the HTTP scheme, or the HTTPS scheme. A URIMAP specifying the HTTPS scheme accepts only Web client requests made using the HTTPS scheme.
STATUS({ENABLED|DISABLED})
This attribute is for all USAGE options. It specifies whether the URIMAP definition is to be installed in an enabled or disabled state. The default is enabled.
TCPIPSERVICE(name)
This attribute is for USAGE(SERVER) and USAGE(PIPELINE). It specifies the 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.
Acceptable characters:
A-Z 0-9 $ @ #
Unless you are using the CREATE command, any lowercase characters you enter are converted to uppercase.

When a URIMAP definition with HTTPS as the scheme matches a request that a Web client is making, CICS checks that the inbound port used by the request is using SSL. If SSL is not specified for the port, the request is rejected with a 403 (Forbidden) status code. When the URIMAP definition applies to all inbound ports, this check ensures that a Web client cannot use an unsecured port to access a secured resource. No check is carried out for a URIMAP definition that specifies HTTP as the scheme, so Web clients can use either unsecured or secured (SSL) ports to access these resources.

Note: The TCPIPSERVICE resource definition is the place where you specify the security measures that are applied for each port. You can choose whether or not to use SSL, and if you do use SSL, you need to choose the exact security measures that are applied (for example, the authentication method, the sending of certificates by client and server, and encryption of messages). Read Security for CICS Web support for more information about the security features that you can use to keep your CICS Web support facility safe.
TEMPLATENAME(name)
This attribute is for USAGE(SERVER), where a static response is to be provided. It 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. It must be defined using a DOCTEMPLATE resource definition, and the TEMPLATENAME attribute of that definition specifies the name that is used in the URIMAP definition. See the CICS Application Programming Guide for instructions on forming a CICS document template.
Acceptable characters:
A-Z a-z 0-9 $ @ # . / - _ % & ¢ ? ! : | " = ¬ , ; < >
For information about entering mixed case information, see Entering mixed case attributes.
Note: Resource level security is not applied to items delivered as a static response. If you need to apply access controls based on a user ID to an item delivered in this way, you need to deliver the material as an application-generated response instead.

If TEMPLATENAME or HFSFILE is specified, ANALYZER must be set to NO, and the other attributes relating to application-generated responses (TRANSACTION, CONVERTER, PROGRAM, and USERID) must be left blank.

If you want to use path matching, include an asterisk as a wildcard character at the end of the name of the CICS document template, and also at the end of the path specified by the PATH attribute. CICS takes the portion of each HTTP request's path that is covered by the wildcard character, and substitutes this as the last part of the template name.

For example, you could create a URIMAP definition with the PATH attribute specified as:
findout/about/*
and the TEMPLATENAME attribute specified as:
templates.facts.*
The URIMAP definition is used to process an incoming HTTP request
http://www.example.com/findout/about/fish.html
CICS appends fish.html to the template name specified in the URIMAP definition in place of the asterisk, so that the template
templates.facts.fish.html
is used to form the static response.
Note: Specifying an asterisk alone for the TEMPLATENAME attribute means that the selected template will have the same name as the part of the URL that corresponds to the wildcard character in the PATH attribute.

When the TEMPLATENAME attribute is specified, if a query string is present on the URI, but is not used in the PATH attribute, CICS automatically passes the content of the query string into the named CICS document template as a symbol list. If you want to use the content of the query string in the document template, you need to include appropriate variables in your document template to be substituted for the content of the query string.

TRANSACTION(name)
This attribute is for USAGE(SERVER), where an application-generated response is to be provided, and USAGE(PIPELINE). It 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.
Acceptable characters:
A-Z a-z 0-9 $ @ # . / - _ % & ¢ ? ! : | " = ¬ , ; < >
For information about entering mixed case information, see Entering mixed case attributes.
The default alias transaction is CWBA for USAGE(SERVER), or CPIH for USAGE(PIPELINE). You can select a different transaction name for the purposes of security, monitoring and accounting, or transaction class limitation. Whatever name you choose for the alias transaction, it must always run the same program, which is determined by the USAGE attribute. For USAGE(SERVER), the program is DFHWBA, which links to the application program named in the PROGRAM attribute of the URIMAP definition (or named by the analyzer program). For USAGE(PIPELINE), the program is DFHPIDSH, which starts the pipeline named in the PIPELINE attribute (and the Web service named in the WEBSERVICE attribute, if specified).

For USAGE(SERVER), if the ANALYZER attribute is specified as YES, the TRANSACTION attribute is used as input to the analyzer program, but the analyzer program can override it. Alternatively, you can leave this attribute blank and let the analyzer program specify it. (For USAGE(PIPELINE), the analyzer is not used.)

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.
Acceptable characters:
A-Z 0-9 $ @ #
For information about entering mixed case information, see Entering mixed case attributes.
USAGE({SERVER|CLIENT|PIPELINE})
Specifies whether this URIMAP definition is for CICS as an HTTP server (SERVER), CICS as an HTTP client (CLIENT), or a Web service (PIPELINE). The USAGE attribute governs which other attributes in the URIMAP definition can be used.

Specifying SERVER creates a URIMAP definition for CICS as an HTTP server. This type of URIMAP definition is used to map the URI of an incoming HTTP request from a Web client, to CICS resources. An application-generated response or a static response can be provided.

Specifying CLIENT creates a URIMAP definition for CICS as an HTTP client. This type of URIMAP definition is used when CICS makes a request for an HTTP resource on a server, so that you can avoid identifying the URI in your application program.

Specifying PIPELINE creates a URIMAP definition for a Web service. This type of URIMAP definition is used for an inbound Web service request (that is, a request by which a client invokes a Web service in CICS). The URI of the incoming request is associated with WEBSERVICE and PIPELINE resources, which specify the processing that is to be performed on the message.

USERID(id)
This attribute is for USAGE(SERVER), where an application-generated response is to be provided, and USAGE(PIPELINE).

USERID specifies a 1- to 8-character default user ID that can be used by any client. For an application-generated response or a web service, the alias transaction is attached under this user ID.

Start of changeWhen authentication is required for the connection, so that CICS requests an authenticated user ID directly from the client, the default user ID that you specify in the URIMAP definition is not used. The authenticated user ID of the client is used instead, or if authentication fails, the request is rejected. Authentication procedures are specified by the AUTHENTICATE attribute of the TCPIPSERVICE definition for the connection.End of change

If ANALYZER(YES) is specified, a user ID from a URIMAP definition or from the client can be changed by the analyzer program, or the analyzer program can set a user ID. If no user ID is specified by any of these means, the default user ID is the CICS default user.

For USAGE(SERVER), if the ANALYZER attribute is specified as YES, the USERID attribute is used as input to the analyzer program, but the analyzer program can override it. Alternatively, you can leave this attribute blank and let the analyzer program specify it. (For USAGE(PIPELINE), the analyzer is not used.)

If surrogate user checking is enabled in the CICS region (with XUSER=YES specified as a system initialization parameter), CICS checks that the user ID used to install the URIMAP definition, is authorized as a surrogate of the user ID specified for the USERID attribute. Where surrogate user checking applies explains surrogate user checking.

WEBSERVICE(name)
This attribute is for USAGE(PIPELINE). When a client makes an inbound Web service request to CICS with the URI specified by this URIMAP definition, WEBSERVICE specifies the name of the Web service. This can be the 1-8 character name of a WEBSERVICE resource definition, or a name up to 32 characters (in mixed case) representing a Web service generated by the CICS Web services assistant.
Acceptable characters:
A-Z a-z 0-9 $ @ # . / - _ % & ¢ ? ! : | " = ¬ , ; < >
For information about entering mixed case information, see Entering mixed case attributes.
A Web service definition defines aspects of the run time environment for a CICS application program deployed in a Web services setting, where the mapping between application data structure and SOAP messages has been generated using CICS-supplied tools. WEBSERVICE resource definitions describes these resource definitions.