File Document (FILDOC)

Where allowed to run: All environments (*ALL)
Threadsafe: No

The File Document (FILDOC) command allows a user to file a document in the document library.

Restrictions:

You can file a document on behalf of another user if you are authorized to work on behalf of the other user. You must be granted authority to work on behalf of another with the Grant User Permission (GRTUSRPMN) command.
The user ID and address must be enrolled in the system distribution directory.
Security for the new document is taken from the parameters in the FILDOC command and not inherited from the folder.

Parameters

Keyword	Description	Choices	Notes
TYPE	Information to be filed	FILE, IDP, *DSTID	Required, Positional 1
TODOC	To document	Character value, *NONE	Optional
TOFLR	To folder	Character value, *NONE	Optional
SENSITIV	Sensitivity	NONE, PERSONAL, PRIVATE, CONFIDENTIAL	Optional
USRAUT	User authority	Single values: *NONE Other values (up to 50 repetitions): Element list	Optional
	Element 1: User profile	Name, *PUBLIC
	Element 2: Authority level	EXCLUDE, USE, CHANGE, ALL, *AUTL
AUTL	Authorization list	Name, *NONE	Optional
ACC	Access code	Single values: *NONE Other values (up to 50 repetitions): 0-2047	Optional
ALWRPL	Allow replacement	NO, YES	Optional
IDPFILE	Profile file	Single values: NONE, DOCFILE, *DSTIDIDP Other values: Qualified object name	Optional
	Qualifier 1: Profile file	Name
	Qualifier 2: Library	Name, LIBL, CURLIB
IDPMBR	Profile member	Name, *FIRST	Optional
USRID	User identifier	Single values: *CURRENT Other values: Element list	Optional
	Element 1: User ID	Character value
	Element 2: Address	Character value
DOCFILE	Document file	Single values: *NONE Other values: Qualified object name	Optional
	Qualifier 1: Document file	Name
	Qualifier 2: Library	Name, LIBL, CURLIB
DOCMBR	Document member	Name, *FIRST	Optional
DSTID	Distribution identifier	Character value, *NONE	Optional
DSTIDEXN	Distribution ID extension	1-99, *NONE	Optional
KEEP	Keep in mail log	NO, YES, *REF	Optional
DOCTYPE	Document type	2-65535, DFT, FFT, *RFT	Optional
SYSCOD	Document system code	Character value, *DFT	Optional
DOCD	Document description	Character value, *DFT	Optional
AUTHOR	Author	Single values: NONE, USRID Other values (up to 50 repetitions): Character value	Optional
DOCCLS	Document class	Character value, *NONE	Optional
KWD	Keyword	Single values: *NONE Other values (up to 50 repetitions): Character value	Optional
SUBJECT	Subject	Single values: NONE, DOCD Other values (up to 50 repetitions): Character value	Optional
DOCDATE	Document date	Date, NONE, CURRENT	Optional
FILCAB	File cabinet location	Character value, *NONE	Optional
CPYLST	Copy list	Single values: *NONE Other values (up to 50 repetitions): Character value	Optional
EXPDATE	Expiration date	Date, *NONE	Optional
REFERENCE	Reference	Character value, *NONE	Optional
ACTDATE	Action due date	Date, NONE, CURRENT	Optional
STATUS	Document status	Character value, *NONE	Optional
CMPDATE	Completion date	Date, NONE, CURRENT	Optional
PROJECT	Project	Character value, *NONE	Optional
DOCCHRID	Document character identifier	Single values: SYSVAL, DEVD Other values: Element list	Optional
	Element 1: Graphic character set	Integer
	Element 2: Code page	Integer
DOCLANGID	Language ID	Character value, *JOB	Optional
DOCCNTRYID	Country or region ID	Character value, *JOB	Optional
PERSONAL	Personal	NO, YES	Optional
DSTEXPDATE	Distribution expiry indicator	Element list	Optional
	Element 1: Date	Date, NONE, CURRENT
	Element 2: Time	Time, *ENDOFDAY
CMDCHRID	Command character identifier	Single values: SYSVAL, DEVD Other values: Element list	Optional
	Element 1: Graphic character set	Integer
	Element 2: Code page	Integer

