Changes to CICSPlex® SM application programming interface

New resource tables

The following have been introduced:

URIMAP resource table

The URIMAP resource table has the following SPI attributes:
URIMAP
URIMAP name
ENABLESTATUS
Shows the CVDA value that indicates whether the map is to be installed in ENABLED or DISABLED state.
USAGE
Shows the CVDA value of Server, Client, or Pipeline indicating whether the map is respectively for CICS® as an HTTP server, CICS as an HTTP client, or Web services.
SCHEME
Shows the CVDA value which indicates whether the scheme component of the URI to which the URI map applies is without SSL (HTTP) or with SSL (HTTPS).
HOST
Shows the 116-character host component of the URI to which the map applies.
PATH
Shows the 255-character path component of the URI to which the map applies.
MEDIATYPE
Shows the 56-character data content of the static response that CICS provides to the inbound HTTP request.
CHARACTERSET
Shows the 40-character name of the character set to which CICS converts the static response that is sent to the inbound HTTP request.
HOSTCODEPAGE
Shows the 10-character name of the IBM® codepage (EBCDIC) in which the text document that forms the static response is encoded.
TEMPLATENAME
Shows the 48-character name of a CICS document template that forms the static response.
HFSFILE
Shows the 255-character fully-qualified name of the UNIX system services HFS file which forms the static response sent to an inbound HTTP request.
TCPIPSERVICE
Shows the 8-character name of the TCPIPSERVICE resource definition that defines the inbound port to which the URI map applies.
ANALYZER
Shows the CVDA value (YES or NO) which shows whether or not an analyzer program is to be involved in processing the inbound HTTP request.
CONVERTER
Shows the 8-character name of a converter program which is to process the content of the request.
TRANSACTION
Shows the 4-character name of an alias transaction used to run the user application that composes a response.
PROGRAM
Shows the 8-character name of the user application program or XML service that specifies the service that deals with the request.
PIPELINE
Shows the 8-character name of the Pipeline that specifies the service that deals with the request.
WEBSERVICE
Shows the 32-character name of the Web service that specifies the service that deals with the request.
USERID
Shows the 8-character user-ID used to attach the alias transaction.
CERTIFICATE
Shows the 32-character label of the certificate to be used as the SSL client certificate when the URI is used for an outbound HTTPS request.
CIPHERS
Start of changeShows a string of up to 56 hexadecimal digits that is interpreted as a list of up to 28 2-digit cipher suite codes used for outbound SSL requests.End of change
NUMCIPHERS
Number of SSL cipher suite codes
LOCATION
Shows the 255-character URI to which the inbound HTTP request should be redirected.
REDIRECTTYPE
Shows the CVDA value (NONE, TEMPORARY or PERMANENT) for the type of redirection.
MAPREFCOUNT
URI map reference count
MATCHDISABLD
URI map host or path disabled
MATCHREDIREC
URI map host or path redirect

URIMPDEF resource table

The URIMPDEF resource table includes the following RDO attributes:
URIMAP
URI map definition name
STATUS
Shows the CVDA value that indicates whether the map is to be installed in ENABLED or DISABLED state.
USAGE
Shows the CVDA value of Server, Client, or Pipeline indicating whether the map is respectively for CICS as an HTTP server, CICS as an HTTP client, or Web services.
SCHEME
Shows the CVDA value which indicates whether the scheme component of the URI to which the URI map applies is without SSL (HTTP) or with SSL (HTTPS).
HOST
Shows the 116-character host component of the URI to which the map applies.
PATH
Shows the 255-character path component of the URI to which the map applies.
MEDIATYPE
Shows the 40-character data content of the static response that CICS provides to the inbound HTTP request.
CHARACTERSET
Shows the 40-character name of the character set to which CICS converts the static response that is sent to the inbound HTTP request.
HOSTCODEPAGE
Shows the 10-character name of the IBM codepage (EBCDIC) in which the text document that forms the static response is encoded.
TEMPLATENAME
Shows the 48-character name of a CICS document template that forms the static response.
HFSFILE
Shows the 255-character fully-qualified name of the UNIX system services HFS file which forms the static response sent to an inbound HTTP request.
TCPIPSERVICE
Shows the 8-character name of the TCPIPSERVICE resource definition that defines the inbound port to which the URI map applies.
ANALYZER
Shows the CVDA value (YES or NO) which shows whether or not an analyzer program is to be involved in processing the inbound HTTP request.
CONVERTER
Shows the 8-character name of a converter program which is to process the content of the request.
TRANSACTION
Shows the 4-character name of an alias transaction used to run the user application that composes a response.
PROGRAM
Shows the 8-character name of the user application program or XML service that specifies the service that deals with the request.
PIPELINE
Shows the 8-character name of the Pipeline that specifies the service that deals with the request.
WEBSERVICE
Shows the 32-character name of the Web service that specifies the service that deals with the request.
USERID
Shows the 8-character user ID used to attach the alias transaction.
CERTIFICATE
Shows the 32-character certificate label to be used as the SSL client certificate when the URI is used for an outbound HTTPS request.
CIPHERS
Start of changeShows a string of up to 56 hexadecimal digits that is interpreted as a list of up to 28 2-digit cipher suite codes used for outbound SSL requests.End of change
LOCATION
Shows the 255-character URI to which the inbound HTTP request should be redirected.
REDIRECTTYPE
Shows the CVDA value (NONE, TEMPORARY or PERMANENT) for the type of redirection.

URIMPGBL resource table

The URIMPGBL resource table includes the following attributes:

MAPREFCOUNT
URI map reference count
MATCHDISABLD
URI map host or path disabled
NOMATCHCOUNT
URI map host or path no match count
MATCHCOUNT
URI map host or path match count
MATCHREDIREC
URI map host or path redirect
MATCHANALYZE
URI map host or path match analyzer
STATICONTENT
URI map static content
DYNAMCONTENT
URI map dynamic content
PIPELINEREQS
URI map pipeline requests
SCHEMEHTTP
URI map scheme (HTTP) requests
SCHEMEHTTPS
URI map scheme (HTTPS) requests
HOSTDISABLED
Host disabled count

HOST resource table

The HOST resource table has the following attributes:
HOSTNAME
Host name
ENABLESTATUS
Shows the CVDA value that indicates whether the host is to be installed in ENABLED or DISABLED state.

Changes to resource tables

TCPDEF resource table

The TCPDEF resource table has the following additional attributes:
PROTOCOL CVDA (USER)
Protocol
MAXDATALEN
Defines the maximum length of data that may be received or sent

Start of changeThe PRIVACY attribute in this resource table is no longer valid in CICS Transaction Server 3.1 (or later versions) and will be ignored.End of change

DOCTEMP resource table

The DOCTEMP resource table has the following additional attributes:
HFSFILE
UNIX Sytem Service Hierarchical File System template file
TEMPLATETYPE
Document template type

DOCDEF resource table

The DOCDEF resource table includes the following attribute:
HFSFILE
Hierarchical File System template file

TASK resource table

The TASK resource table includes the following attributes:
TMRWBRDL
Shows the data length of data read from the repository
TMRWBWDL
Shows the data length of data written to the repository