Retrieve Journal Information (QjoRetrieveJournalInformation) API


  Required Parameter Group:


  Omissible Parameter:


  Service Program Name: QJOURNAL

  Header File: QSYSINC/H.QJOURNAL

  Default Public Authority: *USE

  Threadsafe: Yes

The Retrieve Journal Information (QjoRetrieveJournalInformation) API provides access to journal-related information to help manage a journal environment, including a remote journal environment.

Various types of journal information are provided by the API. General information, similar to information reported by using the Work with Journal Attributes (WRKJRNA) CL command, and additional information are contained in the header section. If requested, information is provided for the journal receiver directory, journaled objects, and remote journals.


Authorities and Locks

Journal Authority
*OBJOPR and some data authority other than *EXECUTE
Journal Library Authority
*EXECUTE
ASP Device Authority
*USE
Journal Lock
*SHRRD

Required Parameter Group

Receiver variable
OUTPUT; CHAR(*)

The receiver variable that is to receive the information requested. You can specify the size of the area smaller than the format requested as long as you specify the length of receiver variable parameter correctly. As a result, the API returns only the data the area can hold.

Length of receiver variable
INPUT; BINARY(4)

The length of the receiver variable provided. The length of receiver variable parameter may be specified up to the size of the receiver variable specified in the user program. If the length of receiver variable parameter specified is larger than the allocated size of the receiver variable specified in the user program, the results are not predictable. The minimum length is 8 bytes if format RJRN0100 is specified. The minimum length is 1 byte if format RJRN0200 is specified.

Note:The format name determines what units are used for the fields Length of receiver variable, Bytes returned, and Bytes available. If format RJRN0100 is specified, the information is in one byte units. If format RJRN0200 is specified, the information is in 4K (4096 bytes) units.

Qualified journal name
INPUT; CHAR(20)

The name of the journal and its library from which the journal attributes and information are to be retrieved. The first 10 characters contain the journal name, and the second 10 characters contain the library name. The special values supported for the library name follow:


Format name
INPUT; CHAR(8)

Format RJRN0100 and RJRN0200 are the only supported formats that are used by this API. For more information, see RJRN0100/RJRN0200 format.

Journal information to retrieve
INPUT; CHAR(*)

Information to be retrieved that is associated with the journal. The information must be in the following format:

Number of variable length records
BINARY(4)
The total number of all of the variable length records. If this field is zero, no variable length records are processed, and no key information will be retrieved.
Variable length records
CHAR(*)
The types of information that should be retrieved. For the specific format of the variable length record, see Format for Variable Length Record.

Omissible Parameter

Error code
I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error code parameter. If this parameter is omitted, diagnostic and escape messages are issued to the application.


Format for Variable Length Record

The following table defines the format for the variable length records.

If the length of the data is longer than the key field's data length, the data will be truncated at the right.

If the length of the data is shorter than the key field's data length and the key contains binary data, an error message is issued. If the key does not contain binary data, the field is padded with blanks.

It is not an error to specify a key more than once. If duplicate keys are specified, the last specified value for that key is used.

Each variable length record must be 4-byte aligned. If not, unpredictable results may occur.


Field Descriptions

Data. The data that is used to determine how the journal information should be retrieved. All values are validity checked.

Key. Identifies specific information to be retrieved about the journal. See Keys for the list of valid keys.

Length of data. The length of the key information.

Length of variable length record. The length of the variable length record. This field is used to get the addressability of the next variable length record.


Keys

The following table lists the valid keys for the key field area of the variable length record.

Note: If you are only interested in summary information about journaled objects, this information is available with format RJRN0100 or format RJRN0200. Key 2 provides detailed information about journaled objects.

Note: The number of objects journaled to the journal can be significant. The time to return the journaled object information (key 2) can also be significant. The space needed to return this information can be more than 2 gigabytes (2,147,483,647).

To get an approximation of the space needed to return the journaled object information (key 2), specify a value of -1 in the input variable Length of receiver variable. By doing this, the API will return in the Bytes available field the calculated size of space that is needed to return the journaled object information without attempting on this request to get any journaled object information. Since only the calculations will be done, the API will be able to return the requested information quickly. The value of Bytes available returned will be in 4K units if format RJRN0200 was specified.

