IMPORT DEFN SOURCE(CATALOG) command

When the IMS management of ACBs is enabled, use the IMPORT DEFN SOURCE(CATALOG) command to activate application and database resource definitions (PSBs and DBDs) in an online IMS system by importing them from the staging data set of the IMS catalog.

The IMS management of ACBs must be enabled before you can use the IMPORT DEFN SOURCE(CATALOG) command. If the IMS management of ACBs is not enabled, IMPORT DEFN SOURCE(CATALOG) is rejected. For more information about the IMS management of ACBs, see IMS management of ACBs.

Start of change If you are modifying certain types of PSBs in an IMSplex that uses a shared IMS catalog, you can activate the modified PSBs in a subset of the IMS systems by using the UPDATEPSB and REFRESHPSB options. You can then test the application changes in the subset before you activate the changes across the entire IMSplex. End of change

The IMPORT command can be issued through TSO SPOC, IBM Management Console for IMS and DB2® for z/OS®, the Manage Resources options in the IMS Applications menu, or any user-written programs that issue commands through OM API. These commands can also be issued to an IMSplex by using the Batch SPOC utility.

Subsections:

Environment
Syntax
Keywords
Usage notes
Output fields
Return and reason codes
Completion codes
Examples

Environment

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

Table 1. Valid environments for the IMPORT command and keywords
Command / Keywords	DB/DC	DBCTL	DCCTL
IMPORT DEFN	X	X	X
OPTION	X	X	X
SOURCE(CATALOG)	X	X

Syntax

Keywords

The following keywords are valid for the IMPORT command:

DEFN

A required keyword.

FOR()

When the OPTION() keyword is specified, specifies which IMS systems in the IMS sysplex are to participate in the IMPORT process. Depending on the type of resources that are being imported and the state of processing in each IMS system, the options that are specified on the OPTION() keyword might impact systems that are not listed in the FOR(IMSID()) keyword. For more information, see the description of the OPTIONS() keyword.

IMSID()

Specify one or more comma-separated IMS IDs of the IMS systems that are to process the IMPORT command and the specified option.

The IMS ID specified on the FOR(IMSID()) keyword must be an IMS that exists within the IMSplex. The IMS specified might be active or down when the command is issued.

Note: Depending on the value that is specified on the OPTION() keyword, the IMS systems that are listed on the IMSID() keyword must either include or exclude the command master.

IMS selects a command master from the IMS systems that the command is routed to when the command is submitted. Therefore, to include the command master, route the command to one or more of the IMS systems that are specified on the IMSID() keyword. To exclude the command master, route the command to one or more IMS systems that are not specified on the IMSID() keyword.

When OPTION(UPDATEPSB) is specified, one of the IMS systems that is specified on the IMSID() keyword must be the command master, so route the IMPORT DEFN command to only the specified IMS systems.

When OPTION(REFRESHPSB) is specified, the command master cannot be an IMS system that is specified on the IMSID() keyword, so route the IMPORT DEFN command to one or more IMS systems that are not specified on the IMSID() keyword.

When either of the preceding options is specified, if the command is routed to all IMS systems in the IMSplex, either explicitly or by default, the success of the command is unpredictable because the IMS system that is selected as the command master is unpredictable.

To see a list of the IMS systems in your IMSplex, issue the QUERY IMSPLEX TYPE(IMS) SHOW(ALL) command.

OPTION()

Specifies optional functions of the command.

You can specify the following options:

DELPENDERR

Specifies that if errors occur during the prepare phase of IMPORT DEFN SOURCE(CATALOG) command processing, the pending resources are deleted from the staging data set. An error in the prepare phase is indicated by OLCPREPF in the IMPORT DEFN command output. End of change

REFRESHPSB

Causes the IMS systems that are listed in the FOR(IMSID()) option to reload from the IMS catalog directory data set all PSBs in the system that have a refresh-pending (REFP) status.

Specify the REFRESHPSB option to activate PSB changes in an IMSplex that were previously activated by the UPDATEPSB option in only a subset of the IMS systems in the IMSplex.

Program resources that might be affected by the changes must be stopped on the systems that are listed in the FOR() option.

PSB activation does not occur for systems that are not listed in the FOR(IMSID()) clause.

To see a list of the IMS systems in your IMSplex, issue the QUERY IMSPLEX TYPE(IMS) SHOW(ALL) command.

While the REFRESHPSB option is being processed by an IMS system, the system status includes RFSHPSB in the LclStat field of the QUERY MEMBER command output.

UPDATEPSB

In an IMSplex, activates PSB changes in the IMS catalog and causes the IMS systems that are listed in the FOR(IMSID()) option to reload the changed PSBs the next time the PSBs are scheduled. IMS systems that are omitted from the FOR(IMSID()) keyword are not notified by the command to reload the modified PSBs and continue to use the original PSB definition in online memory until the REFRESHPSB option is submitted or another event, like a system restart, causes the PSB to be reloaded.

If the staging data set of the IMS catalog contains any DBDs when the UPDATEPSB option is specified, the IMPORT command fails.

The FOR(IMSID()) keyword is not effective for DOPT PSBs. After you issue the UPDATEPSB option, all IMS system that schedule the PSB in the IMSplex load the new, modified PSB from the IMS directory.

The FOR(IMSID()) keyword is effective for non-resident PSBs only if the PSB is cached in the 64-bit storage pools of the IMS systems that are not specified on the FOR(IMSID()) keyword.

