RCVDST (Receive Distribution)
Purpose
The Receive Distribution command allows a user to receive incoming distributions, such as documents. The documents can be placed in folders, in document objects, or in an output file for processing.
Restrictions
- Users cannot receive distributions on behalf of another user unless they have been granted permission to work on behalf of that user with the Grant User Permission (GRTUSRPMN) command.
- The user ID and address must be entered in the system directory.
- Private distributions cannot be received if the requester is working on behalf of another user.
Required Parameters
- DSTID
- Specifies the unique identifier of the distribution. The identifier is
assigned to the distribution by the system that creates it. Only incoming
distributions can be received. If the identifier represents an outgoing
distribution, an error message is returned to the user.
The distribution identifier consists of the sender's address (padded on the right with blanks up to 8 characters), the sender's user ID (padded on the right with blanks up to 8 characters), and a 4-digit zoned sequence number with leading zeros, for example,
'NEWYORK SMITH 0204' or MARYLANDMIKEJONE0099
Apostrophes are needed if there are blanks or special characters in the distribution identifier. The distribution identifier is specified this way because blank characters are valid in a user ID or address.
Note: If DSTID is the only parameter for which a value is specified, the distribution specified is deleted from the incoming mail log and confirmation of delivery is sent back to the sender, even if ACKRCV(*NO) is specified.
Optional Parameters
- DOC
- Specifies the document object name under which a distribution is filed when
it is received. The document object name that is specified must not exist on
the system.
*NONE: The distribution being received is not filed under a document object name.
document-name: Specify the name of the document object name under which the distribution is filed.
- FLR
- Specifies the name of the folder that contains the document.
Note: The folder must exist and the current user of this command must have authority to create new documents in the folder. *NONE: The distribution being received is not placed in a document object. Specify this value if the distributed document is received directly into a database file for processing.
folder-name: Specify the name of the folder to contain the document object name. A folder name can consist of a series of folder names if the document receiving the distribution is located in a folder contained in another folder. Up to 63 characters can be specified.
- OUTFILE
- Specifies the name of the database file to which the output is directed. If
the output file does not exist, this command creates a database file in the
specified library. If the file is created by this function, the text will read
"Outfile for RCVDST." The authority for users with no specific authority to use
the outfile is *EXCLUDE. More information on defining the format of database
files (output files) is in the Office
Services Concepts and Programmer's Guide book.
*NONE: The output is not directed to a database file.
The name of the database file can be qualified by one of the following library values:
-
*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 searched. If no library is specified as the current library for the job, the QGPL library is used.
-
library-name: Specify the name of the library to be searched.
database-file-name: Specify the name of the database file that receives the output.
-
- OUTMBR
- Specifies the name of the database file member to which the output is
directed. If a member already exists, the system uses the second element of
this parameter to determine whether the member is cleared before the new
records are added. If the member does not exist and a member name is not
specified, the system creates a member with the name of the output file
specified on the OUTFILE parameter. If an output file member name is specified,
but the member does not exist, the system creates it.
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 on the OUTFILE parameter. If the member already exists, there is the option to add new records to the end of the existing member, or to clear the member and then add the new records.
member-name: Specify the file member that receives the output. If OUTMBR(member-name) is specified and the member does not exist, the system creates it.
Element 2: Operation to Perform on Member
*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.
- OUTDTATYP
- Specifies which distribution data is written to the database file.
*DFT: The following record codes are written to the output file:
Record Code Description 010 Distribution Description 020 Message Text 105 Document Description 800 Document Data
*ALL: All record formats are written to the output file.
Record Code Description 010 Distribution Description 020 Message Text 105 Document Description 110 Creation Date 115 Expiration date 120 Document date 125 File date 130 Change date 135 Action due date 140 Completion date 145 Author 150 Copy list 155 Document class 160 File cabinet reference 165 Subject 170 Keyword 175 Reference 180 Status 185 Project 190 Authorizing Userid and Address 195 Distribution expiration date and time 200 Reply requested date and time 500 Interchange document profile data 800 Document Data
*DSTINFO: The distribution description record is written to the output file.
*MSG: The message text record is written to the output file.
*DOCD: The document description record is written to the output file.
*DOCDATE: The document date record is written to the output file.
*FILDATE: The file date record is written to the output file.
*CRTDATE: The create date record is written to the output file.
*REF: The reference record is written to the output file.
*CHGDATE: The change date record is written to the output file.
*EXPDATE: The expiration date record is written to the output file.
*ACTDATE: The action due date record is written to the output file.
*CMPDATE: The completion date record is written to the output file.
*SUBJECT: The subject records are written to the output file.
*FILCAB: The filing cabinet reference record is written to the output file.
*STATUS: The status record is written to the output file.
*AUTHOR: The author records are written to the output file.
*DOCCLS: The document class record is written to the output file.
*KWD: The keyword records are written to the output file.
*CPYLST: The copy list records are written to the output file.
*AUTUSR: The authorizing Userid and Address is written to the output file.
*DSTEXPDATE: The distribution expiration date and time is written to the output file.
*RPYDATE: The reply requested date and time is written to the output file.
*IDP: The complete document record (base sub-profile, application subprofile, and any private sub-profiles) is written to the output file.
*DOC: The document data records are written to the output file.
*PROJECT: The project record is written to the output file.
- USRID
- Specifies the user ID and address of the user for whom the distribution is
received. The current user of this command must have the authority to work on
behalf of the specified user ID and address.
*CURRENT: The user profile that is currently running is used.
Element 1: User ID
user-ID: Specify the user ID of the user for whom the distribution is received.
Element 2: User Address
user-address: Specify the user address of the user for whom the distribution is received.
- ACKRCV
- Specifies whether the acknowledgment for confirmation of delivery is sent
back to the sender of the distribution.
*YES: The confirmation of delivery is sent back to the sender.
*NO: The confirmation of delivery is not sent back to the sender.
- DSTIDEXN
- Specifies the extension of the distribution identifier specified on the
DSTID parameter. This extension uniquely identifies duplicate distributions.
This extension is a 2-digit extension that ranges from 01 through 99. For
example, if the distribution ID is NEWYORK SMITH 0204 and two copies
of this distribution were sent to a user, then the user has 2 distributions
with the same distribution ID. To distinguish the two distributions, an
extension is added to each distribution ID and one extension is NEWYORK
SMITH 020401 and the other one is NEWYORK SMITH 020402. If there
are no duplicates, the extension defaults to 01. These extensions map one to
one with the distribution ID specified on the DSTID parameter.
*NONE: There is no duplicate distribution. This is equivalent to an extension of 01.
distribution-ID-extension: Specify the extension associated with the distribution. This is used to uniquely identify duplicate distribution IDs.
- KEEP
- Specifies whether this distribution is either deleted from, or kept in, the
mail log.
*NO: When all the information requested has been written to the output file or document object name, the distribution is removed from the user's incoming mail.
*YES: When all the information requested has been written to the output file or document object name, the distribution is not removed from the user's incoming mail. The incoming distribution is available for another RCVDST request or for processing by another DIA interface, such as OfficeVision.
- CMDCHRID
- Specifies the character identifier (graphic character set and code page)
for data being specified as parameter values on this command. This character
identifier (CHRID) is related to the display device used to specify the
command. More information about CHRID processing is in the Application Display Programming
book.
Note: This value translates the DSTID and USRID parameters to the character set and code page of '930 500'. The SNA Distribution Services 
book contains the character set and code
page table for '930 500'.*SYSVAL: The system determines the graphic character set and code page values for the command parameters from the QCHRID system values.
*DEVD: The system determines the graphic character set and code page values for the command parameter from the display device description where the command is entered. This option is valid only when specified from an interactive job. If this value is specified in an interactive CL program or a batch job, an error message is sent.
Element 1: Character Set
graphic-character-set: Specify the graphic character set values used to create the command parameter.
Element 2: Code Page
code-page: Specify the code page. Valid values range from 1 through 9999.
Examples of RCVDST
Example 1: Receiving Current User Distribution
RCVDST DISTID('SYSTEM1 USERA 0001')
OUTFILE(MYLIB/MYFILE)
OUTMBR(MYMBR *ADD) OUTDTATYP(*ALL) CMDCHRID(*DEVD)
This command receives the current user distribution into output file MYFILE located in library MYLIB. The distribution is added to member MYMBR. All output file information is added to the output file MYFILE.
Example 2: Receiving Distribution Sent to a User
RCVDST DSTID('BAKER RCH38P 0019') DSTINDEXN(01)
OUTFILE(JOWLIB/DOCUMENTS) USRID(*CURRENT)
This command receives a distribution that was sent to a user. It is copied into the first member in a database file called DOCUMENTS in a library called JOWLIB.
Error messages for RCVDST
*ESCAPE Messages
- CPF8A87
- Document name &2 not correct.
- CPF8A97
- Folder name &1 not correct.
- CPF900B
- User ID and address &1 &2 not in System Distribution Directory.
- CPF900C
- Sign on and verify of user failed.
- CPF905C
- Error occurred trying to find a translation table.
- CPF9096
- Cannot use CMDCHRID(*DEVD), DOCCHRID(*DEVD) in batch job.
- CPF9098
- Distribution not received.
- 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.
- CPF9860
- Error occurred during output file processing.