Note: At least 8 bytes must be available in the Receiver variable return area to return the Bytes available information. Only these 8 bytes of information will be returned when the Length of receiver variable is set to -1.


Field Descriptions

Auxiliary storage pool device name. Specify the name of the auxiliary storage pool (ASP) in which the journal resides. This value may be specified for an independent ASP that is in ACTIVE or AVAILABLE status. If this key input is omitted in cases where it is valid for this key to have a value other than an asterisk (*), the thread's library name space will be used. The possible values follow:

Journaled object information. The list of objects that are journaled to the specified journal of specific object types. The input key value indicates what journaled object information to retrieve. The object types that are supported for retrieval are *FILE, *DTAARA, *DTAQ, *LIB, *DIR, *STMF, and *SYMLNK. The possible values follow:

For output values, see Key 2 Output Section.

Journal receiver directory information. The journal receiver directory information that is returned for the journal. Journal receiver directory information can be retrieved for local and remote journals. There are no input values for this key. For output values, see Key 1 Output Section.

Remote journal information. The remote journal information that is returned. Remote journal information can be retrieved for local and remote journals. The input key value indicates what remote journal information to retrieve. The possible values follow:

For output values, see Key 3 Output Section.

RJRN0100/RJRN0200 format

The structure of the information returned is determined by the specified format name. For detailed descriptions of the fields, see Field Descriptions.

Note: The format name determines what units are used for the fields Bytes returned and Bytes available. If format RJRN0100 is specified, the information is in one byte units. If format RJRN0200 is specified, the information is in 4K (4096 bytes) units.


Key 1 Output Section


Key 2 Output Section


Key 3 Output Section


Field Descriptions

Activation date and time. If the journal is a remote journal and it is currently active, this is the date and time the journal was activated. This field is in the CYYMMDDHHMMSS format as follows:

If the journal is a local journal or the journal state is not active, this field will be blank.

Attached dual journal receiver library name. The name of the library that contains the dual journal receiver.

This field is blank if there is no dual receiver.

Attached dual journal receiver name. The journal receiver that was attached at the same time as the attached journal receiver.

This field is blank if there is no dual receiver.

Attached journal receiver library name. The name of the library that contains the attached journal receiver. This field will be blank if no journal receivers are attached.

Attached journal receiver name. The name of the journal receiver that is currently attached to this journal. This field will be blank if no journal receivers are attached.

Auxiliary storage pool (ASP). The number of the auxiliary storage pool to which storage for the object is allocated.

ASP device name. The name of the independent auxiliary storage pool (ASP) to which storage for the object is allocated. *SYSBAS is used to indicate the system ASP and all basic user ASPs.

Bytes available. The number of bytes of data available to be returned. All available data is returned if enough space is provided.

Note: The format name determines what units are used for this field. If format RJRN0100 is specified, the information is in one byte units. If format RJRN0200 is specified, the information is in 4K (4096 bytes) units.

Bytes returned. The number of bytes of data returned.

Note: The format name determines what units are used for this field. If format RJRN0100 is specified, the information is in one byte units. If format RJRN0200 is specified, the information is in 4K (4096 bytes) units.

Controlled-inactivate journal information journal receiver. The name of the journal receiver that contains the controlled inactivate journal information sequence number.

This field will be blank unless the remote journal state is *CTLINACT.

Controlled-inactivate journal information journal receiver library. The library of the journal receiver that contains the controlled inactivate journal information sequence number.

This field will be blank unless the remote journal state is *CTLINACT.

Controlled-inactivate journal information sequence number. The sequence number of the last journal entry that was queued for replication before the Change Remote Journal (CHGRMTJRN) command or the Change Journal State (QjoChangeJournalState) API was called to start a controlled inactivate of the remote journal.

This field will be 0 unless the remote journal state is *CTLINACT.

This field will be -1 if the value could not fit in the specified Binary(4) field. The complete value will be in the Controlled-inactivate journal information sequence number - long field.

Controlled-inactivate journal information sequence number - long. This is the same field as Controlled-inactivate journal information sequence number except the information is in a Char(20) field which is treated as Zoned(20,0).

