Change Distribution (CHGDSTD)

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

The Change Distribution Description (CHGDSTD) command changes descriptive information (such as author, subject, or keywords) or access information about a distribution document in the mail basket. For some parameters, descriptive information can be deleted or added.

Restrictions: (1) To work on behalf of another user, you must be granted permission to work on behalf of the other user with the Grant User Permission (GRTUSRPMN) command. (2) The requester of the command must be enrolled in the system distribution directory. (3) Personal mail distribution cannot be requested by a requester working on behalf of another user.

Top

Parameters

Keyword Description Choices Notes
DSTID Distribution identifier Character value Required, Positional 1
DSTIDEXN Distribution ID extension 1-99, *NONE Optional
COMMENT Comment Character value, *SAME, *RMV Optional
USRID User identifier Single values: *CURRENT
Other values: Element list
Optional
Element 1: User ID Character value
Element 2: Address Character value
SENSITIV Sensitivity *SAME, *NONE, *PERSONAL, *PRIVATE, *CONFIDENTIAL Optional
PERSONAL Personal *SAME, *NO, *YES Optional
IMPORTANCE Content importance *SAME, *NORMAL, *LOW, *HIGH Optional
PTY Priority *SAME, *NORMAL, *HIGH 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
DOCLANGID Language ID Character value, *JOB, *SAME Optional
DOCCNTRYID Country or region ID Character value, *JOB, *SAME Optional
DSTEXPDATE Distribution expiry indicator Element list Optional
Element 1: Date Date, *SAME, *CURRENT, *RMV
Element 2: Time Time, *SAME, *CURRENT, *ENDOFDAY
AUTHOR Author Single values: *SAME
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
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
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
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: *SYSVAL, *DEVD, *SAME
Other values: Element list
Optional
Element 1: Graphic character set Integer
Element 2: Code page Integer
Top

Distribution identifier (DSTID)

Specifies the unique distribution identifier of the distribution. The identifier is assigned to the distribution by the system that originated it. Only incoming distributions can be changed. If the identifier represents an outgoing distribution, an error message is returned.

distribution-id
The distribution identifier 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 the leading zeros. For example, 'NEWYORK SMITH 0204'. This parameter is required when *DSTID is specified on the Information to be sent prompt (TYPE parameter).

This is a required parameter.

Top

Distribution ID extension (DSTIDEXN)

