CMS, MODIFY, ELEMENT
*Conan The Librarian (sorry for the slow response - running on an old VAX)
|
VMS Help CMS, MODIFY, ELEMENT *Conan The Librarian (sorry for the slow response - running on an old VAX) |
|
Changes the characteristics of a specified element or elements.
Format:
MODIFY ELEMENT element-expression /qualifier "remark"
| 1 - Restrictions |
o You cannot modify an element if it is set to read-only access.
o You can modify only the reference copy, remark, and review
attributes of an element that has a generation reserved.
o If you specify /NOTES, you must also specify /POSITION on the
same command line.
o You must specify one or more of the following qualifiers:
/[NO]CONCURRENT
/[NO]HISTORY
/NAME
/[NO]NOTES
/POSITION
/[NO]REFERENCE_COPY
/REMARK
/[NO]REVIEW
| 2 - Command Parameters |
element-expression
Specifies one or more elements to be modified. An element
expression can be an element name, a group name, a wildcard
expression, or a list of these separated by commas.
remark
Specifies a character string to be logged in the history file with
this command, usually used to explain why the command was entered.
The remark is enclosed in quotation marks. If no remark was
entered, a null remark ("") is logged. Note that this parameter
and the string on the /REMARK qualifier are unrelated.
| 3 - Description |
The MODIFY ELEMENT command changes the characteristics of one or
more elements. You can alter the following characteristics:
o The concurrent attribute of the element
o The history string that is inserted in the element history when
the element is reserved or fetched
o The element name
o The notes string and related position attribute
o The reference copy attribute of the element
o The creation remark that is associated with the element
o The review attribute
Use the SHOW ELEMENT command to display element characteristics.
If the history, notes, or position attribute is modified on an
element that has the reference copy attribute, CMS creates an
updated reference copy for the element.
| 4 - Qualifiers |
4.1 - /CONCURRENT
4.2 - /NOCONCURRENT
Specifies whether this element can have multiple reservations. If
you do not specify this qualifier, the existing concurrent access
is not changed.
4.3 - /CONFIRM
Controls whether CMS prompts you for confirmation before each
transaction.
When you specify /CONFIRM and run CMS in interactive mode, CMS
prompts you for confirmation. If you type YES, ALL, TRUE, or 1,
CMS executes the transaction. If you type NO, QUIT, FALSE, 0,
or press RETURN or CTRL/Z, no action is performed. If you type
any other character, CMS continues to prompt until you type an
acceptable response.
CMS does not prompt for confirmation in batch mode.
4.4 - /HISTORY="string"
Establishes the history attribute for the element. If an element
has a history attribute, its history (which is similar to that
produced by the ANNOTATE command) is included in the file when you
retrieve it with the FETCH or RESERVE command.
The quoted string specifies the format of the history. The quoted
string must contain the characters #H or #B (lowercase is allowed)
and can contain other printing characters. To include a quotation
mark in the output history string, type it twice (""). To include
a number sign (#) in the output history string, type it twice
(##).
4.5 - /NOHISTORY
Deletes any existing history attribute. If both /HISTORY and
/NOHISTORY are omitted, any existing history attribute remains
unchanged.
4.6 - /LOG (D)
Controls whether CMS displays success and informational messages
on the default output device. By default, if the command executes
successfully, CMS displays a success message. If you specify
/NOLOG, success and informational messages are suppressed. Any
warning, error, or fatal error messages are displayed regardless
of whether /LOG or /NOLOG is specified.
4.7 - /NAME=element-name
Specifies the new name for the element. The new element name
cannot be the same as an existing element name. Do not use the
file name 00CMS because this name is reserved for CMS. If you
specify the /NAME qualifier, you cannot use wildcards or a comma
list in the element-name parameter, nor can you use a wildcard for
the /NAME qualifier.
If an element is set to /REFERENCE_COPY, CMS creates a new
reference copy of the element in the reference copy directory.
4.8 - /NOTES="string"
Establishes the notes attribute for the element. If an element
has a notes attribute, notes are appended to the lines of the file
when it is retrieved by the FETCH or RESERVE command.
The quoted string specifies the format of the note. The quoted
string can contain text or the characters #G (or #g), or both.
4.9 - /NONOTES
Cancels any current notes attribute and the corresponding position
attribute.
If both /NOTES and /NONOTES are omitted, any existing notes
attribute remains unchanged.
4.10 - /OCCLUDE[=option,...]
Controls whether CMS selects the first instance of the specified
object, or all instances of the specified object in the library
search list. The options field contains one or more keywords
associated with the name of the object. The options field can
contain the following keywords:
ALL--equivalent to (ELEMENT, GROUP)
ELEMENT (D)
NOELEMENT
GROUP (D)
NOGROUP
NONE--equivalent to (NOELEMENT, NOGROUP)
You can specify either ALL or NONE, or any combination of the
[NO]ELEMENT and [NO]GROUP keywords.
By default, CMS performs occlusion for all objects; that is, CMS
selects only the first occurrence of a specified object.
4.11 - /POSITION=n
Establishes the position attribute; that is, the character
position at which the note generated by the /NOTES qualifier is to
begin on the line. A file that has a position attribute must have
a notes attribute. Thus, the /POSITION qualifier can be used only
if the element already has an established notes attribute, or the
/NOTES qualifier is used on the same MODIFY ELEMENT command.
The value n is required and must be an integer in the range 1 to
511. If the length of the line is less than n, the note appears
at position n. If the length of the line is greater than or equal
to n, the note is placed at the next tab stop after the end of
the line. (Tab stops are at position 9 and every 8 characters
thereafter.)
If you omit /POSITION, any current position attribute remains
unchanged.
4.12 - /REFERENCE_COPY
4.13 - /NOREFERENCE_COPY
Controls whether a new reference copy of an element is created or
deleted. If you specify /REFERENCE_COPY, CMS creates a new
reference copy of the element in the reference copy directory and
updates the current reference copy directory whenever you create a
new main line generation of the element. If you specify
/NOREFERENCE_COPY, CMS deletes the existing reference copy of the
element. The reference copy directory must be established before
you issue the MODIFY ELEMENT/REFERENCE_COPY command. Use the MODIFY
LIBRARY/REFERENCE_COPY command to establish the reference copy
directory.
Controls whether CMS creates a new reference copy of an element
whenever you create a new main line generation of the element. If
you specify /NOREFERENCE_COPY, CMS deletes the existing reference
copy.
To establish the reference copy directory, use the MODIFY
LIBRARY/REFERENCE_COPY command.
4.14 - /REMARK="string"
Specifies a new remark to be substituted for the creation remark
that is associated with the element.
4.15 - /REVIEW
4.16 - /NOREVIEW
Controls whether new generations of the element are marked for
review. If you specify /REVIEW, new generations of the element are
marked for review. If you specify /NOREVIEW, new generations are
marked only if the reserved generation is either rejected or has a
review pending. If you do not specify this qualifier, the existing
review attribute is not changed.
To determine whether an element has the review attribute enabled,
use the SHOW ELEMENT/FULL command.
| 5 - Examples |
(1) CMS> MODIFY ELEMENT INIT.FOR/NOCONCURRENT
_Remark: no more changes, other than those already discussed
%CMS-S-MODIFIED, element DISKX:[PROJECT.CMSLIB]INIT.FOR modified
This example sets the element INIT.FOR to NOCONCURRENT access.
This means that only one person can reserve the element at a
time.
(2) CMS> MODIFY ELEMENT/REVIEW EXAMPLE.SDML
_Remark: team should review all changes before performing build
%CMS-S-MODIFIED, element DISKX:[PROJECT.CMSLIB]EXAMPLE.SDML modified
This example marks the latest generation of the element
EXAMPLE.SDML for review, and adds it to the review pending
list. To display what generations are pending review, use the
SHOW REVIEWS_PENDING command.
|
|