Delete receiver delay. The delay time (in minutes) between attempts to delete journal receivers associated with this journal if the delete receiver option is a 1. The default is 10 minutes.

Delete receiver option. Whether the system deletes detached journal receivers that are associated with this journal when they are no longer needed for IPL recovery.


Estimated hundredths of seconds behind. If the journal is an active remote journal and the delivery mode is asynchronous, this is the estimated amount of time, in hundredths of seconds, between when the journal entries are written to disk on the source system and when they are received on the target system. This value will be -1 if the journal is a local journal, the journal is not active, the delivery mode is not asynchronous, or the source system is IBM i 6.1 or earlier.

File type. The type of file journaled.

Filter by object. Specifies whether or not journal entries sent to the remote journal will be filtered by object.

The possible values follow:


Filter by program. Specifies qualified program names. The number of qualified program names in the array is controlled by the Number of programs to filter field. Journal entries sent on behalf of these programs will not be sent to the remote journal.

The first 10 characters contain the program name, and the second 10 characters contain the name of the program's library.

Note: The offset to the filter by program array for each environment is determined by the Offset to filter by program array field.

The possible values for program library name are:


If the program library name has been omitted from the journal entries, no journal entries will be filtered by program name and program library name unless *ALL is specified for the program library name. If the program name has been omitted, no journal entries will be filtered by program name and program library name.

Filter images. Specifies whether or not before images will be sent to the remote journal.

The possible values follow:


Fixed length data *JOB. Indicates whether the job name will be stored when journal entries are deposited.

Fixed length data *LUW. Indicates whether the logical unit of work identifier will be stored when journal entries are deposited.

Fixed length data *PGM. Indicates whether the program name will be stored when journal entries are deposited.

Fixed length data *PGMLIB. Indicates whether the program library name will be stored when journal entries are deposited.

Fixed length data *RMTADR. Indicates whether the remote address will be stored when journal entries are deposited.

Fixed length data *SYSSEQ. Indicates whether the system sequence number will be stored when journal entries are deposited.

Fixed length data *THD. Indicates whether the thread identifier will be stored when journal entries are deposited.

Fixed length data *USR. Indicates whether the user name will be stored when journal entries are deposited.

Fixed length data *XID. Indicates whether the transaction identifier will be stored when journal entries are deposited.

Hundredths of seconds behind. If the remote journal delivery mode is *ASYNC, this is the hundredths of seconds that the source journal is behind in sending journal entries to the target system.

If the remote journal delivery mode is not *ASYNC, or the remote journal state is *INACTIVE, this field is -1.

Internet address. Up to four internet addresses being used by data port services to communicate to the target system. If a node identifier and at least one internet address is retrieved, then data port services is being used as an alternate communication method to the target system.

Note: The offset to the internet address array for each environment is determined by the Offset to internet address array field.

Note: The internet address array will have the same length for each remote journal environment returned. The internet address array length will be large enough to hold the maximum number of internet addresses that can be specified for data port services. The internet address array will be populated with internet addresses up to the Number of internet addresses returned. Any remaining internet addresses in the array will be blank.

Journal cache. Specifies whether journal entries were cached before being written out to disk.

Journal delivery mode. The journal delivery mode that is being used to replicate journal entries to this journal.

Journal entries filtered. Indicates whether or not journal entry filtering is active for this journal.

Journal library name. The name of the library that contains the journal.

Journal name. The name of the journal.

Journal receiver attached date and time. The date and time that this journal receiver was attached to the journal. For a journal receiver attached to a *REMOTE journal, this is the date and time that the journal receiver was attached on the local system. This field is in the CYYMMDDHHMMSS format as follows:

Journal receiver library name. The name of the library that contains the journal receiver.

Journal receiver name. The name of the journal receiver.

Journal receiver number. A number that is associated with a journal receiver and assigned by the system, which is relative to all other journal receivers in the journal receiver directory at this time. For a given journal receiver, this number will change as journal receivers are added and deleted from the directory. The first 2 digits identify the journal chain number and the last 3 digits identify the journal receiver number within the chain.

A chain identifies a group of journal receivers that are contiguous, which allows the system to process entries across journal receivers within the same chain.

