Change Document Description (CHGDOCD)

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

The Change Document Description (CHGDOCD) command allows you to change the information describing a document that was filed previously.

Restrictions:

To change the document profile values, you must have at least change (*CHANGE) authority to the document, all object (*ALLOBJ) special authority, or be working on behalf of a user who is authorized to the document.
To change the security values (for example, ACC, USRAUT, PERSONAL, AUTL), the checkout flag, and the allow replacement flag, you must be the owner of the document, have all (*ALL) authority to the object, or *ALLOBJ special authority, or be working on behalf of a user who is authorized to the document.
Authority to work on behalf of others is granted with the Grant User Permission (GRTUSRPMN) command.

Top

Parameters

Keyword	Description	Choices	Notes
DOC	Document	Character value, *DOCID	Required, Positional 1
FLR	Folder	Character value, *NONE	Optional, Positional 3
USRID	User identifier	Single values: CURRENT Other values: Element list*	Optional, Positional 2
	Element 1: User ID	Character value
	Element 2: Address	Character value
DOCID	Document identifier	Character value, *NONE	Optional
SENSITIV	Sensitivity	SAME, NONE, PERSONAL, PRIVATE, *CONFIDENTIAL	Optional
DOCD	Document description	Character value, *SAME	Optional
DOCDATE	Document date	Date, SAME, RMV	Optional
EXPDATE	Expiration date	Date, SAME, RMV	Optional
ACTDATE	Action due date	Date, SAME, RMV	Optional
CMPDATE	Completion date	Date, SAME, RMV	Optional
REFERENCE	Reference	Character value, SAME, RMV	Optional
STATUS	Status	Character value, SAME, RMV	Optional
PROJECT	Project	Character value, SAME, RMV	Optional
ACC	Access code	Single values: SAME, RMVALL Other values (up to 50 repetitions): Element list	Optional
	Element 1: Access code	1-2047
	Element 2: Add or remove access code	ADD, RMV
AUTL	Authorization list	Name, SAME, RMV	Optional
USRAUT	User authority	Single values: SAME, RMVALL Other values (up to 50 repetitions): Element list	Optional
	Element 1: User profile	Name, *PUBLIC
	Element 2: Authority level	USE, CHANGE, ALL, EXCLUDE, AUTL, RMV
MARK	Mark for offline	Single values: SAME, NO Other values: Element list	Optional
	Element 1: Mark for offline	*YES
	Element 2: Offline type	KEEP, RMVTXT, *RMVALL
ALWRPL	Allow replacement	SAME, NO	Optional
CHKOUT	Check out	SAME, NO	Optional
AUTHOR	Author	Single values: SAME, RMVALL Other values (up to 50 repetitions): Element list	Optional
	Element 1: Author	Character value
	Element 2: New author	Character value, ADD, RMV
DOCCLS	Document class	Character value, SAME, RMV	Optional
KWD	Keyword	Single values: SAME, RMVALL Other values (up to 50 repetitions): Element list	Optional
	Element 1: Keyword	Character value
	Element 2: New keyword	Character value, ADD, RMV
SUBJECT	Subject	Single values: SAME, RMVALL Other values (up to 50 repetitions): Element list	Optional
	Element 1: Subject	Character value
	Element 2: New subject	Character value, ADD, RMV
FILCAB	File cabinet location	Character value, SAME, RMV	Optional
CPYLST	Copy list	Single values: SAME, RMVALL Other values (up to 50 repetitions): Element list	Optional
	Element 1: Copy list	Character value
	Element 2: New copy list	Character value, ADD, RMV
CMDCHRID	Command character identifier	Single values: SYSVAL, DEVD Other values: Element list	Optional
	Element 1: Graphic character set	Integer
	Element 2: Code page	Integer
DOCCHRID	Document character identifier	Single values: SAME, SYSVAL, DEVD Other values: Element list*	Optional
	Element 1: Graphic character set	Integer
	Element 2: Code page	Integer