Program resources that might be affected by the changes must be stopped on the systems that are listed in the FOR(IMSID()) option. Stopping the resources is not necessary for systems that are not listed in the FOR(IMSID()) option, unless the PSB is a DOPT PSB or a non-resident PSB that is not cached in the 64-bit storage pool of the systems.

All pending PSB changes in the staging data set are activated in the IMS systems that are listed in the FOR(IMSID()) clause when the IMPORT command is issued with the UPDATEPSB option.

When OPTION(UPDATEPSB) is specified, one of the IMS systems that is specified on the IMSID() keyword must be the command master, so route the IMPORT DEFN command to only the specified IMS systems.

To see a list of the IMS systems in your IMSplex, issue the QUERY IMSPLEX TYPE(IMS) SHOW(ALL) command.

While OPTION(UPDATEPSB) is being processed by an IMS system, the system status includes UPDPSB in the LclStat field of the QUERY MEMBER command output.

SOURCE()

Specifies the source of the resource definitions to be imported.

CATALOG: A required parameter that indicates that the resources to be activated are to be imported into the online IMS systems from the staging data set of the IMS catalog.

Usage notes

Before you run the IMPORT DEFN SOURCE(CATALOG) command, stop all existing database and program resources that will be affected by the changes.

After the command processing completes, restart all databases and programs that were stopped for the change.

When the IMPORT DEFN SOURCE(CATALOG) command is issued, IMS takes the following actions:

Adds or replaces the ACBs in the directory data set of the IMS catalog.
Removes the ACBs from the staging data set of the IMS catalog.
Removes all old copies of the resources from memory and casts out DMBs and PSBs from their respective pools.
If the IMS catalog is shared by multiple IMS systems, coordinates the change across the IMSplex.
Updates the IMS catalog HEADER segment for the imported objects.

When you issue the IMPORT DEFN SOURCE(CATALOG) command, IMS uses an internal process that is similar to the online change function to activate the resources in online IMS systems. Consequently, if you issue the QUERY MEMBER command during import processing, the status reflects the same prepare and commit phases that online change uses. If errors occur, the messages might also reflect these phases.

The IMPORT DEFN SOURCE(CATALOG) command can be issued only through the Operations Manager (OM) API. This command applies to DB/DC and DBCTL systems in which the IMS management of ACBs is enabled by ACBMGMT=CATALOG in the CATALOG section of the DFSDFxxx member.

The IMPORT command is not valid on the XRF alternate, RSR tracker, or FDBR region.

The IMPORT DEFN SOURCE(CATALOG) command is valid for the following resource types:

Database descriptors (DBDs)
Program views (PSBs) and their associated application control blocks (ACBs)

By default, when the IMPORT command is issued, OM routes the command to all active IMS systems (or to all IMS systems that are specified in the route list if the ROUTE parameter is specified on the CSLOMCMD or CSLOMI request) that registered interest in the command. All IMS systems that receive the command attempt to process the IMPORT command and import the resource definitions from the specified source. If you need the IMPORT command to be processed by a specific IMS, the ROUTE parameter must be used to direct the IMPORT command to the specific IMS.

The value of the ACBSHR= parameter that is in effect on the command master IMS system can affect whether the other IMS systems in the IMSplex process an IMPORT DEFN SOURCE(CATALOG) command.

If ACBSHR=Y is specified in the command master, the IMPORT DEFN SOURCE(CATALOG) command is processed by all IMS systems in the IMSplex that specify ACBSHR=Y and any IMS systems that specify ACBSHR=N, if they are specified on the ROUTE parameter when the command is issued. For IMS systems that specify ACBSHR=N, the IMPORT command succeeds only if the IMS systems have pending ACB changes in the IMS catalog instance that they use.
If ACBSHR=N is specified on the command master, the command is processed by the command master and by any IMS systems that also specify ACBSHR=N and are specified on the ROUTE parameter. The command is rejected by IMS systems that specify ACBSHR=Y.

The IMS system that serves as the command master is selected by IMS from the IMS systems to which the IMPORT DEFN command was routed.

The UPDATEPSB and REFRESHPSB options each require you to route the command differently. When the UPDATEPSB option is specified, you must route the command to one or more of the IMS systems that are specified on the FOR(IMSID()) keyword. When the REFRESHPSB option is specified, you must route the command to one or more IMS systems that are not specified on the FOR(IMSID()) keyword.

Start of change The UPDATEPSB option is for use with PSBs that IMS systems store in online memory, such as PSBs defined as resident and non-resident PSBs that have been cached in a 64-bit storage pool. For dynamic option (DOPT) PSBs and for non-resident PSBs that are not cached in an online 64-bit storage pool of an IMS system, the effect of the UPDATEPSB option is no different than issuing the IMPORT DEFN SOURCE(CATALOG) command without OPTION(UPDATEPSB) specified. End of change

Start of change The IMS systems that are not specified in the FOR(IMSID()) keyword when the UPDATEPSB option is specified do not process the IMPORT command so do not reload their in-memory PSB definitions after the modified PSB definitions are imported into the IMS directory. However, after command processing completes, if an IMS system that was not specified on the command is required to reload its in-memory PSB definition from the IMS directory for any other reason, the modified PSB definition will become the active PSB definition in that IMS system. End of change

