Remove Remote Journal (QjoRemoveRemoteJournal) API


  Required Parameter Group:

1 Qualified journal name Input Char(20)
2 Relational database directory entry Input Char(18)

  Omissible Parameter Group:

3 Request variable Input Char(*)
4 Length of request variable Input Binary(4)
5 Format name of request variable Input Char(8)
6 Error code I/O Char(*)

  Service Program: QJOURNAL

  Default Public Authority: *USE

  Threadsafe: No

The Remove Remote Journal (QjoRemoveRemoteJournal) API disassociates a remote journal on the specified target system from the specified journal on the source system. The journal on the source system may be either a local journal or another remote journal.

The remote journal, and any associated journal receivers, are not deleted from the target system by the API processing. No processing is performed on the target system for the API. The remote journal that remains on the target system may later be added back to the remote journal definition for the journal on the source system by using the Add Remote Journal (ADDRMTJRN) command or the Add Remote Journal (QjoAddRemoteJournal) API.

It is the responsibility of the user to delete the remote journal and any associated journal receivers from the target system, if so desired.

Once a remote journal has been removed from a journal, all of the journal receivers that are currently in the journal's receiver directory on the source system will no longer be protected from deletion even if the journal entries have not yet been replicated to the remote journal.


Restrictions

The following restrictions apply:


Authorities and Locks

Source Journal Authority
*CHANGE, *OBJMGT
Source Journal Library Authority
*EXECUTE
Service Program Authority
*EXECUTE
Source Journal Lock
*EXCLRD

Required Parameter Group

Qualified journal name
INPUT; CHAR(20)

The name of the journal on the source system from which the remote journal is being removed, and the library where it resides. The journal on the source system may be either a local journal or a remote journal. The first 10 characters contain the journal name, and the second 10 characters contain the name of the library where the journal is located on the source system.

The special values supported for the library name follow:

*LIBL Library list
*CURLIB Current library

Relational database directory entry
INPUT; CHAR(18)

The name of the relational database directory entry that contains the remote location name of the target system.


Omissible Parameter Group

Request variable
INPUT; CHAR(*)

The request variable structure that describes the input for the Remove Remote Journal (QjoRemoveRemoteJournal) API.

Length of request variable
INPUT; BINARY(4)

The length of the request variable, in bytes. The length of the request variable must be set to 20 bytes.

Format name of request variable
INPUT; CHAR(8)

The format RMRJ0100 is the only supported format that is used by this API. See RMRJ0100 Format for more information on the RMRJ0100 format.

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.


RMRJ0100 Format

The following table defines the information that may be provided for format RMRJ0100 when you remove a remote journal.

Offset Type Field
Dec Hex
0 0 CHAR(20) Qualified remote journal name

Field Descriptions

Qualified remote journal name. The qualified name of the remote journal on the target system. The first 10 characters contain the remote journal name, and the second 10 characters contain the name of the library where the remote journal resides on the target system. If this field is not provided or is blank, the resolved qualified journal name is assumed.


Error Messages

Message ID Error Message Text
CPF24B4 E Severe error while addressing parameter list.
CPF3CF1 E Error code parameter not valid.
CPF3C21 E Format name &1 is not valid.
CPF3C90 E Literal value cannot be changed.
CPF6981 E Remote journal &1 in &2 not removed.
CPF6982 E Relational database directory entry &1 not valid.
CPF6992 E Remote journal &1 in &2 not removed.
CPF8100 E All CPF81xx messages could be returned. xx is from 01 to FF.
CPF9801 E Object &2 in library &3 not found.
CPF9802 E Not authorized to object &2 in &3.
CPF9803 E Cannot allocate object &2 in library &3.
CPF9810 E Library &1 not found.
CPF9820 E Not authorized to use library &1.
CPF9830 E Cannot assign library &1.
CPF9872 E Program or service program &1 in library &2 ended. Reason code &3.


API Introduced: V4R2

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