UPDATE LE command

The parameters can be filtered by a transaction code, LTERM name, user ID, or program name for MPP and JMP regions. The parameters may be filtered by a program name for IFB, BMP, and JBP regions. Message driven BMP regions can also filter on a transaction code. Any combination of parameters may be used to qualify the application instance to which the runtime parameters are applied. The first available entry in the table is used. The new entry may be added before or after existing entries, depending on where free space exists in the table.

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) from which the UPDATE LE command and keywords can be issued.

Syntax

>>-+-UPDATE-+--LE----------------------------------------------->
   '-UPD----'       

>--+-SET(LEOPT(-+-NO--+-))--------------------------------------+-><
   |            '-YES-'                                         |   
   | .-,--------------------.                                   |   
   | V                      |                                   |   
   '---+-LTERM(ltermname)-+-+-SET(LERUNOPTS(runtimeparameters))-'   
       +-PGM(programname)-+                                         
       +-TRAN(tranname)---+                                         
       '-USERID(userid)---'                                         

Keywords

The following keywords are valid for the UPDATE LE command:

LTERM()

Specifies the 1-8 character name of the lterm to which the parameters are to be defined.

PGM()

Specifies the 1-8 character name of the program to which the parameters are to be defined.

SET()

Specifies the updates to attributes or parameters.

LEOPT()

Specifies whether LE runtime parameters can be overridden dynamically for all active IMS™ systems in the IMSplex. YES indicates that the IMS systems enable overrides which enables the DL/I INQY call to retrieve runtime parameters. NO indicates that the IMS systems do not enable dynamic overrides to the parameters.

This option allows the user to override the LEOPT=Y|N option that is specified in the DFSCGxxx PROCLIB member without having to bring down the IMS system.

When runtime overrides are disabled (IMS is started with LEOPT=N or the UPD LE SET(LEOPT(NO)) command is issued) the runtime parameter table continues to be updated as UPD LE SET(LERUNOPTS()) or DEL LE commands are issued. If the UPD LE SET(LEOPT(YES)) command is then specified, all changes that were made during the time overrides were disabled are available.

This command is automatically routed to all IMS systems that are active in the IMSplex. The user can not override the OM routing to route to a single IMS.

LERUNOPTS()

Specifies the LE dynamic runtime parameters. If an existing set of parameters is found for the specified TRAN, LTERM, USERID, or PGM, the new parameter string completely replaces the existing parameter string. The parameters are not appended to the existing string. The string is only replaced when the specified filters are an exact match for the existing entry.

If there is no existing entry, then the first unused entry that is large enough to contain the parameters is used for the update. An unused entry is one that was previously deleted by the DEL LE command. If there are no unused entries or none that are large enough, storage is allocated for a new entry and the entry is added to the top of the table.

The UPDATE LE SET(LERUNOPTS()) command is processed regardless of the LEOPT system option. This means that IMS continues to build the runtime parameter table entries even though they will not be retrieved through the DL/I INQY call.

This command is automatically routed to all IMS systems that are active in the IMSplex. The user cannot override the parameters on a single IMS.

TRAN()

Specifies the 1-8 character name of the transaction to which the parameters are to be defined.

USERID()

Specifies the 1-8 character name of the user ID to which the parameters are to be defined.

Usage notes

This command may be specified only through the Operations Manager API. The command syntax for this command is defined in XML and is available to automation programs that communicate with OM.

OM overrides the routing on the command and routes the command to all IMS systems in the IMSplex. The user specified route list is ignored.

At least one of the resource filters (TRAN, LTERM, USERID, or PGM) must be specified.

Output fields

Return, reason, and completion codes

The OM return and reason codes that may be returned as a result of this command are standard for all commands entered through the OM API. An IMS return and reason code is returned to OM by the UPDATE LE command.

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.