Start of change Usually, the IMS systems that are excluded from the UPDATEPSB option continue to use the original, in-memory PSB definitions until either the IMPORT DEFN SOURCE(CATALOG) OPTION(REFRESHPSB) command is issued for the IMS system or the IMS system is restarted. In-memory PSB definitions that are prevented from reloading when the UPDATEPSB option is specified have a refresh-pending (REFP) status in the IMPORT command response. End of change

Start of change To activate the PSB modifications in an IMS system and remove the PSBs refresh-pending status, issue the IMPORT DEFN SOURCE(CATALOG) OPTION(REFRESHPSB) command with the ID of the IMS system specified on the FOR(IMSID()) keyword. The REFRESHPSB option reloads all PSB definitions that have a refresh-pending status in the IMS system. End of change

Output fields

In addition to the message, command response output is also returned in XML tag structure. The following table shows the IMPORT response output fields. The columns in the table are as follows:

Short label: Contains the short label that is generated in the XML output.
Long label: Contains the long label that is generated in the XML output.
Keyword: Identifies keyword on the command that caused the field to be generated. N/A (not applicable) appears for output fields that are always returned. The value error appears for output fields that are returned only when an error occurs.
Meaning: Provides a brief description of the output field.

Table 2. Output fields for the IMPORT command
Short label	Long label	Keyword	Meaning
ADD	ADD		The listed DBD or PSB was added as new to the IMS directory data set. This output field is displayed only if it applies to one or more DBDs or PSBs.
CATS	CATSHR		Y The directory data sets are shared by IMS in the plex with ACBSHR=Y specified and with the same catalog alias specified. N The directory data sets is accessed by this IMS only.
CC	CC	N/A	Completion code.
CCTXT	CCText	error	Completion code text that briefly explains the meaning of the nonzero completion code.
CHG	CHNG		The listed DBD or PSB was successfully modified in the IMS directory data sets. This output field is displayed only if it applies to one or more DBDs or PSBs.
CPY	COPY		The listed DBD or PSB was added to the IMS directory data set, but cannot be used until its runtime control block is created in the online IMS system by either a CREATE DB or a CREATE PGM command. This output field is displayed only if it applies to one or more DBDs or PSBs.
DBD	DBDName		Name of the DBD acted upon during IMPORT command processing.
DLT	DLET		The listed DBD or PSB was removed from the IMS directory data set because updates to another DBD removed the last or only logical relationship that required it. This output field is displayed only if it applies to one or more DBDs or PSBs.
ERRT	ErrorText		Additional information about errors.
PHST	ErrPhase		A phase where an error occurred: OLCPREPF The process failed at prepare phase. The process is aborted. OLCCMT1F The process failed at commit phase 1. The process is aborted. OLCCMT2F The process failed at commit phase 2. The process is aborted. OLCCMT3F The process failed at commit phase 3. The process is aborted. OLCCMT4F The process failed at commit phase 4. The process reached a commit point.
MBR	MbrName	N/A	IMSplex member that built the output line.
PSB	PSBName		Name of the imported PSB.
RFP	REFP		This IMS system is not yet using the most current version of the PSB that is in the IMS directory data set. To activate the most current version of the PSB in this IMS system, issue IMPORT DEFN SOURCE(REFRESHPSB) FOR(`this_ims`). This output field is displayed only if it applies to one or more DBDs or PSBs.
RFS	RFSH		The listed DBD or PSB was successfully imported into the IMS directory data set. The only difference between the imported version and the previous version is the timestamp. This output field is displayed only if it applies to one or more DBDs or PSBs.

Return and reason 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.

Table 3. Return and reason codes for the IMPORT command
Return code	Reason code	Meaning
X'0000008'	X'0000203C'	The command contains an invalid keyword parameter value.
X'00000008'	X'00002004'	Invalid command keyword or invalid command keyword combination.
X'00000008'	X'00002008'	Insufficient number of keywords.
X'00000008'	X'00002009'	Multiple values for same attribute.
X'00000008'	X'00002028'	The command contains an invalid keyword.
X'00000008'	X'00002176'	The Command (CMD) master was not provided. If OPTION(UPDATEPSB) is specified, the IMS command master must be included in the FOR(IMSID(imsid)) list.
X'00000008'	X'00002177'	The Command (CMD) master was provided. If OPTION(REFRESHPSB) is specified, the IMS command master must not be included in the FOR(IMSID(imsid)) list.
X'0000000C'	X'00003000'	Command was successful for some resource definitions but failed for others.
X'00000010'	X'00004100'	Resource structure is full.
X'00000010'	X'00004104'	No RM address space.
X'00000010'	X'00004108'	No SCI address space.
X'00000010'	X'0000400C'	Command is not valid on the XRF alternate.
X'00000010'	X'00004014'	Command is not valid on the RSR tracker.
X'00000010'	X'00004018'	No resource structure exists, or resource structure is not available.
X'00000010'	X'0000401C'	Command is not valid on the FDBR region.
X'00000010'	X'00004120'	Online change phase is in progress.
X'00000010'	X'00004124'	The IMPORT command is rejected, because a process of a similar type is in progress. Possible commands in progress are /DISPLAY MODIFY, CREATE DB, or DELETE DB commands. Wait until the other process completes and issue the IMPORT command again.
X'00000010'	X'00004509'	RM data version is lower than the IMS data version.
X'00000014'	X'00005000'	The IMPORT command was terminated, because IMODULE GETSTOR storage could not be obtained.
X'00000014'	X'00005004'	DFSOCMD response buffer could not be obtained.
X'00000014'	X'00005008'	DFSPOOL storage could not be obtained.
X'00000014'	X'0000500C'	AWE could not be obtained.
X'00000014'	X'00005010'	Unable to obtain latch.
X'00000014'	X'00005018'	Unable to obtain a 64-bit buffer.
X'00000014'	X'00005100'	RM request error.
X'00000014'	X'00005108'	SCI request error.
X'00000014'	X'00005FFF'	The IMPORT command could not be processed because of an internal error.
X'0000000C'	X'00003004'	No requests were successful.

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