DOCLANGID	Language ID	Character value, SAME, JOB	Optional
DOCCNTRYID	Country or region ID	Character value, SAME, JOB	Optional
PERSONAL	Personal	SAME, NO, *YES	Optional

Top

Document (DOC)

Specifies the name of the document for which descriptive information is to be changed on the local system.

This is a required parameter.

*DOCID: The document being changed is identified by the library-assigned document name specified on the Document identifier (DOCID) parameter.
name: Specify the user-assigned name of the document being changed. A maximum of 12 characters can be specified.

Top

Folder (FLR)

Specifies the name of the folder that contains the document to be changed. This parameter must be specified if a user-assigned document name is specified on the Document (DOC) parameter.

*NONE: No folder is specified when the document is identified on the Document identifier (DOCID) parameter.
name: Specify the user-assigned name of the folder that contains the document to be changed. The folder name can consist of a series of folder names (FLR1/FLR2/etc.) if the document is located in a folder that is contained in another folder. A maximum of 63 characters can be specified. This value is required when DOC(name) is specified.

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 identifier (DOCID)

Specifies the library-assigned name of the document. This is the name assigned to the document by the system when it was created. Documents filed outside the local system have only library-assigned document names. The library-assigned document names can be determined by using the Query Document Library (QRYDOCLIB) command or by the message returned from the File Document (FILDOC) command.

Library-assigned document names are 24 characters in length with the following format:

YYYYMMDDHHMNSSHSSNSNSNSN

where:

       YYYY = year
         MM = month
         DD = day
         HH = hour
         MN = minute
         SS = second
         HS = hundredths of a second
   SNSNSNSN = system name

*NONE: No library-assigned document name is required when the document is identified on the Document (DOC) parameter.
name: Specify the library-assigned document name of the document to be changed.

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).

*SAME: The value does not change.
*NONE: The document has no sensitivity restrictions.
*PERSONAL: The distribution 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

Document description (DOCD)

Specifies the description for the document being changed. This is the Document Interchange Architecture Profile document name field.

*SAME: The document description does not change.
description: Specify the new description of the document. A maximum of 44 characters can be specified.

Top

Document date (DOCDATE)

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

*SAME: The document date does not change.
*RMV: The document date is removed from the filed document.
date: Specify the document date to be added or replaced. The date must be specified in the job date format.

Top

Expiration date (EXPDATE)

Specifies the date when the document is no longer needed.

*SAME: The expiration date does not change.
*RMV: The expiration date is removed from the filed document.
date: Specify the expiration date of the document to be replaced or added. The date must be specified in the job date format.

Top

Action due date (ACTDATE)

Specifies the date when the action requested is due.

*SAME: The action due date does not change.
*RMV: The action due date is removed from the filed document.
date: Specify the action due date to be replaced or added. The date must be specified in the job's date format.

Top

Completion date (CMPDATE)

Specifies the date when the action requested is completed.

*SAME: The completion date does not change.
*RMV: The completion date is removed from the filed document.
date: Specify the completion date to be replaced or added. The date must be specified in the job date format.

Top

Reference (REFERENCE)

Specifies a reference associated with the document.

*SAME: The reference field does not change.
*RMV: The document reference is removed from the filed document.
reference: Specify the document reference to be replaced or added. A maximum of 60 characters can be used.

Top

Status (STATUS)

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

*SAME: The document status does not change.
*RMV: The document status is removed from the information for the filed document.
status: Specify the status of the document being replaced or added. A maximum of 20 characters can be specified.

Top

Project (PROJECT)

Specifies the name of the project with which the document is associated.

*SAME: The project name does not change.
*RMV: The document project name is removed from the information for the filed document.
name: Specify the document project name to substitute or add. A maximum of 10 characters can be specified.

Top

Access code (ACC)

Specifies that access codes are to be added or deleted. Access codes must be added on the system with the Add Access Code (ADDACC) command.

Single values

*SAME: The access codes do not change.
*RMVALL: All access codes are removed from the filed document.

