Display Journal (DSPJRN)

Where allowed to run: All environments (*ALL)
Threadsafe: No
Parameters
Examples
Error messages

The Display Journal (DSPJRN) command allows you to convert journal entries (contained in one or more receivers) into a form suitable for external representation. Output of the command can be displayed or printed with the job's spooled printer output or directed to a database output file. If the database output file exists, records may either replace or be added to the current data in the indicated file member. The system creates the specified database file and member if they do not exist. Database files created by the system have a standard format. A warning message is sent and the records are truncated if any of the entries are longer than the specified maximum record length of the output files.

The contents of selected entries in the journal receivers may be converted for output. It is also possible to selectively limit the entries that are displayed. If no journal entries satisfy the selection or limitation criteria, an escape message is sent indicating that fact.

Gaps may exist in the sequence numbers of the entries converted. These occur because some of the journal entries represent internal system information. These internal entries can be shown by specifying INCHIDENT(*YES).

It is possible to show journal entries whose journal sequence numbers are reset in the chain of receivers being specified.

Restrictions:

Top

Parameters

Keyword Description Choices Notes
JRN Journal Single values: *INTSYSJRN
Other values: Qualified object name
Required, Positional 1
Qualifier 1: Journal Name
Qualifier 2: Library Name, *LIBL, *CURLIB
FILE Journaled physical file Single values: *ALLFILE
Other values (up to 300 repetitions): Element list
Optional, Positional 2
Element 1: File Qualified object name
Qualifier 1: File Name, *ALL
Qualifier 2: Library Name, *LIBL, *CURLIB
Element 2: Member Name, *FIRST, *ALL, *NONE
OBJ Objects Values (up to 300 repetitions): Element list Optional
Element 1: Object Qualified object name
Qualifier 1: Object Name, *ALL
Qualifier 2: Library Name, *LIBL, *CURLIB
Element 2: Object type *FILE, *DTAARA, *DTAQ
Element 3: Member, if data base file Name, *FIRST, *ALL, *NONE
OBJPATH Objects Values (up to 300 repetitions): Element list Optional
Element 1: Name Path name
Element 2: Include or omit *INCLUDE, *OMIT
OBJFID File identifier Values (up to 300 repetitions): Hexadecimal value Optional
SUBTREE Directory subtree *NONE, *ALL Optional
PATTERN Name pattern Values (up to 20 repetitions): Element list Optional
Element 1: Pattern Character value, *
Element 2: Include or omit *INCLUDE, *OMIT
RCVRNG Range of journal receivers Single values: *CURRENT, *CURCHAIN
Other values: Element list
Optional, Positional 3
Element 1: Starting journal receiver Qualified object name
Qualifier 1: Starting journal receiver Name
Qualifier 2: Library Name, *LIBL, *CURLIB
Element 2: Ending journal receiver Single values: *CURRENT
Other values: Qualified object name
Qualifier 1: Ending journal receiver Name
Qualifier 2: Library Name, *LIBL, *CURLIB
FROMENTLRG Starting large sequence number Character value, *FIRST Optional
FROMTIME Starting date and time Element list Optional
Element 1: Starting date Date
Element 2: Starting time Time
TOENTLRG Ending large sequence number Character value, *LAST Optional
TOTIME Ending date and time Element list Optional
Element 1: Ending date Date
Element 2: Ending time Time
NBRENT Number of journal entries Integer, *ALL Optional
JRNCDE Journal codes Single values: *ALL, *CTL
Other values (up to 16 repetitions): Element list
Optional
Element 1: Journal code value A, B, C, D, E, F, J, L, M, P, Q, R, S, T, U
Element 2: Journal code selection *ALLSLT, *IGNFILSLT, *IGNOBJSLT
ENTTYP Journal entry types Single values: *ALL, *RCD
Other values (up to 300 repetitions): Character value
Optional
JOB Job name Single values: *ALL
Other values: Qualified job name
Optional
Qualifier 1: Job name Name
Qualifier 2: User Name
Qualifier 3: Number 000000-999999
PGM Program Name, *ALL Optional
USRPRF User profile Name, *ALL Optional
CCIDLRG Commit cycle large identifier Character value, *ALL Optional
DEPENT Dependent entries *ALL, *NONE Optional
OUTFMT Output format *CHAR, *HEX Optional
JRNID Journal identification number Character value Optional
OUTPUT Output *, *PRINT, *OUTFILE Optional
INCHIDENT Include hidden entries *NO, *YES Optional
OUTFILFMT Outfile format *TYPE1, *TYPE2, *TYPE3, *TYPE4, *TYPE5 Optional
OUTFILE File to receive output Qualified object name Optional
Qualifier 1: File to receive output Name
Qualifier 2: Library Name, *LIBL, *CURLIB
OUTMBR Output member options Element list Optional
Element 1: Member to receive output Name, *FIRST
Element 2: Replace or add records *REPLACE, *ADD
ENTDTALEN Entry data length Single values: *OUTFILFMT, *CALC
Other values: Element list
Optional
Element 1: Field data format Integer, *VARLEN
Element 2: Variable length field length Integer, *CALC
Element 3: Allocated length Integer, *FLDLEN
NULLINDLEN Null value indicators length Single values: *OUTFILFMT, *CALC
Other values: Element list
Optional
Element 1: Field data format 1-8000, *VARLEN
Element 2: Variable length field length 1-8000, *CALC
Element 3: Allocated length 1-8000, *FLDLEN
INCENT Include entries *CONFIRMED, *ALL Optional
FROMENT Starting sequence number 1-9999999999, *FIRST Optional
TOENT Ending sequence number 1-9999999999, *LAST Optional
CMTCYCID Commit cycle identifier 1-9999999999, *ALL Optional
Top

Journal (JRN)

Specifies the journal from which the journal entries are retrieved for conversion and output.

This is a required parameter.

Single values

*INTSYSJRN
The internal system journal associated with the journal specified on the JRNID parameter is used. Internal system journals are not stored in libraries.

Note: You must specify a value for JRNID when specifying JRN(*INTSYSJRN).

Note: You must have *ALLOBJ special authority to specify JRN(*INTSYSJRN).

Qualifier 1: Journal

journal-name
Specify the name of the journal.

Qualifier 2: Library

*LIBL
All libraries in the library list for the current thread are searched until the first match is found.
*CURLIB
The current library for the job is searched. If no library is specified as the current library for the job, QGPL is used.
library-name
Specify the name of the library to be searched.
Top

Journaled physical file (FILE)

Specifies a maximum of 300 qualified file names whose journal entries are converted for output. This parameter also specifies the name of the file member whose journal entries are to be converted for output.

Either the FILE parameter may be specified, or one or more of the object parameters (OBJ, OBJPATH, or OBJFID) may be specified, but not both.

To determine which journal entries are to be converted for output, based on the specified file member name, the following is done:

Notes:

  1. The journal identifier is the unique identifier associated with the object when journaling is started for that object. The journal identifier stays constant, even if the object is renamed, moved or restored. See the Journal Management information in the iSeries Information Center at http://www.ibm.com/eserver/iseries/infocenter for more information.
  2. When specifying a database file on this parameter, journal entries with the following journal code values are converted for output only if they satisfy the values specified on the other parameters:
    • Journal code D (database file-level information entries).
    • Journal code F (file member-level information entries).
    • Journal code R (record-level information entries).
    • Journal code U (user-generated entries).
    • Other journal codes, if *IGNFILSLT is the second element of the journal code. If *ALLSLT is the second element of the journal code, no journal entries with that code are converted for output.

Single values

*ALLFILE
The search for the journal entries received is not limited to a specified file name. All journal entries are converted for output, regardless of which objects, if any, the entries are associated with.

Element 1: File

Qualifier 1: File

*ALL
Journal entries for all physical files in the specified library (the library name must be specified) whose journaled changes are currently in the journal receiver are converted for output. If *ALL is specified and the user does not have the required authority to all of the files, an error occurs, and the command ends.
file-name
Specify the name of the physical database file whose journal entries are being converted for output.

Qualifier 2: Library

*LIBL
All libraries in the job's library list are searched until the first match is found.
*CURLIB
The current library for the job is used to locate the file. If no library is specified as the current library for the job, QGPL is used.
name
Specify the library where the file is located.

Element 2: Member

*FIRST
Journal entries for the database file and the first member in the file are converted for output.
*ALL
Journal entries for the database file and all the currently existing members in the file are converted for output.
*NONE
Only entries for the database file are converted for output. Entries for members of the file are not converted for output.
name
Specify the name of the file member whose entries are being converted for output. If the specified physical file does not exist on the system, specify either *ALL or a specific file member name.