Completion codes

Table 4. Completion codes for the IMPORT command
Completion code	Completion code text	Meaning
0		Command completed successfully for resource or descriptor definition.
1	COMMAND NOT APPLICABLE TO THIS IMS	The IMPORT DEFN SOURCE(CATALOG) command does not apply to this IMS.
2	COMMAND NOT ATTEMPTED BY THIS IMS	The IMPORT DEFN SOURCE(CATALOG) command was not attempted by this IMS for one of the following reasons: The IMPORT DEFN SOURCE(CATALOG) command master encountered an error and did not direct this IMS to process the IMPORT DEFN SOURCE(CATALOG) command. The IMPORT DEFN SOURCE(CATALOG) command master rejected the command because one or more IMS systems are down. The IMPORT DEFN SOURCE(CATALOG) command master did not direct this IMS to process the command.
3	IMS ALREADY IN REQUESTED OLC STATE	This IMS already processed the IMPORT DEFN SOURCE(CATALOG) command.
4	OLC PHASE INCOMPLETE ON THIS IMS	The IMPORT DEFN SOURCE(CATALOG) command is incomplete on this IMS. Look for other nonzero completion codes in the command output to determine why command processing is incomplete.
5	OLC COMPLETE, SOME MBRS UNUSABLE	The IMPORT DEFN SOURCE(CATALOG) command is complete; however, during internal commit processing after the IMS list was updated in the IMS directory, an error was encountered and one or more ACBs that were added or changed are unusable.
1D	XRF TAKEOVER IS IN PROGRESS	The IMPORT DEFN SOURCE(CATALOG) command cannot be processed because a takeover is in progress.
32	NOT ALLOWED FOR AN MSDB	The IMPORT command cannot be processed because one of the resources that is being imported from the staging directory is an MSDB. If the IMPORT command that is being processed does not include the NAME keyword, the command terminates on the first error, and the command output includes only the resources processed until the error. If the IMPORT command that is being processed includes the NAME keyword, all the resources that are associated with the name or names that are specified on the IMPORT command are listed in the command output.
51	NO RESOURCE STRUCTURE	The resource structure is not available. The resource could not be registered with RM. The resource definition was not imported.
52	RESOURCE STRUCTURE FULL	The resource structure is full. The resource could not be registered with RM. The resource definition was not imported.
58	IMS NOT REGISTERED TO RM	IMS is not registered to RM.
60	IMODULE GETMAIN storage error.
61	DFSBCB STORAGE ERROR	DFSBCB storage error. Could not get storage for DDIR, PDIR, RCTE, or SMB control block. The resource or descriptor definition was not imported.
62	HIOP storage error.
63	WKAP storage error.
64	GETSTOR STORAGE ERROR	DFSPOOL storage error. Could not get storage from the CMDP pool. The resource or descriptor was not imported.
73	PROGRAM SCHEDULED	Program is scheduled.
77	DEPENDENT REGIONS ACTIVE	One or more dependent regions are scheduled against the database, or one or more areas are open. The DEDB cannot be updated.
80	DATASET ERROR	Function (8 characters), ddname (8 characters), return code (8 bytes), and error detail (8 characters). Function can be one of the following: BLDL Data set BLDL error. BUSY The data set is busy. The detail contains the job name that has the data set. DIR Data set directory error. EMPTY Library is empty. ENQUEUE Data set enqueue error. EOF Data set end-of-file (EOF) error. OPEN Data set open error. Error detail can be 'DLS REG'. READ Data set read error. WRITE Data set write error. Ddname can be the DFSDIRC, the ddname of the IMS directory data set or DFSSTDI, the ddname of the staging data set of the IMS directory. Return code is the data set service return code. Reason code is the data set service reason code.
90	INTERNAL ERROR	An IMS internal error occurred. The definition was not imported.
91	TIMEOUT ERROR	An internal prepare phase, commit phase, or abort phase of the IMPORT DEFN SOURCE(CATALOG) command timed out before this IMS responded to the internal prepare or commit phase. The prepare phase or commit phase might have succeeded on this IMS.
94	RM REQUEST ERROR	An RM request error occurred. The resource could not be registered with RM. The resource definition was not imported.
B0	RESOURCE DEFINITION ERROR	The resource exists as another resource type in the RM structure. The resource definition was not imported.
B1	RESOURCE STATE ERROR	Resource type (8 characters), resource name (8 characters), error detail (16 characters). The resource name is the name of the resource as it is defined to IMS, such as the database name, the program name, or the transaction name. The error detail can be one of the following: AREA OPEN An area associated with the FP DEDB is open. AREA STARTED An area associated with the FP DEDB is started. DATABASE `dbname` ALTER INCOMPLETE Alter processing is not complete for a HALDB database. After alter processing completes, retry the INITIATE OLC command. DATABASE `dbname` STG TOO SMALL The IMPORT DEFN SOURCE(CATALOG) command cannot process the altered DDIR because there is not enough internal block storage. The lack of storage could be caused by the start of another HALDB alter operation after the IMPORT command reaches the commit phase. Retry the IMPORT DEFN SOURCE(CATALOG) command. Error details continued in next row.
B1	RESOURCE STATE ERROR (continued)	DBD ACTIVE A /DBDUMP command is active for the database. DBR ACTIVE A /DBRECOVERY command is active for the database. DBR NEEDED A /DBRECOVERY command is needed for the database resource. The IMPORT DEFN SOURCE(CATALOG) command was initiated to either change or delete one or more HALDB databases which have not been taken offline with a /DBR command. If the IMS catalog is enabled with an alias other than DFSC (the standard alias prefix), and the catalog databases have been modified with the IMPORT DEFN SOURCE(CATALOG) command, issue the /DBR DB command for the databases IMS1D000 and IMS1X000 instead of DFSCD000 and DFSCX000. DEP REGS ACTIVE Dependent regions using the FP DEDB are active. Error details are shown in next row.
B1	RESOURCE STATE ERROR (continued)	Error detail (continued): INTERNAL ERROR The resource control block is not found in the active IMS, or the resource control block exists. These are internal errors that should not occur. IN USE The resource is in use. A transaction has queuing in progress (either terminal input program-to-program switch). A database is in use. PSB SCHEDULED A program referencing a database to be changed or deleted is scheduled. QUEUEING Messages are queued to the transaction or program. SCHEDULED The named resource (a transaction or program to be changed or deleted, or a program referencing a database to be changed or deleted) is scheduled. SUSPENDED The transaction to be changed or deleted is on the suspend queue.
B2	IMS STATE ERROR	IMS state error (32 characters). The IMS state can be one of the following: CHECKPOINT IN PROGRESS This IMS has checkpoint in progress. NOT-REACHABLE The online change phase is rejected because this IMS is NOT-REACHABLE. The SCI on the OS image where this IMS is active is down. Restart the SCI and reissue the IMPORT DEFN SOURCE(CATALOG) command. OLC ALREADY COMMITTED The internal online change phase of IMPORT command processing is rejected because online change is already committed.
B2	IMS STATE ERROR (continued)	IMS state error (32 characters). The IMS state can be one of the following: OLC PHASE IN PROGRESS The IMPORT DEFN SOURCE(CATALOG) command is rejected because this IMS is processing either another IMPORT DEFN SOURCE(CATALOG) command or an online change request. RECOVERY IN PROGRESS The IMPORT DEFN SOURCE(CATALOG) command is rejected because the online recovery service is already in progress. RESOLVE DB INDOUBTS This IMS has DB indoubts. You must resolve the DB indoubts either by reconnecting the coordinator controller and IMS or by using an operator command. RESTART IN PROGRESS This IMS has restart in progress. RESTART NOT COMPLETE This IMS initialized before the IMPORT DEFN SOURCE(CATALOG) command was issued, but has not completed restart. The command is rejected as long as this IMS is in this state.
D6	DATABASE IN USE	Database in use. The DEDB cannot be changed because the DEDB is in use in a region.
E1	DB MUST BE STOPPED AND OFFLINE	The database must be stopped and taken offline in order for the attribute to be changed. You might need to issue a /DBR DB command or an UPDATE DB STOP(ACCESS) command to stop the database and take it offline before issuing the IMPORT DEFN command.
120	STAGING ACBLIB IS EMPTY	The IMPORT DEFN SOURCE(CATALOG) command failed.
121	RESOURCE IN CMD HAS NO CHANGE	The IMPORT DEFN SOURCE(CATALOG) command failed.
122	NOT ALL PSBS REBUILT FOR THIS DMB	The IMPORT DEFN SOURCE(CATALOG) command failed.
123	STAGING LIBRARY LEVEL NOT COMPATIBLE WITH CURRENT IMS	The IMPORT DEFN SOURCE(CATALOG) command failed.
125	NO PSB REBUILT	During processing of the IMPORT DEFN SOURCE(CATALOG) command, IMS found existing PSB resources in the IMS directory that must be rebuilt before a modified DBD resource can be activated.
1D0	NOT DONE DUE TO ERROR	The identified resource was not imported because an error occurred. Check for other completion codes that are greater than 4 to determine the cause of the error.
1F2	DIRECTORY BLDL FAILED	During processing of the IMPORT DEFN SOURCE(CATALOG) command, IMS encountered a BLDL error while reading the directory data sets.
1F3	BAD ACB FORMAT IN DIRECTORY	During processing of the IMPORT DEFN SOURCE(CATALOG) command, IMS encountered an ACB that contains a block with an unrecognized DBD or PSB format.
1F5	OPEN DIRECTORY FAILED	During processing of the IMPORT DEFN SOURCE(CATALOG) command, IMS was unable to open the IMS directory data set for update. This is probably an internal error. Contact IBM Software Support.
1F6	CANNOT IMPORT IMS SYSTEM RSC	During processing of the IMPORT DEFN SOURCE(CATALOG) command, IMS encountered an ACB for the IMS catalog or another IMS system resource. The IMS catalog cannot be modified by using the IMPORT DEFN SOURCE(CATALOG) command.
1FB	PSB NOT REBUILT	During processing of the IMPORT DEFN SOURCE(CATALOG) command, IMS found existing PSB resources in the IMS directory that must be rebuilt before a modified DBD resource can be activated.
1FC	I/O ERROR READING DIRECTORY	During processing of the IMPORT DEFN SOURCE(CATALOG) command, IMS was unable to read from the IMS directory. Determine the cause of the error and restore or rebuild the IMS directory. After the IMS directory is recovered, reissue the IMPORT command.
1FD	I/O ERROR READING STAGING	During processing of the IMPORT DEFN SOURCE(CATALOG) command, IMS was unable to read from the staging data set of the IMS catalog. Resubmit the resource changes to IMS by using either DDL or one of the IMS catalog populate utilities. After the changes are resubmitted to IMS, reissue the IMPORT command.
1FE	ADDED MBR NOT IN STAGING	This is probably an internal error. Contact IBM Software Support.
1FF	REPLACED MEMBER NOT IN STAGING	This is probably an internal error. Contact IBM Software Support.
227	ERROR CLEANUP DIRECTORY	IMPORT DEFN SOURCE(CATALOG) command processing attempted to clean up the directory data sets before initiating a new import activation process, but the cleanup process failed. Check the console for error messages and correct any errors before resubmitting the IMPORT command.
231	DLET MBR NOT IN DIRECTORY	During processing of the IMPORT DEFN SOURCE(CATALOG) command, IMS attempted to delete a resource from the IMS directory, but the resource was not found in the IMS directory.
235	EMPTY STAGING DIRECTORY	During processing of the IMPORT DEFN SOURCE(CATALOG) command, no resources were found to import in the staging data set.
236	I/O ERROR UPDATING DIRECTORY	During processing of the IMPORT DEFN SOURCE(CATALOG) command, IMS was unable to update the IMS directory. This is probably an internal error. Contact IBM Software Support.
237	I/O ERROR READING DFSIMSL	During processing of the IMPORT DEFN SOURCE(CATALOG) command, IMS could not read the IMS list in the IMS directory.
238	I/O ERROR WRITING DFSIMSR	During processing of the IMPORT DEFN SOURCE(CATALOG) command, IMS could not update the resource list in the IMS directory.
23A	I/O ERROR WRITING DFSIMSL	During processing of the IMPORT DEFN SOURCE(CATALOG) command, IMS could not write to the list of IMS systems that share the IMS catalog in the IMS directory.
23C	THIS IMS CATALOG IS NO LONGER SHARED	The ACBSHR specification for this IMS system changed from ACBSHR=Y to ACBSHR=N. When processing the IMPORT DEFN SOURCE(CATALOG) command, IMS no longer includes this IMS system in the global coordination of changes to a shared IMS catalog in the IMSplex.
23D	DIRECTORY DATA SET FULL	The IMPORT DEFN SOURCE(CATALOG) command failed because the directory data set was full. Run the catalog recovery utility to get more spaces for the data sets.
23E	STAGING BLDL FAILED	During processing of the IMPORT DEFN SOURCE(CATALOG) command, IMS encountered a BLDL error while reading the staging data sets.
240	IMSID NOT FOUND IN DFSIMSL	During processing of the IMPORT DEFN SOURCE(CATALOG) command, an imsid provided in the FOR(IMSID(imsid)) list does not exist in the DFSIMSL member of the IMS directory data set.
241	DMB FOUND IN STAGING DATA SET	During processing of the IMPORT DEFN SOURCE(CATALOG) command, a DMB was found in the staging data set.
242	NO RESOURCES IN REFRESH PENDING	During processing the IMPORT DEFN SOURCE(CATALOG) OPTION(REFRESHPSB) no PSBs were found to refresh.