Element 1: Access code

1-2047: Specify the access codes that are to be added or deleted.

Element 2: Add or remove access code

*ADD: The access code specified is added to the access codes for the filed document being changed.
*RMV: The access code specified is removed from the access codes for the filed document being changed.

Top

Authorization list (AUTL)

Specifies that the authority for the document named on the Document (DOC) parameter or Document identifier (DOCID) parameter comes from the authorization list.

*SAME: The authorization list does not change.
*RMV: The current authorization list is removed from the filed document.
name: Specify the name of the authorization list whose authority replaces the current authorization list or adds an authorization list if one does not currently exist.

Top

User authority (USRAUT)

Specifies the user ID and address of the users that can access the document and the authority each user has. This parameter is used to change the authorizations for this document by removing a user's authority for the document or changing the user's authority.

Single values

*SAME: The list of users who have access to the document does not change.
*RMVALL: All users are removed from the authorization list for the filed document.

Element 1: User profile

*PUBLIC: The authority given to users or user groups who do not have specific authority to the document, or who are not on the authorization list is changed.
name: Specify the user profile name of a user deleted from the specific user access list or whose authority is to be changed.

Element 2: Authority level

*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 in the AUTL parameter Authorization list (AUTL) parameter is used for the document. *AUTL is valid only if *PUBLIC is also specified.
*RMV: The user's specific authorization for the filed document is removed.

Top

Mark for offline (MARK)

Specifies whether the document should be saved offline. Mark is a function of the Save Document Library Object (SAVDLO) command where documents that have been marked for offline (MARK(*YES) specified) are saved on disk, diskette, or tape.

Single values

*SAME: The mark for offline value does not change.
*NO: The mark for offline is turned off and the document is not saved offline by the SAVDLO command.

Element 1: Mark for offline

*YES: The mark for offline is turned on and the document is saved offline by the SAVDLO command.

Element 2: Offline type

The possible values that can be specified with *YES are:

*KEEP: When the document is saved to disk, diskette, or tape, the document is also kept for online use.
*RMVTXT: When the document is saved to disk, diskette, or tape, the document content is deleted but the document profile is kept online for document library searches.
*RMVALL: When the document is saved to disk, diskette, or tape, the document is deleted. No trace of the document is left online for the document library searches.

Top

Allow replacement (ALWRPL)

Specifies whether to allow replacement of the document content. Once a document is changed so that it cannot be replaced, it cannot be changed back to a document that can be replaced. You must have all (*ALL) authority to the document to request this change.

*SAME: The document content replacement value does not change.
*NO: The document content cannot be changed after this request is complete.

Top

Check out (CHKOUT)

Specifies the setting for the checkout value. This value can be set only for documents that can be replaced. With this parameter, you can reset the checkout status of a document already checked out by a Retrieve Document (RTVDOC) request. A document cannot be checked out for update with this parameter. This parameter is ignored for a document that cannot be replaced. Only the document owner or users with all (*ALL) authority to the object can request the checkout value be set off.

*SAME: The checkout flag does not change.
*NO: The checkout flag is set to off.

Top

Author (AUTHOR)

Specifies the author of the document.

If you want to specify a value in mixed case, the value must be enclosed in apostrophes.

Single values

*SAME: The author of the document does not change.
*RMVALL: All author names are removed.

Element 1: Author

character: Specify the name of the current author that is to be removed or replaced, or the author that is to be added.

Element 2: New author

character: Specify the new author name to replace the current author name.
*ADD: The user is added as author for the filed document.
*RMV: The user is removed as author for the filed document.

Top

Document class (DOCCLS)

Specifies the class associated with this document.

*SAME: The document class does not change.
*RMV: The document class for the filed document is removed.
class: Specify the document class to replace the existing document class or the document class to be added. A maximum of 16 characters can be specified.

Top

Keyword (KWD)

Specifies the keywords that can be used to describe the document.

If you want to specify a value in mixed case, the value must be enclosed in apostrophes.

Single values

