UPDATE RTCDESC command

A descriptor is a model that can be used to create descriptors or resources. Updating a descriptor changes only the attributes explicitly specified on the UPDATE command. Attributes not specified retain their existing values. Any routing code resource or descriptor can be created using this descriptor as a model, by specifying the CREATE LIKE(DESC(descriptor_name)) command. Any descriptor or resource that was already created using this descriptor is not updated.

Subsections:

• Environment
• Syntax
• Keywords
• Usage notes
• Output fields
• Return, reason, and completion codes
• Examples

Environment

The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the commands and keywords.

Syntax

                              .-,----.     
                              V      |     
>>-+-UPDATE-+--RTCDESC--NAME(---name-+-)------------------------>
   '-UPD----'                              

          .-,----------------.                           
          V                  |                           
>----SET(---+-DEFAULT(Y)---+-+-)----+----------------+---------><
            +-INQ(-+-N-+-)-+        '-OPTION(ALLRSP)-'   
            |      '-Y-'   |                             
            '-PGM(name)----'                             

Keywords

The following keywords are valid for the UPDATE RTCDESC command:

NAME

Specifies the 1-8 character name of the routing code descriptor. Wildcards can be specified in the name. The name is a repeatable parameter. If the NAME parameter specified is a specific or wildcard name, command responses are returned for all the descriptor names that are processed. For NAME(*), command responses are returned only for the descriptor names that resulted in an error. OPTION(ALLRSP) can be specified with NAME(*) to obtain the command responses for all the descriptor names that are processed.

OPTION

Specifies additional functions to be performed along with the command.

ALLRSP

Indicates that the response lines are to be returned for all descriptors that are processed on the command. The default action is to return response lines only for the descriptors that resulted in an error. It is valid with NAME(*) only. ALLRSP is ignored for other NAME values.

SET

Specifies the attribute values to be changed.

DEFAULT(Y)

Specifies this descriptor as the default, which resets the existing default descriptor to DEFAULT(N). When a descriptor or resource is created without the LIKE keyword, any attribute not specified on the CREATE command takes the value defined in the default descriptor. Only one descriptor can be defined as the default for a resource type. IMS™ defines a routing code descriptor called DBFDSRT1, where all attributes are defined with the default value. Defining a user-defined descriptor to be the default overrides the current default descriptor. Because only one routing code descriptor can be the default at one time, only one routing code descriptor name can be specified with DEFAULT(Y).

INQ

Specifies the inquiry option.

N

This is not an inquiry routing code.

Y

This is an inquiry routing code. Any message associated with the routing code is an inquiry transaction. This should be specified only for programs that do not cause a change to a database. Programs are prohibited from issuing Insert, Delete, or Replace calls to a database when processing an inquiry transaction.

PGM

The name of the application program associated with the routing code. The program must exist and be defined with a BMPTYPE of N.

Usage notes

If all the attributes specified by the UPDATE command are already defined for the descriptor, no update is actually made, no descriptors are quiesced, no log record is created, and a completion code of zero is returned. This avoids unnecessary overhead when no action needs to be taken.

Descriptors exist for the life of the IMS unless they are deleted using a DELETE command. The descriptors are recoverable across an IMS warm start or emergency restart. Descriptors are lost if IMS is cold started, unless cold start imports definitions that were exported while IMS was up.

The UPDATE RTCDESC command can be issued only through the OM API. Fast Path must be installed on the system. This command applies to DB/DC and DCCTL systems.

This command is not valid on the XRF alternate, RSR tracker, or FDBR region. The UPDATE RTCDESC commands are not valid if online change for MODBLKS is enabled (DFSDFxxx or DFSCGxxx defined with MODBLKS=OLC, or MODBLKS not defined).

These commands are recoverable.

If the descriptor is the IMS-defined routing code descriptor (DBFDSRT1), the only attribute that can be updated is the DEFAULT attribute.

Each descriptor is updated individually. Individual updating does not work like online change where either all descriptors are updated or no descriptors are updated.

Output fields

Return, reason, and completion codes

The following table includes the return and reason codes and a brief explanation of the codes. The return or reason code returned for the command might also indicate an error from a CSL request.

Errors unique to the processing of this command are returned as completion codes. The following table includes an explanation of the completion codes.

Table 4. Completion codes for the UPDATE RTCDESC command

Completion code	Completion code text	Meaning
0		Command completed successfully for routing code descriptor.
10	NO RESOURCES FOUND	Routing code descriptor name is invalid, or the wildcard parameter specified does not match any descriptor names.
17	ANOTHER CMD IN PROGRESS	Another command (such as DELETE or UPDATE) is in progress for this routing code descriptor. This could also mean this command, if the resource is specified by more than one specific or wildcard parameter.
48	NOT ALLOWED FOR IMS RESOURCE	The specified UPDATE command is not allowed for the IMS descriptor or resource. DBFDSRT1 is an example of an IMS descriptor. The only IMS descriptor attribute you can update is DEFAULT(Y).
61	DFSBCB STORAGE ERROR	DFSBCB storage error. Could not get storage for RCTE control block.
7A	RTC/FP=N PGM CONFLICT	Program specified is not Fast Path exclusive.
8A	WILDCARD PARAMETER NOT SUPPORTED	A wildcard parameter was specified with DEFAULT(Y). Only one descriptor can be the default at one time.
90	INTERNAL ERROR	Internal error.
1D7	IMPORT CHANGE LIST ERROR	The descriptor is in the process of being imported from the change list in the IMSRSC repository or was not successfully imported from the change list. The descriptor cannot be updated until it is successfully imported from the repository.