Top

Information to be filed (TYPE)

Specifies the type of information being filed and the parameters that are valid on this command.

This is a required parameter.

*FILE: The database file specified on the Document file (DOCFILE) parameter and the Document member (DOCMBR) parameter parameter is filed.
Note: If this value is specified, you must specify the default values on the FILCAB, DSTID, DSTIDEXN, and KEEP parameters and you cannot specify DOCFILE(*NONE).
*IDP: The interchange document profile (IDP) specified on the Profile file (IDPFILE) parameter and the Profile member (IDPMBR) parameter, or the document profile built by this command, is filed.
Note: If this value is specified, you must specify the default values on the DOCFILE, DOCMBR, DOCTYPE, SYSCODE, DOCCHRID, DSTID, DSTIDEXT, and KEEP parameters. If this value is specified, and IDPFILE and FILCAB cannot both specify *NONE.
*DSTID: The distribution document identified by the distribution identifier specified in the Distribution identifier (DSTID) parameter is filed from the mail log into the document library.
Note: If this value is specified, you cannot specify DSTID(*NONE).

Top

To document (TODOC)

Specifies the name of the newly filed document.

name: Specify the user-assigned name of the newly filed document. A maximum of 12 characters can be specified. This document name must not exist in the folder that the document is being filed into.

Top

To folder (TOFLR)

Specifies the name of the folder that contains the newly filed document. This parameter can be specified only when a value is also specified on the To document (TODOC) parameter.

*NONE: The newly filed document does not have a user-assigned name and is not filed in a folder.
name: Specify the name of the folder to contain the newly filed document. A folder name can consist of a series of folder names (FLR1/FLR2/etc.) if the document is being filed in a folder that is contained in another folder. A maximum of 63 characters can be specified.
You must specify a folder name when a document name is specified on the To document (TODOC) parameter.

Top

Sensitivity (SENSITIV)

Specifies the level of sensitivity defined by the X.400 standard. The four levels include no sensitivity, personal, private and company confidential. Any document marked as private is still available to users who are normally authorized to it, but is unavailable to users who are working on your behalf (even though it may be available to them when they are not working on your behalf).

*NONE: The document has no sensitivity restrictions.
*PERSONAL: The document is intended for the user as an individual.
*PRIVATE: The document contains information that should be accessed only by the owner.
*CONFIDENTIAL: The document contains information that should be handled according to company procedures.

Top

User authority (USRAUT)

Specifies name of an existing user and the user authority level. This parameter is used to change the authorized users for this document by giving more users authority to the document, removing a user's authority for the document, or changing the user's authority to the document.

*NONE: No users have specific authority to access the document.
*PUBLIC: Authority is given to the users who do not have specific authority to the document, who are not on the authorization list, and whose user's group does not have specific authority to the document.
name: Specify the user profile names of one or more users being given authority to the document.

*ALL: The user can perform all operations except those limited to the owner or controlled by authorization list management (*AUTLMGT) authority. The user can control the object's existence, specify the security for the object, change the object, and perform basic functions on the object. The user also can change ownership of the object.

*CHANGE: The user can perform all operations on the object except those limited to the owner or controlled by object existence (*OBJEXIST) and object management (*OBJMGT) authorities. The user can change and perform basic functions on the object. *CHANGE authority provides object operational (*OBJOPR) authority and all data authority. If the object is an authorization list, the user cannot add, change, or remove users.

*USE: The user can perform basic operations on the object, such as running a program or reading a file. The user cannot change the object. Use (*USE) authority provides object operational (*OBJOPR), read (*READ), and execute (*EXECUTE) authorities.

*EXCLUDE: The user cannot access the object.

*AUTL: The authority of the authorization list specified on the Authorization list (AUTL) parameter is used for the document. The *AUTL value is valid only if *PUBLIC is also specified.

Top

Authorization list (AUTL)

Specifies the name of an authorization list used to secure the document specified on the To document (TODOC) parameter.

*NONE: An authorization list is not specified.
name: Specify the name of the authorization list whose authority is used for the document.

Top

Access code (ACC)

Specifies the access codes used with this document. The access codes must already exist on the system. If they do not already exist, they must be added on the system with the Add Access Code (ADDACC) command.