Examples

Example 1 for IMPORT DEFN SOURCE(CATALOG)

The following example shows the output after issuing the IMPORT DEFN SOURCE(CATALOG) command in a single IMS system.

TSO SPOC input:

IMPORT DEFN SOURCE(CATALOG)

TSO SPOC output:

MbrName  Member     CC CATSHR DBDName  PSBName  CHNG DLET    
IMS1     IMS1        0 N                                      
IMS1     IMS1        0 N      DEDBGS1A          Y            
IMS1     IMS1        0 N      FPSI1ASA               Y        
IMS1     IMS1        0 N               BMP255   Y

OM API input:

CMD(IMPORT DEFN SOURCE(CATALOG))

OM API output:

 <?xml version="1.0"?>                                                        
 <!DOCTYPE imsout SYSTEM "imsout.dtd">                                        
 <imsout>                                                                    
 <ctl>                                                                        
 <omname>OM1OM   </omname>                                                    
 <omvsn>1.7.0</omvsn>                                                        
 <xmlvsn>20  </xmlvsn>                                                        
 <statime>2015.276 06:24:56.083208</statime>                                  
 <stotime>2015.276 06:24:56.836962</stotime>                                  
<staseq>CFA3D9F7A8308DE5</staseq>                                  
<stoseq>CFA3D9F860362863</stoseq>                                  
<rqsttkn1>USRT011 10232456</rqsttkn1>                              
<rc>00000000</rc>                                                  
<rsn>00000000</rsn>                                                
</ctl>                                                            
<cmd>                                                              
<master>IMS1    </master>                                          
<userid>USRT011 </userid>                                          
<verb>IMP </verb>                                                  
<kwd>DEFN            </kwd>                                        
<input>IMPORT DEFN SOURCE(CATALOG) </input>                        
</cmd>                                                            
<cmdrsphdr>                                                        
<hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="n" key="0"        
 scroll="yes" len="8" dtype="CHAR" align="left" />                