The chain number starts with zero and is incremented sequentially each time a new chain is needed. For example, new chains are started when a damaged journal receiver is recovered by restoring a partial version.

Within a chain, each newly attached journal receiver is given a journal receiver number starting with one and incrementing sequentially to 999.

When you journal to dual journal receivers, both journal receivers are assigned the same number.

Journal receiver saved date and time. The date and time that the journal receiver was last saved. This field is in the CYYMMDDHHMMSS format, which is described in the journal receiver attached date and time field description.

Journal receiver size. The number of kilobytes of auxiliary disk storage used by this journal receiver.

This field will be zero if the journal receiver is damaged.

Journal receiver status. The status of the journal receiver. The status can be one of the following:

Journal recovery count. The journal recovery count allows a user to choose between faster abnormal IPL or independent ASP vary on recovery and decreased run time processing. The value specified influences the frequency with which journaled objects are forced to auxiliary storage as those objects are changed. The specified journal recovery count indicates the approximate number of journaled changes that would need to be recovered during journal synchronization for this journal in the event of an abnormal IPL or vary on. Specifying a smaller value decreases the number of changes that would need to be recovered from this journal in the event of an abnormal IPL or vary on by increasing the frequency with which changed objects are forced. Specifying a larger value increases the number of changes that would need to be recovered for this journal during an abnormal IPL or vary on by decreasing the frequency with which changed objects are forced. Changing this value may affect overall system performance as it affects the utilization of auxiliary storage devices.

All journals are created with the system default journal recovery count. If a value other than the system default is specified, the system default journal recovery count will no longer be in effect for this journal.

The operating system is shipped with a system default journal recovery count of 250,000. If there is a need to change the system default journal recovery count for all newly created journals and all existing journals that have the system default (*SYSDFT) specified for their journal recovery count, please refer to the Change Journal Recovery Count (QJOCHRVC) API.

Journal state. An indication as to whether journal entries are currently being sent to a journal. For a remote journal, this is whether the journal is actively receiving journal entries from the source system journal.

Journal text. The text description of the journal.

Journal type. The journal type defines the scope of the journal and some of its characteristics. The valid journal types follow:

Journaled object limit. The journaled object limit defines how many objects can be journaled to the journal. The valid journaled object limits follow:

Key. Specific information retrieved about the journal.

Length of key information header section. The length of the header information in the given keys information section. The header is followed by the list information section, which is a repeating list of entries for the given key.

Length of each entry in key information list section. The length of an entry within a specific list that is returned for a given key.

Local journal ASP group name. The name of the independent auxiliary storage pool (ASP) group of the local journal. *SYSBAS is used to indicate the system ASP and all basic user ASPs. The local journal is the journal that is the initiator of the original journal deposit that has been replicated downstream to this journal.

This field is blank if there is no local journal.

Local journal library name. The library name of the local journal. The local journal is the journal that is the initiator of the original journal deposit that has been replicated downstream to this journal.

This field is blank if there is no local journal.

Local journal name. The journal name of the local journal. The local journal is the journal that is the initiator of the original journal deposit that has been replicated downstream to this journal.

This field is blank if there is no local journal.

Local journal system. The system name of the local journal. The local journal is the journal that is the initiator of the original journal deposit that has been replicated downstream to this journal.

This field is blank if there is no local journal.

This field is *UNKNOWN if no journal receiver is currently attached or if the journal receiver is damaged or destroyed.

Local journal system associated with the attached journal receiver. If this attached journal receiver is associated with a remote journal, this field is the system name of the local journal. See the local journal system field for more information.

Local journal system associated with the journal receiver. If this journal receiver was associated with a remote journal, this field is the system name of the local journal. See the local journal system field for more information.

Manage receiver delay. The delay time (in minutes) between attempts to attach new journal receivers to this journal if the manage receiver option is a value of 1. The default is 10 minutes.

Zero is returned when the journal is a remote journal.

Manage receiver option. Whether the system or user manages the changing of journal receivers; that is, detaching the currently attached journal receivers and attaching new journal receivers. This option is applicable only for local journals and is blank for remote journals. Possible values follow:

Maximum bundle size. The number of bytes in the largest bundle that has been sent to the target system since the source journal transitioned to an active state.

If the remote journal state is *INACTIVE, this field is -1.

Maximum bundle size date and time. The date and time that the maximum bundle size was sent to the target system. This field is in the CYYMMDDHHMMSS format as follows:

If the remote journal state is *INACTIVE, this field will be blank.

Maximum entries behind. If the remote delivery mode is *ASYNC, this is the maximum number of entries that were waiting to be sent to the target system.

If the remote journal delivery mode is not *ASYNC, or the remote journal state is *INACTIVE, this field is -1.

Maximum entries behind date and time. If the remote delivery mode is *ASYNC, this is the date and time that the maximum entries behind occurred. This field is in the CYYMMDDHHMMSS format as follows:

If the remote journal delivery mode is not *ASYNC, or the remote journal state is *INACTIVE, this field will be blank.

Maximum estimated hundredths of seconds behind. The maximum value of the Estimated hundredths of seconds behind field since the journal was activated. This field will be -1 if the journal is a local journal, the journal state is not active, the most recent delivery mode is synchronous, or the source system is IBM i 6.1 or earlier.

Maximum estimated hundredths of seconds behind date and time. This is the date and time that the maximum estimated hundredths of seconds behind occurred. This field is in the CYYMMDDHHMMSS format as follows:

This field will be blank if the journal is a local journal, the journal state is not active, the most recent delivery mode is synchronous, or the source system is IBM i 6.1 or earlier.

Maximum hundredths of seconds behind. If the remote delivery mode is *ASYNC, this is the maximum hundredths of seconds that the source journal was behind in sending journal entries to the target system.

If the remote journal delivery mode is not *ASYNC, or the remote journal state is *INACTIVE, this field is -1.

Maximum hundredths of seconds behind date and time. If the remote delivery mode is *ASYNC, this is the date and time that the maximum hundredths of seconds behind occurred. This field is in the CYYMMDDHHMMSS format as follows:

If the remote journal delivery mode is not *ASYNC, or the remote journal state is *INACTIVE, this field will be blank.

Maximum restart attempts. The number of times the operating system will attempt to reactivate the remote journal after a recoverable failure.

Message queue library name. The name of the library that contains the message queue.

Message queue name. The name of the message queue that is associated with this journal. This message queue will receive various messages that describe the operations on the journal. For example, if the threshold value of the attached journal receiver is exceeded during journaling and the journal currently is being managed by the user, a CPF7099 message is sent to this message queue. If the journal is being managed by the system, then CPF7020 is sent to this message queue when the change journal has successfully completed. Messages issued by the remote journal support will also be sent to this message queue. The MNGRCV parameter on the Create Journal (CRTJRN) command or on the Change Journal (CHGJRN) command) specifies whether the journal is being managed by the user or by the system.

Minimize entry specific data for data areas. Whether journal entries for data areas may have minimized entry specific data. The possible values are:

Minimize entry specific data for files. Whether journal entries for files may have minimized entry specific data. The possible values are:

Node identifier. The node identifier being used by data port services to identify the target system in a cluster environment. If a node identifier and at least one internet address is retrieved, then data port services is being used as an alternate communication method to the target system.

This field will be set to *NONE if the remote journal is not configured for data port services. If this field is *NONE, the relational database is used for all communications to the target system.

Number of active internet addresses. The number of internet addresses that are active for data port services.

This field will be -1 when the remote journal is not configured for data port services.

Number of active internet addresses date and time. The date and time that the number of active internet addresses last changed. This field is in the CYYMMDDHHMMSS format as follows:

This field will be blank when the remote journal is not configured for data port services.

Number of attached journal receivers. The number of journal receivers that are currently attached to the journal. If this number is two, the dual journal receiver information is returned. If this number is one or zero, the dual journal receiver information is returned as blanks. If this number is zero, the journal receiver information is returned as blanks, and if the journal receiver directory key is specified, there will be no entries returned.

Number of bundles. This is the number of bundles that have been sent to the target system since the source journal transitioned to an active state.

If the remote journal state is *INACTIVE, this field will be -1.