If *ALL is specified for the file-name element, this member name is used for all applicable files in the library. For example, if library-name/*ALL *FIRST is specified on the FILE parameter, the journal entries of the first members of all applicable files in the specified library are converted for output.

Top

Objects (OBJ)

Specifies a maximum of 300 qualified object names whose journal entries are converted for output. The possible object types are *FILE, *DTAARA, and *DTAQ. If *FILE is specified, this parameter also specifies the name of the file member whose journal entries are to be converted for output.

Either the FILE parameter may be specified, or one or more of the object parameters (OBJ, OBJPATH, or OBJFID) may be specified, but not both.

To determine which journal entries are to be converted for output, based on the specified object name, the following is done:

Notes:

  1. The journal identifier is the unique identifier associated with the object when journaling is started for that object. The journal identifier stays constant, even if the object is renamed, moved or restored. See the Journal Management information in the iSeries Information Center at http://www.ibm.com/eserver/iseries/infocenter for more information.
  2. When specifying an object on this parameter, journal entries with the following journal code values are converted for output only if they satisfy the values specified on the other parameters in addition to the object name specification:
    • Journal code D (database file-level information entries).
    • Journal code E (data area information entries).
    • Journal code F (file member-level information entries).
    • Journal code Q (data queue information entries).
    • Journal code R (record-level information entries).
    • Journal code U (user-generated entries).
    • Other journal codes, if *IGNOBJSLT is the second element of the journal code. If *ALLSLT is the second element of the journal code, no journal entries with that code are converted for output.

Element 1: Object

Qualifier 1: Object

*ALL
Journal entries for all objects of the specified object type in the specified library (the library name must be specified) whose journaled changes are currently in the journal receiver are converted for output. The library name must be specified. If *ALL is specified and the user does not have the required authority for all objects in the library, a message is sent and the command ends.
object-name
Specify the name of the object whose journaled changes are being converted for output.

Qualifier 2: Library

*LIBL
All libraries in the library list for the current thread are searched until the first match is found.
*CURLIB
The current library for the job is searched. If no library is specified as the current library for the job, QGPL is used.
library-name
Specify the name of the library to be searched.

Element 2: Object type

Specify the object type of the object whose journaled changes are being converted for output.

*FILE
Entries for database files and database file members are converted for output.
*DTAARA
Entries for data areas are converted for output.
*DTAQ
Entries for data queues are converted for output.

Element 3: Member, if data base file

Specify the name of the member in the file that has its journal entries converted for output. If *ALL is specified for the first part of this parameter, the value specified for the member name is used for all applicable files in the library. For example, if *FIRST is specified, the journal entries of the first member of all applicable files in the specified library are converted for output.

Note: If the specified object type is not *FILE, the member name element value is ignored.

*FIRST
Journal entries for the database file and the first member in the file are converted for output.
*ALL
Journal entries for the database file and all the currently existing members in the file are converted for output.
*NONE
Only entries for the database file are converted for output. Entries for members of the file are not converted for output.
name
Specify the name of the file member whose entries are being converted for output. If the specified physical file does not exist on the system, specify either *ALL or a specific file member name.

If *ALL is specified for the object-name element, this member name is used for all applicable files in the library. For example, if library-name/*ALL *FILE *FIRST is specified on the OBJ parameter, the journal entries of the first members of all applicable files in the specified library are converted for output.

Top

Objects (OBJPATH)

Specifies a maximum of 300 objects whose journal entries are converted for output. Only objects whose path name identifies an object of type *STMF, *DIR or *SYMLNK that are in the "root" ('/'), QOpenSys, and user-defined file systems are supported. All other objects are ignored.

This parameter is not valid for remote journals.

Either the FILE parameter may be specified, or one or more of the object parameters (OBJ, OBJPATH, or OBJFID) may be specified, but not both.

Only objects that are currently linked with the specified path name and have a journal identifier associated with them are used in journal entry selection. If the specified object does exist, the journal identifier associated with that link is used for journal entry selection. If a specified object does not exist or does not have a journal identifier associated with it, that link is not used in selecting journal entries and no error is sent.

Notes:

  1. The journal identifier is the unique identifier associated with the object when journaling is started for that object. The journal identifier stays constant, even if the object is renamed, moved or restored. See the Journal Management information in the iSeries Information Center at http://www.ibm.com/eserver/iseries/infocenter for more information.
  2. When specifying an object on this parameter, journal entries with the following journal code values are converted for output only if they satisfy the values specified on the other parameters in addition to the object name specification:
    • Journal code B (integrated file system information entries).
    • Journal code U (user-generated entries).
    • Other journal codes, if *IGNOBJSLT is the second element of the journal code. If *ALLSLT is the second element of the journal code, no journal entries with that code are converted for output.

Element 1: Name

path-name
Entries for objects identified by the path name are converted for output.

A pattern can be specified in the last part of the path name. An asterisk (*) matches any number of characters and a question mark (?) matches a single character. If the path name is qualified or contains a pattern, it must be enclosed in apostrophes. Symbolic links within the path name will not be followed. If the path name begins with the tilde character, then the path is assumed to be relative to the appropriate home directory.

Additional information about path name patterns is in the Integrated file system information in the iSeries Information Center at http://www.ibm.com/eserver/iseries/infocenter.

Element 2: Include or omit

The second element specifies whether names that match the path name should be included or omitted from the operation. Note that in determining whether a name matches a pattern, relative name patterns are always treated as relative to the current working directory.

Note: The SUBTREE parameter specifies whether the subtrees are included or omitted.

*INCLUDE
The objects that match the object name pattern are to be included in determining what journal entries are converted for output, unless overridden by an *OMIT specification.
*OMIT
The objects that match the object name pattern are not to be included in determining what journal entries are converted for output. This overrides an *INCLUDE specification and is intended to be used to omit a subset of a previously selected pattern.
Top

File identifier (OBJFID)

Specifies a maximum of 300 file identifiers (FID) whose journal entries are converted for output. FIDs are a unique identifier associated with integrated file system related objects. This field is input in hexadecimal format. Only objects whose FID identifies an object of type *STMF, *DIR or *SYMLNK that are in the "root" ('/'), QOpenSys, and user-defined file systems are supported. All other objects are ignored.

Either the FILE parameter may be specified, or one or more of the object parameters (OBJ, OBJPATH, or OBJFID) may be specified, but not both.

To determine which journal entries are to be converted for output, based on the specified file identifier, the following is done:

Notes:

  1. The journal identifier is the unique identifier associated with the object when journaling is started for that object. The journal identifier stays constant, even if the object is renamed, moved or restored. See the Journal Management information in the iSeries Information Center at http://www.ibm.com/eserver/iseries/infocenter for more information.
  2. When specifying an object on this parameter, journal entries with the following journal code values are converted for output only if they satisfy the values specified on the other parameters in addition to the object name specification:
    • Journal code B (integrated file system information entries).
    • Journal code U (user-generated entries).
    • Other journal codes, if *IGNOBJSLT is the second element of the journal code. If *ALLSLT is the second element of the journal code, no journal entries with that code are converted for output.
file-identifier
Entries for objects identified with the FID are converted for output.
Top

Directory subtree (SUBTREE)

Specifies whether the directory subtrees are included in determining the objects for which journal entries are converted for output.

Note: This parameter is only valid if one or more path names were specified on the OBJPATH parameter.

*NONE
Only the objects that match the selection criteria are processed. The objects within selected directories are not implicitly processed.
*ALL
All objects that meet the selection criteria are processed in addition to the entire subtree of each directory that matches the selection criteria. The subtree includes all sub-directories and the objects within those sub-directories.
Top

Name pattern (PATTERN)

Specifies a maximum of 20 patterns to be used to include or omit objects for which journal entries are converted for output.

Only the last part of the path name will be considered for the name pattern match. Path name delimiters are not allowed in the name pattern. An asterisk (*) matches any number of characters and a question mark (?) matches a single character. If the path name is qualified or contains a pattern, it must be enclosed in apostrophes.

If the Name Pattern parameter is not specified the default will be to match all patterns.

Note: This parameter is only valid if one or more path names were specified on the OBJPATH parameter.

Element 1: Pattern

'*'
All objects that match the input OBJPATH parameter are to be included.
name-pattern
Specify the pattern to be used to include or omit objects for which journal entries are converted for output. Only the last part of the path name will be considered for the name pattern match. Path name delimiters are not allowed in the name pattern.

If the Name Pattern parameter is not specified the default will be to match all patterns.

Additional information about path name patterns is in the Integrated file system information in the iSeries Information Center at http://www.ibm.com/eserver/iseries/infocenter.

Element 2: Include or omit

The second element specifies whether names that match the pattern should be included or omitted from the operation. Note that in determining whether a name matches a pattern, relative name patterns are always treated as relative to the current working directory.

Note: The SUBTREE parameter specifies whether directory subtrees are included or omitted.

*INCLUDE
The objects that match the object name pattern are included in the operation, unless overridden by an *OMIT specification.
*OMIT
The objects that match the object name pattern are not to be included in the operation. This overrides an *INCLUDE specification and is intended to be used to omit a subset of a previously selected pattern.
Top

Range of journal receivers (RCVRNG)

Specifies the starting (first) and ending (last) journal receivers (the receiver range) that contain the journal entries being converted for output. The system starts with the starting journal receiver (as specified by the first value) and proceeds through the receiver chain until the ending receiver (as specified by the last value) is processed.

Note: If the maximum number of receivers (2045) in the range is surpassed, an error occurs and no journal entries are converted.

Single values

*CURRENT
The journal receiver that is currently attached when starting to convert journal entries is used.
*CURCHAIN
The journal receiver chain that includes the journal receiver that is currently attached when starting to convert journal entries is used. This receiver chain does not cross a break in the chain. If there is a break in the chain, the receiver range is from the most recent break in the chain through the receiver that is attached when starting to convert journal entries.

Element 1: Starting journal receiver

Qualifier 1: Starting journal receiver

name
Specify the name of the first journal receiver whose entries are converted for output.

Qualifier 2: Starting date

*LIBL
All libraries in the job's library list are searched until the first match is found.
*CURLIB
The current library for the job is used to locate the journal receiver. If no library is specified as the current library for the job, QGPL is used.
name
Specify the library where the journal receiver is located.

Element 2: Ending journal receiver

Single values

*CURRENT
The journal receiver that is currently attached when starting to convert journal entries is used.

Qualifier 1: Ending journal receiver

name
Specify the name of the last journal receiver whose entries are to be converted for output.

Qualifier 2: Library

*LIBL
All libraries in the job's library list are searched until the first match is found.
*CURLIB
The current library for the job is used to locate the journal receiver. If no library is specified as the current library for the job, QGPL is used.
name
Specify the library where the journal receiver is located.
Top

Starting large sequence number (FROMENTLRG)

Specifies the first journal entry that is being considered for conversion for external representation.

Note: You can specify a value for either the Starting sequence number (FROMENT) parameter or the Starting large sequence number (FROMENTLRG) parameter, but not for both.

*FIRST
The first journal entry in the specified journal receiver range is the first entry being considered for conversion for external representation.
starting-sequence-number
Specify the assigned sequence number of the first journal entry that is being considered for conversion for external representation. The possible range is 1 to 18,446,744,073,709,551,600.
Top

Starting date and time (FROMTIME)

Specifies the date and time of the first journal entry being converted for external representation.

Element 1: Starting date

date
Specify the starting date. The starting date and time of the first journal entry occurring at or after the specified starting date and time becomes the starting point for the range of entries to be converted for external representation.

Element 2: Starting time

starting-time
Specify the starting time. The starting date and time of the first journal entry occurring at or after the specified starting date and time becomes the starting point for the range of entries to be converted for external representation.

The time can be specified in 24-hour format with or without a time separator:

  • Without a time separator, specify a string of 4 or 6 digits (hhmm or hhmmss) where hh = hours, mm = minutes, and ss = seconds.
  • With a time separator, specify a string of 5 or 8 digits where the time separator specified for your job is used to separate the hours, minutes, and seconds. If you enter this command from the command line, the string must be enclosed in apostrophes. If a time separator other than the separator specified for your job is used, this command will fail.
Top

Ending large sequence number (TOENTLRG)

Specifies the last journal entry being converted for external representation.

Note: You can specify a value for either the Ending sequence number (TOENT) parameter or the Ending large sequence number (TOENTLRG) parameter, but not for both.

*LAST
The last journal entry in the specified journal receiver range is the final entry being converted for external representation.
ending-sequence-number
Specify the specific sequence number of the final journal entry being converted for external representation. The possible range is 1 to 18,446,744,073,709,551,600.
Top

Ending date and time (TOTIME)

Specifies the creation date and time of the last journal entry being converted for external representation.

Element 1: Ending date

ending-date
Specify the ending date. The ending date and time of the first journal entry occurring at or before the specified ending time on the specified ending date becomes the ending point for the range of entries to be converted for external representation.

Element 2: Ending time

ending-time
Specify the ending time. The ending date and time of the first journal entry occurring at or before the specified ending time on the specified ending date becomes the ending point for the range of entries to be converted for external representation.

The time can be specified in 24-hour format with or without a time separator:

  • With a time separator, specify a string of 5 or 8 digits where the time separator specified for your job is used to separate the hours, minutes, and seconds. If you enter this command from the command line, the string must be enclosed in apostrophes. If a time separator other than the separator specified for your job is used, this command will fail.
  • Without a time separator, specify a string of 4 or 6 digits (hhmm or hhmmss) where hh = hours, mm = minutes, and ss = seconds.
Top

Number of journal entries (NBRENT)

Specifies the total number of journal entries that are being converted for output.

*ALL
All journal entries that satisfy the selection values and that are in the specified journal receiver range are converted.
maximum-entries
Specify the maximum number of journal entries to be converted. If the journal entry specified on the TOENTLRG, TOENT, or TOTIME parameter is reached before the value specified on the NBRENT parameter is met, the command ends normally.
Top

Journal codes (JRNCDE)

Specifies the journal codes for which journal entries are converted for output.

Single values

*ALL
The conversion of journal entries is not limited to entries with a particular journal code.
*CTL
Only journal entries created to control the journal functions are converted for external representation. The journal codes are 'J' and 'F'.

Element 1: Journal code value

journal-code
Specify the journal code for which journal entries are converted.

For a list of the journal codes that are valid on this parameter, press F4 (Prompt) from the JRNCDE prompt. An explanation of the list of journal codes that can be specified is in the Journal Management information in the iSeries Information Center at http://www.ibm.com/eserver/iseries/infocenter.

Element 2: Journal code selection

*ALLSLT
The journal entries with the specified journal code are converted for output only if all other selection parameters are satisfied.
*IGNFILSLT
Journal entries having the specified journal code are converted for output only if all selection parameters, except the FILE parameter, are satisfied.

Note: This value is not valid for journal codes D, F, and R. This value is not valid if the OBJ, OBJPATH, or OBJFID parameters are specified.

*IGNOBJSLT
Journal entries having the specified journal code are converted for output only if all selection parameters are satisfied except OBJ, OBJPATH, OBJFID, SUBTREE, and PATTERN.

Note: This value is not valid for journal codes B, D, E, F, Q, and R. This value is not valid if the FILE parameter is specified.

Top

Journal entry types (ENTTYP)

Specifies whether to limit the conversion of journal entries to those of a specified entry type.

Single values

*ALL
The conversion of journal entries is not limited to a particular entry-type.
*RCD
Only entries that have an entry type for record level operations are converted. The following entry types are valid: BR, DL, DR, IL, PT, PX, UB, UP, and UR.

Other values

entry-type
Specify the entry type that limits the number of journal entries being converted for external representation. Up to 300 valid entry types can be specified. More information on entry types is in the Journal Management information in the iSeries Information Center at http://www.ibm.com/eserver/iseries/infocenter.
Top

Job name (JOB)

Specifies that the journal entries being converted for external representation are limited to the journal entries for a specified job. Only journal entries for the specified job are converted for external representation.

Single values

*ALL
The conversion of journal entries for external representation is not limited to entries for a specified job.

Other values

job-identifier
Specify the job name, the user name, and the job number of the job to use. You can also specify that the job name only, or that the job name and the user name be used.
job-name
Specify the job name of the job.
user-name
Specify the user name of the job.
job-number
Specify the system-assigned job number.
Top

Program (PGM)

Specifies that the journal entries being converted for external representation are limited to the journal entries created by a specified program.

*ALL
The conversion of journal entries is not limited to entries created by a particular program.
program-name
Specify the name of the program whose journal entries are being converted for external representation.
Top

User profile (USRPRF)

Specifies that the journal entries being considered for conversion for external representation are limited to the journal entries created for the specified user profile name. The user name identifies the user profile under which the job was run that deposited the journal entries.

*ALL
The conversion of journal entries is not limited to entries for a specified user profile.
user-name
Specify the name of the user profile whose journal entries are being converted for external representation.
Top

Commit cycle large identifier (CCIDLRG)

Specifies the journal entries considered for conversion based on their associated commit cycle identifier. A commit cycle consists of all journal entries sharing the same commit cycle identifier.

Note: You can input a value for either the Commit cycle identifier field (CMTCYCID) or the Commit cycle large identifier field (CCIDLRG) but not for both.

*ALL
The journal entries converted are not limited to a specified commit cycle identifier.
commit-cycle-identifier
Specify the commit cycle identifier of the journal entries to be considered for conversion. The possible range is 1 to 18,446,744,073,709,551,600.
Top

Dependent entries (DEPENT)

Specifies whether the journal entries to be converted for output include the journal entries recording actions

*ALL
The journal entries relating to trigger programs, referential constraints and the entries which will be ignored by an Apply or Remove Journaled Changes operations are converted.
*NONE
The journal entries relating to trigger programs, referential constraints and the entries which will be ignored by an Apply or Remove Journaled Changes operations are not converted.
Top

Output format (OUTFMT)

Specifies whether the entry specific data portion of the journal entry information appears in character format or hexadecimal format. This keyword is ignored if *OUTFILE is specified for the Output (OUTPUT) parameter.

*CHAR
The entry specific data portion of the journal entry is shown in character format.
*HEX
The entry specific data portion of the journal entry is shown in hexadecimal format.
Top

Journal identification number (JRNID)

Specifies the five-character journal identification number (ID) of the internal system journal (*INTSYSJRN) to be displayed. Journal IDs are assigned by the system. The first two characters represent the journal type, and the last three characters are the auxiliary storage pool (ASP) identifier.

Note: The JRNID parameter can only be specified if JRN(*INTSYSJRN) is specified.

Following is a listing of journal types:

Journal Types
10
System-managed access path protection (SMAPP)
20
Directory
30
Spool
Top

Output (OUTPUT)

Specifies whether the output from the command is shown at the requesting work station, printed with the job's spooled printer output, or sent to the database file specified on the File to receive output (OUTFILE) parameter.

When the output of the command is directed to the requesting work station, basic information on the journal entries is shown. From the basic display, an option can be selected to show information in detail for any journal entry being shown.

If the output is printed with the job's spooled printer output, all of the information that would be shown is printed. File QPDSPJRN in QSYS is used for printed output.

*
The output is shown (if requested by an interactive job) or printed with the job's spooled output (if requested by a batch job).
*PRINT
The output is printed with the job's spooled output.
*OUTFILE
The output is directed to the database file specified for the File to receive output (OUTFILE) parameter.
Top

Include hidden entries (INCHIDENT)

Specifies whether hidden journal entries should be returned. Hidden entries are generated and used by the system. When hidden entries are returned, it will be possible to display all journal entries such that no sequence numbers will be unaccounted for.

*NO
Hidden journal entries are not converted for output.
*YES
Hidden journal entries are converted for output.
Top

Outfile format (OUTFILFMT)

Specifies the format of the journal entries written to the output file specified on the File to receive output (OUTFILE) parameter. This parameter can be specified only if the value *OUTFILE is specified on the OUTPUT parameter.

Note: If the Receiver size options field (RCVSIZOPT) for the journal was specified as *MAXOPT3, the sequence number, commit cycle identifier, the count of entries applied or removed or relative record number fields can reach a maximum value of 18,446,744,073,709,551,600. The length of these fields in the *TYPE1, *TYPE2, *TYPE3, and *TYPE4 formats is defined to hold a 10 digit number. Only the *TYPE5 format has fields large enough to hold this maximum value. During the building of the output file for the *TYPE1, *TYPE2, *TYPE3, or *TYPE4 formats, if a sequence number or commit cycle identifier larger than 10 digits is found, the field is set to -1 for that record. At the conclusion of writing the output file, an informational message (CPI7013) will be issued to the joblog as an alert that the output file contains incomplete information in those particular fields.

*TYPE1
The converted entries are formatted to include the minimum information that can be specified. The information fields and the format of the information in each journal entry is shown in the following table:
Figure: Table 1 - OUTFILFMT(*TYPE1) Journal Entry Format

Field Name             : Length   : From     : To
=======================+==========+==========+==========
Entry Length           : 5        : 1        : 5
-----------------------+----------+----------+----------
Sequence Number (2)    : 10       : 6        : 15
-----------------------+----------+----------+----------
Journal Code           : 1        : 16       : 16
-----------------------+----------+----------+----------
Journal Entry Type     : 2        : 17       : 18
-----------------------+----------+----------+----------
Date                   : 6        : 19       : 24
-----------------------+----------+----------+----------
Time                   : 6        : 25       : 30
-----------------------+----------+----------+----------
Job Name               : 10       : 31       : 40
-----------------------+----------+----------+----------
User Name              : 10       : 41       : 50
-----------------------+----------+----------+----------
Job Number             : 6        : 51       : 56
-----------------------+----------+----------+----------
Program Name           : 10       : 57       : 66
-----------------------+----------+----------+----------
Object Name            : 10       : 67       : 76
-----------------------+----------+----------+----------
Object Library         : 10       : 77       : 86
-----------------------+----------+----------+----------
Member Name            : 10       : 87       : 96
-----------------------+----------+----------+----------
Count/RRN (3)          : 10       : 97       : 106
-----------------------+----------+----------+----------
Flag                   : 1        : 107      : 107
-----------------------+----------+----------+----------
Commit Cycle ID (4)    : 10       : 108      : 117
-----------------------+----------+----------+----------
Incomplete data        : 1        : 118      : 118
-----------------------+----------+----------+----------
Minimized Entry        : 1        : 119      : 119
Specific Data          :          :          :
-----------------------+----------+----------+----------
Reserved               : 6        : 120      : 125
-----------------------+----------+----------+----------
Entry-Specific Data    : 100 (1)  : 126      : 225
========================================================
Note:
(1)  This is the field length in the system-supplied
database file, QADSPJRN.  However, a length of up to
32641 bytes can be specified for this field using the
ENTDTALEN parameter.
(2)  When the RCVSIZOPT of the journal is *MAXOPT3, this field
will be set to -1 if the sequence number is larger than 10
digits.
(3)  When the RCVSIZOPT of the journal is *MAXOPT3, this field
will be set to -1 if the count of entries applied or removed
or relative record number is larger than 10 digits.
(4)  When the RCVSIZOPT of the journal is *MAXOPT3, this field
will be set to -1 if the commit cycle identifier is larger
than 10 digits.

*TYPE2
The converted entries include the information returned when OUTFILFMT(*TYPE1) is specified, the name of the user profile for the job that generated the displayed journal entries, and the name of the system on which the output records were generated. The format of the information in each journal entry is shown in the following table:
Figure: Table 2 - OUTFILFMT(*TYPE2) Journal Entry Format

Field Name             : Length   : From     : To
=======================+==========+==========+==========
Entry Length           : 5        : 1        : 5
-----------------------+----------+----------+----------
Sequence Number (2)    : 10       : 6        : 15
-----------------------+----------+----------+----------
Journal Code           : 1        : 16       : 16
-----------------------+----------+----------+----------
Journal Entry Type     : 2        : 17       : 18
-----------------------+----------+----------+----------
Date                   : 6        : 19       : 24
-----------------------+----------+----------+----------
Time                   : 6        : 25       : 30
-----------------------+----------+----------+----------
Job Name               : 10       : 31       : 40
-----------------------+----------+----------+----------
User Name              : 10       : 41       : 50
-----------------------+----------+----------+----------
Job Number             : 6        : 51       : 56
-----------------------+----------+----------+----------
Program Name           : 10       : 57       : 66
-----------------------+----------+----------+----------
Object Name            : 10       : 67       : 76
-----------------------+----------+----------+----------
Object Library         : 10       : 77       : 86
-----------------------+----------+----------+----------
Member Name            : 10       : 87       : 96
-----------------------+----------+----------+----------
Count/RRN (3)          : 10       : 97       : 106
-----------------------+----------+----------+----------
Flag                   : 1        : 107      : 107
-----------------------+----------+----------+----------
Commit Cycle ID (4)    : 10       : 108      : 117
-----------------------+----------+----------+----------
User Profile           : 10       : 118      : 127
-----------------------+----------+----------+----------
System Name            : 8        : 128      : 135
-----------------------+----------+----------+----------
Incomplete data        : 1        : 136      : 136
-----------------------+----------+----------+----------
Minimized Entry        : 1        : 137      : 137
Specific Data          :          :          :
-----------------------+----------+----------+----------
Reserved               : 18       : 138      : 155
-----------------------+----------+----------+----------
Entry-Specific Data    : 100 (1)  : 156      : 255
========================================================
Note:
(1)  This is the field length in the system-supplied
database file, QADSPJR2. However, a length of up to
32611 bytes can be specified for this field using the
ENTDTALEN parameter.
(2)  When the RCVSIZOPT of the journal is *MAXOPT3, this field
will be set to -1 if the sequence number is larger than 10
digits.
(3)  When the RCVSIZOPT of the journal is *MAXOPT3, this field
will be set to -1 if the count of entries applied or removed
or relative record number is larger than 10 digits.
(4)  When the RCVSIZOPT of the journal is *MAXOPT3, this field
will be set to -1 if the commit cycle identifier is larger
than 10 digits.

*TYPE3
The converted journal entries include all the information returned when OUTFILFMT(*TYPE2) is specified, and the null value indicators. The format of the information in each converted journal entry is shown in the following table:
Figure: Table 3 - OUTFILFMT(*TYPE3) Journal Entry Format

Field Name             : Length   : From     : To
=======================+==========+==========+==========
Entry Length           : 5        : 1        : 5
-----------------------+----------+----------+----------
Sequence Number (5)    : 10       : 6        : 15
-----------------------+----------+----------+----------
Journal Code           : 1        : 16       : 16
-----------------------+----------+----------+----------
Journal Entry Type     : 2        : 17       : 18
-----------------------+----------+----------+----------
Timestamp (1)          : 26       : 19       : 44
-----------------------+----------+----------+----------
Job Name               : 10       : 45       : 54
-----------------------+----------+----------+----------
User Name              : 10       : 55       : 64
-----------------------+----------+----------+----------
Job Number             : 6        : 65       : 70
-----------------------+----------+----------+----------
Program Name           : 10       : 71       : 80
-----------------------+----------+----------+----------
Object Name            : 10       : 81       : 90
-----------------------+----------+----------+----------
Object Library         : 10       : 91       : 100
-----------------------+----------+----------+----------
Member Name            : 10       : 101      : 110
-----------------------+----------+----------+----------
Count/RRN (6)          : 10       : 111      : 120
-----------------------+----------+----------+----------
Flag                   : 1        : 121      : 121
-----------------------+----------+----------+----------
Commit Cycle ID (7)    : 10       : 122      : 131
-----------------------+----------+----------+----------
User Profile           : 10       : 132      : 141
-----------------------+----------+----------+----------
System Name            : 8        : 142      : 149
-----------------------+----------+----------+----------
Incomplete data        : 1        : 150      : 150
-----------------------+----------+----------+----------
Minimized Entry        : 1        : 151      : 151
Specific Data          :          :          :
-----------------------+----------+----------+----------
Reserved               : 18       : 152      : 169
-----------------------+----------+----------+----------
Null Value Indicators  : 52 (2,3) : 170      : 221
-----------------------+----------+----------+----------
Entry-Specific Data    : 102 (3,4): 222      : 323
========================================================
Notes:
(1) The date and time of the journal entry is in 26-byte
SAA timestamp format instead of separate date and time
fields as in *TYPE1 and *TYPE2.
(2) This is a 50-character variable-length field in the
system-supplied database file QADSPJR4. However, a
length of up to 8000 characters can be specified for
this field using the NULLINDLEN parameter.
(3) The first two bytes are the length of the variable-
length field followed by the actual data if the fields
are variable-length fields.
(4) This is a 100-character variable-length field in
the system-supplied database file QADSPJR4. However, a
length of up to 32596 characters can be specified for
this field using the ENTDTALEN parameter if it is a
fixed-length field and the null value indicators field
is also a fixed-length field.
(5)  When the RCVSIZOPT of the journal is *MAXOPT3, this field
will be set to -1 if the sequence number is larger than 10
digits.
(6)  When the RCVSIZOPT of the journal is *MAXOPT3, this field
will be set to -1 if the count of entries applied or removed
or relative record number is larger than 10 digits.
(7)  When the RCVSIZOPT of the journal is *MAXOPT3, this field
will be set to -1 if the commit cycle identifier is larger
than 10 digits.

*TYPE4
The converted entries include the information returned when OUTFILFMT(*TYPE3) is specified, the journal identifier, the physical file trigger indicator, and the referential constraint indicator. The format of the information in each converted journal entry is shown in the following table:
Figure: Table 4 - OUTFILFMT(*TYPE4) Journal Entry Format

Field Name             : Length   : From     : To
=======================+==========+==========+==========
Entry Length           : 5        : 1        : 5
-----------------------+----------+----------+----------
Sequence Number (5)    : 10       : 6        : 15
-----------------------+----------+----------+----------
Journal Code           : 1        : 16       : 16
-----------------------+----------+----------+----------
Journal Entry Type     : 2        : 17       : 18
-----------------------+----------+----------+----------
Timestamp(1)           : 26       : 19       : 44
-----------------------+----------+----------+----------
Job Name               : 10       : 45       : 54
-----------------------+----------+----------+----------
User Name              : 10       : 55       : 64
-----------------------+----------+----------+----------
Job Number             : 6        : 65       : 70
-----------------------+----------+----------+----------
Program Name           : 10       : 71       : 80
-----------------------+----------+----------+----------
Object Name            : 10       : 81       : 90
-----------------------+----------+----------+----------
Object Library         : 10       : 91       : 100
-----------------------+----------+----------+----------
Member Name            : 10       : 101      : 110
-----------------------+----------+----------+----------
Count/RRN (6)          : 10       : 111      : 120
-----------------------+----------+----------+----------
Flag                   : 1        : 121      : 121
-----------------------+----------+----------+----------
Commit Cycle ID (7)    : 10       : 122      : 131
-----------------------+----------+----------+----------
User Profile           : 10       : 132      : 141
-----------------------+----------+----------+----------
System Name            : 8        : 142      : 149
-----------------------+----------+----------+----------
Journal Identifier     : 10       : 150      : 159
-----------------------+----------+----------+----------
Referential            : 1        : 160      : 160
Constraint             :          :          :
-----------------------+----------+----------+----------
Trigger                : 1        : 161      : 161
-----------------------+----------+----------+----------
Incomplete data        : 1        : 162      : 162
-----------------------+----------+----------+----------
Ignore during APYJRNCHG: 1        : 163      : 163
or RMVJRNCHG           :          :          :
-----------------------+----------+----------+----------
Minimized Entry        : 1        : 164      : 164
Specific Data          :          :          :
-----------------------+----------+----------+----------
Reserved               : 5        : 165      : 169
-----------------------+----------+----------+----------
Null Value Indicators  : 52       : 170 (2,3): 221
-----------------------+----------+----------+----------
Entry-Specific Data    : 102      : 222 (3,4): 323
========================================================
Notes:
(1) The date and time of the journal entry is in 26-byte
SAA timestamp format instead of separate date and time
fields as in *TYPE1 and *TYPE2.
(2) This is a 50-character variable-length field in the
system-supplied database file QADSPJR4. However, a
length of up to 8000 characters can be specified for
this field using the NULLINDLEN parameter.
(3) The first two bytes are the length of the variable-
length field followed by the actual data if the fields
are variable-length fields.
(4) This is a 100-character variable-length field in
the system-supplied database file QADSPJR4. However, a
length of up to 32596 characters can be specified for
this field using the ENTDTALEN parameter if it is a
fixed-length field and the null value indicators field
is also a fixed-length field.
(5)  When the RCVSIZOPT of the journal is *MAXOPT3, this field
will be set to -1 if the sequence number is larger than 10
digits.
(6)  When the RCVSIZOPT of the journal is *MAXOPT3, this field
will be set to -1 if the count of entries applied or removed
or relative record number is larger than 10 digits.
(7)  When the RCVSIZOPT of the journal is *MAXOPT3, this field
will be set to -1 if the commit cycle identifier is larger
than 10 digits.

*TYPE5
The converted entries include the information returned when OUTFILFMT(*TYPE4) is specified, in addition to the program library name, the program library ASP device name, the program library ASP number, the system sequence number, the logical unit of work, the transaction identifier, the thread identifier, the remote address, the address family, the remote port, the arm number, the receiver name, the receiver library name, the receiver library ASP device name, the receiver library ASP number, and the object type. The format of the information in each converted journal entry is shown in the following table:
Figure: Table 5 - OUTFILFMT(*TYPE5) Journal Entry Format

Field Name             : Length   : From     : To
=======================+==========+==========+==========
Entry Length           : 5        : 1        : 5
-----------------------+----------+----------+----------
Sequence Number        : 20       : 6        : 25
-----------------------+----------+----------+----------
Journal Code           : 1        : 26       : 26
-----------------------+----------+----------+----------
Journal Entry Type     : 2        : 27       : 28
-----------------------+----------+----------+----------
Timestamp(1)           : 26       : 29       : 54
-----------------------+----------+----------+----------
Job Name               : 10       : 55       : 64
-----------------------+----------+----------+----------
User Name              : 10       : 65       : 74
-----------------------+----------+----------+----------
Job Number             : 6        : 75       : 80
-----------------------+----------+----------+----------
Program Name           : 10       : 81       : 90
-----------------------+----------+----------+----------
Program Library Name   : 10       : 91       : 100
-----------------------+----------+----------+----------
Program Library ASP    : 10       : 101      : 110
Device Name            :          :          :
-----------------------+----------+----------+----------
Program Library ASP    : 5        : 111      : 115
Number                 :          :          :
-----------------------+----------+----------+----------
Object Name            : 10       : 116      : 125
-----------------------+----------+----------+----------
Object Library         : 10       : 126      : 135
-----------------------+----------+----------+----------
Member Name            : 10       : 136      : 145
-----------------------+----------+----------+----------
Count/RRN              : 20       : 146      : 165
-----------------------+----------+----------+----------
Flag                   : 1        : 166      : 166
-----------------------+----------+----------+----------
Commit Cycle ID        : 20       : 167      : 186
-----------------------+----------+----------+----------
User Profile           : 10       : 187      : 196
-----------------------+----------+----------+----------
System Name            : 8        : 197      : 204
-----------------------+----------+----------+----------
Journal Identifier     : 10       : 205      : 214
-----------------------+----------+----------+----------
Referential            : 1        : 215      : 215
Constraint             :          :          :
-----------------------+----------+----------+----------
Trigger                : 1        : 216      : 216
-----------------------+----------+----------+----------
Incomplete data        : 1        : 217      : 217
-----------------------+----------+----------+----------
Ignore during APYJRNCHG: 1        : 218      : 218
or RMVJRNCHG           :          :          :
-----------------------+----------+----------+----------
Minimized Entry        : 1        : 219      : 219
Specific Data          :          :          :
-----------------------+----------+----------+----------
Object indicator       : 1        : 220      : 220
-----------------------+----------+----------+----------
System Sequence Number : 20       : 221      : 240
-----------------------+----------+----------+----------
Receiver Name          : 10       : 241      : 250
-----------------------+----------+----------+----------
Receiver Library Name  : 10       : 251      : 260
-----------------------+----------+----------+----------
Receiver Library ASP   : 10       : 261      : 270
Device Name            :          :          :
-----------------------+----------+----------+----------
Receiver Library ASP   : 5        : 271      : 275
Number                 :          :          :
-----------------------+----------+----------+----------
Arm Number             : 5        : 276      : 280
-----------------------+----------+----------+----------
Thread Identifier      : 8        : 281      : 288
-----------------------+----------+----------+----------
Thread Identifier      : 16       : 289      : 304
Formatted              :          :          :
-----------------------+----------+----------+----------
Address Family         : 1        : 305      : 305
-----------------------+----------+----------+----------
Remote Port            : 5        : 306      : 310
-----------------------+----------+----------+----------
Remote Address         : 46       : 311      : 356
-----------------------+----------+----------+----------
Logical Unit of Work   : 39       : 357      : 395
-----------------------+----------+----------+----------
Transaction Identifier : 140      : 396      : 535
-----------------------+----------+----------+----------
Object Type            : 7        : 536      : 542
-----------------------+----------+----------+----------
File Type Indicator    : 1        : 543      : 543
-----------------------+----------+----------+----------
Nested Commit Level    : 7        : 544      : 550
-----------------------+----------+----------+----------
Reserved               : 5        : 551      : 555
-----------------------+----------+----------+----------
Null Value Indicators  : 52 (2,3) : 556      : 607
-----------------------+----------+----------+----------
Entry-Specific Data    : 102 (3,4): 608      : 709
========================================================
Notes:
(1) The date and time of the journal entry is in 26-byte
SAA timestamp format instead of separate date and time
fields as in *TYPE1 and *TYPE2.
(2) This is a 50-character variable-length field in the
system-supplied database file QADSPJR5. However, a
length of up to 8000 characters can be specified for
this field using the NULLINDLEN parameter.
(3) The first two bytes are the length of the variable-
length field followed by the actual data if the fields
are variable-length fields.
(4) This is a 100-character variable-length field in
the system-supplied database file QADSPJR5. However, a
length of up to 32210 characters can be specified for
this field using the ENTDTALEN parameter if it is a
fixed-length field and the null value indicators field
is also a fixed-length field.

Top

File to receive output (OUTFILE)

Specifies the name and library of the database file to which the output of the command is directed. If the output file already exists, the system attempts to use it. Records may replace or be added to the current data in the file member. If no records are written to the database file (because of the specified selection values), and *REPLACE is specified on the OUTMBR parameter, records are cleared from the existing database file. If the file does not exist, this command creates a database file in the specified library.

Qualifier 1: File to receive output

file-name
Specify the name of the file.

Qualifier 2: Library

*LIBL
All libraries in the library list for the current thread are searched until the first match is found.
*CURLIB
The current library for the job is searched. If no library is specified as the current library for the job, QGPL is used.
library-name
Specify the name of the library to be searched.
Top

Member to receive output (OUTMBR)

Specifies the name of the database file member that receives the output of the command.

Element 1: Member to receive output

*FIRST
The first member in the file receives the output. If OUTMBR(*FIRST) is specified and the member does not exist, the system creates a member with the name of the file specified for the File to receive output (OUTFILE) parameter. If the member already exists, you have the option to add new records to the end of the existing member or clear the member and then add the new records.
name
Specify the name of the file member that receives the output. If it does not exist, the system creates it.

Element 2: Replace or add records

*REPLACE
The system clears the existing member and adds the new records.
*ADD
The system adds the new records to the end of the existing records.
Top

Entry data length (ENTDTALEN)

Specifies the maximum field length of the entry specific data portion of the journal entry when the output file is created by the system. This field contains part of the variable portion of the journal entries (such as the after-image of records for update journal entries). If the output file exists, this parameter is ignored.

For this parameter, a single value or a single list of three elements can be specified.

Note: This parameter is valid only if OUTPUT(*OUTFILE) is specified.

Single values

*OUTFILFMT
The field length of the entry specific data field in the output file is determined by the value specified on the Outfile format (OUTFILFMT) parameter. The attributes of this field are the same as those of the entry specific data field in the corresponding model output file supplied by the system.

If *TYPE1 or *TYPE2 is specified on the Outfile format (OUTFILFMT) parameter, the entry specific data field in the output database file is a fixed-length field 100 characters long.

If *TYPE1 and *TYPE2 are not specified on Outfile format (OUTFILFMT) parameter, the entry specific data field in the output file is a variable length field with a maximum field length of 100 characters and an allocated length of 100 characters. The buffer is 2 bytes longer than the maximum field length to include the length portion of the variable length field.

*CALC
The system calculates the length of the entry specific data field to accommodate the longest entry specific data among all journal entries in the specified receiver range. The entry specific data field is a fixed-length character field. The minimum length of the field is 130 characters. If the length calculated by the system causes the record format length to exceed the maximum record length, a message is sent and the entry-specific data field is truncated.

If the length calculated by the system causes the record format length to exceed 32766 bytes, a diagnostic message is signaled and the entry specific data field is truncated. If *TYPE1 and *TYPE2 are not specified on the Outfile format (OUTFILFMT) parameter, and the null value indicator field is a variable length field, the record format length cannot exceed 32740 bytes.

Element 1: Field data format

*VARLEN
The entry specific data field is a variable length field. This value can be specified only when OUTFILFMT(*TYPE1) and OUTFILFMT(*TYPE2) are not specified. If you specify this value, you can specify a value for the maximum field length and the allocated length of the entry specific data field.
field-length
Specify a field length of the entry specific data portion of the output file. If *TYPE1 is specified on the Outfile format (OUTFILFMT) parameter, valid values range from 1 through 32641. If *TYPE2 is specified on the OUTFILFMT parameter, valid values range from 1 through 32611. If *TYPE3 or *TYPE4 is specified on the OUTFILFMT parameter and the null values indicator field is a fixed-length field, valid values range from 1 through 32596. If *TYPE5 is specified on the OUTFILFMT parameter and the null values indicator field is a fixed-length field, valid values range from 1 through 32210. If *TYPE3 or *TYPE4 is specified and the null value indicators field is a variable length field, valid values range from 1 through 32570. If *TYPE5 is specified and the null value indicators field is a variable length field, valid values range from 1 through 32184.

Note: The sum of the values specified on the Entry data length (ENTDTALEN) parameter and the Null value indicators length (NULLINDLEN) parameter cannot exceed the maximum record length for a database file (32740 for a file with variable length fields and 32766 for a file with fixed-length fields).

Element 2: Variable length field length

*CALC
The system calculates the maximum length of the entry specific data field to accommodate the longest entry specific data of all journal entries in the specified receiver range. The minimum length of this field is 130 bytes. The corresponding buffer length is 132 bytes: 130 bytes of data and 2 bytes for the length portion of the variable length field.
field-length
Specify the number of characters for the maximum field length. If the null value indicators field is a fixed-length field, valid values range from 1 to 32570. If the null value indicators field is a variable length field, valid values range from 1 to 32185.

Element 3: Allocated length

*FLDLEN
The allocated length is the same as the maximum length of the field.
allocated-length
Specify the allocated length. If *CALC is specified for the maximum field length and the maximum field length calculated by the system is smaller than the allocated length you specify, the allocated length is set to the maximum field length. If a particular maximum field length is specified, the allocated length cannot exceed the maximum field length.

The following table lists the range of values for the ENTDTALEN parameter:

Figure: Table 6 - Range of Values for ENTDTALEN Parameter

Output    : Entry-    : Null Value: Entry Data: Maximum
File      : Specific  : Indicators: Length    : Record
Format    : Data      : Format    :           : Length
          : Format    :           :           :
==========+===========+===========+===========+===========
*TYPE1    : Fixed     : Not       : 1-32641   : 32766
          :           : applicable:           :
          :           :           :           :
----------+-----------+-----------+-----------+-----------
*TYPE2    : Fixed     : Not       : 1-32611   : 32766
          :           : applicable:           :
          :           :           :           :
----------+-----------+-----------+-----------+-----------
*TYPE3    : Fixed     : Fixed     : 1-32596   : 32766
----------+-----------+-----------+-----------+-----------
*TYPE3    : Fixed     : Variable  : 1-32570   : 32740
----------+-----------+-----------+-----------+-----------
*TYPE3    : Variable  : Fixed     : 1-32570   : 32740
----------+-----------+-----------+-----------+-----------
*TYPE3    : Variable  : Variable  : 1-32568   : 32738
----------+-----------+-----------+-----------+-----------
*TYPE4    : Fixed     : Fixed     : 1-32596   : 32766
----------+-----------+-----------+-----------+-----------
*TYPE4    : Fixed     : Variable  : 1-32570   : 32740
----------+-----------+-----------+-----------+-----------
*TYPE4    : Variable  : Fixed     : 1-32570   : 32740
----------+-----------+-----------+-----------+-----------
*TYPE4    : Variable  : Variable  : 1-32568   : 32738
----------+-----------+-----------+-----------+-----------
*TYPE5    : Fixed     : Fixed     : 1-32210   : 32766
----------+-----------+-----------+-----------+-----------
*TYPE5    : Fixed     : Variable  : 1-32184   : 32740
----------+-----------+-----------+-----------+-----------
*TYPE5    : Variable  : Fixed     : 1-32184   : 32740
----------+-----------+-----------+-----------+-----------
*TYPE5    : Variable  : Variable  : 1-32182   : 32738
==========================================================
Note:
When the file contains variable-length fields, the
maximum record length does not include the 2 bytes per
variable-length field.

Top

Null value indicators length (NULLINDLEN)

Specifies the length of the null value indicators field when the output file is created by the system. This parameter can be specified only if OUTFILFMT(*TYPE1) and OUTFILFMT(*TYPE2) are not specified.

Null value indicators are present in journal entries for record level operations as follows:

  1. The corresponding physical file has null capable fields.
  2. The record image has been minimized in the entry specific data.

If the record image has not been minimized in the entry specific data, then there is one null value indicator per field in the physical file. Each indicator is one character long and can be either:

If the record image has been minimized on file field boundaries in the entry specific data, then there is one null value indicator per field in the physical file. Each indicator is one character long and can be either:

Single values

*OUTFILFMT
The null value indicators field has the same attributes as the corresponding field in the system-supplied model output file QADSPJR3, QADSPJR4 or QADSPJR5. It is a variable length character field with a maximum length and an allocated length of 50 characters each. The buffer is 2 bytes longer than the maximum field length to include the length portion of the variable length field.
*CALC
The system calculates the length of the field to accommodate the journal entry with the maximum number of null value indicators in the specified receiver range. In this case, the null value indicators field is a fixed-length character field. The minimum length of this field is 1 character to ensure that the field exists when the output file is created. If the length calculated by the system causes the record format length to exceed 32766, a diagnostic message is sent and the null value indicators field is truncated. If the entry specific data field is a variable length field, the record format length cannot exceed 32740 bytes.

Element 1: Field data format

*VARLEN
To specify a variable-length field, specify *VARLEN for the first element and length values for the last two elements (or let the system use the default values). The null value indicators field is a variable length field. If you specify this value, you can specify a value for the maximum length and the allocated length of the field.
field-length
Specify the field length. Valid values range from 1 through 8000 characters. A nonzero value is required by the system to ensure that the field exists when the output file is created. In this case, the null value indicators field is a fixed-length field.

Element 2: Variable length field length

*CALC
The system calculates the length of the null value indicators field to accommodate the journal entry with the maximum number of null value indicators in the specified receiver range. To ensure that the field exists in the output file that is created, the minimum length of the field is 1 byte. The corresponding buffer length is 3 bytes: 1 byte of data and 2 bytes for the length portion of the variable length field.
field-length
Specify the maximum field length. Valid values range from 1 to 8000 characters.

Element 3: Allocated length

*FLDLEN
The allocated length is the same as the maximum field length.
allocated-length
Specify the allocated length. Valid values range from 1 to 8000 characters. If *CALC is specified for the maximum field length and the maximum length calculated by the system is smaller than the allocated length you specify, the allocated length is set to the maximum field length. If the maximum field length is specified, the allocated length cannot exceed the maximum field length.

The following table lists the range of values for the NULLINDLEN Parameter:

Figure: Table 7 - Range of Values for NULLINDLEN Parameter

Output    : Entry-    : Null Value: Null Line : Maximum
File      : Specific  : Indicators: Indicator : Record
Format    : Data      : Format    : Length    : Length
          : Format    :           :           :
==========+===========+===========+===========+===========
*TYPE3    : Fixed     : Fixed     : 1-8000    : 32766
----------+-----------+-----------+-----------+-----------
*TYPE3    : Fixed     : Variable  : 1-8000    : 32740
----------+-----------+-----------+-----------+-----------
*TYPE3    : Variable  : Fixed     : 1-8000    : 32740
----------+-----------+-----------+-----------+-----------
*TYPE3    : Variable  : Variable  : 1-8000    : 32738
----------+-----------+-----------+-----------+-----------
*TYPE4    : Fixed     : Fixed     : 1-8000    : 32766
----------+-----------+-----------+-----------+-----------
*TYPE4    : Fixed     : Variable  : 1-8000    : 32740
----------+-----------+-----------+-----------+-----------
*TYPE4    : Variable  : Fixed     : 1-8000    : 32740
----------+-----------+-----------+-----------+-----------
*TYPE4    : Variable  : Variable  : 1-8000    : 32738
----------+-----------+-----------+-----------+-----------
*TYPE5    : Fixed     : Fixed     : 1-8000    : 32766
----------+-----------+-----------+-----------+-----------
*TYPE5    : Fixed     : Variable  : 1-8000    : 32740
----------+-----------+-----------+-----------+-----------
*TYPE5    : Variable  : Fixed     : 1-8000    : 32740
----------+-----------+-----------+-----------+-----------
*TYPE5    : Variable  : Variable  : 1-8000    : 32738
==========================================================
Note:
When the file contains variable-length fields, the maximum
record length does not include the 2 bytes per variable-
length field.

Top

Include entries (INCENT)

Specifies whether only the confirmed, or both the confirmed and unconfirmed, journal entries are converted for output. This parameter only applies when converting journal entries for output from a remote journal.

Confirmed entries are those journal entries which have been sent to this remote journal and the state of the Input/Output (I/O) to auxiliary storage for the same journal entries on the local journal is known.

Unconfirmed entries are those journal entries which have been sent to this remote journal, but the state of the Input/Output (I/O) to auxiliary storage for the same journal entries on the local journal is not known, or the object name information for those journal entries is not yet known to the remote journal. Unconfirmed journal entries can only exist within the attached receiver of a remote journal. This only applies if synchronous delivery mode is being used for a particular remote journal.

*CONFIRMED
Only those journal entries which have been confirmed are converted for output.
*ALL
All confirmed and unconfirmed journal entries are converted for output.
Top

Starting sequence number (FROMENT)

Specifies the first journal entry that is being considered for conversion for external representation.

Note: You can specify a value for either the Starting sequence number (FROMENT) parameter or the Starting large sequence number (FROMENTLRG) parameter, but not for both.

*FIRST
The first journal entry in the specified journal receiver range is the first entry being considered for conversion for external representation.
starting-sequence-number
Specify the assigned sequence number of the first journal entry that is being considered for conversion for external representation. The possible range is 1 to 9,999,999,999.
Top

Ending sequence number (TOENT)

Specifies the last journal entry being converted for external representation.

Note: You can specify a value for either the Ending sequence number (TOENT) parameter or the Ending large sequence number (TOENTLRG) parameter, but not for both.

*LAST
The last journal entry in the specified journal receiver range is the final entry being converted for external representation.
ending-sequence-number
Specify the specific sequence number of the final journal entry being converted for external representation. The possible range is 1 to 9,999,999,999.
Top

Commit cycle identifier (CMTCYCID)

Specifies the journal entries considered for conversion based on their associated commit cycle identifier. A commit cycle consists of all journal entries sharing the same commit cycle identifier.

Note: You can input a value for either the Commit cycle identifier field (CMTCYCID) or the Commit cycle large identifier field (CCIDLRG) but not for both.

*ALL
The journal entries converted are not limited to a specified commit cycle identifier.
commit-cycle-identifier
Specify the commit cycle identifier of the journal entries to be considered for conversion. The possible range is 1 to 9,999,999,999.
Top

Examples

Example 1: Converting Journal Entries for Display

DSPJRN   JRN(MYLIB/JRNLA)

When issued at a work station, this command converts and shows the first journal entries in the journal receiver currently attached (when the converting of journal entries is started) to the journal JRNLA in library MYLIB. Subsequent entries are shown by pressing the Page Down key. When entered from a batch job, the above command prints all converted journal entries with the job's spooled printer output. The entry-specific data portion of the journal entries are shown in character format.

Example 2: Converting Journal Entries to an Output File

DSPJRN   JRN(MYLIB/JRNLA)
         FILE((LIB1/A MBR3) (LIB1/C) (LIB2/*ALL *ALL))
         RCVRNG((RCVLIB/RCV27 RCVLIB/RCV30))
         FROMENT(4736)  ENTTYP(UP DL)
         JOB(000666/QPGMR/WORKST01)
         PGM(TSTPGMA)  ENTDTALEN(280)
         OUTPUT(*OUTFILE)  OUTFILE(MYLIB/JRNENTFIL1)

This command converts selected journal entries in the journal receiver chain (from receiver RCV27 in library RCVLIB to receiver RCV30 in library RCVLIB) that is associated with JRNLA in library MYLIB and places them in the first member of the database file JRNENTFIL1 in library MYLIB. If the database file does not exist, it is created with a format of QJORDJE. The last field in the format is 280 bytes in length. The journal entry that has a sequence number of 4736 is the first entry written to the output file. Only entries for record updates and deletes made by program TSTPGMA in the job 000666/QPGMR/WORKST01 to member MBR3 of file A in library LIB1, the first member of file C in library LIB1, and all members of all files in library LIB2 are written to the output file.

Example 3: Converting Journal Entries for a Specific User Profile

DSPJRN   JRN(SS/J)  FILE(SS1/PF)  RCVRNG((SS/R1  *CURRENT))
         JRNCDE(F)  USRPRF(MAC7)
         OUTFILE(FMTLIB/ENTFILE)  OUTFILFMT(*TYPE2)

This command converts selected journal entries in the journal receiver range. The range begins with journal receiver R1 in library SS and ends with the journal receiver currently attached (when the converting of journal entries is started) to journal J in library SS. The entries are placed in the first member of the database file ENTFILE in library FMTLIB. If the file does not exist, it is created with the QJORDJE2 format. The last field of the format is 100 bytes in length. Only entries made by the user MAC7 to the first member of file PF in library SS1 are written to the output file.

Example 4: Converting Journal Entries with Null Value Field Length Specified

DSPJRN   JRN(LIBPROD/PRODJRN)  FILE(APPLIB/PFILE)
         OUTFILFMT(*TYPE5)  OUTFILE(JRNLIB/ENTFILE)
         ENTDTALEN(*VARLEN 500 100)  NULLINDLEN(25)

This command converts selected journal entries from the journal receiver currently attached (when the converting of entries is started) to the journal PRODJRN in library LIBPROD. The entries are placed in the first member of the database file ENTFILE in library JRNLIB. If the file does not exist, it is created with the QJORDJE5 format. The entry-specific data field is a variable-length field with a maximum field length of 500 characters and an allocated length of 100 characters. The null value indicators field is a fixed-length field of 25 characters. Only entries for the file PFILE in library APPLIB and for the first member of the file are written to the output file.

Example 5: Converting Journal Entries with Null Value Field Length Calculated

DSPJRN   JRN(JRNLIB/JRNA)  FILE(FILLIB/FILEA)
         ENTTYP(UP DL)  OUTPUT(*OUTFILE)
         OUTFILFMT(*TYPE5)  OUTFILE(ENTLIB/ENTFILE)
         ENTDTALEN(*CALC)  NULLINDLEN(*VARLEN *CALC *FLDLEN)

This command converts only the record update (UP) and record delete (DL) journal entries for the first member of file PFILEA in library FILLIB from the journal receiver currently attached (when the converting of entries is started) to the journal JRNA in library JRNLIB. The entries are written to the first member of database file ENTFILE in library ENTLIB. If the file does not exist, it is created with the QJORDJE5 format. The system calculates the length of the fixed-length, entry-specific data field. The system also calculates the length of the variable-length null value indicators field. The allocated length of this field is the same as the maximum field length.

Example 6: Converting Journal Entries Using *IGNFILSLT and *CURCHAIN

DSPJRN   JRN(JRNLIB/JRNA)  FILE(FILLIB/FILEA)
         RCVRNG(*CURCHAIN)
         JRNCDE((F *ALLSLT) (R *ALLSLT) (U *IGNFILSLT))
         OUTPUT(*PRINT)

This command converts journal entries with:

Journal entries are converted from the chain of journal receivers, which are the journal receivers in the range from the latest chain break through the journal receiver currently attached when the converting of entries is started, associated with the journal JRNA in library JRNLIB. The converted entries are written to a print file.

Example 7: Converting Journal Entries for Data Area, Data Queue, and Integrated File System Objects

DSPJRN   JRN(LIBPROD/PRODJRN)
         OBJ((APPLIB/D1 *DTAARA) (APPLIB/D2 *DTAQ)
         (APPLIB/D3 *FILE *NONE))
         OBJPATH(('/mydirectory')) SUBTREE(*YES)
         OUTFILFMT(*TYPE5)  OUTFILE(JRNLIB/ENTFILE)

This command converts selected journal entries from the journal receiver currently attached (when the converting of entries is started) to the journal PRODJRN in library LIBPROD. The entries are placed in the first member of the database file ENTFILE in library JRNLIB. If the file does not exist, it is created with the QJORDJE5 format. Only entries associated with the specified objects are converted. These objects are a data area in library APPLIB called D1, a data queue in library APPLIB called D2, and a database file D3 in library APPLIB, as well as the directory '/mydirectory' and all directories, stream files, and symbolic links within that directory or one of its subdirectories.

Top

Error messages

*ESCAPE Messages

CPF7002
File &1 in library &2 not a physical file.
CPF7006
Member &3 not found in file &1 in &2.
CPF7007
Cannot allocate member &3 file &1 in &2.
CPF701B
Journal recovery of an interrupted operation failed.
CPF705C
INCENT(*ALL) not allowed for a local journal.
CPF7053
Values for RCVRNG parameter not correct; reason code &1.
CPF7054
FROM and TO values not valid.
CPF7055
Maximum number of objects exceeded.
CPF7057
*LIBL not allowed with FILE(*ALL) or OBJ(*ALL).
CPF706B
Not authorized to specify JRN(*INTSYSJRN).
CPF706C
Value &1 for JRNID parameter not valid.
CPF7060
Object not found and not journaled in specified receiver range.
CPF7061
Conversion of journal entries failed.
CPF7062
No entries converted or received from journal &1.
CPF7065
Entry type (ENTTYP) not valid for journal code (JRNCDE).
CPF707A
Value specified for ENTDTALEN is not valid.
CPF7074
RCVRNG for specified SEARCH not valid.
CPF708D
Journal receiver found logically damaged.
CPF709C
JOB, PGM, and USRPRF not valid for receiver range.
CPF70A9
OBJPATH parameter not valid for a remote journal.
CPF70AC
File identifier &1 not found.
CPF9801
Object &2 in library &3 not found.
CPF9802
Not authorized to object &2 in &3.
CPF9803
Cannot allocate object &2 in library &3.
CPF9809
Library &1 cannot be accessed.
CPF9810
Library &1 not found.
CPF9820
Not authorized to use library &1.
CPF9822
Not authorized to file &1 in library &2.
CPF9825
Not authorized to device &1.
CPF9845
Error occurred while opening file &1.
CPF9846
Error while processing file &1 in library &2.
CPF9847
Error occurred while closing file &1 in library &2.
CPF9850
Override of printer file &1 not allowed.
CPF9860
Error occurred during output file processing.
CPF9871
Error occurred while processing.
CPF9875
Resources exceeded on ASP &1.
Top