<hdr slbl="IMSMBR" llbl="Member" scope="LCL" sort="a" key="4"      
 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" />                              
<hdr slbl="CCTXT" llbl="CCText" scope="LCL" sort="n" key="0"      
 scroll="yes" len="*" dtype="CHAR" align="left" skipb="yes" />    
<hdr slbl="CATS" llbl="CATSHR" scope="LCL" sort="n" key="0"        
 scroll="yes" len="1" dtype="CHAR" align="left" skipb="yes" />        
<hdr slbl="RSC" llbl="RSCName" scope="LCL" sort="a" key="3" scroll="no
 len="8" dtype="CHAR" align="left" skipb="yes" />                    
<hdr slbl="DBD" llbl="DBDName" scope="LCL" sort="a" key="2" scroll="no
 len="8" dtype="CHAR" align="left" skipb="yes" />                    
<hdr slbl="PSB" llbl="PSBName" scope="LCL" sort="a" key="1" scroll="no
 len="8" dtype="CHAR" align="left" skipb="yes" />                    
<hdr slbl="ADD" llbl="ADD" scope="LCL" sort="n" key="0" scroll="yes"  
 len="1" dtype="CHAR" align="left" skipb="yes" />                    
<hdr slbl="CHG" llbl="CHNG" scope="LCL" sort="n" key="0" scroll="yes"
 len="1" dtype="CHAR" align="left" skipb="yes" />                    