Number of entries. The number of entries that are contained within the specific list of information returned for a given key.

Number of entries behind. If the remote journal delivery mode is *ASYNC, this is the number of entries that are waiting to be sent to the target system.

If the remote journal delivery mode is not *ASYNC, or the remote journal state is *INACTIVE, this field will be -1.

Number of programs to filter. The number of programs specified in the filter by program array.

If the remote journal state is *INACTIVE, this field will be -1.

Number of internet addresses. The number of internet addresses configured for data port services.

This field will be -1 when the remote journal is not configured for data port services. If this field is -1, the relational database is used for all communications to the target system.

Number of keys in key section. The number of keys that are listed in the key section with specific information returned.

Number of retransmissions. The total number of times the local system retransmitted a segment because an acknowledgement was not received. This is a cumulative count of all segments resent since the remote journal was last activated. A value greater than zero may indicate a problem with the network.

If the information is not available, this field will be -1.

Object file identifier. The file identifier (FID) of the integrated file system object that is journaled to the specified journal.

This field will be blank if the object type field is not the special value *IFS.

Object library name. The name of the library that contains the object that is journaled to the specified journal.

This field will be contain *DIR, *SYMLNK, or *STMF if the object type field is the special value *IFS.

Object name. The name of the object that is journaled to the specified journal.

This field will be blank if the object type field is the special value *IFS.

Object type. The type of the object that is journaled to the specified journal.

Note: If the object is of type *DIR, *SYMLNK, or *STMF, the object type listed will be the special value *IFS.

Offset to filter by program array. The byte offset from the start of the Relational database directory entry field to the first program to be filtered.

Offset to internet address array. The byte offset from the start of the Relational database directory entry field to the start of the Internet address array.

This field will be -1 when the remote journal not configured for data port services. If this field is -1, the relational database is used for all communications to the target system.

Offset to key information. The offset from the start of the format to the key information section. Specifically, this offset points to the Number of keys in key section field.

Offset to start of key information. The offset from the start of the key section, which starts immediately after the Number of keys in key section field, to the specific information returned for a given key.

Receiver size option *MAXOPT1. Whether the journal receiver attached to the journal can have a maximum receiver size of approximately one terabyte (1,099,511,627,776 bytes) and a maximum sequence number of 9,999,999,999. Additionally, the maximum size of the journal entry that can be deposited is 15,761,440 bytes. Journal receivers attached to a journal while this option is in effect cannot be saved and restored to any releases prior to V4R5M0, nor can they be replicated to any remote journals on any systems at releases prior to V4R5M0. This option is applicable only for local journals and is blank for remote journals.

Receiver size option *MAXOPT2. Whether the journal receiver attached to the journal can have a maximum receiver size of approximately one terabyte (1,099,511,627,776 bytes) and a maximum sequence number of 9,999,999,999. Additionally, the maximum size of the journal entry which can be deposited is 4,000,000,000 bytes. Journal receivers attached to a journal while this option is in effect cannot be saved and restored to any releases prior to V5R1M0, nor can they be replicated to any remote journals on any systems at releases prior to V5R1M0. This option is applicable only for local journals and is blank for remote journals.

Receiver size option *MAXOPT3. Whether the journal receiver attached to the journal can have a maximum receiver size of approximately one terabyte (1,099,511,627,776 bytes) and a maximum sequence number of 18,446,744,073,709,551,600. Additionally, the maximum size of the journal entry which can be deposited is 4,000,000,000 bytes. Journal receivers attached to a journal while this option is in effect cannot be saved and restored to any releases prior to V5R3M0, nor can they be replicated to any remote journals on any systems at releases prior to V5R3M0. This option is applicable only for local journals and is blank for remote journals.

Receiver size option *MINFIXLEN. The size of the journal entries that are deposited into the attached journal receivers is reduced by the automatic removal of all fixed length data such as job name, machine sequence number, and so on. This option is applicable only for local journals and is blank for remote journals.

Receiver size option *RMVINTENT. Whether the size of the receivers that are attached to the journal are reduced by automatic removal of the internal system entries. Removal occurs only for entries that are required for initial program load (IPL) recovery when those entries are no longer required. This option is applicable only for local journals and is blank for remote journals.