*NONE: No access codes are assigned to this document. Authority for this document is controlled by the values specified on the User authority (USRAUT) parameter and the Authorization list (AUTL) parameter.
0-2047: Specify the access codes that control who can use the document. A maximum of 50 access codes can be specified. Access code 0 gives use (*USE) authority to all users.

Top

Allow replacement (ALWRPL)

Specifies the setting to allow replacement of the document content of the document being filed. If this parameter is specified when filing a document that cannot be replaced, it is ignored. A document that cannot be replaced cannot be changed back to a document that can be replaced.

*NO: The document content of the document being filed cannot be replaced.
*YES: The document content of the document being filed can be replaced.

Top

Profile file (IDPFILE)

Specifies where the document profile information is located. If you specify this parameter, the remaining parameters after the Profile member (IDPMBR) parameter are ignored, except the Command character identifier (CMDCHRID) parameter and the Document character identifier (DOCCHRID) parameter.

*NONE: The interchange document profile (IDP) is supplied by other parameters on this command. There is no database file containing the IDP information. If *NONE is specified, the Profile member (IDPMBR) parameter is ignored.
*DSTIDIDP: The IDP information associated with the distribution document is used. The Profile member (IDPMBR) parameter is ignored. This is valid only when TYPE (*DSTID) is specified.
*DOCFILE: The database file specified for the document also contains the profile information. If *DOCFILE is specified, the Document file (DOCFILE) parameter and Document member (DOCMBR) parameter are used for the document profile information.
name: Specify the name of the database file that contains the IDP. The document profile database file can be a user-defined file or the output file specified on the Receive Distribution (RCVDST) or Retrieve Document (RTVDOC) commands. If you specify a user-defined file, it must have the same format as the output file produced by RCVDST or RTVDOC. If an output file is specified, only the data portion of the document profile record is read from the output file. The prefix is removed from the document profile record.

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 used to locate the database file. If no current library is specified as the library for the job, QGPL is used.
name: Specify the library where the database file is located.

Top

Profile member (IDPMBR)

Specifies the interchange document file member name being used. This parameter is used only when a database file name is also specified on the Profile file (IDPFILE) parameter.

*FIRST: The first member created in the database file is used.
name: Specify the name of the database file member being used.

Top

User identifier (USRID)

Specifies which user ID and user ID address should be associated with the request.

Single values

*CURRENT: You are performing the request for yourself.

Element 1: User ID

character: Specify another user's user ID or your user ID. You must have been given permission to work on behalf of another user or have all object (*ALLOBJ) special authority.

Element 2: Address

character: Specify another user's address or your address. You must have been given permission to work on behalf of another user or have *ALLOBJ authority.

Top

Document file (DOCFILE)

Specifies the names of the database file and the library that contains the document data. The database file is a user-defined file or the output file specified in either the Receive Distribution (RCVDST) command or the Retrieve Document (RTVDOC) command. If an output file is specified, only the data portion of the document data record is read from the output file. The prefix is removed from the document data record.

name: Specify the name of the database file that contains the document data.

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 used to locate the database file. If no library is specified as the library for the job, QGPL is used.
name: Specify the library where the database file is located.

Top

Document member (DOCMBR)

Specifies the document database file member that is used.

*FIRST: The first member created in the database file is used.
name: Specify the name of the database file member that is used.

Top

Distribution identifier (DSTID)

Specifies the unique distribution identifier of the distribution. The distribution identifier is assigned by the system when the distribution is originated. Distribution identifiers can be found by using the Query Distribution (QRYDST) command. Identifiers are also returned from the Send Distribution (SNDDST) command.

*NONE: No distribution identifier is used.
distribution-id: Specify the 3-part distribution identifier which is composed of the second part of the sender's user ID (padded on the right to 8 characters), the first part of the sender's user ID (padded on the right to 8 characters), and a 4-digit zoned sequence number with leading zeros. For example, 'NEWYORK SMITH 0204'. This parameter is required when *DSTID is specified on the Information to be sent (TYPE) parameter.

Top

Distribution ID extension (DSTIDEXN)