<hdr slbl="CPY" llbl="COPY" scope="LCL" sort="n" key="0" scroll="yes"
 len="1" dtype="CHAR" align="left" skipb="yes" />                    
<hdr slbl="RFS" llbl="RFSH" scope="LCL" sort="n" key="0" scroll="yes"
 len="1" dtype="CHAR" align="left" skipb="yes" />                    
<hdr slbl="DLT" llbl="DLET" scope="LCL" sort="n" key="0" scroll="yes"
 len="1" dtype="CHAR" align="left" skipb="yes" />                    
</cmdrsphdr>                                                          
<cmdrspdata>                                                          
<rsp>MBR(IMS1    ) IMSMBR(IMS1    ) CC(   0) CATS(N) </rsp>          
<rsp>MBR(IMS1    ) IMSMBR(IMS1    ) CC(   0) CCTXT() CATS(N)          
 DBD(DEDBGS1A) CHG(Y) </rsp>                                          
<rsp>MBR(IMS1    ) IMSMBR(IMS1    ) CC(   0) CCTXT() CATS(N)          
 DBD(FPSI1ASA) DLT(Y) </rsp>                                              
<rsp>MBR(IMS1    ) IMSMBR(IMS1    ) CC(   0) CCTXT() CATS(N) PSB(BMP255    
  ) CHG(Y) </rsp>                                                          
</cmdrspdata>                                                              
</imsout>

Example 2 for IMPORT DEFN SOURCE(CATALOG) in a shared ACB environment (ACBSHR=Y)

The following example shows a scenario in which the processing of the IMPORT DEFN SOURCE(CATALOG) command fails in a multisystem environment where three IMS systems, IMS1, IMS2, and IMS3, share the ACBs in the IMS directory data set of the IMS catalog. In this scenario, IMS1, the command master, abends during phase 1 of commit processing. Later, IMS2 also abends.

The following example is of the QUERY MEMBER command that is routed to all IMS systems before IMS1, the command master, abends. The QUERY MEMBER command output shows that the processing of an IMPORT DEFN SOURCE(CATALOG) is in progress at phase 1 of commit processing in IMS1 and at phase 0 in both IMS2 and IMS3.

TSO SPOC input:

QUERY MEMBER TYPE(IMS) SHOW(ALL)

TSO SPOC output:

  Response for: QUERY MEMBER TYPE(IMS) SHOW(ALL)                       
MbrName    CC Type  Status LclAttr                 LclStat                 
IMS1        0 IMS   IMPCMD                                                 
IMS1        0 IMS          GBLOLC,NO-STM,DIRECTORY IMPPHC1I,SECCMD,SECMSG  
IMS2        0 IMS   IMPCMD                                                 
IMS2        0 IMS          GBLOLC,NO-STM,DIRECTORY IMPPHC0I,SECCMD,SECMSG  
IMS3        0 IMS   IMPCMD                                                 
IMS3        0 IMS          GBLOLC,NO-STM,DIRECTORY IMPPHC0I,SECCMD,SECMSG

The following QUERY command is routed to all IMS systems and shows that IMS1, the command master for the IMPORT DEFN SOURCE(CATALOG) command, abended during phase 1 of commit processing. Because the commit point was not reached, the import is aborted.

Both IMS2 and IMS3 attempt to take over import processing to abort the updates that were made to the directory data sets and to cleanup RM process information.

TSO SPOC output:

  Response for: QUERY MEMBER TYPE(IMS) SHOW(ALL)                     More:    >  
MbrName    CC Type  Status                   LclAttr                 LclStat>   
IMS2        0 IMS   IMPCMD,IMPPHC1T,IMPABORT                                    
IMS2        0 IMS                            GBLOLC,NO-STM,DIRECTORY SECCMD,SECM
IMS3        0 IMS   IMPCMD,IMPPHC1T,IMPABORT                                    
IMS3        0 IMS                            GBLOLC,NO-STM,DIRECTORY SECCMD,SECM

In the following example, the QUERY MEMBER command was routed to all systems, but now IMS2, which became the new command master after the abend of IMS 1, also abended. IMS2 abended before it finished cleaning up the import process. IMS 3 cleans up its own local system, but not the directory or RM blocks, because IMS3 did not succeed in taking over processing after the first abend of IMS1.

 Response for: QUERY MEMBER TYPE(IMS) SHOW(ALL)                      