Redirected receiver library name. For a local or *TYPE1 remote journal, this field gives the redirected receiver library name that is currently in place on this journal's local journal for any downstream journal receivers associated with *TYPE1 remote journals.

This field is set to *NONE if no receiver library redirection was specified when *TYPE1 remote journals were added.

This field is set to the redirected receiver library name that is currently in place on this remote journal if the specified journal is a *TYPE2 remote journal.

Relational database directory entry. The name of the relational database directory entry that is associated with the remote journal.

Relational database directory entry details. The first 512 bytes of the relational database (RDB) entry details being used to communicate to the target system. To view the format of this information use the Display File Field Description (DSPFFD) command on the RDB directory logical file, QADBXRMTNM, in library QSYS.

To see details beyond what is returned in the first 512 bytes, specify the RDB name on the Display Relational Database Entry Detail (DSPRDBDIRE) command.

Remote journal active state date and time. The date and time that the remote journal environment transitioned from a *SYNCPEND or *ASYNCPEND delivery mode to a *SYNC or *ASYNC delivery mode. This field is in the CYYMMDDHHMMSS format as follows:

If the remote journal state is *INACTIVE, this field will be blank.

Remote journal last catch-up date and time. The date and time that the remote journal environment last transitioned to a *SYNCPEND or *ASYNCPEND delivery mode. This field is in the CYYMMDDHHMMSS format as follows:

If the remote journal state is *INACTIVE, this field will be blank.

Remote journal delivery mode. The remote journal delivery mode that is being used to replicate journal entries to the remote journal.

Remote journal library name. The library name of the remote journal that is directly downstream of this journal.

This field is blank if there is no remote journal.

Remote journal name. The name of the remote journal that is directly downstream of this journal.

This field is blank if there is no remote journal.

Remote journal receiver library name. The library name of the remote journal receiver that is directly downstream of this journal.

This field is blank if there is no remote journal or if one was not specified on the Add Remote Journal (ADDRMTJRN) command or the Add Remote Journal (QjoAddRemoteJournal) API.

Remote journal state. An indication as to whether the remote journal is actively receiving journal entries from the source system journal.

Remote journal type. The type of remote journal that was created, and that influences characteristics of the remote journal such as journal receiver restore options, redirection capabilities, and remote journal association support. The possible values are:

Reserved. The bytes reserved to align binary fields or for future use.

Restart delay time. The time (in seconds) between attempts to reactivate the remote journal after a recoverable failure.

Sending task priority. If the remote journal delivery mode is *ASYNC, this is the priority of the sending task on the source system.

If the remote journal delivery mode is not *ASYNC, or the remote journal state is *INACTIVE, this field is -1.

Source journal ASP group name. The name of the independent auxiliary storage pool (ASP) group of the source journal. *SYSBAS is used to indicate the system ASP and all basic user ASPs. The source journal is the journal that is directly upstream from this journal.

This field is blank if there is no source journal.

Source journal library name. The library name of the source journal. The source journal is the journal that is directly upstream of this journal.

This field is blank if there is no source journal, if no journal receiver is currently attached, or if the journal receiver is damaged or destroyed.

Source journal name. The journal name of the source journal. The source journal is the journal that is directly upstream of this journal.

This field is blank if there is no source journal.

This field is *UNKNOWN if no journal receiver is currently attached, or if the journal receiver is damaged.

Source journal system. The system name of the source journal. The source journal is the journal that is directly upstream of this journal.

This system name is determined when the remote journal is activated by using the Change Remote Journal (CHGRMTJRN) command or by calling the Change Journal State (QjoChangeJournalState) API. The name is based on the current system name at that time as seen by using the Display Network Attributes (DSPNETA) command.

This field is blank if there is no source journal, if no journal receiver is currently attached, or if the journal receiver is damaged.

Source journal system associated with the attached journal receiver. If this attached journal receiver is associated with a remote journal, this field is the system name of the source journal. See the source journal system field for more information.

Source journal system associated with the journal receiver. If this journal receiver was associated with a remote journal, this field is the system name of the source journal. See the source journal system field for more information.