Specifies the extension of the distribution identifier (if any) specified on the Distribution identifier (DSTID) parameter. This 2-digit extension has a value ranging from 01 through 99 that uniquely identifies duplicate distributions. The default value is 01.

*NONE: There is no duplicate distribution. *NONE is equivalent to an extension of 01.
distribution-id-extension: Specify the extension associated with the distribution. This is used to uniquely identify duplicate distributions.

Top

Keep in mail log (KEEP)

Specifies whether to keep a copy of the distribution document filed in the mail log, delete the distribution from the mail log, or keep a reference in the mail log of the filed distribution document.

*NO: Delete the distribution document from the mail log after the file is complete.
*YES: Keep a copy of the filed distribution document in the mail log.
*REF: The distribution document is deleted and a reference to the filed distribution document is kept in the mail log.

Top

Document type (DOCTYPE)

Specifies the type of document being used. This identifier is used by the system to determine whether the data stream can be handled properly.

*DFT: The system creates the proper document type identifier based on the source of the data.
*FFT: The document is in Final Form Text. This type of document is intended to be viewed and printed, but not edited, by the receiver.
*RFT: The document is in Revisable Form Text. This type of document can be viewed, printed, and edited by the receiver.

2-65,535: Specify a document type identifier value. The numbers from 2 through 32,767 are controlled by registering them with the IBM Document Interchange Architecture and are used for IBM-defined document types. The numbers ranging from 32,768 through 65,535 are not registered with IBM and can be used for non-IBM-defined document types. The meaning of these document types must be determined by defining the value of the system code on the System code (SYSCOD) parameter.

Top

System code (SYSCOD)

Specifies the text used with the value specified on the Document type (DOCTYPE) parameter to help uniquely identify the type of document being used. The receiver of the data stream determines the document data stream and processing requirements to edit, view, print, or change the document.

*DFT: The system supplies a default system code. If the value specified on the Document type (DOCTYPE) parameter is a number ranging from 2 through 32,767, the default is retrieved from message CPX9026. If the value specified on the Document type (DOCTYPE) parameter is in the range from 32,768 through 65,535, a system code must be specified.
system-code: Specify the text that uniquely identifies the type of document being sent. A maximum of 13 characters can be specified.

Top

Document description (DOCD)

Specifies a description for the document being filed. This description is in the Document Interchange Architecture document name field.

Note: This parameter is ignored if the Profile file (IDPFILE) parameter is specified.

*DFT: The system creates a document description from the database files. The default is (library-name/file-name/member-name) for database files. If *IDP is specified on the Information to be filed (TYPE) parameter to file only a reference to a printed document, the default document name is Hardcopy Document Reference and is retrieved from the message CPX9025. An installation may change this message, but only the first 44 characters are used in the document name. If *DSTID is specified on the Information to be filed (TYPE) parameter, the default document name will be the distribution document name specified when the distribution was sent.
description: Specify the description of the document. A maximum of 44 characters can be specified.

Top

Author (AUTHOR)

Specifies the author or authors of the document.

*NONE: No author is identified for the document.
*USRID: The user ID and address specified on the User identifier (USRID) parameter is used as the author's name.
name: Specify the name of the author or authors. A maximum of 50 authors can be specified.

Note: This parameter is ignored if the Profile file (IDPFILE) parameter is specified.

Top

Document class (DOCCLS)

Specifies the class associated with this document, such as MEMO, FORM, or SHEET.

*NONE: No class is assigned to the document.
class: Specify the document class. A maximum of 16 characters can be specified.

Note: This parameter is ignored if the Profile file (IDPFILE) parameter is specified.

Top

Keyword (KWD)

Specifies the keywords that describe the document.

*NONE: No keywords are defined for this document.
keyword: Specify the keywords to describe the document. A maximum of 50 keywords can be specified. Each keyword can have a maximum of 60 characters.

Note: This parameter is ignored if the Profile file (IDPFILE) parameter is specified.

Top

Subject (SUBJECT)

Specifies the subject or subjects of the document.

*NONE: No subject is defined for the document.
*DOCD: The document description is used as the subject for the document.
subject: Specify the subject or subjects of the document. A maximum of 50 subjects can be specified and each subject can have a maximum of 60 characters of text.