MbrName    CC Type  Status                   LclAttr                 LclStat   
IMS3        0 IMS   IMPCMD,IMPPHC1F,IMPABORT                                    
IMS3        0 IMS                            GBLOLC,NO-STM,DIRECTORY SECCMD,SECM

To resolve import processing after the failures, the IMPORT DEFN SOURCE(CATALOG) command is issued again on IMS3. The new import command cleans up the prior import process before it attempts to import the resources again. After IMS1 and IMS2 are restarted, they will pick up the changed resources from the directory and will not process any IMPORT log records.

Response for: IMPORT DEFN SOURCE(CATALOG)                                                          
MbrName  Member     CC CCText          ErrorText                        ErrPhase CATSHR DBDName  PSBName  CHNG
---------------------------------------------------------------------------------------------------------------
IMS3     IMS1        4 IMS STATE ERROR ABENDED                                   Y                             
IMS3     IMS2        4 IMS STATE ERROR ABENDED                                   Y                            
IMS3     IMS3        0                                                           Y                          
IMS3     IMS3        0                                                           Y      DBOHIDK5          Y   
IMS3     IMS3        0                                                           Y      DBVHDJ05          Y    
IMS3     IMS3        0                                                           Y      D2XHDJ05          Y    
IMS3     IMS3        0                                                           Y      D2XHIDK5          Y   
IMS3     IMS3        0                                                           Y               PSBEJK05 Y

Example 3 for the OPTION() keyword of the IMPORT DEFN SOURCE(CATALOG) command

The following example shows a scenario in which a PSB is activated in only a subset of IMS systems in an IMSplex by issuing a sequence of IMPORT DEFN SOURCE(CATALOG) commands with OPTION(UPDATEPSB) or OPTION(REFRESHPSB) specified.

There are three IMS systems, IMS1, IMS2, and IMS3, in the IMSplex and they share the ACBs in the IMS directory data set of the IMS catalog.

The following command with OPTION(UPDATEPSB) activates PSB DDLTFPE1 on IMS1 only, which is also the command master. On IMS2 and IMS3, the PSB is placed in a refresh-pending state.

TSO SPOC input:

IMPORT DEFN SOURCE(CATALOG) OPTION(UPDATEPSB) FOR(IMSID(IMS1))

The log output for the preceding command shows that IMS1 is the command master.

Log for:  IMPORT DEFN SOURCE(CATALOG) OPTION(UPDATEPSB) FOR(IMSID(IMS1))
                                                                        
 IMSplex . . . . . : PLEX1                                              
 Routing . . . . . : IMS1                                               
 Start Time. . . . : 2016.264 15:18:59.26                               
 Stop Time . . . . : 2016.264 15:18:59.86                               
 Return code . . . : 00000000                                           
 Reason code . . . : 00000000                                           
 Reason text . . . :                                                    
 Command master. . : IMS1

The TSO SPOC output shows that the active PSB on IMS1 changed:


Response for: IMPORT DEFN SOURCE(CATALOG) OPTION(UPDATEPSB) FOR(IMSID(IMS1))     
MbrName  Member     CC CATSHR PSBName  CHNG REFP                            
-------- -------- ---- ------ -------- ---- ----                            
IMS1     IMS1        0 Y                                                    
IMS1     IMS1        0 Y      DDLTFPE1 Y                                    
IMS1     IMS2        0 Y      DDLTFPE1      Y                               
IMS1     IMS3        0 Y      DDLTFPE1      Y

Next, the IMPORT command is issued with OPTION(REFRESHPSB) and FOR(IMSID(IMS2)) specified to activate the PSB on IMS2. On IMS3, the PSB remains in a refresh-pending state. On IMS1, the refresh request is not applicable because the PSB is already active. The command response also shows that the refresh is not applicable for IMS1 (as it was the command master) and that the command was not attempted for IMS3 as it was not in the FOR() clause.

TSO SPOC input:

IMPORT DEFN SOURCE(CATALOG) OPTION(REFRESHPSB) FOR(IMSID(IMS2))

The log output for the preceding command shows that IMS1 is still the command master.

Log for:  IMPORT DEFN SOURCE(CATALOG) OPTION(REFRESHPSB) FOR(IMSID(IMS2))
                                                                         
 IMSplex . . . . . : PLEX1                                               
 Routing . . . . . : IMS1                                                
 Start Time. . . . : 2016.264 15:19:57.28                                
 Stop Time . . . . : 2016.264 15:19:57.67                                
 Return code . . . : 02000004                                            
 Reason code . . . : 00001014                                            
 Reason text . . . : At least one request completed with warning/s.      
 Command master. . : IMS1

The TSO SPOC output shows that the active PSB on IMS2 changed, the command was not applicable to IMS1, and not processed by IMS3:

Response for: IMPORT DEFN SOURCE(CATALOG) OPTION(REFRESHPSB) FOR(IMSID(IMS2))
MbrName  Member     CC CCText                         CATSHR PSBName  CHNG   
-------- -------- ---- ------------------------------ ------ -------- ----   
IMS1     IMS1        2 CMD NOT ATTEMPTED BY THIS IMS                        
IMS1     IMS3        2 CMD NOT ATTEMPTED BY THIS IMS                         
IMS1     IMS2        0                                Y      DDLTFPE1 Y