Super bundle count. If the remote journal delivery mode is *ASYNC, this is the number of that the remote journal environment has automatically gone into super bundling mode. Super bundling mode helps the remote journal environment keep up with the local journal when the local journal has a high rate of journal entry deposits.

If the remote journal delivery mode is not *ASYNC, or the remote journal state is *INACTIVE, this field is -1.

Synchronous sending time out. If the remote journal delivery mode is *SYNC, this is the maximum amount of time in seconds to wait for a response from the remote system when a response is required in a synchronous remote journal environment. A special value of 0 indicates that the system will choose a system default for the synchronous sending time out.

If the remote journal delivery mode is not *SYNC, or the remote journal state is *INACTIVE, this field is -1.

Total number of journaled access paths. The total number of access paths that are currently being journaled to this journal.

Total number of journaled commitment definitions. The total number of commitment definitions that are currently being implicitly journaled to this journal.

Total number of journaled data areas. The total number of data areas that are currently being journaled to this journal.

Note: This field will be set in the key 2 return structure only if data areas were requested to be returned by the journaled object information key. Otherwise it will be 0 in the key 2 return structure. This value will always be returned in the base format structure.

Total number of journaled data queues. The total number of data queues that are currently being journaled to this journal.

Note: This field will be set in the key 2 return structure only if data queues were requested to be returned by the journaled object information key. Otherwise it will be 0 in the key 2 return structure. This value will always be returned in the base format structure.

Total number of journaled files. The total number of files that are currently being journaled to this journal.

Note: This field will be set in the key 2 return structure only if files were requested to be returned by the journaled object information key. Otherwise it will be 0 in the key 2 return structure. This value will always be returned in the base format structure.

Total number of journaled integrated file system objects of type *DIR, *STMF, and *SYMLNK. The total number of integrated file system objects of type *DIR, *STMF, and *SYMLNK that are currently being journaled to this journal.

Note: This field will be set in the key 2 return structure only if integrated file system objects were requested to be returned by the journaled object information key. Otherwise it will be 0 in the key 2 return structure. This value will always be returned in the base format structure.

Total number of journaled libraries. The total number of libraries that are currently being journaled to this journal.

Note: This field will be set in the key 2 return structure only if libraries were requested to be returned by the journaled object information key. Otherwise it will be 0 in the key 2 return structure. This value will always be returned in the base format structure.

Total number of journaled members. The total number of file members that are currently being journaled to this journal.

Note: This field will be set in the key 2 return structure only if files were requested to be returned by the journaled object information key. Otherwise it will be 0 in the key 2 return structure. This value will always be returned in the base format structure.

Total number of journaled objects. This is the total of all objects journaled to the journal. This count includes explicitly journaled objects such as files, file members, access paths, data areas, data queues, libraries, and integrated file system objects. This count also includes implicitly journaled objects such as journal receivers, commitment definitions, and objects journaled for system recovery purposes.

Note: The summation of these total number of object fields may give a number that is higher or lower than the value returned in the total number of journaled objects field. This is possible because the total number of objects includes some objects journaled by the system for system recovery purposes. Also, all of the total fields can be actively changing while retrieving the values.

Total number of journal receivers. The total number of journal receivers that are associated with the journal.

Total number of remote journals. The total number of remote journals that are directly downstream of this journal.

Total size of journal receivers. The total size of the journal receivers in number of kilobytes of auxiliary disk storage that are associated with the journal. The size is in units of the total size of journal receivers multiplier. The total size is equal to or smaller than the total size multiplied by the total size of journal receivers multiplier.

Total size of journal receivers multiplier. The value to multiply the total size of journal receivers by to get the true total size. The value is 1 if the total size of journal receivers is smaller than 2,147,483,647 kilobytes and 1024 if it is larger.

Validity checking. The validity checking status. When communications validity checking is turned on, the remote journal environment will provide additional checking to verify that the data which is received by the target system matches the data that was sent from the source system. If the data does not match, the data will not be written to the target system, the remote journal environment will be inactivated, and messages indicating the communications failure will be issued to the journal message queue and QHST. The possible values follow:



Error Messages


API introduced: V4R2

[ Back to top | Journal and Commit APIs | APIs by category ]