Specifies the extension of the distribution identifier (if any) specified on the Distribution identifier prompt (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

Comment (COMMENT)

Specifies comments that describe the distribution document.

*SAME
The comment does not change.
*RMV
The comment is removed from the distribution document.
comment
Specify up to 256 characters of text, enclosed in apostrophes.
Top

User identifier (USRID)

Specifies which user ID address is associated with this request.

*CURRENT
The person currently running the command is authorized to the distribution being changed.
user-id address
Specify the user ID address that is authorized to the distribution to be changed. If the named user ID address differs from the current user ID address, the current user must be authorized to work on behalf of the named user by the Grant User Permission (GRTUSRPMN) command or by the OfficeVision/400 program.
Top

Sensitivity (SENSITIV)

Specifies the level of sensitivity defined by the X.400 standard. The four levels include normal, personal, private and company confidential. Private distributions cannot be viewed by a user working on behalf of another user.

*SAME
The value does not change.
*NONE
The distribution has no sensitivity restrictions.
*PERSONAL
The distribution is sent to the recipient as an individual.
*PRIVATE
The distribution contains information that should be accessed only by the recipient.
*CONFIDENTIAL
The distribution contains information that should be handled according to company procedures.
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.

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

Content importance (IMPORTANCE)

Specify low, normal or high importance. This is an indication to the recipient of the content importance of the distribution. It is different from priority which relates to the speed with which the distribution was sent.

*SAME
The value does not change.
*NORMAL
A distribution of normal importance.
*HIGH
A very important distribution.
*LOW
A low importance distribution.
Top

Priority (PTY)

Specifies the speed with which the distribution is sent. The prior version's purpose for priority is no longer valid because it relates to the speed by which the distribution arrived at the system. To ensure compatibility with applications from previous releases, this parameter will remain. If the command is prompted without this parameter specified, this parameter is not displayed.

*SAME
The value does not change.
*NORMAL
The distribution document arrived through a normal-speed line.
*HIGH
The distribution document arrived through a high-speed line.
Top

Document description (DOCD)

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

*SAME
The document description does not change.
document-description
Specify the new description of the document. A maximum of 44 characters can be specified, enclosed in apostrophes.
Top

Document date (DOCDATE)

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

*SAME
The distribution document date does not change.
*RMV
The distribution document date is removed from the distribution document.
document-date
Specify the distribution document date to be added or changed.
Top

Expiration date (EXPDATE)

Specifies the document expiration date beyond which the distribution document is no longer needed.

*SAME
The expiration date does not change.
*RMV
The expiration date is removed from the distribution document.
expiration-date
Specify the expiration date 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 distribution document.
action-due-date
Specify the action due date to be replaced or added. The action due date must be specified in the job 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 distribution document.
completion-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 distribution document.

*SAME
The reference field does not change.
*RMV
The reference is removed from the distribution document.
reference
Specify the document reference being changed or added. A maximum of 60 characters can be used.
Top

Status (STATUS)

Specifies the user-defined status indicator (In Process, Pending Approval, or Retired) of the distribution document.

*SAME
The status indicator does not change.
*RMV
The status indicator is removed.
status
Specify the document status indicator being changed or added. A maximum of 20 characters can be specified.
Top

Project (PROJECT)

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

*SAME
The project name does not change.
*RMV
The project name is removed from the distribution document.
project
Specify the distribution document project being replaced or added. A maximum of 10 characters can be specified.
Top

Language ID (DOCLANGID)

Specifies the language identifier to be placed in this distribution 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 prompt (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 F4 key from the Language ID prompt (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 distribution 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 prompt (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-identifier
Specify a country or region identifier. Press the F4 key from the Country or region ID prompt (DOCCNTRYID parameter) to see a list of valid identifiers.
Top

Distribution expiry indicator (DSTEXPDATE)

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

The possible Distribution Expiration Date values are:

*SAME
The value does not change.

If *SAME is specified for both the distribution expiration date and distribution expiration time, no changes are made to the distribution expiration date and time.

If *SAME is specified for the distribution expiration date and a value other than *SAME is specified for the distribution expiration time, the command checks for the existence of the distribution expiration date. If the distribution expiration date exists, the date remains unchanged and the time is changed as specified. If the distribution expiration date does not exist, an error message is issued indicating this condition, and you must specify something other than *SAME.

*CURRENT
The distribution expiration date is set to the current date.
*RMV
The distribution expiration date and time are removed from the distribution document.
distribution expiration date
Specify the value to use as the expiration date. The date must be in the format specified by the system value QDATFMT.

The possible Distribution Expiration Time values are:

*SAME
The value does not change.

If *SAME is specified for both the distribution expiration date and distribution expiration time, no changes are made to the distribution expiration date and time.

If *SAME is specified for the distribution expiration time and a value other than *SAME is specified for the distribution expiration date, the system checks for the existence of the distribution expiration time. If the distribution expiration time exists, the time does not change and the date is change as specified. If the distribution expiration time does not exist, an error message is issued, and you must specify something other than *SAME.

*CURRENT
The distribution expiration time is set to the current time.
*ENDOFDAY
An expiration time is the end of the specified date. The time is set to 23:59:59.
dist-expiration-time
Specify the value used as the expiration time.

The time is specified in 24-hour format and can be specified 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. Valid values for hh range from 00 to 23. Valid values for mm and ss range from 00 to 59.

With a time separator, specify a string of 5 or 8 digits (hours and minutes, or hours, minutes, and seconds). The time separator specified by the system value QTIMSEP is used to separate the hours, minutes, and seconds. If the command is entered from the command line, the string must be entered in apostrophes. If a time separator other than the separator used for your job is used, the command fails. Valid values for hh range from 00 to 23. Valid values for mm and ss range from 00 to 59.

Top

Author (AUTHOR)

Specifies the author or authors of the distribution document. A maximum of 20 characters can be specified, enclosed in apostrophes.

You can enter multiple values for this parameter.

The possible author values are:

*SAME
The author of the document does not change.
author
Specify a current author that is changed or removed, or the author that is being added.

The possible new author values are:

new-author
Specify the new author to replace the current author associated with the distribution document.
*ADD
The specified value is added to the information about the distribution document.
*RMV
The specified value is removed from the information about the distribution document.
Top

Document class (DOCCLS)

Specifies the class associated with this distribution document.

*SAME
The document class does not change.
*RMV
The document class for the distribution document is removed.
document-class
Specify the document class that is replaced or added. A maximum of 16 characters can be specified, enclosed in apostrophes.
Top

Keyword (KWD)

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

You can enter multiple values for this parameter.

The possible keyword values are:

*SAME
The keywords do not change.
keyword
Specify a current keyword that is changed or removed, or the keyword that is being added. A maximum of 60 characters can be specified, enclosed in apostrophes.

The possible new keyword values are:

new-keyword
Specify a new keyword to replace the current keyword. A maximum of 60 characters can be specified, enclosed in apostrophes.
*ADD
The specified value is added to the information about the distribution document.
*RMV
The specified value is removed from the information about the distribution document.
Top

Subject (SUBJECT)

Specifies the subject of the distribution document.

You can enter multiple values for this parameter.

The possible subject values are:

*SAME
The subject of the distribution document does not change.
subject
Specify a current subject to be changed or removed, or the subject being added. A maximum of 60 characters can be used.

The possible new subject values are:

new-subject
Specify a new subject to replace the current subject. A maximum of 60 characters can be used.
*ADD
The specified document subject is added to the information about the distribution document.
*RMV
The specified document subject is removed from the information about the distribution document.
Top

File cabinet location (FILCAB)

Specifies the physical location where the distribution document is stored. This parameter is intended for printed distribution documents. It changes only the Document Interchange Architecture Profile field that refers to the printed document.

*SAME
The file cabinet location does not change.
*RMV
The file cabinet location is removed from the distribution document.
file-cabinet-location
Specify the file cabinet location to be added or changed.
Top

Copy list (CPYLST)

Specifies names or addresses of users who receive this distribution document.

You can enter multiple values for this parameter.

The possible copy list values are:

*SAME
The copy list does not change.
copy-list
Specify a current copy list entry to be changed or removed, or a new copy list entry to be added.

The possible new copy list values are:

new-copy-list
Specify the new copy list entry to replace the current copy list entry.
*ADD
The specified copy list entry is added to the information about the distribution list.
*RMV
The specified copy list entry is removed from the information about the distribution list.
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.

*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.
graphic-character-set code-page
Specify the graphic character set and code page values used to create the data.

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

Top

Examples

Example 1: Deleting an Author

CHGDSTD   DSTID('NEWYORK SMITH   0201')  DSTIDEXN(01)
          AUTHOR('John W. Baker' *DLT)
          KWD('PC Attached Scanners' *ADD)

This command deletes one of the authors associated with a distribution document and adds a new keyword to the distribution document.

Example 2: Changing the User-Defined Document Name

CHGDSTD   DSTID('NEWYORK SMITH   0201')  DSTIDEXN(02)
          DOCD('S/38 1984 Sales')  USRID(JACOBSON RCHJACOB)

In this example, a person authorized to work on behalf of JACOBSON is changing the user-defined document name associated with a document on the second distribution sent to the user.

Top

Error messages

*ESCAPE Messages

CPF90D5
Distribution description not changed.
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.
Top