Note: This parameter is ignored if the Profile file (IDPFILE) parameter is specified.

Top

Document date (DOCDATE)

Specifies any date the user needs to assign to the document.

*NONE: No date is assigned to the document.
*CURRENT: The system assigns the current system date to the document.
date: Specify the document date. The date must be specified in the job date format.

Note: This parameter is ignored if the Profile file (IDPFILE) parameter is specified.

Top

File cabinet location (FILCAB)

Specifies the location of the document. This parameter is intended to describe the location of printed documents. The interchange document profile (IDP) that refers to the printed document is distributed. This parameter is required if *IDP is also specified on the Information to be sent (TYPE) parameter and *NONE is specified on the Profile file (IDPFILE) parameter.

*NONE: No filing cabinet reference is defined for this document.
reference: Specify the text that describes where the printed document is located. A maximum of 60 characters can be specified.

Note: This parameter is ignored if the Profile file (IDPFILE) parameter is specified.

Top

Copy list (CPYLST)

Specifies the names of the users that receive this document.

*NONE: No copy list is included for this document.
name: Specify the names of the users that receive the document. A maximum of 50 names can be specified. Each name can have a maximum of 60 characters.

Note: This parameter is ignored if the Profile file (IDPFILE) parameter is specified.

Top

Expiration date (EXPDATE)

Specifies the date on which the document is no longer needed.

*NONE: No document expiration date is specified.
date: Specify the document expiration date. The date must be specified in the job date format.

Note: This parameter is ignored if the Profile file (IDPFILE) parameter is specified.

Top

Reference (REFERENCE)

Specifies a reference associated with the document.

*NONE: No reference field is included for this document distribution.
reference: Specify text that describes the reference associated with the document. A maximum of 60 characters can be used.

Note: This parameter is ignored if the Profile file (IDPFILE) parameter is specified.

Top

Action due date (ACTDATE)

Specifies the date when the action requested is due.

*NONE: No action due date request is specified.
*CURRENT: The current system action due date is used.
date: Specify the action due date. The date must be specified in the job date format.

Note: This parameter is ignored if the Profile file (IDPFILE) parameter is specified.

Top

Document status (STATUS)

Specifies the user-defined status of the document. Examples of status are: In Process, Pending Approval, or Retired.

*NONE: No status is included in this document.
status: Specify text that describes the status of the document. A maximum of 20 characters can be specified.

Note: This parameter is ignored if the Profile file (IDPFILE) parameter is specified.

Top

Completion date (CMPDATE)

Specifies the date when the requested action is completed.

*NONE: No completion date is included.
*CURRENT: The current system date is used as the completion date.
date: Specify the action completion date. The date must be specified in the job date format.

Note: This parameter is ignored if the Profile file (IDPFILE) parameter is specified.

Top

Project (PROJECT)

Specifies the project associated with the document.

*NONE: No project field information is included in this document.
name: Specify the name of the project associated with the document. A maximum of 10 characters can be specified.

Note: This parameter is ignored if the Profile file (IDPFILE) parameter is specified.

Top

Document character identifier (DOCCHRID)

Specifies the character identifier (graphic character set and code page) for the document data being used. The character identifier is related to the display device used to create the document data.

Note: This parameter is ignored if the Profile file (IDPFILE) parameter is specified.

*SYSVAL: The system determines the graphic character set and code page values for the command parameters from the QCHRID system value.

*DEVD: The system determines the graphic character set and code page values from the display device description where this command was entered. This option is valid only when entered from an interactive job. If this option is specified in a batch job, an error occurs.

graphic-character-set code-page: Specify the graphic character set and code page values used to create the data being distributed.

Note: Both parts can be up to 5 digits in length.

Top

Language ID (DOCLANGID)

Specifies the language identifier to be placed in this document's interchange document profile (IDP).

*JOB: The language identifier specified for the job in which this command is entered is used.
language-identifier: Specify a language identifier. Press the PF4 key from the Language ID (DOCLANGID) parameter to see a list of valid identifiers.

Note: This parameter is ignored if the Profile file (IDPFILE) parameter is specified.

Top

Country or region ID (DOCCNTRYID)

