|UPDATE AREA : | |
|| || .-,-------------. | V | |>>-+-UPDATE-+--AREA--NAME-+-(---+-areaname--+-+-)-+-------------> | '-UPD----' | '-areaname*-' | | '-(*)-------------------' | |>--+-START(ACCESS)-----+--+--------------------------+----------> | '-STOP-+-(ACCESS)-+-' | .-,----------. | | '-(SCHD)---' | V | | | '-OPTION(---+-ALLRSP-+-+-)-' | +-FEOV---+ | '-NOFEOV-' | | .-SCOPE(ALL)----. |>--+---------------+------------------------------------------->< | '-SCOPE(ACTIVE)-' |
| ||>>-+-UPDATE-+--DATAGRP--NAME(datagrpname)-----------------------> | '-UPD----' | |>--+-START(ACCESS)-+--------------------------+-+---------------> | | '-SET(ACCTYPE(-+-BRWS-+-))-' | | | +-EXCL-+ | | | +-READ-+ | | | '-UPD--' | | '-STOP-+-(ACCESS)-+--------------------------' | '-(SCHD)---' | | .-SCOPE(ALL)----. |>--+---------------------------+--+---------------+------------>< | | .-,-------------. | '-SCOPE(ACTIVE)-' | | V | | | '-OPTION(---+-ALLRSP----+-+-' | +-DBALLOC---+ | +-FEOV------+ | +-NODBALLOC-+ | '-NOFEOV----' |
|| .-,-----------. | V | |>>-+-UPDATE-+--DB--NAME-+-(---+-dbname--+-+-)-+-----------------> | '-UPD----' | '-dbname*-' | | '-(*)-----------------' | |>--+-START---(ACCESS)-+--------------------------+---+----------> | | '-SET(ACCTYPE(-+-BRWS-+-))-' | | | +-EXCL-+ | | | +-READ-+ | | | '-UPD--' | | +-STOP-+-(ACCESS)--+------------------------------+ | | +-(SCHD)----+ | | | '-(UPDATES)-' | | '-SET(LOCK(-+-ON--+-))----------------------------' | '-OFF-' | | .-SCOPE(ALL)----. |>--+-----------------------------+--+---------------+---------->< | | .-,-------------. | '-SCOPE(ACTIVE)-' | | V | | | '-OPTION(---+-ALLRSP----+-+-)-' | +-DBALLOC---+ | +-FEOV------+ | +-NOBACKOUT-+ | +-NODBALLOC-+ | +-NOFEOV----+ | +-NOOPEN----+ | '-OPEN------' |
>>-+-UPDATE-+--LE-----------------------------------------------> '-UPD----' >--+-SET(LEOPT(-+-NO--+-))--------------------------------------+->< | '-YES-' | | .-,--------------------. | | V | | '---+-LTERM(ltermname)-+-+-SET(LERUNOPTS(runtimeparameters))-' +-PGM(programname)-+ +-TRAN(tranname)---+ '-USERID(userid)---'
|UPDATE OLREORG: | |
||| .-,------------. | V | |>>-+-|UPDATE|--+--OLREORG--NAME--(---+-partname-+-+-)-------------> | +-|UPD|-----+ '-*--------' | +-|/UPDATE|-+ | '-|/UPD|----' | | .-----------------------------. | V | |>----+-SET(RATE(rate))---------+-+----------------------------->< | '-OPTION--(--+-DEL---+--)-' | '-NODEL-' |
.-,-------------. V | >>-+-UPDATE-+--TRAN--NAME(---+-tranname--+-+-)------------------> '-UPD----' '-tranname*-' >--+---------------------------------------+--------------------> | .-,------------------------. | | V | | '-CLASS(-----current_class_number---+-)-' .-SCOPE(ALL)----. >--+-| A |--------+--+---------------+------------------------->< +-| B |--------+ '-SCOPE(ACTIVE)-' +-| A |--| B |-+ '-| C |--------' A: .-,-----------. V | |--START(---+-Q-------+-+-)-------------------------------------| +-SCHD----+ +-SUSPEND-+ '-TRACE---' B: .-,---------. V | |--STOP(---+-Q-----+-+-)----------------------------------------| +-SCHD--+ '-TRACE-' C: .-,------------------------------------. V | |--SET(---+-CLASS(new_class_number)----------+-+-)--------------| +-CPRI(new_current_priority)-------+ +-LCT(new_limit_count)-------------+ +-LPRI(new_limit_priority)---------+ +-MAXRGN(new_maximum_regions)------+ +-NPRI(new_normal_priority)--------+ +-PARLIM(new_parallel_limit_count)-+ +-PLCT(new_processing_limit_count)-+ +-SEGNO(new_segment_number)--------+ '-SEGSZ(new_segment_size)----------'
Table 175, Table 176, Table 177, Table 178, Table 179, and Table 180 list the environments (DB/DC, DBCTL, and DCCTL) from which the UPDATE command and keywords can be issued.
|Command / Keywords | |DB/DC | |DBCTL | |DCCTL |
---|---|---|---|
|UPDATE AREA | |X | |X | | |
|NAME | |X | |X | | |
|OPTION | |X | |X | | |
|SCOPE | |X | |X | | |
|START | |X | |X | | |
|STOP | |X | |X | | |
Command / Keywords | DB/DC | DBCTL | DCCTL |
---|---|---|---|
UPDATE LE | X | X | X |
LTERM | X | X | X |
PGM | X | X | X |
SET | X | X | X |
TRAN | X | X | X |
USERID | X | X | X |
|Command |/ Keywords | |DB/DC | |DBCTL | |DCCTL |
---|---|---|---|
|OLREORG | |X | |X | | |
|NAME | |X | |X | | |
|SET | |X | |X | | |
|OPTION | |X | |X | | |
The UPDATE AREA command allows changes to the status of area resources. |The UPDATE AREA command can only be specified using the OM API and is processed |only by the DB/DC and DBCTL environments. The command is also not |allowed on the XRF alternate.
|When the UPDATE AREA command is issued, the command only applies to the IMS to which |it is routed. The command does not preload or preopen areas on other |IMSs in the IMSplex that share the area. UPDATE AREA is routed by OM. OM routes the command to all active DB/DC |or DBCTL IMS systems, unless specific routing is specified. OM selects |one IMS as the command master.
|The UPDATE AREA STOP(SCHD) command is not allowed on any RSR tracker. However, the commands, UPDATE AREA START(ACCESS) or UPDATE AREA STOP(ACCESS), are allowed only on a database level RSR tracker. UPDATE AREA START(ACCESS) and UPDATE AREA STOP(SCHD) are recoverable and a X'22' log record is written but UPDATE AREA STOP(ACCESS) is not recoverable.
|Wildcard parameters can be specified. The area names that match |the generic or wildcard parameter are processed. For specific or |wildcard names, response lines are returned for all the area names |that are processed.
| |When the NAME(*) is specified, the response lines are returned |for only the area names that resulted in an error. If OPTION(ALLRSP) |is specified with NAME(*), response lines are returned for all the |area names that are processed.
|FEOV is only valid with STOP(ACCESS) and is not valid on an RSR tracker.
|OPTION(NOFEOV) is the default. NOFEOV is only valid with STOP(ACCESS).
|ACTIVE and ALL produce the same results.
|An UPDATE AREA START(ACCESS) can be issued on an RSR tracker to resume tracking for those |areas that were stopped or had tracking errors. In addition, Online |Forward Recovery (OFR) is started for areas that are not current |with mainline tracking.
| |For virtual storage option (VSO) areas, the UPDATE AREA START(ACCESS) can be used to preopen areas that are defined with the PREOPEN |option. For VSO areas defined with the PRELOAD option, the command |causes the areas to be loaded into the z/OS data space or an XES |structure depending on the sharelevel of the area. The command has |no effect on VSO areas that are in virtual storage.
|The UPDATE AREA STOP(ACCESS) command for VSO areas removes the areas from the data space |or XES structure and forces updates to be written back to DASD.
| |An UPDATE AREA START(ACCESS) command is required to open and reallocate the areas closed |by the UPDATE AREA STOP(ACCESS) command.
|If UPDATE AREA STOP(SCHD) is processed during HSSP processing, the area will be released |after the current commit processing completes. Any image copy option |in process when the command is issued can affect the continued system |operation.
| |For VSO DEDB areas that are in a z/OS data space or XES structure, the UPDATE AREA STOP(SCHD) command action results in the removal of the VSO areas from |the data space or XES structure and having the updates written to |DASD.
|Table 181 shows the UPDATE AREA output fields. The columns in the table are as follows: |
||Short Label | |Keyword | |Meaning |
---|---|---|
|AREA | |ERR | |Area name. The area name is always returned. |
|CC | |N/A | |Completion code for the line of output. Completion code |is always returned. |
|EERT | |ERR | |Error text returned to add more meaning to the completion |code and may include a return code from a service. The error text |may be returned for a non-zero completion code. |
|MBR | |N/A | |The IMSplex member that built the output line. |The IMS identifier of the IMS for which the area information is displayed. |The IMS identifier is always returned. |
An IMS return and reason code is returned |to OM by the UPDATE AREA command. The OM return and reason codes that may be returned |as a result of the UPDATE AREA command are standard for all commands entered through the |OM API. See IMS Version 9: Common Service Layer Guide and Reference for a list of the |OM codes and the code meanings.
|Table 182 includes the return |and reason codes and a brief explanation of the UPDATE AREA command. Table 183 includes |an explanation of the completion codes. Errors unique to the processing |of UPDATE AREA command are returned as completion codes. A completion code |is returned for each action against an individual resource.
| |Return Code | |Reason Code | |Meaning | |
---|---|---|
X'00000000' | |X'000000000' | |The UPDATE AREA command completed successfully. | |
X'00000008' | |X'00002014' | |The UPDATE AREA command is not processed because an invalid character is |found in the area name parameter. | |
X'00000008' | |X'00002040' | |More than one filter or keyword value is specified on |the UPDATE AREA command. Either more than one keyword or an invalid combination |of filters was specified. For example, START(ACCESS) and STOP(ACCESS) was specified, or OPTION(NOFEOV,FEOV) was specified. Check the input command and reenter the correct combinations. | |
X'0000000C' | |X'00003000' | |The UPDATE AREA command is successful for at least one resource name. The UPDATE AREA command was not successful for one or more resource names. |The completion code indicates the reason for the error with the |resource name. The completion codes that can be returned by the UPDATE AREA command are listed in Table 183. | |
X'0000000C' | |X'00003004' | |The UPDATE AREA command was not successful for all the resource name(s) specified. |The completion code indicates the reason for the error with the resource |name. The completion codes that can be returned by the UPDATE AREA command are listed in Table 183. | |
X'00000010' | |X'0000400C' | |The UPDATE AREA command is not processed because the flavor entered is not |valid on the XRF alternate. | |
X'00000010' | |X'00004014' | |The UPDATE AREA command is not processed because the function is not valid |on the RSR tracker. | |
X'00000010' | |X'00004024' | |The UPDATE AREA command is not processed because Fast Path is not installed. | |
X'00000014' | |X'00005004' | |The UPDATE AREA command processing terminated because a DFSCOMD response |buffer could not be obtained. | |
X'00000014' | |X'00005008' | |The UPDATE AREA command processing terminated because a DFSPOOL storage could |not be obtained. | |
X'00000014' | |X'0000500C' | |The UPDATE AREA command processing terminated because AWE could not be obtained. | |
X'00000014' | |X'00005014' | |The UPDATE AREA command processing terminated because a WKAP storage could |not be obtained. | |
X'00000014' | |X'00005FFF' | |The UPDATE AREA command processing terminated due to an internal error. | |
Table 184 shows different instances |of the UPDATE AREA command and other IMS commands that perform similar functions.
| |UPDATE AREA Command | |Similar IMS Commands | |
---|---|
UPDATE AREA NAME(name) STOP(ACCESS) | |/DBR AREA areaname | |
UPDATE AREA NAME(name) START(ACCESS) | |/START AREA areaname | |
UPDATE AREA NAME(name) STOP(SCHD) | |/STOP AREA areaname | |
The following are examples of |the UPDATE AREA command:
| | |TSO SPOC input: |
|UPD AREA NAME(DB21AR1*) STOP(ACCESS)|
TSO SPOC output: |
|AreaName MbrName CC |DB21AR1 IMS2 0 |DB21AR1 SYS3 0 |DB21AR10 IMS2 0 |DB21AR10 SYS3 0 |DB21AR11 IMS2 0 |DB21AR11 SYS3 0|
OM API input: |
|CMD(UPD AREA NAME(DB21AR1*) STOP(ACCESS))|
OM API output: |
|<imsout> |<ctl> |<omname>OM1OM </omname> |<omvsn>1.2.0</omvsn> |<xmlvsn>1 </xmlvsn> |<statime>2003.132 16:17:33.260435</statime> |<stotime>2003.132 16:17:33.281165</stotime> |<staseq>B968A333F5A93283</staseq> |<stoseq>B968A333FAB8DC83</stoseq> |<rqsttkn1>USRT005 10091733</rqsttkn1> |<rc>00000000</rc> |<rsn>00000000</rsn> |</ctl> |<cmd> |<master>IMS2 </master> |<userid>USRT005 </userid> |<verb>UPD </verb> |<kwd>AREA </kwd> |<input>UPD AREA NAME(DB21AR1*) STOP(ACCESS) </input> |</cmd> |<cmdrsphdr> |<hdr slbl="AREA" llbl="AreaName" scope="LCL" sort="a" key="1" | scroll="no" len="8" dtype="CHAR" align="left" skipb="no" /> |<hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="a" key="2" scroll="no" | len="8" dtype="CHAR" align="left" skipb="no" /> |<hdr slbl="CC" llbl="CC" scope="LCL" sort="n" key="0" scroll="yes" | len="4" dtype="INT" align="right" skipb="no" /> |<hdr slbl="ERRT" llbl="ErrorText" scope="LCL" sort="n" key="0" | scroll="yes" len="16" dtype="CHAR" align="left" skipb="yes" /> |</cmdrsphdr> |<cmdrspdata> |<rsp>AREA(DB21AR1 ) MBR(IMS2 ) CC( 0) </rsp> |<rsp>AREA(DB21AR10) MBR(IMS2 ) CC( 0) </rsp> |<rsp>AREA(DB21AR11) MBR(IMS2 ) CC( 0) </rsp> |<rsp>AREA(DB21AR1 ) MBR(SYS3 ) CC( 0) </rsp> |<rsp>AREA(DB21AR10) MBR(SYS3 ) CC( 0) </rsp> |<rsp>AREA(DB21AR11) MBR(SYS3 ) CC( 0) </rsp> |</cmdrspdata> |</imsout>|
Explanation: The command stops access to all the areas that match |the area name specified and makes them unavailable.The areas data |sets are closed and deallocated.
|| | |TSO SPOC input: |
|UPD AREA NAME(*) STOP(SCHD)|
TSO SPOC output: |
|Log for . . : UPD AREA NAME(*) STOP(SCHD) | IMSplex . . . . . : PLEX1 | Routing . . . . . : | Start time. . . . : 2003.132 09:22:15.79 | Stop time . . . . : 2003.132 09:22:17.53 | Return code . . . : 00000000 | Reason code . . . : 00000000 | Command master. . IMS2|
OM API input: |
|CMD(UPD AREA NAME(*) STOP(SCHD))|
OM API output: |
|<imsout> |<ctl> |<omname>OM1OM </omname> |<omvsn>1.2.0</omvsn> |<xmlvsn>1 </xmlvsn> |<statime>2003.132 16:22:15.799896</statime> |<stotime>2003.132 16:22:17.536107</stotime> |<staseq>B968A44169058C8E</staseq> |<stoseq>B968A44310E6BE2D</stoseq> |<rqsttkn1>USRT005 10092215</rqsttkn1> |<rc>00000000</rc> |<rsn>00000000</rsn> |</ctl> |<cmd> |<master>IMS2 </master> |<userid>USRT005 </userid> |<verb>UPD </verb> |<kwd>AREA </kwd> |<input>UPD AREA NAME(*) STOP(SCHD) </input> |</cmd> |</imsout>|
Explanation: The command is routed to IMS2 and SYS3, and the |command is successful at both IMSs. No response lines are returned |because the default action for NAME(*) is to return response lines |only for the area names that resulted in an error. OPTION(ALLRSP) |can be specified to obtain all the area names processed on the command.
|| | |The UPDATE DATAGRP command allows changes to the status of the members of a |data group. The command can only be specified through the OM API |and can be processed only by the DB/DC and DBCTL environments. In |addition, the UPDATE DATAGRP command is not allowed on the XRF alternate.
|When the UPDATE DATAGRP command is issued, it only applies to the IMS system to which |it is routed. It does not apply to the other IMS systems in the |IMSplex that share the database or areas in the data group. The |routing of the UPDATE DATAGRP command is done by OM. OM routes the command to all active |DB/DC or DBCTL IMS systems, unless specific routing is specified. |OM selects one IMS as the command master.
|A response line is returned for the data group name from each |IMS. Response lines are also returned for each data group member |that resulted in an error. No response lines are returned for the |data group members that are processed successfully unless OPTION(ALLRSP) |is specified.
|The default action is to return response lines only for the databases and |areas or both that resulted in an error. A response line with the datagroup |name is always returned.
|DBALLOC can only be specified with START(ACCESS).
| |Only one of DBALLOC or NODBALLOC can be specified.
|FEOV is only valid with STOP(ACCESS). FEOV is not valid on an RSR tracker.
|NODBALLOC can only be specified with START(ACCESS). NODBALLOC is the default action for UPDATE DATAGRP command if OPTION(DBALLOC) is not specified.
| |Only one of DBALLOC or NODBALLOC can be specified.
|OPTION(NOFEOV) is the default action after the UPDATE DATAGRP STOP(ACCESS) command is processed.
| |NOFEOV is only valid with STOP(ACCESS).
|Currently, ACTIVE and ALL produce the same results.
|Additional functions to be peformed along with START(ACCESS) can be specified using the OPTION keyword.
| |An UPDATE DATAGRP START(ACCESS) command with SET(ACCTYP) or OPTION(DBALLOC|NODBALLOC|NOBACKOUT|OPEN|NOOPEN) is invalid on the RSR tracker.
|Table 185 shows |the output fields for the UPDATE DATAGRP. The columns in the table are as follows: |
|An |IMS return and reason code is returned to OM by the UPDATE DATAGRP command. The OM return and reason codes that may be returned |as a result of the UPDATE DATAGRP command are standard for all commands entered through the |OM API. See IMS Version 9: Common Service Layer Guide and Reference for a list of the |OM codes and the code meanings.
|Table 186 includes the return |and reason codes and a brief explanation of the UPDATE DATAGRP command. Table 187 includes |an explanation of the completion codes. Errors unique to the processing |of UPDATE DATAGRP command are returned as completion codes. A completion code |is returned for each action against an individual resource.
| |Return Code | |Reason Code | |Meaning | |
---|---|---|
X'00000000' | |X'00000000' | |The UPDATE DATAGRP command completed successfully. | |
X'00000008' | |X'00002004' | |An invalid keyword or more than one keyword is specified |on the UPDATE DATAGRP command. | |
X'00000008' | |X'00002014' | |The UPDATE DATAGRP command is not processed because an invalid character is |found in the data group name. | |
X'00000008' | |X'00002040' | |More than one filter or keyword value is specified |on the UPDATE DATAGRP command. Either more than one keyword or an invalid combination |of filters was specified. For example, START(ACCESS) and STOP(ACCESS) was specified, or OPTION(DBALLOC,NODBALLOC) was specified. Check the input command and reenter the correct |combinations. | |
X'0000000C' | |X'00003000' | |THe UPDATE DATAGRP command is successful for at least one member in the data |group. The UPDATE DATAGRP command is not successful for one or more members in the |data group. The completion code indicates the reason for the error |with the data group member name. The completion codes that can be |returned by the UPDATE DATAGRP command are listed in the UPDATE DATAGRP completion code table. | |
X'0000000C' | |X'00003004' | |The UPDATE DATAGRP command is not successful for all the members in the data |group. The completion code indicates the reason for the error with |the data group member name. The completion codes that can be returned |by the UPDATE DATAGRP command are listed in the UPDATE DATAGRP completion code table. | |
X'00000010' | |X'0000400C' | |The UPDATE DATAGRP command is not processed because the flavor entered is not |valid on the XRF alternate. | |
X'00000010' | |X'00004014' | |The UPDATE DATAGRP command is not processed because the function is not valid |on the RSR tracker. | |
X'00000014' | |X'00005004' | |The UPDATE DATAGRP command processing terminated because a DFSOCMD response |buffer could not be obtained. | |
X'00000014' | |X'00005008' | |The UPDATE DATAGRP command processing terminated because DFSPOOL storage could |not be obtained. | |
X'00000014' | |X'0000500C' | |The UPDATE DATAGRP command processing terminated because AWE could not be obtained. | |
X'00000014' | |X'00005014' | |The UPDATE DATAGRP command processing terminated because a WKAP storage could |not be obtained. | |
X'00000014' | |X'00005FFF' | |The UPDATE DATAGRP command processing terminated due to an internal error. | |
Completion Code | |Meaning | |
---|---|
| | See UPDATE AREA completion code table (Table 183) |for codes that can be returned for the areas in a data group. | |
| | See UPDATE DB completion code table ( Table 191 ) |for codes that can be returned for the databases in the data group. | |
Table 188 shows different instances |of the UPDATE DATAGRP command and other IMS commands that perform similar functions. |
| |UPDATE DATAGRP Command | |Similar IMS Commands | |
---|---|
UPDATE DATAGRP NAME(name) STOP(ACCESS) | |/DBR DATAGRP datagrpname | |
UPDATE DATAGRP NAME(name) START(ACCESS) | |/START DATAGRP datagrpname | |
UPDATE DATAGRP NAME(name) STOP(SCHD) | |/STOP DATAGRP datagrpname | |
The following are examples |of the UPDATE DATAGRP command:
| | |TSO SPOC input: |
|UPD DATAGRP NAME(GROUP1) STOP(ACCESS)|
TSO SPOC output: |
|DataGroup DBName AreaName MbrName CC |GROUP1 IMSA 0 |GROUP1 IMS1 8 |GROUP1 DEDBJN03 IMS1 C |GROUP1 DEDBJN03 DB3AREA0 IMS1 F0|
OM API input: |
|CMD(UPD DATAGRP NAME(GROUP1) STOP(ACCESS))|
OM API output: |
|<imsout> |<ctl> |<omname>OM1OM </omname> |<omvsn>1.2.0</omvsn> |<xmlvsn>1 </xmlvsn> |<statime>2003.129 22:45:55.898843</statime> |<stotime>2003.129 22:45:55.990001</stotime> |<staseq>B965346AB45DB229</staseq> |<stoseq>B965346ACA9F1263</stoseq> |<rqsttkn1>USRT005 10154555</rqsttkn1> |<rc>0200000C</rc> |<rsn>00003000</rsn> |</ctl> |<cmderr> |<mbr name="IMS1 "> |<typ>IMS </typ> |<styp>DBDC </styp> |<rc>0000000C</rc> |<rsn>00003000</rsn> |</mbr> |</cmderr> |<cmd> |<master>IMSA </master> |<userid>USRT005 </userid> |<verb>UPD </verb> |<kwd>DATAGRP </kwd> |<input>UPD DATAGRP NAME(GROUP1) STOP(ACCESS) </input> |</cmd> |<cmdrsphdr> |<hdr slbl="DG" llbl="DataGroup" scope="LCL" sort="a" key="1" | scroll="no" len="8" dtype="CHAR" align="left" skipb="no" /> |<hdr slbl="DB" llbl="DBName" scope="LCL" sort="a" key="3" scroll="no" | len="8" dtype="CHAR" align="left" skipb="yes" /> |<hdr slbl="AREA" llbl="AreaName" scope="LCL" sort="a" key="4" | scroll="no" len="8" dtype="CHAR" align="left" skipb="yes" /> |<hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="a" key="2" scroll="no" | len="8" dtype="CHAR" align="left" skipb="no" /> |<hdr slbl="CC" llbl="CC" scope="LCL" sort="n" key="0" scroll="yes" | len="4" dtype="INT" align="right" skipb="no" /> |<hdr slbl="ERRT" llbl="ErrorText" scope="LCL" sort="n" key="0" | scroll="yes" len="16" dtype="CHAR" align="left" skipb="yes" /> |</cmdrsphdr> |<cmdrspdata> |<rsp>DG(GROUP1 ) MBR(IMSA ) CC( 0) </rsp> |<rsp>DB(DEDBJN03) AREA(DB3AREA0) DG(GROUP1 ) MBR(IMS1 ) CC( F0) |</rsp> |<rsp>DB(DEDBJN03) DG(GROUP1 ) MBR(IMS1 ) CC( C) </rsp> |<rsp>DG(GROUP1 ) MBR(IMS1 ) CC( 8) </rsp> |</cmdrspdata> |</imsout>|
Explanation: The command stops access to all the members of datagroup |GROUP1 and takes them offline. The command response lines are returned |for all the databases or areas that resulted in an error. No response |lines are returned for members for which the command was successful.
|| | |TSO SPOC input: |
|UPD DATAGRP NAME(GROUP1) START(ACCESS) OPTION(ALLRSP)|
TSO SPOC output: |
|DataGroup DBName AreaName MbrName CC |GROUP1 IMSA 0 |GROUP1 DB21AR1 IMSA 0 |GROUP1 BE3PARTS IMSA 0 |GROUP1 DEDBJN03 IMSA 0 |GROUP1 IMS1 0 |GROUP1 DB21AR1 IMS1 0 |GROUP1 BE3PARTS IMS1 0 |GROUP1 DEDBJN03 IMS1 0|
OM API input: |
|CMD(UPD DATAGRP NAME(GROUP1) START(ACCESS) OPTION(ALLRSP))|
OM API output: |
|<imsout> |<ctl> |<omname>OM1OM </omname> |<omvsn>1.2.0</omvsn> |<xmlvsn>1 </xmlvsn> |<statime>2003.129 22:46:51.490484</statime> |<stotime>2003.129 22:46:51.672332</stotime> |<staseq>B965349FB88B4445</staseq> |<stoseq>B965349FE4F0C36A</stoseq> |<rqsttkn1>USRT005 10154651</rqsttkn1> |<rc>00000000</rc> |<rsn>00000000</rsn> |</ctl> |<cmd> |<master>IMSA </master> |<userid>USRT005 </userid> |<verb>UPD </verb> |<kwd>DATAGRP </kwd> |<input>UPD DATAGRP NAME(GROUP1) START(ACCESS) OPTION(ALLRSP) </input> |</cmd> |<cmdrsphdr> |<hdr slbl="DG" llbl="DataGroup" scope="LCL" sort="a" key="1" | scroll="no" len="8" dtype="CHAR" align="left" skipb="no" /> |<hdr slbl="DB" llbl="DBName" scope="LCL" sort="a" key="3" scroll="no" | len="8" dtype="CHAR" align="left" skipb="yes" /> |<hdr slbl="AREA" llbl="AreaName" scope="LCL" sort="a" key="4" | scroll="no" len="8" dtype="CHAR" align="left" skipb="yes" /> |<hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="a" key="2" scroll="no" | len="8" dtype="CHAR" align="left" skipb="no" /> |<hdr slbl="CC" llbl="CC" scope="LCL" sort="n" key="0" scroll="yes" | len="4" dtype="INT" align="right" skipb="no" /> |<hdr slbl="ERRT" llbl="ErrorText" scope="LCL" sort="n" key="0" | scroll="yes" len="16" dtype="CHAR" align="left" skipb="yes" /> |</cmdrsphdr> |<cmdrspdata> |<rsp>DB(DEDBJN03) DG(GROUP1 ) MBR(IMSA ) CC( 0) </rsp> |<rsp>DB(BE3PARTS) DG(GROUP1 ) MBR(IMSA ) CC( 0) </rsp> |<rsp>AREA(DB21AR1 ) DG(GROUP1 ) MBR(IMSA ) CC( 0) </rsp> |<rsp>DG(GROUP1 ) MBR(IMSA ) CC( 0) </rsp> |<rsp>DB(DEDBJN03) DG(GROUP1 ) MBR(IMS1 ) CC( 0) </rsp> |<rsp>DB(BE3PARTS) DG(GROUP1 ) MBR(IMS1 ) CC( 0) </rsp> |<rsp>AREA(DB21AR1 ) DG(GROUP1 ) MBR(IMS1 ) CC( 0) </rsp> |<rsp>DG(GROUP1 ) MBR(IMS1 ) CC( 0) </rsp> |</cmdrspdata> |</imsout>|
Explanation: The command starts access of all the members of |datagroup, GROUP1, and makes them available. The command response |lines are returned for all the databases or areas that are processed |with OPTION(ALLRSP) specified.
|| | |The UPDATE DB command allows changes to the status of database resources. |For example, UPDATE DB can make a database available, take the database offline, |stop scheduling, stop updates, lock, and unlock a database. The UPDATE DB command may only be specified through the OM API and can |only be processed by the DB/DC and DBCTL environments. Also, the |command is not allowed on the XRF alternate system.
|When the UPDATE DB command is issued, it only applies to the IMS system to which |it is routed. The command is not processed by other IMS systems |in the IMSplex that share the database but do not receive the command. |The routing of the UPDATE DB command is done by OM. OM routes the command to all active |DB/DC or DBCTL IMS systems, unless specific routing is specified. |OM selects one IMS as the command master.
|The UPDATE DB SET(LOCK(ON)), UPDATE DB SET(LOCK(OFF)), UPDATE DB STOP(SCHD), and UPDATE DB STOP(UPDATES) commands are not allowed on an RSR tracker. The UPDATE DB START(ACCESS) with SET(ACCTYP) or OPTION(DBALLOC|NODBALLOC|NOBACKOUT|OPEN|NOOPEN) are also invalid on the RSR tracker.
||The UPDATE DB command is valid for HALDB databases. If the command is issued |for a HALDB master, it applies to all the HALDB partitions. Each |partition inherits the access limitations of the HALDB master. However, |the status condition is only displayed on the HALDB master and not |on the partitions. If the command is issued on one HALDB partition, |it applies only to that HALDB partition and not the HALDB master.|
|NAME(*) is the architected method on IMSPlex commands to allow |the user to specify that the command applies to all the database |resources.
| |Wildcard parameters can be specified on the NAME keyword. The database names that match the generic or wildcard |parameter are processed. For specific or wildcard names, response |lines are returned for all the database names that are processed.
| |For NAME(*), response lines are returned for all database names |that resulted in an error. If OPTION(ALLRSP) is specified with NAME(*), |response lines are returned for all the database names that are |processed.
| |When the database specified is a DEDB, a response line is returned |for the DEDB name. A response line is also returned for all the |areas of a DEDB that resulted in errors. A response line is not |returned for the areas of a DEDB for which the command action is |successful.
|DBALLOC can only be specified with START(ACCESS). DBALLOC is the default action when specific database names |are specified on the command. Only one of DBALLOC or NODBALLOC can |be specified.
| |OPTION(DBALLOC) is not valid for a HALDB master.
|The IMS log switches to the next OLDS and a simple checkpoint |is taken. This switch is marked as a recovery point for log archiving purposes. |FEOV is only valid with STOP(UPDATES) and STOP(ACCESS).
| |FEOV does not apply to an RSR tracker.
|NOBACKOUT can only be specified with START(ACCESS) and is not valid with NAME(*). OPTION(NOBACKOUT) is not valid for a HALDB master.
|The database will be allocated when it is scheduled. NODBALLOC can |only be specified with START(ACCESS). NODBALLOC is the default action when NAME(*) is specified. |Only one of DBALLOC or NODBALLOC can be specified. OPTION(NODBALLOC) is ignored for HALDB masters.
|OPTION(NOFEOV) can be specified with STOP(ACCESS) and STOP(UPDATES).
| |NOOPEN can only be specified with START(ACCESS). NOOPEN is the default action unless the database has EEQE's.
| |Only one of OPEN or NOOPEN can be specified. OPTION(NOOPEN) is not valid for a HALDB master.
|OPEN cannot be specified with NAME(*) or if NODBALLOC is specified. |Only one of OPEN or NOOPEN can be specified. OPTION(OPEN) is not valid for a HALDB master.
|Currently, ACTIVE and ALL produce the same results.
|For a shared secondary index database, an UPDATE DB SET(LOCK(ON)) on the first secondary index or subsequent secondary indexes |affects only the named database.
|The UPDATE DB START(ACCESS) command can be used to allocate or reallocate all databases |other than DEDBs. For a DEDB, an UPDATE AREA command can be used to allocate or reallocate the DEDB areas.
| |For a DEDB, the UPDATE DB START(ACCESS) command also causes any unloaded randomizer, that was specified |in the DBD source, to be reloaded.
| ||When the UPDATE DB START(ACCESS) command is specified for a HALDB partition, the partition |is not allocated unless it has EEQEs, the OPEN keyword is specified, |or it was previously authorized but not allocated. The action taken |to allocate the data sets is dependant on the status of the master |database and its availability.|
| |The UPDATE DB START(ACCESS) command may reset the USTOPPED status for transactions that |are suspended. If the transaction is suspended and its processing |program has access to the started database, the UPDATE DB START(ACCESS) command will result in the USTOPPED attribute being reset. |Any messages on the suspend queue for that transaction will be transferred |to the normal processing queue.
| |If there was a prior dynamic backout or emergency restart backout failure, |then the UPDATE DB START(ACCESS) command will attempt to perform the backout again.
| |If the database is registered to DBRC, then DBRC is informed |when batch backout is successfully executed, and the failing backout |will not be attempted again when an UPDATE DB START(ACCESS) command is issued.
| |The UPDATE DB START(ACCESS) command is not processed for the databases being accessed |by batch programs.
| |For a HIDAM database, the UPDATE DB START(ACCESS) command must be issued for both the index and the data area |DBD. If a backout failure occurs for this database, the command |causes the backout to be attempted again.
| |On an RSR tracker, the UPDATE DB START(ACCESS) command can be used to resume tracking for those databases |that were stopped by a tracking subsystem processing. The command |can also be used to start online forward recovery (OFR) for those |databases that are not current with mainline tracking.
| |For shared secondary index databases, the UPDATE DB START(ACCESS) can be issued on the first secondary index or subsequent |secondary indexes to undo the actions of the prior UPDATE DB STOP(SCHD) and UPDATE DB STOP(UPDATES) commands.
| |Additional functions can be performed with START(ACCESS) by specifying the OPTION keyword. OPTION(DBALLOC | NODBALLOC), OPTION(NOBACKOUT), OPTION(NOOPEN | OPEN) can be specified along with START(ACCESS). The OPTION keyword is not valid for a HALDB master.
|OPTION(NOFEOV) is the default action for STOP(ACCESS). The IMS log is not switched to the next OLDS and a simple |checkpoint is not taken. OPTION(FEOV) can be specified on the command to switch to the next OLDS |and take an IMS simple checkpoint.
| |The UPDATE DB STOP(ACCESS) command can be used on a database readiness level (DLT) tracker |to take shadow areas and databases offline for image copy and recovery. |The command can also be used to stop online forward recovery (OFR) |in progress for the specified database.
| |The UPDATE DB STOP(ACCESS) command will not deallocate a data set if a VSAM data set |hardware error occurred. For shared secondary index databases, an UPDATE DB STOP(ACCESS) on the first secondary index affects all databases sharing |the secondary index dataset. An UPDATE DB STOP(ACCESS) command on the subsequent secondary indexes affects only |the named database.
|An UPDATE DB START(ACCESS) command can be used to reset the effect of an UPDATE DB STOP(SCHD) command.
| |If the command is issued for a DEDB or MSDB, programs using the database |will not be scheduled. For other databases, the programs will still |be scheduled. If the INIT call was issued, however, a call against |the database will result in either a 3308 pseudoabend or a BA status |code.
| |When the UPDATE DB STOP(SCHD) command is issued for a database that is in use by an MPP |region, the command is processed after the region completes processing |the current message. After the current message processing is complete, |the application program receives a QC status indicating no more |messages even if there are messages to be processed.
| |When the UPDATE DB STOP(SCHD) command is issued for a database that is in use by a BMP |region, the command is rejected.
| |In a DBCTL system, CCTL can specify LONG or SHORT when it schedules |a PSB. When the UPDATE DB STOP(SCHD) command is issued for a database that is in use by a LONG |thread, the command is rejected. When the command is issued for |a database that is in use by a SHORT thread, the thread completes |before the command is processed.
| |For a shared secondary index database, an UPDATE DB STOP(SCHD) on the first secondary index or subsequent secondary indexes |affects only the named databases.
|STOP(UPDATES) is not valid for DEDBs or MSDBs.
| |An UPDATE DB START(ACCESS) command is required to reset the effect of an UPDATE DB STOP(UPDATES) command.
| |When the UPDATE DB STOP(UPDATES) command is processed, the message processing regions using |the specified database are terminated at the conclusion of processing |their transactions in preparation to close the database and allow |the databases to be opened input only. As the message processing |regions terminate programs, the data sets of the database are closed.
| |OPTION(FEOV) forces the IMS log to switch to the next OLDS. This switch |is marked as a recovery point for log archiving purposes. IMS also |issues a simple checkpoint. OPTION(NOFEOV), which is the default, overrides this action.
| ||After the command is processed, the scheduling of |transactions is resumed. No transactions will be allowed to update |the specified databases. Programs with update intent will be scheduled, |but update calls to DL/I databases will result in a 3303 pseudoabend, |a BA, or BB status code. The pseudoabend or status codes appear |only if the application program informed IMS through the INIT STATUS GROUPA or GROUPB call that it is prepared to accept status codes regarding |data unavailability.|
| |An UPDATE DB STOP(UPDATES) on the first secondary index affects all databases sharing |the secondary index data set. An UPDATE DB STOP(UPDATES) on subsequent secondary indexes affects only the named database.
|Table 189 shows the output fields for |the UPDATE DB. The columns in the table are as follows: |
|Short Label | |Keyword | |Meaning | |
---|---|---|
AREA | |ERR | |Area name of the DEDB that resulted in an error |during the processing of the command. | |
CC | |N/A | |Completion code for the line of output. Completion |code is always returned. | |
DB | |N/A | |Database name. The database name is always returned. | |
ERRT | |ERR | |Error text returned to add more meaning to the completion |code and may include a return code from a service. The error text |is only returned if the completion coe is non-zero. | |
MBR | |N/A | |IMSplex member that built output line. IMS identifier |of the IMS for which the database information is displayed. IMS |identifier is always returned. | |
An IMS return and reason code is returned |to OM by the UPDATE DB command. The OM return and reason codes that may be returned |as a result of the UPDATE DB command are standard for all commands entered through the |OM API. See IMS Version 9: Common Service Layer Guide and Reference for a list of the |OM codes and the code meanings.
|Table 190 includes the return |and reason codes and a brief explanation of the UPDATE DB command. Table 191 includes |an explanation of the completion codes. Errors unique to the processing |of UPDATE DB command are returned as completion codes. A completion code |is returned for each action against an individual resource.
| || || |Table 192 shows |different instances of the UPDATE DB command and other IMS commands that perform similar functions. |
| || |The following are examples of the UPDATE DB command:
| | |TSO SPOC input: |
|UPD DB NAME(BE3PARTS PDHDOKA D2XHDJ05 DEDBJN21) START(ACCESS)|
TSO SPOC output: |
|DBName MbrName CC |BE3PARTS IMSA A0 |BE3PARTS IMS1 A0 |DEDBJN21 IMSA 0 |DEDBJN21 IMS1 0 |D2XHDJ05 IMSA 0 |D2XHDJ05 IMS1 0 |PDHDOKA IMSA 0 |PDHDOKA IMS1 0|
OM API input: |
|CMD (UPD DB NAME(BE3PARTS PDHDOKA D2XHDJ05 DEDBJN21) START(ACCESS))|
OM API output: |
|<imsout> |<ctl> |<omname>OM1OM </omname> |<omvsn>1.2.0</omvsn> |<xmlvsn>1 </xmlvsn> |<statime>2003.128 21:41:33.429986</statime> |<stotime>2003.128 21:41:33.548653</stotime> |<staseq>B963E429B4CE2C4A</staseq> |<stoseq>B963E429D1C6D02E</stoseq> |<rqsttkn1>USRT005 10144133</rqsttkn1> |<rc>0200000C</rc> |<rsn>00003008</rsn> |</ctl> |<cmderr> |<mbr name="IMSA "> |<typ>IMS </typ> |<styp>DBCTL </styp> |<rc>0000000C</rc> |<rsn>00003000</rsn> |</mbr> |<mbr name="IMS1 "> |<typ>IMS </typ> |<styp>DBDC </styp> |<rc>0000000C</rc> |<rsn>00003000</rsn> |</mbr> |</cmderr> |<cmd> |<master>IMSA </master> |<userid>USRT005 </userid> |<verb>UPD </verb> |<kwd>DB </kwd> |<input>UPD DB NAME(BE3PARTS PDHDOKA D2XHDJ05 DEDBJN21) START(ACCESS)</input> |</cmd> |<cmdrsphdr> |<hdr slbl="DB" llbl="DBName" scope="LCL" sort="a" key="1" scroll="no" | len="8" dtype="CHAR" align="left" skipb="no" /> |<hdr slbl="AREA" llbl="AreaName" scope="LCL" sort="a" key="3" | scroll="no" len="8" dtype="CHAR" align="left" skipb="yes" /> |<hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="a" key="2" scroll="no" | len="8" dtype="CHAR" align="left" skipb="no" /> |<hdr slbl="CC" llbl="CC" scope="LCL" sort="n" key="0" scroll="yes" | len="4" dtype="INT" align="right" skipb="no" /> |<hdr slbl="ERRT" llbl="ErrorText" scope="LCL" sort="n" key="0" | scroll="yes" len="16" dtype="CHAR" align="left" skipb="yes" /> |</cmdrsphdr> |<cmdrspdata> |<rsp>DB(DEDBJN21) MBR(IMSA ) CC( 0) </rsp> |<rsp>DB(BE3PARTS) MBR(IMSA ) CC( A0) </rsp> |<rsp>DB(D2XHDJ05) MBR(IMSA ) CC( 0) </rsp> |<rsp>DB(PDHDOKA ) MBR(IMSA ) CC( 0) </rsp> |<rsp>DB(DEDBJN21) MBR(IMS1 ) CC( 0) </rsp> |<rsp>DB(BE3PARTS) MBR(IMS1 ) CC( A0) </rsp> |<rsp>DB(D2XHDJ05) MBR(IMS1 ) CC( 0) </rsp> |<rsp>DB(PDHDOKA ) MBR(IMS1 ) CC( 0) </rsp> |</cmdrspdata> |</imsout>|
Explanation: The command starts access of the listed databases |and makes them available. Any error in starting the database is |returned as a completion code.
|| | |TSO SPOC input: |
|UPD DB NAME(BE3PARTS DEDBJN03 PVHDJ5A DBHDOK01 ) STOP(ACCESS)|
TSO SPOC output: |
|DBName AreaName MbrName CC |BE3PARTS IMSA 0 |BE3PARTS IMS1 0 |DBHDOK01 IMSA 0 |DBHDOK01 IMS1 0 |DEDBJN03 IMSA 0 |DEDBJN03 IMS1 C |DEDBJN03 DB3AREA0 IMS1 F0 |PVHDJ5A IMSA 0 |PVHDJ5A IMS1 0|
OM API input: |
|CMD(UPD DB NAME(BE3PARTS DEDBJN03 PVHDJ5A DBHDOK01 ) STOP(ACCESS))|
OM API output: |
|<imsout> |<ctl> |<omname>OM1OM </omname> |<omvsn>1.2.0</omvsn> |<xmlvsn>1 </xmlvsn> |<statime>2003.129 22:41:53.466082</statime> |<stotime>2003.129 22:41:53.680616</stotime> |<staseq>B965338380AE2E8E</staseq> |<stoseq>B9653383B50E8663</stoseq> |<rqsttkn1>USRT005 10154153</rqsttkn1> |<rc>0200000C</rc> |<rsn>00003000</rsn> |</ctl> |<cmderr> |<mbr name="IMS1 "> |<typ>IMS </typ> |<styp>DBDC </styp> |<rc>0000000C</rc> |<rsn>00003000</rsn> |</mbr> |</cmderr> |<cmd> |<master>IMSA </master> |<userid>USRT005 </userid> |<verb>UPD </verb> |<kwd>DB </kwd> |<input>UPD DB NAME(BE3PARTS DEDBJN03 PVHDJ5A DBHDOK01 ) STOP(ACCESS) </input> |</cmd> |<cmdrsphdr> |<hdr slbl="DB" llbl="DBName" scope="LCL" sort="a" key="1" scroll="no" | len="8" dtype="CHAR" align="left" skipb="no" /> |<hdr slbl="AREA" llbl="AreaName" scope="LCL" sort="a" key="3" | scroll="no" len="8" dtype="CHAR" align="left" skipb="yes" /> |<hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="a" key="2" scroll="no" | len="8" dtype="CHAR" align="left" skipb="no" /> |<hdr slbl="CC" llbl="CC" scope="LCL" sort="n" key="0" scroll="yes" | len="4" dtype="INT" align="right" skipb="no" /> |<hdr slbl="ERRT" llbl="ErrorText" scope="LCL" sort="n" key="0" | scroll="yes" len="16" dtype="CHAR" align="left" skipb="yes" /> |</cmdrsphdr> |<cmdrspdata> |<rsp>DB(DEDBJN03) MBR(IMSA ) CC( 0) </rsp> |<rsp>DB(BE3PARTS) MBR(IMSA ) CC( 0) </rsp> |<rsp>DB(DBHDOK01) MBR(IMSA ) CC( 0) </rsp> |<rsp>DB(PVHDJ5A ) MBR(IMSA ) CC( 0) </rsp> |<rsp>DB(DEDBJN03) AREA(DB3AREA0) MBR(IMS1 ) CC( F0) </rsp> |<rsp>DB(DEDBJN03) MBR(IMS1 ) CC( C) </rsp> |<rsp>DB(BE3PARTS) MBR(IMS1 ) CC( 0) </rsp> |<rsp>DB(DBHDOK01) MBR(IMS1 ) CC( 0) </rsp> |<rsp>DB(PVHDJ5A ) MBR(IMS1 ) CC( 0) </rsp> |</cmdrspdata> |</imsout>|
Explanation: The UPD DB NAME(BE3PARTS DEDBJN03 PVHDJ5A DBHDOK01) STOP(ACCESS) command stops access to the databases BE3PARTS, DEDBJN03, |PVHDJ5A, and DBHDOK01 and takes them offline. Response lines are |returned for all the databases that are processed. Response lines |are also returned for the DEDB areas that resulted in an error.
|| | |TSO SPOC input: |
|UPD DB NAME(*) STOP(SCHD)|
TSO SPOC output: |
|Log for . . : UPD DB NAME(*) STOP(SCHD) |IMSplex . . . . . : PLEX1 |Routing . . . . . : |Start time. . . . : 2003.128 15:06:15.89 |Stop time . . . . : 2003.128 15:06:15.92 |Return code . . . : 00000000 |Reason code . . . : 00000000 |Command master. . : IMSA|
OM API input: |
|CMD(UPD DB NAME(*) STOP(SCHD))|
OM API output: |
|<imsout> |<ctl> |<omname>OM1OM </omname> |<omvsn>1.2.0</omvsn> |<xmlvsn>1 </xmlvsn> |<statime>2003.128 22:06:15.898464</statime> |<stotime>2003.128 22:06:15.916720</stotime> |<staseq>B963E9AF7F96026A</staseq> |<stoseq>B963E9AF840B0E06</stoseq> |<rqsttkn1>USRT005 10150615</rqsttkn1> |<rc>00000000</rc> |<rsn>00000000</rsn> |</ctl> |<cmd> |<master>IMSA </master> |<userid>USRT005 </userid> |<verb>UPD </verb> |<kwd>DB </kwd> |<input>UPD DB NAME(*) STOP(SCHD) </input> |</cmd> |</imsout>|
Explanation: The UPD DB NAME(*) STOP(SCHD) command is routed to all IMSs to stop the scheduling of |all the databases and to prevent subsequently scheduled programs from |accessing them. The command is successful for all IMSs. No response |lines are returned because the default action for NAME(*) is to |return response lines only for area names that resulted in an error. |OPTION(ALLRSP) can be specified to obtain all the database names |processed by the command.
|The UPDATE LE command allows the user to define Language Environment (LE) runtime parameter overrides or to change the system option to enable/disable LE override processing. The parameters can be filtered by a transaction code, LTERM name, userid, 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.
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.
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.
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.
Table 193 shows the UPDATE LE output fields. The columns in the table are as follows:
Short Label | Keyword | Meaning |
---|---|---|
CC | N/A | Completion code for the line of output. Completion code is always returned. |
MBR | N/A | IMSplex member (IMS identifier) that built the output line. Member name is always returned. |
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. In Table 194 the return and reason code for the UPDATE LE command are displayed.
Table 195 contains the completion code that can be returned on a UPDATE LE command.
Completion Code | Meaning |
---|---|
0 | The UPDATE LE command completed successfully for the specified resource. |
The following are examples of the UPDATE LE command.
Assume the following filters and parameters are specified on UPD LE SET(LERUNOPTS()) commands that are processed in the order listed.
Rules for matching an entry which results in an update of an existing entry:
Table 196 is a logical representation of the parameter override table entries at the end of the command processing. The table includes the transaction name, LTERM, USERID, Program, and LERUNOPTS for each entry.
Entry# | TRAN | LTERM | USERID | PROGRAM | LERUNOPTS |
---|---|---|---|---|---|
1 | PART | DFSSAM02 | aaaa | ||
2 | PART | BETTY | bbbb | ||
3 | PART | TERM1 | cccc | ||
4 | DFSSAM02 | dddd | |||
5 | PART | TERM1 | BARBARA | eeee | |
6 | PART | TERM1 | BOB | ffff | |
7 | TERM2 | BETTY | gggg | ||
8 | PART | TERM2 | iiii |
TSO SPOC input:
UPD LE TRAN(IAPMDI26) USERID(USRT001) SET(LERUNOPTS(RPTOPTS=((ON),NOOVR),RPTSTG=((OFF),NOOVR)))
TSO SPOC output:
MbrName CC SYS3 0
OM API input:
CMD(UPD LE TRAN(IAPMDI26) USERID(USRT001) SET(LERUNOPTS(RPTOPTS=((ON),NOOVR),RPTSTG=((OFF),NOOVR))))
OM API output:
<imsout> <ctl> <omname>OM1OM </omname> <omvsn>1.1.0</omvsn> <xmlvsn>1 </xmlvsn> <statime>2002.163 17:56:10.220516</statime> <stotime>2002.163 17:56:10.221547</stotime> <staseq>B7C4CA4EDBFE420E</staseq> <stoseq>B7C4CA4EDC3EB382</stoseq> <rqsttkn1>USRT002 10105610</rqsttkn1> <rc>00000000</rc> <rsn>00000000</rsn> </ctl> <cmd> <master>SYS3 </master> <userid>USRT002 </userid> <verb>UPD </verb> <kwd>LE </kwd> <input>UPD LE TRAN(IAPMDI26) USERID(USRT001) SET(LERUNOPTS(RPTOPTS=((ON),NOOVR),RPTSTG=((OFF),NOOVR))) </input> </cmd> <cmdrsphdr> <hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="A" key="1" scroll="NO" len="8" dtype="CHAR" align="left" /> <hdr slbl="CC" llbl="CC" scope="LCL" sort="N" key="0" scroll="YES" len="4" dtype="INT" align="right" /> </cmdrsphdr> <cmdrspdata> <rsp>MBR(SYS3 ) CC( 0) </rsp> </cmdrspdata> </imsout>
Explanation: The UPDATE LE command adds an entry to the LE runtime options table. The entry added by this command defines two filters: userid and transaction. The transaction is set to IAPMDI26 and the userid is set to USRT001. The runtime options string for this table entry is RPTOPTS=((ON),NOOVR),RPTSTG=((OFF),NOOVR). The output shows that IMS member SYS3 processed the command with a return code of 0.
| | ||The UPDATE OLREORG command allows you to change the rate or the DEL or NODEL data |set disposition flags of an owned HALDB OLR.|
||The output for this type-2 format command is defined |in XML and is available to automation programs that communicate |with OM. See the Appendix of the IMS Version 9: Common Service Layer Guide and Reference for |sample IMS command XML.|
||For the type-1 version of the command, you can specify |only one NAME keyword for each of these commands that you issue.|
| |A rate value of 50 specifies that 50% of the elapsed time be |spent copying records and the remaining 50% be spent in a delay. |This causes the reorganization to run approximately twice as long |as it would have run with a rate value of 100.
| |You can use the RATE parameter to control the intensity at which |the reorganization runs. This can affect both the reorganization's |speed and its impact on the rest of the system. The value you specify |for rate is the percentage of elapsed time to be devoted to copying |records. The remaining time is to be an intentionally introduced |delay in the copying process that minimizes the reorganization's |impact on other IMS work and on the whole system.
| |RATE(100) is the default.
||When the /UPDATE OLREORG command is entered as a type-1 command, the command response |is returned in a message format.|
||When the command completes successfully, message |DFS0725I with a completion code of 0 is returned to the system console |and master terminal. If the command results in an error, a non-zero |completion code or an error message is returned to the master terminal |and system console.|
|If the command results in an error, this error message is returned |to the entering terminal: |
|DFS0725I INITIATE|UPDATE|TERMINATE OLREORG COMMAND FOR DB dbnamexx COMPLETE. |CC= nn | where: dbnamexx is the HALDB partition name entered on the command | nn is the completion code|| | |
This section describe the responses from the OM API for |the UPDATE OLREORG command.Table 197 shows |the UPDATE OLREORG output fields. The columns in the table are as follows: |
|N/A appears for output fields that are always returned.
||Short Label | |Show Keyword | |Meaning |
---|---|---|
|PART | |N/A | |Partition name. |
|MBR | |N/A | |The IMS that built the command response line. |
|CC | |N/A | |Completion code. |
The OM return and reason codes that might be returned |as a result of the UPDATE OLREORG command are standard for all commands entered through the |OM API.
|Table 72 includes the return |and reason codes and a brief explanation of the UPDATE OLREORG command. Table 199 includes |an explanation of the completion codes. Errors unique to the processing |of UPDATE OLREORG command are returned as completion codes. A completion code |is returned for each action attempted on a HALDB partition.
|Return Code | |Reason Code | |Meaning |
---|---|---|
|X'00000000' | |X'00000000' | |The UPDATE OLREORG command completed successfully. |
|X'00000008' | |X'00002008' | |Insufficient number of keywords specified. |
|X'00000010' | |X'0000400C' | |Command issued on an XRF alternate. |
| | |X'00004014' | |Command issued on an RSR tracker. |
|X'00000014' | |X'00005000' | |A GETMAIN error occurred. |
This section provides Entry ET, Response ET, OM API, and |TSO SPOC input and output examples and explanations for UPDATE OLREORG.
| |Entry ET: |
|/UPD OLREORG NAME(PDHDOKA) SET(RATE(25))|
Response ET: |
|DFS0725I UPDATE OLREORG COMMAND FOR DB PDHDOKA COMPLETE. CC= 0|
Explanation: The UPDATE OLREORG command is issued for partition PDHDOKA to change the OLR |rate to 25. The command is successful as indicated in the message DSF0725 |command response.
| |TSO SPOC input: |
|UPD OLREORG NAME(PDHDOKA,PDHDOKB) SET(RATE(25))|
TSO SPOC output: |
||Partition MbrName CC | PDHDOKA IMSA 0 | PDHDOKA IMS1 24 | PDHDOKB IMSA 0 | PDHDOKB IMS1 24|
OM API input: |
|CMD (UPD OLREORG NAME(PDHDOKA,PDHDOKB) SET(RATE(25)))|
OM API output: |
|<imsout> |<ctl> |<omname>OM1OM </omname> |<omvsn>1.2.0</omvsn> |<xmlvsn>1 </xmlvsn> |<statime>2003.168 21:17:57.712194</statime> |<stotime>2003.168 21:17:57.713062</stotime> |<staseq>B996297E02942007</staseq> |<stoseq>B996297E02CA6487</stoseq> |<rqsttkn1>USRT005 10141757</rqsttkn1> |<rc>0200000C</rc> |<rsn>00003000</rsn> |</ctl> |<cmderr> |<mbr name="IMS1 "> |<typ>IMS </typ> |<styp>DBDC </styp> |<rc>0000000C</rc> |<rsn>00003004</rsn> |</mbr> |</cmderr> |<cmd> |<master>IMSA </master> |<userid>USRT005 </userid> |<verb>UPD </verb> |<kwd>OLREORG </kwd> |<input>UPD OLREORG NAME(PDHDOKA,PDHDOKB) SET(RATE(25)) </input> |</cmd> |<cmdrsphdr> |<hdr slbl="PART" llbl="Partition" scope="LCL" sort="A" key="1" | scroll="NO" len="9" dtype="CHAR" align="left" /> |<hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="N" key="0" scroll="NO" | len="8" dtype="CHAR" align="left" /> |<hdr slbl="CC" llbl="CC" scope="LCL" sort="N" key="0" scroll="YES" | len="4" dtype="INT" align="right" /> |</cmdrsphdr> |<cmdrspdata> |<rsp> PART(PDHDOKA ) MBR(IMSA ) CC( 0) </rsp> |<rsp> PART(PDHDOKB ) MBR(IMSA ) CC( 0) </rsp> |<rsp> PART(PDHDOKA ) MBR(IMS1 ) CC( 24) </rsp> |<rsp> PART(PDHDOKB ) MBR(IMS1 ) CC( 24) </rsp> |</cmdrspdata> |</imsout>|
Explanation: The UPDATE OLREORG command is issued for partitions PDHDOKA and PDHDOKB to update |the OLR rate to 25. The command is successful at IMSA where OLR |is in progress and not at IMS1 where OLR is not in progress. A completion |code of 24 is returned in the IMS1 response.
The UPDATE TRAN command changes the status of transaction resources in an IMSplex.
This command may be specified only through the OM API.
The UPDATE TRAN command is not valid on the RSR tracker.
The UPDATE TRAN SET(MAXRGN) and UPDATE TRAN STARTISTOP(TRACE) commands are valid on the XRF alternate. All other instances of the UPDATE TRAN command are not valid on the XRF alternate.
The UPDATE TRAN command with START(Q,SCHD,SUSPEND), STOP(Q,SCHD), or SET(CLASS,CPRI,LCT,LPRI,MAXRGN,NPRI,PARLIM,PLCT,SEGNO,SEGSZ) is recoverable over an IMS restart. The UPDATE TRAN command with START(TRACE), or STOP(TRACE) is not recoverable over an IMS restart.
A new X'22' log record is written during the processing of the UPDATE TRAN command with START(Q,SCHD,SUSPEND), STOP(Q,SCHD), or SET(CLASS,CPRI,LCT,LPRI,MAXRGN,NPRI,PARLIM,PLCT,SEGNO,SEGSZ). A log record is not written for the UPDATE TRAN command with START(TRACE) or STOP(TRACE).
The command syntax for this command is defined in XML and is available to automation programs that communicate with OM.
PARLIM can not be specified for CPI Communications driven transactions.
PLCT can not be specified for CPI Communications driven transactions.
SEGNO can not be specified for CPI Communications driven transactions.
SEGSZ can not be specified for CPI Communications driven transactions.
Table 200 shows |the UPDATE TRAN output fields. The columns in the table are as follows: |
|Short Label | |Keyword | |Meaning | |
---|---|---|
CC | |N/A | |Completion code for the line of output. The completion code |is always returned. | |
MBR | |N/A | |The IMSplex member that built the output line. |The IMS identifier of the IMS for which the transaction information |is displayed. The IMS identifier is always returned. | |
TRAN | |N/A | |The transaction name. The transaction name is |always displayed. | |
Table 201 contains the return and reason codes for the UPDATE TRAN command.
Errors unique to the processing of the UPDATE TRAN command are returned as a completion code. A completion code is returned for each action against an individual resource. The following completion codes in Table 202 may be returned on an UPDATE TRAN command.
Table 203 shows different instances of the UPDATE TRAN command and other IMS commands that perform similar functions.
TSO SPOC input:
UPDATE TRAN NAME(ADDINV) STOP(Q,SCHD)
TSO SPOC output:
Trancode MbrName CC ADDINV SYS3 0
OM API input:
CMD(UPDATE TRAN NAME(ADDINV) STOP(Q,SCHD))
OM API output:
<imsout> <ctl> <omname>OM1OM </omname> <omvsn>1.1.0</omvsn> <xmlvsn>1 </xmlvsn> <statime>2002.163 17:11:29.656126</statime> <stotime>2002.163 17:11:29.682014</stotime> <staseq>B7C4C0527953EC28</staseq> <stoseq>B7C4C0527FA5E144</stoseq> <rqsttkn1>USRT002 10101129</rqsttkn1> <rc>00000000</rc> <rsn>00000000</rsn> </ctl> <cmd> <master>SYS3 </master> <userid>USRT002 </userid> <verb>UPD </verb> <kwd>TRAN </kwd> <input>UPDATE TRAN NAME(ADDINV) STOP(Q,SCHD) </input> </cmd> <cmdrsphdr> <hdr slbl="TRAN" llbl="Trancode" scope="LCL" sort="a" key="1" scroll="no" len="8" dtype="CHAR" align="left" /> <hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="a" key="2" scroll="no" len="8" dtype="CHAR" align="left" /> <hdr slbl="CC" llbl="CC" scope="LCL" sort="n" key="0" scroll="yes" len="4" dtype="INT" align="right" /></cmdrsphdr> <cmdrspdata> <rsp>TRAN(ADDINV ) MBR(SYS3 ) CC( 0) </rsp> </cmdrspdata> </imsout>
Explanation: Queuing and scheduling is stopped for transaction ADDINV.