A CICS definition that describes the universal resource identifier (URI) of requests from web clients or requests to a remote server.
The Primary key field for this resource class is NAME .
The following actions are supported:
The parameter data for the INSTALL action is described in Parameters for installing CICS Definitions.
PARM(' [ERRQUEUE] RESGROUP(value) .')
API Actions
PARM(' [NOTIFY(value)] USAGE(value) [FORCEINS(value)] [STATECHK(value)] [MODE(value)] [OVERTYPE(value)] [OVERRIDE(override)] TARGET(value) [RELATED(value)] .')
PARM(' [ERRQUEUE] RESGROUP(value) .')
Code | Description | Code | Description |
DIFF_VERSION | Different version | INV_RESTYPE | Invalid resource type |
EARLY_NAMELIST_END | Early name list end | INV_RSCOPE | Invalid related scope |
INCONSISTENT_SET | Inconsistent set condition | INV_STATECHK | Invalid state check |
INV_ACTION | Invalid action | INV_STRNGTERM | Invalid string term |
INV_ATTRIBUTE | Invalid attribute | INV_TSCOPE | Invalid target scope |
INV_CONTEXT | Context not found | INV_USAGE | Invalid usage |
INV_DATA | Attribute data invalid | INV_VER | Invalid resource version |
INV_EMBEDTERM | Invalid embedded terminator | MISSING_RELSYSID | Missing related system identifier |
INV_FORCEINS | Invalid force install | MORE_THAN_1_RELSYS | More than one related system |
INV_LITERAL | Invalid literal | NODEFS_SELECTED | No definitions selected |
INV_MINNAME | Invalid minor name | NON_MP | Maintenance point CMAS not available |
INV_MODE | Invalid mode | NOTHING_INSTALLED | Nothing installed |
INV_NAME | Invalid name | NOTIFY | Notify |
INV_NAMELIST | Invalid name list | NO_RELATED | No related systems |
INV_NOTIFY | Invalid notify | NO_TARGETS | No targets |
INV_ORSTGNA | Invalid override string | PARTIAL_INSTALL | Partial install |
INV_ORSTRING | Invalid override string | REC_CHANGED | Resource definition already changed |
INV_OVERTYPE | Invalid over type | REC_EXISTS | Resource already exists |
INV_OVRBLOCK | Invalid override block | REC_NOT_FOUND | Requested resource not found |
INV_RECADDR | Invalid record address | SCOPE_CONFLICT | Scope conflict |
INV_RECLEN | Invalid record length | SCOPE_REQUIRED | Scope required |
INV_RESGROUP | Resource group not found | USAGE_CONFLICT | Usage conflict |
Name | Datatype | Source | Len | Req | Sum | Description | Default | Value Range | Attr ID |
---|---|---|---|---|---|---|---|---|---|
CHANGETIME | DATETIME | CPSM | 8 | Yes | MAX | Last time the definition was changed | 1 | ||
DEFVER-2 | BINARY | CPSM | 1 | Yes | AVG | Definition version | 0 | 0-15 | 5 |
NAME-1 | CHAR | CPSM | 8 | Yes | DIF | URI map definition name | 7 | ||
CREATETIME | DATETIME | CPSM | 8 | Yes | MAX | Definition creation time | 9 | ||
USERDATA1 | CHAR | CPSM | 8 | No | DIF | User data area 1 | 10 | ||
USERDATA2 | CHAR | CPSM | 8 | No | DIF | User data area 2 | 11 | ||
USERDATA3 | CHAR | CPSM | 8 | No | DIF | User data area 3 | 12 | ||
DESCRIPTION | CHAR | CPSM | 58 | No | DIF | Definition description | 13 | ||
STATUS | CVDAS | CPSM | 4 | Yes | LIKE | Enabled status | ENABLED | 15 | |
STATUS Input/Output Valid Values | ENABLED DISABLED | ||||||||
USAGE | CVDAS | CPSM | 4 | Yes | LIKE | URI map usage type | SERVER | 16 | |
USAGE Input/Output Valid Values | SERVER CLIENT PIPELINE | ||||||||
SCHEME | CVDAS | CPSM | 4 | Yes | LIKE | Scheme component of URI to which the map applies | HTTP | 17 | |
SCHEME Input/Output Valid Values | HTTP HTTPS | ||||||||
HOST | CHAR | CPSM | 116 | Yes | DIF | Host component of URI to which the map applies | 18 | ||
PATH | CHAR | CPSM | 255 | Yes | DIF | Path component of URI to which the map applies | 19 | ||
MEDIATYPE | CHAR | CPSM | 56 | No | DIF | Static data response to the inbound HTTP request | 20 | ||
CHARACTERSET | CHAR | CPSM | 40 | No | DIF | Character set of CICS response to the HTTP request | 21 | ||
HOSTCODEPAGE | CHAR | CPSM | 10 | No | DIF | Code page in which the static response is encoded | 22 | ||
TEMPLATENAME | CHAR | CPSM | 48 | No | DIF | Document template to form the static response | 23 | ||
HFSFILE | CHAR | CPSM | 255 | No | DIF | Qualified HFS file to form the static response | 24 | ||
TCPIPSERVICE | CHAR | CPSM | 8 | No | DIF | Inbound TCP/IP service relating to this URI map | 25 | ||
ANALYZER | EYUDA | CPSM | 4 | No | LIKE | Use an analyzer program to process HTTP request | NO | 26 | |
ANALYZER Input/Output Valid Values | NO YES | ||||||||
CONVERTER | CHAR | CPSM | 8 | No | DIF | Converter program to process request content | 27 | ||
TRANSACTION | CHAR | CPSM | 4 | No | DIF | Alias transaction to run application for response | CWBA | 28 | |
PROGRAM | CHAR | CPSM | 8 | No | DIF | Application program that will process the request | 29 | ||
PIPELINE | CHAR | CPSM | 8 | No | DIF | Pipeline that will process the request | 30 | ||
WEBSERVICE | CHAR | CPSM | 32 | No | DIF | Web service that will process the request | 31 | ||
USERID | CHAR | CPSM | 8 | No | DIF | The user ID to attach the alias transaction | 32 | ||
CERTIFICATE | CHAR | CPSM | 32 | No | DIF | SSL client certificate for outbound HTTPS request | 33 | ||
CIPHERS | CHAR | CPSM | 56 | No | DIF | Cipher suite codes to be used for outbound SSL | 34 | ||
LOCATION | CHAR | CPSM | 255 | No | DIF | URI to which to redirect the inbound HTTP request | 35 | ||
REDIRECTTYPE | CVDAS | CPSM | 4 | Yes | LIKE | Type of redirection | NONE | 37 | |
REDIRECTTYPE Input/Output Valid Values | NONE TEMPORARY PERMANENT |