Specifies the country or region identifier to be placed in this document's interchange document profile (IDP).

*JOB: The country or region identifier specified for the job in which this command is entered is used.
country-or-region-ID: Specify a country or region identifier. Press the PF4 key from the Country or region ID (DOCCNTRYID) parameter to see a list of valid identifiers.

Note: This parameter is ignored if the Profile file (IDPFILE) parameter is specified.

Top

Personal (PERSONAL)

Specifies whether the document distribution is private or not. This parameter is replaced by SENSITIV but the PERSONAL parameter can still be used. However, because this parameter may be removed in a later release, whenever possible use the SENSITIV parameter.

If PERSONAL(*YES) is used, the SENSITIV parameter must be omitted or it must be with the value SENSITIV(*NONE). If the command is prompted without this parameter specified, this parameter is not displayed.

*NO: Only the owner and users that have authorization to the document can get access to documents that are not sensitive. Users authorized to work on behalf of other users who have access to the document can access documents that are not sensitive. This value will map to SENSITIV(*NONE).
*YES: Only the owner can get access to private documents. Users authorized to work on behalf of other users who have access to the document cannot get access to the document. This value will map to SENSITIV(*PRIVATE).

Top

Distribution expiry indicator (DSTEXPDATE)

Specifies the date and time on which the distribution is no longer needed in the mail log.

*NONE: No expiration date,
*CURRENT: The current date is used.
date: Specify the value to use as the expiration date. The date must be specified in the format specified by the system value QDATFMT.

Element 2: Time

*ENDOFDAY: An expiration time is requested by the end of the specified date. The time is set to 23:59:59.
time: Specify the value used as the expiration time.

Top

Command character identifier (CMDCHRID)

Specifies the character identifier (graphic character set and code page) for the data being entered as command parameter values. The character identifier is related to the display device used to enter the command.

The CMDCHRID parameter applies to the following parameters and means that the character set and code page are stored with the fields to allow the display station that accesses the document to correctly print or display the fields. The fields are translated to a common character set and code page when the fields are written to the search database. The interchangeable character set and code page are '697 500'.

The following fields are translated:

User identifier (USRID)
Distribution identifier (DSTID)
Document system code (SYSCOD)
Document description (DOCD)
Author (AUTHOR)
Document class (DOCCLS)
Keyword (KWD)
Subject (SUBJECT)
File cabinet location (FILCAB)
Copy list (CPYLST)
Reference (REFERENCE)
Document status (STATUS)
Project (PROJECT)

Single values

*SYSVAL: The system determines the graphic character set and code page values for the command parameters from the QCHRID system value.

*DEVD: The system determines the graphic character set and code page values from the display device description where this command was entered. This option is valid only when entered from an interactive job. If this option is specified in a batch job, an error occurs.

Element 1: Graphic character set

1-32767: Specify the graphic character set to use.

Element 2: Code page

1-32767: Specify the code page to use.

Top

Examples

Example 1: Filing a Personal Document

FILDOC   TYPE(*FILE)  DOCFILE(MARYLIB/MARYFILE)
         SENSITIV(*PRIVATE)  IDPFILE(*DOCFILE)

This command files a private document using a database file that has the document content and document profile information. The default for the distribution ID extension is 01 (DSTID(01)).

Example 2: Filing a Distribution Document

FILDOC   TYPE(*DSTID)  DSTID('NEWYORK SMITH 0201')  DSTID(02)
         DOCCLS('NEW CLASS')  TODOC(DST0201)  TOFLR(FLRDST)

This command files a distribution document in the document library QDOC in document DST0201 and folder FLRDST. The document class is changed in the distribution document, and the second distribution that was sent to the user is filed.

Top

Error messages

*ESCAPE Messages

CPF900B: User ID and address &1 &2 not in System Distribution Directory.
CPF900C: Sign on and verify of user failed.
CPF901B: Document filing request failed.
CPF902B: Authority of *AUTL is allowed only with USRAUT(*PUBLIC).
CPF905C: Error occurred trying to find a translation table.
CPF9096: Cannot use CMDCHRID(*DEVD), DOCCHRID(*DEVD) in batch job.
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.

Top