*SAME: The keywords do not change.
*RMVALL: All keywords are removed for the filed document.

Element 1: Keyword

character: Specify a current keyword to be removed or replaced, or a keyword to be added.

Element 2: New keyword

character: Specify a new keyword to replace the current keyword. A maximum of 60 characters can be specified, enclosed in apostrophes.
*ADD: The keyword for the filed document is added.
*RMV: The keyword for the filed document is removed.

Top

Subject (SUBJECT)

Specifies the subject of the document.

If you want to specify a value in mixed case, the value must be enclosed in apostrophes.

Single values

*SAME: The subject does not change.
*RMVALL: All subjects are removed for the filed document.

Element 1: Subject

character: Specify a current subject to be removed or replaced, or a subject to be added.

Element 2: New subject

character: Specify a new subject to replace the current subject.
*ADD: The subject for the filed document is added.
*RMV: The subject for the filed document is removed.

Top

File cabinet location (FILCAB)

Specifies the location where the document is stored. This parameter is intended for printed documents. All that changes is the interchange document profile (IDP) that refers to the printed document.

*SAME: The file cabinet reference does not change.
*RMV: The file cabinet reference for the filed document is removed.
filing-cabinet-reference: Specify the file cabinet reference to be added or replaced. A maximum of 60 characters can be specified.

Top

Copy list (CPYLST)

Specifies names or addresses of users who receive this document.

If you want to specify a value in mixed case, the value must be enclosed in apostrophes.

Single values

*SAME: The copy list does not change.
*RMVALL: All copy list entries are removed from the filed document.

Element 1: Copy list

character: Specify a current copy list entry that is to be removed or replaced, or a new copy list entry to be added.

Element 2: New copy list

character: Specify the new copy list entry to replace the current copy list entry.
*ADD: The copy list entry is added for the filed document.
*RMV: The copy list entry is removed for the filed document.

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.

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

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.

*SAME: The character identifier does not change.

*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

Language ID (DOCLANGID)

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

This parameter can be used to add a language identifier to the document's IDP if the identifier has not been specified previously, or to change the value of an existing language identifier.

Note: If you specify a value on this parameter and no value has previously been specified on the Country or region ID (DOCCNTRYID) parameter, you must also specify a country or region identifier.

*SAME: The language identifier does not change.
*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.

Top

Country or region ID (DOCCNTRYID)

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

This parameter can be used to add a country or region identifier to the document's IDP if an identifier has not been specified previously, or to change the value of an existing country or region identifier.

Note: If you specify a value on this parameter and no value has previously been specified on the Language ID (DOCLANGID) parameter, you must also specify a language identifier.

*SAME: The country or region identifier does not change.
*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.

Top

Personal (PERSONAL)

Specifies whether the document being changed is a personal document. If it is, only the owner or an authorized user can access it. 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). 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.

*SAME: The value does not change.
*NO: The document is not a personal document. This value will map to SENSITIV(*NONE).
*YES: The document is a personal document. This value will map to SENSITIV(*PRIVATE).

Top

Examples

CHGDOCD   DOC(DOC1)  FLR(FLR1)  SENSITIV(*PRIVATE)
          AUTL(USERAUTL)  ALWRPL(*NO)  AUTHOR('AUTHOR1' *RMV)

This command changes document DOC1, which is located in folder FLR1, to a private document. This document is no longer a document that can be replaced. AUTHOR1 is removed from the list of authors. If an authorization list already exists, it is replaced with authorization list USERAUTL. If an authorization list does not exist, USERAUTL is added as the authorization list for the document. The remaining information associated with the document does not change.

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.
CPF902B: Authority of *AUTL is allowed only with USRAUT(*PUBLIC).
CPF905C: Error occurred trying to find a translation table.
CPF905E: Cannot specify *RMV when USRAUT(*PUBLIC) is specified.
CPF9096: Cannot use CMDCHRID(*DEVD), DOCCHRID(*DEVD) in batch job.
CPF9099: Document description not changed.

Top