rmscom & rmsmon reference manual c40 - emperex · commands and the operational considerations...

Revision Management System(RMS)RMSCOM and RMSMONReference Manual

Abstract This manual describes the user interface for Data Design Systems’ RMS product asimplemented on Tandem NonStop computer systems. The syntax for all RMSCOMcommands and the operational considerations for the RMSMON process aredescribed in detail in this publication.

Part Number 080203 C40

Product Version RMS C40

Operating System GUARDIAN C30-D30

Printing Date September 1996

Data Design Systems Inc.5915 Airport Road, Suite 625,Mississauga, Ontario, Canada,L4V 1T1

Phone: (905) 677-6666Fax: (905) 677-6671

www.datadesign.com

Document History

Edition Part Number Operating System DateVersion

Preliminary Draft 080203 C10-D Guardian C00 October 1989Beta Release 080203 C10 Guardian C10 February 1990Production Release 080203 C20 Guardian C10,C20 March 1990C22 Release Update 080203 C22 Guardian C11-C30 October 1990C23 Release Update 080203 C23 Guardian C11-C30 January 1991C24 Release Update 080203 C24 Guardian C20-C30 July 1991C24 Release Update 1 080203 C24 Guardian C20-C30 October 1991C24 Release Update 2 080203 C24 Guardian C20-C30 December 1991C30 Release Update 3 080203 C30 Guardian C20-C30 March 1992C30 Second Edition 080203 C30 Guardian C20-C30 November 1992C31 Third Edition 080203 C31 Guardian C30-D20 November 1993C31 Release Update 1 080203 C31 Guardian C30-D20 June 1994C40 Fourth Edition 080203 C40 Guardian C30-D30 January 1996C40 Release Update 1 080203 C40 Guardian C30-D30 October 1996

Copyright Notice

Copyright © 1989, 1990, 1991, 1992, 1993, 1994, 1996 by Data Design Systems, Inc. Printedin Canada.

All rights reserved. No part of this document may be reproduced in any form, includingphotocopying, optical character scanning recognition, facsimile (FAX) transmission andtranslation to another language without the prior written consent of Data Design Systems, Inc.

The information contained in this document is furnished under a license agreement andnon-disclosure agreement. The software and associated documentation may be used only inaccordance with the terms of the agreement.

Trademarks or Service Marks

The following are trademarks or service marks of Data Design Systems Inc.

ATS, DBOL, DDSDIFF, DDSMAKE, GMAIL, InterAccess, RMS.

The following are trademarks or service marks of Tandem Computers Incorporated:

Expand, Guardian , NetBatch, NonStop , PATHMAKER, TACL, Transfer, Tandem.

Table of Contents

Preface

Purpose and Scope......................................................................................xiOrganization ...............................................................................................xiWho Should Read What .............................................................................xiiRelated Manuals and Products ...................................................................xii

Introduction to RMS 1

The Catalog.................................................................................................1-1Component Types.......................................................................................1-2Special Components ...................................................................................1-3Version Number in RMS............................................................................1-4References ..................................................................................................1-5Rules and Rule Naming..............................................................................1-6Compilation Relationships .........................................................................1-7SQL Compilation Within RMS..................................................................1-8Dependencies..............................................................................................1-11Separate Compilation .................................................................................1-11Multinode External Compilation Set-up ....................................................1-15Using INSPECT With RMS.......................................................................1-16Archive Management .................................................................................1-17Releases ......................................................................................................1-18Post-Development Changes (Bugfixes) ....................................................1-19SCOBOL TCLPROG Groups ....................................................................1-20PNA Rule Database Groups.......................................................................1-21DDLDICT Group Component ...................................................................1-23DDLDICT Promotion.................................................................................1-25SQL DDL Change Management ................................................................1-26Segmented Source Libraries.......................................................................1-26DATALIB - Data Library Extraction .........................................................1-33Managing External Components Within RMS ..........................................1-39Setting Up the RMS Environment .............................................................1-43

RMSCOM and RMSMON Startup Commands 2

Starting RMSCOM Command...................................................................2-2Customization Entities ...............................................................................2-3Running RMSCOM....................................................................................2-4Starting RMSMON ....................................................................................2-5

RMSCOM Commands - Overview and Summary 3

General Command Format .........................................................................3-1Keyword Abbreviations .............................................................................3-2

Table of Contents

080203 Data Design Systems, Inc. iii

Environment Commands 4

EXIT Command .........................................................................................4-3SETPROMPT Command ...........................................................................4-4

RMSCOM Control Commands 5

ALTER RMS Command ............................................................................5-2CLEANUP RMS Command ......................................................................5-5INFO RMS Command ...............................................................................5-6OPEN Command........................................................................................5-8SHUTDOWN RMS Command..................................................................5-9

Component Commands 6

ADD COMPONENT Command................................................................6-3ADD USERCHANGE Command .............................................................6-12ALTER COMPONENT Command............................................................6-14ALTER USERCHANGE Command..........................................................6-17ALTER VERSION Command ...................................................................6-18BROWSE Command..................................................................................6-19CONDENSE Command.............................................................................6-20DELETE COMPONENT Command .........................................................6-22DELETE USERCHANGE Command.......................................................6-23DELETE VERSIONS Command ..............................................................6-24DIFFERENCES Command........................................................................6-26DISCONTINUE VERSION Command.....................................................6-31EXTRACT Command................................................................................6-33GROUP Command.....................................................................................6-38INFO COMPONENT Command...............................................................6-39INFO COMPONENT Report Formats ......................................................6-41INFO PCR Command ................................................................................6-46INFO SSV Command.................................................................................6-47INFO USERCHANGE Command.............................................................6-48INFO VERSION Command.......................................................................6-49LINK COMPONENT Command...............................................................6-50LINK VERSION Command ......................................................................6-51LIST LOCK Command..............................................................................6-52LOCK Command .......................................................................................6-54MAP Command..........................................................................................6-55OBSOLETE Command..............................................................................6-57RENUMBER Command............................................................................6-59RESET Command ......................................................................................6-61ROLLOUT Command................................................................................6-62SET COMMENT Command......................................................................6-64SET COMPONENT Command .................................................................6-65SET EXTRACT Command........................................................................6-67SET IMAGE Command .............................................................................6-69

Table of Contents

iv 080203 Data Design Systems, Inc.

SET SSV Command...................................................................................6-70SET SUBMIT Command...........................................................................6-71SHOW Command.......................................................................................6-72SUBMIT Command ...................................................................................6-74UNLINK COMPONENT Command.........................................................6-96UNLINK VERSION Command ................................................................6-97UNLOCK Command..................................................................................6-98

State Commands 7

ADD STATE Command.............................................................................7-2ALTER STATE Command .........................................................................7-3DELETE STATE Command ......................................................................7-4DEMOTE Command..................................................................................7-5LINK STATE Command............................................................................7-7LIST STATE Command .............................................................................7-8PROMOTE COMPONENT Command.....................................................7-9PROMOTE RELEASE Command ............................................................7-13PROMOTE USERCHANGE Command...................................................7-17RESET STATE Command .........................................................................7-21SET STATE Command...............................................................................7-22UNLINK STATE Command ......................................................................7-23

Release Commands 8

ADD RELEASE Command.......................................................................8-3ADD REQUISITE COMPONENT Command..........................................8-7ADD REQUISITE RELEASE Command .................................................8-9ALTER REQUISITE COMPONENT Command......................................8-12ALTER REQUISITE RELEASE Command .............................................8-13CLEANUP RELEASE Command .............................................................8-14DELETE RELEASE Command.................................................................8-15DELETE REQUISITE COMPONENT Command ...................................8-16DELETE REQUISITE RELEASE Command...........................................8-17DISCONTINUE RELEASE Command.....................................................8-18DUPLICATE RELEASE Command..........................................................8-19FREEZE RELEASE Command.................................................................8-21LINK RELEASE Command ......................................................................8-26LIST RELEASE Command .......................................................................8-27RESET RELEASE Command ...................................................................8-30SET RELEASE Command.........................................................................8-31SHOW RELEASE Command....................................................................8-33THAW RELEASE Command....................................................................8-34UNLINK RELEASE Command ................................................................8-35

Table of Contents

080203 Data Design Systems, Inc. v

Security Commands 9

How Does RMS Handle Security?.............................................................9-3Command Security Requirements..............................................................9-4INFO SECURITY Command ....................................................................9-10SECURE Command...................................................................................9-12

Server Commands 10

ALTER SERVER Command......................................................................10-2FREEZE SERVER Command ...................................................................10-6INFO SERVER Command.........................................................................10-7START SERVER Command......................................................................10-9STATUS SERVER Command....................................................................10-10STOP SERVER Command ........................................................................10-12THAW SERVER Command ......................................................................10-13

Compile Commands 11

ADD COMPILE Command.......................................................................11-3ADD REFERENCE Command..................................................................11-6ADD RULE Command ..............................................................................11-8ALTER RULE Command ..........................................................................11-12DELETE COMPILE Command ................................................................11-13DELETE REFERENCE Command ...........................................................11-14DELETE RULE Command........................................................................11-15DUPLICATE RULE Command.................................................................11-16EDIT RULE Command..............................................................................11-17LIST COMPILE Command .......................................................................11-18LIST DEPENDENCIES Command...........................................................11-19LIST REFERENCE Command..................................................................11-21LIST RULE Command ..............................................................................11-23PRODUCE Command................................................................................11-25RESET PRODUCE Command ..................................................................11-31SET PRODUCE Command .......................................................................11-32SHOW PRODUCE Command...................................................................11-35

Distribution and Acquisition Commands 12

ACQUIRE Command ................................................................................12-4ADD ATTRIBUTE Command...................................................................12-12ADD LICENSE Command ........................................................................12-13ADD LOCATION Command ....................................................................12-14ALTER ATTRIBUTE Command...............................................................12-19ALTER LICENSE Command ....................................................................12-20ALTER LOCATION Command.................................................................12-21DELETE ATTRIBUTE Command ............................................................12-22DELETE DISTRIBUTE Command...........................................................12-23

Table of Contents

vi 080203 Data Design Systems, Inc.

DELETE LICENSE Command..................................................................12-24DELETE LOCATION Command..............................................................12-25DISTRIBUTE RELEASE Command ........................................................12-26FALLBACK LOCATION Command ........................................................12-36IMPACT RELEASE Command.................................................................12-41INFO LOCATION Command....................................................................12-42INFO RELEASE Command ......................................................................12-44INFO SPATH Command ............................................................................12-46INSTALL RELEASE Command ...............................................................12-47RESET ACQUIRE Command ...................................................................12-55RESET FALLBACK Command ................................................................12-56RESET LOCATION Command.................................................................12-57RESET SPATH Command .........................................................................12-58SET ACQUIRE Command ........................................................................12-59SET DISTRIBUTE Command...................................................................12-60SET FALLBACK Command .....................................................................12-61SET INSTALL Command..........................................................................12-62SET LOCATION Command......................................................................12-63SET SPATH Command ..............................................................................12-64SHOW Command.......................................................................................12-65VERIFY LOCATION Command...............................................................12-66

RMS Monitor Errors A

RMS Monitor EMS Events B

Syntax Summary C

Produce Errors D

Informational Messages .............................................................................D-1Warnings.....................................................................................................D-5Errors ..........................................................................................................D-6Serious Errors .............................................................................................D-9

Table of Contents

080203 Data Design Systems, Inc. vii

Figures

Figure 1-1 Sample Catalog Structure.........................................................1-1Figure 1-2 Sample Version Relationship....................................................1-5Figure 1-3 Example of Compile Relationships and References ................1-7Figure 1-4 Dependencies Derived From Figure 1-3 ..................................1-11Figure 1-5 Levels........................................................................................1-12Figure 1-6 Explicit Separate Compilation..................................................1-13Figure 1-7 Custom Separate Compilation..................................................1-14Figure 2-1 RMS Process Structure.............................................................2-1Figure 6-7 Creating a Bugfix Version at Different States..........................6-89Figure 9-1 RMS Access Control ................................................................9-3

Tables

Table 1-1 DATALIB Name Generation .....................................................1-35Table 1-2 DATALIB DATA-DESC Attributes...........................................1-36Table 3-1 Keyword Abbreviations - RMS Commands..............................3-2Table 3-2 Keyword Abbreviations - Environment Commands .................3-3Table 3-3 Command Summary ..................................................................3-3Table 4-1 Environment Command Summary ............................................4-1Table 4-2 Setprompt Meta Characters........................................................4-4Table 5-1 RMSMON Control Commands Summary.................................5-1Table 6-1 Component Commands Summary ............................................6-1Table 6-2 Supported Language Settings.....................................................6-7Table 6-3 Add Component Requirements..................................................6-9Table 6-4 Summary of Differences Between Extract Modes ....................6-36Table 6-5 Differences in C and C-ANSI Submit Processing. ....................6-81Table 6-6 Submit/Extract Source Macros. .................................................6-82Table 6-7 Language Dependent Embedded Pragmatic Expressions .........6-90Table 6-8 Embedded Pragmatic Expressions.............................................6-91Table 6-9 Auxiliary Attributes for Components ........................................6-93Table 7-1 State Commands Summary........................................................7-1Table 8-1 Release Commands Summary ...................................................8-2Table 8-2 Release Manifest Templates.......................................................8-4Table 8-3 Reserved Attributes for Releases ...............................................8-5Table 8-4 Auxiliary Attributes for Releases...............................................8-23Table 9-1 Security Commands Summary ..................................................9-2Table 9-2 Command Security Attribute Cross-Reference .........................9-4Table 10-1 Server Command Summary ....................................................10-1Table 11-1 Compile Commands Summary ................................................11-2Table 11-1 Adding a GROUP Compile Relationship ................................11-4Table 11-2 RMS Compile Macros and Variables.......................................11-10Table 11-3 Language Option Variables......................................................11-11Table 11-4 Rule Troubleshooting...............................................................11-29Table 11-5 Auxiliary Attributes for Components ......................................11-30Table 11-6 Security Mask Evaluation ........................................................11-34Table 12-1 Distribution and Acquisition Command Summary.................12-1Table 12-2 Auxiliary Attributes for Releases.............................................12-6

Table of Contents

viii 080203 Data Design Systems, Inc.

Table 12-3 Release Manifest File Names...................................................12-9Table 12-4 Acquiring From Another Monitor: Configuration ..................12-10Table 12-5 RMS Reserved Location Names..............................................12-15Table 12-6 Reserved Attributes for Locations ...........................................12-16Table 12-7 Special Sublocations Specified for Temp Locations ...............12-17Table 12-8 TACL variables available to distribution rules. .......................12-33Table 12-9 Auxiliary Attributes for Components ......................................12-35Table 12-10 TACL Variables Available to Fallback Rules ........................12-39Table 12-11 Comparison Between DISTRIBUTE and INSTALL ...........12-51Table 12-12 TACL Variables Available to Install Rules............................12-52Table 12-13 Auxiliary Attributes for Components ....................................12-54Table 12-14 SHOW Command Summary..................................................12-65

Table of Contents

080203 Data Design Systems, Inc. ix

Notes:

Table of Contents

x 080203 Data Design Systems, Inc.

0 Preface

Purpose and Scope

The Revision Management System (RMS) RMSCOM and RMSMON Reference Manualpresents the syntax for all user-interface commands supported by the RMSCOM process.

Organization

This manual is organized based on the broad command classes.

Section 1 is an introduction to RMS.

Section 2 describes starting RMSCOM and RMSMON.

Section 3 describes the format and purpose of RMSCOM commands.

Section 4 describes the commands for manipulating the command history buffer andredirecting RMSCOM input and output.

Section 5 describes the commands for controlling RMSMON.

Section 6 describes the commands for manipulating components.

Section 7 describes the commands for manipulating state markers.

Section 8 describes the commands for creating and controlling releases.

Section 9 describes the commands for controlling access to RMS entities.

Section 10 describes the commands for controlling server processes that RMSMON usesto perform lengthy commands, such as EXTRACT, SUBMIT, and PRODUCE.

Section 11 describes the commands for compiling object components from within RMS.

Section 12 describes the RMS release distribution and acquisition facilities.

Appendix A is a list of RMS error codes.

Appendix B is a list of RMS events.

Appendix C is a syntax summary of RMSCOM commands.

Appendix D is a list of PRODUCE errors.

PrefacePurpose and Scope

080203 Data Design Systems, Inc. xi

Who Should Read What

This manual is written for all RMS users.

Related Manuals and Products

Here is a list of RMS (Revision Management System) manuals:

The Introduction to the Revision Management System (RMS) (Part No. 80201) providesintroductory information on the capabilities of the RMS product. You should read thismanual first!

The Revision Management System (RMS) User’s Guide (Part No. 80207).

The Common User Interface (CUI) User’s Guide (Part No. 80000) guides first-time usersthrough the set of common environment-related commands.

The Revision Management System (RMS) Tutorial Guide (Part No. 80208) givesstep-by-step instructions on how to use RMS.

The Revision Management System (RMS) Utilities Reference Manual (Part No. 80206)describes the utility programs associated with RMS.

The Revision Management System (RMS) Installation Guide (Part No. 80202).

The Revision Management System (RMS) Programming Manual, Volumes 1 and 2 (PartNos. 80204 and 80205).

The Data Compression Facilities (PRESS) User’s Guide (Part No. 80501).

General Transfer/Mail Gateway Reference and Customization Guide (Part No. 84021B40).

The following are D30 versions of Tandem publications and are supplemental:

GUARDIAN Operating System User’s Guide

GUARDIAN Programmer’s Guide

GUARDIAN System Operations Guide

ENSCRIBE Programmer’s Guide

TACL Programming Guide

TACL Reference Manual

PrefaceWho Should Read What

xii 080203 Data Design Systems, Inc.

Pathway PATHCOM Reference Manual

Pathway System Management Guide

NonStop SQL/MP Reference Manual

NonStop SQL/MP Report Writer Guide

NonStop SQL Messages Manual

NonStop SQL Installation and Management Guide

NETBATCH Manual

TAL Programmer’s Guide.

You might also find these manuals helpful:

Programmatic Network Administrator (PNA) RDL Manual (Part No. 48818)

Programmatic Network Administrator (PNA) System Management Manual (Part No.48815).

PrefaceRelated Manuals and Products

080203 Data Design Systems, Inc. xiii

Notes:

PrefaceRelated Manuals and Products

xiv 080203 Data Design Systems, Inc.

Notation Conventions

The following list summarizes the conventions for syntax notation in this manual:

Syntax Conventions

Notation Meaning

UPPERCASELETTERS

Upper-case letters represent keywords and reserved words; you must enterthese items exactly as shown.

lowercase lettersLower-case italic letters represent variable items that you must supply.

Brackets [ ] Brackets enclose optional syntax items. A vertically-aligned group of itemsenclosed in brackets represents a list of selections from which you maychoose one or none.

Braces { } Braces enclose required syntax items. A vertically-aligned group of itemsenclosed in braces represents a list of selections from which you mustchoose only one.

Vertical Line(|) A vertical line separating items in a list enclosed in either braces or bracketsis an alternative to vertical alignment of the options (usually in short liststhat can be easily shown on one line).

Ellipsis ... An ellipsis immediately following a pair of brackets or braces indicates thatyou can repeat the enclosed syntax item any number of times.

Spaces If two items are separated by a space, that space is required between theitems. If one of the items is a punctuation symbol such as a parenthesis or acomma, spaces are optional.

Punctuation Parenthesis, commas, semicolons, and other symbols or punctuation notdescribed above must be entered precisely as shown. If any of thepunctuation above appears enclosed in quotation marks, that character is arequired character and you must enter it as shown.

& Continue to type the command as one line.

C40-ERxxxxx This is the change number, found in the left margin. It indicates that achange or addition has been made to both the software and the manual sincethe last edition.

This line indicates where the changed or new information ends.

All Returns are implicit.

080203 Data Design Systems, Inc. xv

Notes:

xvi 080203 Data Design Systems, Inc.

11 Introduction to RMS

This section provides a brief synopsis of some of the RMS concepts and facilities. Furtherintroductory material is available in the Introduction to the Revision Management System(RMS) manual.

The Catalog

All software components managed by RMS are maintained within the RMS catalog. It isorganized heirarchically by groups. Any group can contain components of most types,including other groups.

Figure 1-1 Sample Catalog Structure

Config-Data Server-1 Server-2Requestors

Factory-ControlPoint-of-SaleEDIAccounting

Externals APPL Releases

root (\)

Src-1 Src-2 Object

Introduction to RMSThe Catalog

080203 Data Design Systems, Inc. 1-1

Component Types

Every file or item managed by RMS is called a component. RMS supports the followingcomponent types:

Source components represent standard source-file-type items that are generally compiledinto object files. These components are EDIT-format files. Examples of these componentsare TAL, COBOL, and DDL source files.

Document components represent EDIT-format files which are not used for compilationpurposes.

Note! TFORM files which are run through the TFORM processor within RMS should be classed as sourcecomponents, not document components.

Object components represent standard code 100 files which are produced by the variousTandem compilers and binders.

C40-ER00126 Here is a list of all supported file types for the RMS type OBJECT:

File Code CISC RISC

100 Old-Style C-series Accelerated Objectsand D-series Objects

700 COFF ObjectsELF Objects

Data file components represent any ENSCRIBE format files.

Keyed components represent key-sequenced ENSCRIBE files.

Group components logically organize components of all types into convenient areas.

C40-ER00129 Note! RMS doesn’t allow you to delete various predefined groups. In addition to any prior restrictions on theroot "\" and \RELEASES components, the following groups can’t be deleted: \ORPHANS, \RULES,\LOCATIONS, \PROFILES, \EXTERNALS, \SERVERS, \STATES, \USERCHANGE.

There are a number of special group components which are described below:

TCLPROG Library components represent PATHWAY POBJ files. These componentscontain SCOBOL object components. The file attribute of such a component isrepresented by the base file name of the TCLPROG (POBJ), e.g.$DATA.PATHWAY.POBJ.

Introduction to RMSComponent Types

1-2 080203 Data Design Systems, Inc.

Source Library components represent Tandem-format copy libraries which areseparated by ?SECTION statements. These libraries are presented to compilers inalphabetical order by section. The first part of the library which does not appear in asection is named ".FILE-HEADER".

Subsystem Release, Subrelease, and Variant groups represent collections of softwarewhich can be distributed, acquired, or installed. These groups generally contain linksto components in other groups. The \RELEASES group contains all releases.

The \EXTERNALS group contains groups and components representing items whichRMS will consider as references and dependencies of normal components but whichwill not otherwise be managed.

DDLDICT Group components represent a DDL dictionary and must be type GROUP,with a LANGUAGE attribute of DDLDICT and a FILE attribute pointing to asubvolume.

PNALIB Group components represent a PNA library, must be of type GROUP, with aLANGUAGE attribute of PNALIB and must have a physical file name. PNA objectcomponents added to a PNALIB must be of type OBJECT with a LANGUAGEattribute of PNA.

Special Components

C40-ER00050 RMSCOM supports the .MESSAGE component. This component (typically an EXTERNALSOURCE component) specifies a file which will be copied to the current RMSCOM OUTfile, when using the OPEN or GROUP commands. In other words, it displays the contents ofthe file when you run RMSCOM and use OPEN or GROUP. It also documents the catalog andhow pieces of that catalog are to be used.

The OPEN command will cause the file associated with the \.MESSAGE component tobe copied.

The GROUP command will cause the .MESSAGE component inside the specified groupto be reported. If no .MESSAGE component exists, no report is made.

This enhancement is motivated by an effort to try and help users new to a catalog understandits contents by being self-documenting. For more information, refer to OPEN (5-8) andGROUP (6-38).

Introduction to RMSSpecial Components


Version Number in RMS

An RMS version number consists of 4 parts: e.g. 1.2.0.4.

In this case, 1 is the major version level, 2 is the second minor change under major versionlevel 1, 0 is the variant branch version (this is currently reserved for future use) and 4 is the4th bugfix version under version 1.2.

Usage of the Version Numbers

If a version number is to be assigned for a new version, only the first two parts should beused.

Never assign a version with a non-zero third part. This is meant for a variant or branchwhich is not currently supported.

It is not recommended to use the bugfix number in the Latest state.

RMS has two distinct methods of version numbering. Each method is used by a specific classof component type:

Numbered versions apply to normal source, document, keyed, and release-manifestcomponents. These numbers are as follows: 1.0; 3.4; 2.2.0.3. A complete discussion ofversion numbers is given in the Introduction to the Revision Management System (RMS).

Datestamp versions apply to all external components, data files, and object files. Youshould always remember that the version of an object corresponds to the time at which itwas compiled. Do not depend on the ordering of versions by datestamp numbers tocorrelate with source version numbers.

C40-PR0098 Note! RMS release distribution, object recompilation, acquisition and installation functions preserve themodification timestamp of the object, based on the object’s version time. Remember that the object’sversion number is a date and timestamp format version and corresponds to the object’s bind time.

Warning! The object’s version time is based on universal time (Z) also known as GMT. Modification times onacquiring systems are corrected to the appropriate local time relative to the version time. The versiontime will be consistent regardless of where the object is distributed or acquired.

Bugfix or sequence numbers are provided in the event that a version of a component needs tobe modified when there are existing "later" versions. Bugfix versions are always created whenyou submit a new version of a component which is not to become the LATEST version.

Introduction to RMSVersion Number in RMS


Figure 1-2 Sample Version Relationship

You should be aware that post-development changes (bugfix versions) are not automaticallyincluded in higher level versions. Where appropriate, you must explicitly merge the changesinto higher versions (e.g. LATEST) either using the RMSMERGE facility or manually withthe assistance of the DIFFERENCES command.

Please also be aware that submitting a bugfix version causes the BUGFIX component flagattribute to be raised.

References

RMS automatically determines the interrelationships between source components at SUBMITtime. Various statements such as ?SOURCE, COPY, #include, ?SEARCH, etc., are processedby RMS and recorded as references. You can query these references using the LISTREFERENCE command.

References are also used to determine the object components which are used by a MAINobject component in the creation of an executable program object file. You must initiallyspecify these relationships using the ADD REFERENCE command.

LATEST

DEVEL

TEST

1.0

1.0.0.1 1.0.0.2 1.0.0.3

1.2.0.1 1.2.0.2

1.1

1.2

2.0

PROD

Introduction to RMSReferences


Rules and Rule Naming

RMS keeps track of compilation instructions using rules. Rules are commands which arepassed to TACL to perform various tasks. Rules are structured as follows:

Step 0:== First job step of a compile... Step 1:== Second job step of a compile...etc.

You are permitted 64 job steps each containing approximately 10,000 bytes of information.RMS checks the TACL completion code at the end of each step in order to detect processingfailures. There are special TACL MACROS provided by RMS which manipulate completioncodes if necessary.

For standard compiles, RMS uses rules inherited by the source component. There are anumber of special rules that do not follow this convention:

DISTRIBUTE

This rule is executed by RMS on a release library immediately before the release is to beplaced on the distribution medium. The DISTRIBUTE rule contains a TACL macroallowing manipulations to be performed on the release library, such as acceleration ofobjects.

POST-DISTRIBUTE

This rule is executed by RMS on a release library after it has been placed in its finalexecution location. The POST-DISTRIBUTE rule could be used to start up the pathwayagain, and proceed with processing.

PRE-INSTALL

This rule is executed by RMS on a release library before it has been placed in its finalexecution location. The PRE-INSTALL rule could be used to shut down a pathway andmake a backup copy of the current executing environment.

INSTALL

This rule is executed by RMS on a release library after it has been placed in its finalexecution location. The INSTALL rule could be used to start up the pathway again, andproceed with processing.

FALLBACK

This rule is executed by RMS on an installation/distribution location when a FALLBACKcommand is processed. This rule must be present and return a completion code of zero forFALLBACK to proceed.

Introduction to RMSRules and Rule Naming


Compilation Relationships

RMS allows any type of component to be created using any other type of component, as longas a processor is available to perform the necessary compilation. To establish a compilerelationship you must specify a principal source component (not necessarily of type source)and a target object component (not necessarily of type object). A rule can also be specified todirect the compilation. Rules are discussed later. You use the ADD COMPILE command toestablish such relationships. You must create a compile relationship to every object you wishto produce.

A principal source component is the file which you would normally pass to a compiler. Aprincipal source component can compile to different object components using different rules.In contrast, a given object component can only be produced from one principal source.

Figure 1-3 Example of Compile Relationships and References

TALRULE

StandardTALRule

CustomTAL-1Rule

LIBOBJ

LIBSRC

Compiles to

Compiles to

Compiles to

References

References

References

References

TALSRC OBJ1SRCLIB

procliba

RTNLIB

OBJ2

proclibb

Introduction to RMSCompilation Relationships


SQL Compilation Within RMS

Aside from the actual program sources and objects needed for SQL compilation within RMS,there are two pieces of information that are essential to the whole process:

the SQL catalog which defines the database schema

the SQL Table and View defines that are used within the program.

The client’s overall configuration will have many SQL catalogs. The principal catalog is thedefinitive development catalog that is used for compilation. This catalog must be maintainedin an upwardly-compatible manner to all production catalogs. All RMS compilation will beperformed against the definitive catalog. The RMS compilation rule for SQL requiresknowledge of this catalog.

All tables and views should be specified within program source using Guardian DEFINEs.The use of DEFINEs enables programs to be moved from one environment to another withouta program source change and full recompile. These defines must also be specified to the RMScompilation rule.

Recognizing the practical aspects of managing changing SQL environments, it is notrecommended to hard-code catalog or table defines in RMS compilation rules. Rather, thisinformation should be placed in the RMSLBASE file1. The following is an example of entriesin RMSLBASE:

?SECTION Catalog TEXT$DATA.SQLCAT?SECTION LoadDefines MACROSET DEFINE CLASS MAPADD DEFINE =TABLE1, FILE $DATA.TABLES.TABLE1ADD DEFINE =TABLE2, FILE $DATA.TABLES.TABLE2ADD DEFINE =VIEW1, FILE $DATA.TABLES.VIEW1

The above example defines two TACL items:

the catalog variable containing the name of the subvolume corresponding to the SQLcatalog

the LoadDefines macro containing commands that are executed to define the macros tothe RMS compilation rule.

1The RMSLBASE file should be placed in the same subvolume as the RMSSTART andRMSMAKE files. RMSMAKE and the PRODUCE command automatically loadRMSLBASE if it is present. RMSLBASE is loaded after the RMSBASE file and maysupersede definitions in RMSBASE.

Introduction to RMSSQL Compilation Within RMS


The following example illustrates the changes that are needed to the SQLCOBOL rule tosupport the execution of the above TACL macros. You should use the EDIT RULE commandto make these changes. All changed items are highlighted in bold.

ADD RULE SQLCOBOL,LANGUAGE COBOL,STEP 0== Remember that an SQL catalog is required.:RMS:SQL^Catalog &

may be empty.#PUSH TempName1 TempName2 MyCatalog#SET TempName1 [:rms:TempName]#SET TempName2 [:rms:TempName]== The following statement should be customized.#SET MyCatalog [Catalog]LoadDefines//ADD RULE SQLCOBOL,FILE $SYSTEM.SYSTEM.SQLCOBOL,STEP 1[:rms:processor]/IN [:RMS:source],OUT [:RMS:list^loc SQLPRE]/ &

[TempName1], [TempName2]== Preprocessor can generate warnings which should be == ignored.[:RMS:ignore^warnings]//ADD RULE SQLCOBOL,FILE $SYSTEM.SYSTEM.COBOL85,STEP 2[:rms:processor]/IN [TempName1],OUT [:RMS:list^loc SQLCOB]/&

[:RMS:Object];[RMS:Cobol^Options]PURGE [TempName1] [TempName2]//

Note! Before attempting to make any of these changes, please ensure that you have a thoroughunderstanding of Guardian DEFINEs and their relationships to SQL and Guardian processmanagement. Information on Guardian DEFINEs can be obtained from the Guardian OperatingSystems Programming Guide. DEFINEs are discussed throughout the SQL programmingdocumentation. The SQL Installation and Management Guide is also required reading.



Additional Notes

Some users have requested that the SQL macro definitions not be loaded from RMSLBASEevery time any PRODUCE is done. This can be accomplished using a redirection macro thatperforms the same basic task as the above examples:

In RMSLBASE:

?SECTION LoadDefines MACRO== This macro loads and executes definitions from the== MYDEFS file in the RMS object subvolume.[#IF NOT [#VARIABLEINFO/EXISTENCE/ :mydefs] |THEN|

LOAD /KEEP 1/ [:rms:rms_].MYDEFS]:mydefs:loadsql

The LoadDefines macro in RMSLBASE should be moved to the MYDEFS file and renamedto :mydefs:loadsql. The new LoadDefines macro will ensure that the macro is executed onlyonce per PRODUCE command and will not be loaded if SQL is not used.

Note! No rule change is required to instrument RMS with this variation.

The :mydefs:loadsql MACRO in the MYDEFS file accomplishes two things:

The variable :mydefs is automatically created when MYDEFS is loaded. This preventsMYDEFS from being loaded a second time in the compile session.

Contains all Guardian DEFINEs needed to compile SQL object files.



Dependencies

During component compilation, RMS translates component references, compile ruleinformation, and compile relationship information into dependencies. Dependencies relate oneversion of a compiled component to the versions of components which were used in thecompilation. Figure 1-4 shows the transition between the references in Figure 1-3 todependencies:

Figure 1-4 Dependencies Derived From Figure 1-3

Separate Compilation

RMS supports the concept of separate program compilation. Separate compilation facilitiesallow development personnel to create distinct, reusable source and object modules which canbe separately tested and later bound into multiple executable program objects. RMS providesa default BIND rule which works for programs which have relatively simple BINDERinstructions (e.g. SELECT SEARCH with a single ADD CODE for the main module).Developers can either use this rule or develop their own, based on information provided bythe PRODUCE command.

Note! You should not attempt to create your own separate compilation rules unless you are experienced withboth BINDER and TACL. See the appropriate reference manuals for details.

LIBSRCDepends on

Depends on

Depends on

LIBOBJ

TALSRC

OBJ2

OBJ1SRCLIB

RTNLIB

procliba

proclibb

Introduction to RMSDependencies


To use the default separate compilation BIND rule, you must set up references from the"MAIN" object component to all object components to be searched. RMS automaticallypropogates such references to newly created object versions. Once the references areestablished, create a compile relationship (see ADD COMPILE 6-3) from the "MAIN" objectcomponent to the executable object component.

There are two basic methods for handling separate compilation: explicit and custom. It is notoften easy to choose between the various methods of managing compilation. The choice isgenerally made based on the type of business and the frequency and type of change to theapplication. This section outlines the major differences between the types of separatecompilation and how to choose between the methods.

Figure 1-5 Levels

Levels refer to the number of separate compile steps needed to get from the lowest source tothe highest object in a separate compilation situation.

Topology Refers to the structure of the interrelationships betweenapplication software components.

Level 3

Level 2

Level 1

Source

Object

Source

Executable

Object Object

Source Source

Introduction to RMSSeparate Compilation


Explicit Separate Compilation.

This compilation method is, by far, the most straightforward of all separate compilationmethods. Very little action is required by programmers and managers to maintain it. RMSautomatically determines the relationships between sources and objects by parsing sourcecode at submit time. The ?SEARCH, #pragma search, and FILE IS statements in the varioussupported languages cause RMS to build the appropriate relationships.

Figure 1-6 Explicit Separate Compilation

The one drawback to this method is that it is neither space nor time efficient. Space efficiencyis reduced because objects become incrementally larger as each compile occurs, until the finalexecutable object is created. Time efficiency is also reduced because low-level source changeswill trigger recompilation of source at higher levels.

Both space and time efficiency depend on the number of levels involved in the separatecompilation. If there are only two levels in the application, this method is, by far, the mosteffective in terms of the trade-off between manageability and efficiency.

Source Executable

Source Object

Source Object

Source Object

Source Object



Custom Separate Compilation.

Very little action is required by programmers and managers to maintain this method, on anongoing basis. RMS automatically determines the relationships between objects by parsingBINDER source code. Examples of the key statements are: SELECT SEARCH and ADDCODE. The ?SEARCH, #pragma search, and FILE IS statements in the various supportedlanguages also cause RMS to build the appropriate relationships.

Figure 1-7 Custom Separate Compilation

This method requires programmers to explicitly specify the list of objects that are needed tobind the object together in a bind file. The bind file not only provides BINDER directives thatcan control the resulting object file but also documents, in one place, the objects that arerequired. Problem resolution with regard to references is generally a single point issue oflocating the bind file and adding or deleting object files.

The one drawback to this method is that it is does require an explicit bind file. It is, however,the most efficient method in terms of time. The RMSMAKE processor has much less work todo to establish a compile environment. It is marginally less efficient because a bind filecomponent must be maintained within RMS. Fewer pages of physical memory are required byRMSMAKE, however, to support this method. This method is slightly less manageable thanthe explicit method as it requires the introduction and maintenance of a bind file.

This method is, by far, the most favoured method for medium to large applications. Customseparate compilation offers more flexibility and control than any other method and hasbecome, since its introduction, the preferred method of handling the intricacies of separatecompilation.

Source Object

Object

Source Object

Source Object

Source

Source Object

Source Object



Multinode External Compilation Set-up

RMS can be set up to perform optimization of external compiles when running in amulti-Expand node environment with a central RMS monitor. In such environments, workingsource, objects, and compilers are automatically copied across Expand when needed by acompilation rule. These files are cached on the remote node until replaced by a subsequentcompile or manually purged. If the correct version of a file is already present on the remotenode, it is not copied. To enable this feature, the following items must be set up within theRMS catalog:

1. The location RMS-TEMP\node-name must be added to the catalog. This location refers tothe subvolume on the remote node \node-name that will be using RMSMAKE. Allworking components will be automatically extracted to this subvolume.

If the RMS catalog is in node \SYSA and the external compile is to be done on \SYSB, a newlocation RMS-TEMP\SYSB must be added to the catalog. If RMS cannot find theappropriate location for a specific node, it will use the RMS-TEMP location as the default.

2. The location RMS-TEMP-TOOLS\node-name must be added to the catalog. This locationrefers to the subvolume on the remote node \node-name where compilers and processors,and any associated utilities, will be copied.

3. Appropriate security entries must be created to allow remote access to any componentsneeded during compilation.

The following is a sample RMSCOM script for setting up the compilation environment:

RMS 1) OPEN \src.$RMPRMS 2) ADD LOCATION RMS-TEMP\remote,TARGET \remote.$work.subvolRMS 3) ADD LOCATION RMS-TEMP-TOOLS\remote,TARGET &

\remote.$work.compilerRMS 4) SECURE \appl\src:*, user \*.devel.* + readRMS 5) SECURE \appl\obj:*, user \*.devel.* + (read,modify)

For more information, please refer to RMS-TEMP (12-15) in the ADD LOCATIONcommand.

Introduction to RMSMultinode External Compilation Set-up


Using INSPECT With RMS

The Tandem INSPECT and Data Design Systems’ RMS products can work together toeffectively assist in the support and debugging of application programs. The followingconsiderations for the use of the two products must be given:

INSPECT uses the object file BINDER and SYMBOLS regions to determine the nameand last modification timestamp of source files used to create a given object. The sourcefile name corresponds to the file name that RMS presents to compilers during theexecution of an RMS rule.

RMS presents the same last modification timestamp to the compiler (during compilation)and to the user (following an extract). Users can be reasonably certain of debugging thecorrect version of a source file if INSPECT does not complain about the modificationtime of the file.

To deal with the difference between the source file name in the INSPECT BINDERregion and the file where the user extracts the source component to disk, use theINSPECT ADD SOURCE ASSIGN command.

Setting up RMS for Use With INSPECT

1. Set up a location called "RMS-TEMP" to refer to the disk subvolume where RMS willperform all compilation. All temporary source files used during compilation will beextracted to this subvolume. For example:

ADD LOCATION RMS-TEMP,TARGET $DATA.RMSWORK

2. Use a standard set of subvolumes (possibly organized on a project, user or group basis) forextracting components. Users can be encouraged to use these standard subvolumesthrough the definition of user-specific aliases in RMSCSTM or global aliases inRMSLOCL. For example, add the following entries to RMSLOCL:

ALIAS get "EXTRACT %1% TO $WORK.NEW.*,FOR EDIT"ALIAS put "SUBMIT $WORK.NEW.* TO %1%,PURGE"

3. Create or modify the file INSPCSTM in the user’s default subvolume to contain thefollowing statement:

ADD SOURCE ASSIGN $DATA.RMSWORK, $WORK.NEW

With this infrastructure in place, developers will find it easier to use INSPECT with RMS.Files will be in known subvolumes for users, RMS, and INSPECT.

Note! If, after testing is complete and no changes have been made to the file extracted for use withINSPECT, the lock on the source file must be removed manually. See UNLOCK (6-97) for more details.

Introduction to RMSUsing INSPECT With RMS


Archive Management

RMS uses an archive area to store versions of objects and data files. You define an archive byadding an RMS location whose name must begin with "ARCHIVE" and a target subvolumewhere archive files are to be stored. The first alphabetically-ordered archive location name is"active" (where new files are stored). The Archive location must exist for an acquiring RMSCatalog if object or data components are present in the release. Otherwise, the ACQUIRERELEASE command will fail with an error 2012 DRMS-ERR-CANNOT-SUBMIT. Thesubvolume associated with the archive location should be backed up with the RMS catalog.

When an object is produced, it will be stored in the archive automatically. If the PRODUCEoption COMPRESS ON was used with the produce, the object will be stored in thecompressed form. Submitted objects and data files are not compressed automatically. You canrun the CPRESS program (which is the same program as RMSPRESS server) interactivelyagainst the archive subvolume to compress all archive files there. All compressed files willhave a file code of 2199. Make certain the SOURCEDATE option is specified on the CPRESScommand line if that program is used.

An archive file name always starts with "A" followed by a 7 digit number. You can runRMSIDENT against the archive file to query the originating version and component from theRMS monitor. However, if the archive file was compressed, RMSIDENT will not work untilit is expanded.

It is recommended that you clean up the archived objects and data files periodically by doing aDELETE VERSIONS, ARCHIVE, KEEP LATEST. If the disk on which the Archive residesis full, you can add a new Archive location pointing to another disk. However, the newArchive location name must alphabetically precede all existing Archives, in order for RMS tostore new archive files there.

C40-ER00065 Note! The archive handler deals with conflicting file names in RMS archives. RMS automatically bypassespreviously-existing names in archive subvolumes. This deals with situations where two RMS catalogsshare the same archive.

Archive Management

The RMS archive manager permits archives to be grouped by class (SUBMIT or PRODUCE)and by catalog group. These archive definitions are similar to the ARCHIVE component, inthat they must be specified as subvolumes. However, they can be placed as locationsanywhere in the catalog and are inherited to subgroups.

The \LOCATIONS\ARCHIVE* locations are still in effect as defaults where no .ARCHIVE*locations applies.

Introduction to RMSArchive Management


Releases

RMS allows developers and library managers to package software using releases. A releaseconsists of an arbitrary set of components. A release can be in one of three stages:

CREATED or OPEN

In this stage, components can be added to or deleted from a release. To accomplish this,use the LINK COMPONENT or UNLINK COMPONENT command. Once you arefinished specifying your release, freeze its contents using the FREEZE RELEASEcommand.

CONTENTS FROZEN

In this stage, developers can continue to work on a release, without being able to add newcomponents or remove old ones. New versions of components are still able to be includedin the release. To lock a release, freeze the versions associated with the release with theFREEZE RELEASE, VERSIONS command.

DISTRIBUTION

In this stage, a release can be installed or distributed. Development can still proceed oncomponents which happen to be in the release; however, the release itself is independentof such changes.

Each release has an associated state. These states correspond to those available to components.RMS uses the state of a release (e.g. PROD) to determine the appropriate versions ofcomponents to be included in the release. RMS will only include versions of componentswhich are at a state equal to the release state.

Introduction to RMSReleases


Post-Development Changes (Bugfixes)

Occasionally, there will be urgent situations in which a change needs to be made to code thatis currently executing in the PRODUCTION environment. It is not always advisable to makethis change to the current LATEST version as it may be currently undergoing development byanother user and it is not ready to be implemented into production. Changing the previousversion of the component in question will not accomplish what is needed either, as by doingso, an incompatibility would be introduced between the previous and the LATEST versions.

Therefore a post-development change (bugfix) is necessary to make the change to the codewithout impacting the development of the LATEST version. The changes in the bugfix versionmay need to be incorporated into the later versions of the component.

The post-development change mechanism allows problems to be corrected in versions of thecode other than the LATEST state. This is specifically designed to allow old versions ofcomponents to be corrected.

RMS provides a special mechanism, the BUGFIX flag, to alarm users of the existence of abugfix version on a component. The flag will trigger a warning message whenever a newversion is being SUBMITed, EXTRACTed , or PROMOTEd. This enables the user toexamine the contents of the bugfix version and determine if it is necessary to incorporate thefixes into the later versions of the component using the RMSMERGE utility.

In view of the above special considerations for post-development changes, any changes to theLATEST version of a component is automatically streamed into a normal version. RMS willalso prohibit the explicit creation of a bugfix branch off the LATEST version of a component.

Example

If version 2.4 is both the PROD and LATEST version for component A, any of the two RMScommands below will automatically generate a new version 2.5 for component A:

SUBMIT * AS PROD TO ASUBMIT * AS LATEST TO A

However, the following RMS command will fail:

SUBMIT * AS 2.4.0.1 TO A

Note! After working on the bugfix version at a LATEST version 2.4.0.1, you may want to create anothermainline version 2.5. In this case, the mainline version 2.4 should be locked when 2.5 is beingsubmitted, since the proper chronological version progression is from 2.4 to 2.5.

If the version to which you need to apply a bugfix is at multiple states (for example, version 2.4 is atDEVEL, TEST and PROD), then you have to apply the bugfix to the lowest state (DEVEL) and promoteit appropriately.

Introduction to RMSPost-Development Changes (Bugfixes)


SCOBOL TCLPROG Groups

RMS supports the compilation of object components which are SCOBOL run-units. All suchcomponents must be placed in at least one TCLPROG group component. The following rulesapply to TCLPROGs:

SCOBOL source components are handled in the same manner as all other standard sourcecomponents.

SCOBOL object components added to a TCLPROG group must have a language of"SCOBOL", must be of type OBJECT, and must not have a physical file name. Theymust exist as children of a TCLPROG group component.

TCLPROG group components must have a language of "TCLPROG", must be of typeGROUP, and must have a physical file name. The physical file name corresponds to aPOBJ file name. The file name must be in a form that can be passed to SCOBOL. The fileportion of this filename must not exceed five characters. For example, if the managedfile is $DATA.A.POBJ1, the actual files managed by RMS are $DATA.A.POBJ1COD,$DATA.A.POBJ1DIR and $DATA.A.POBJ1SYM. These files can’t be stored in theARCHIVE location.

A SCOBOL object component can appear in any number of TCLPROG componentsthrough the use of the LINK COMPONENT command.

A SCOBOL object component is always compiled into its "principal" TCLPROG (i.e. theone appearing in its path name), regardless of where the object component is linked.

You may compile a TCLPROG group in its entirety. All SCOBOL units are first compiledinto their "principal" TCLPROG. Any SCOBOL units for which the principal TCLPROGis not the TCLPROG being produced are copied into the latter TCLPROG aftercompilation.

TCLPROG groups can only contain SCOBOL object components. This restriction maynot be enforced but must be rigidly followed.

Generally, a SCOBOL object is compiled from source, but RMS also supports submissionof externally-compiled SCOBOL objects. The SCOBOL object must be an existingcomponent underneath a vaild TCLPROG, and its name must match the name of theobject as it existed in the TCLPROG to be submitted. Please refer to SUBMIT (6-74) formore information.

Management Considerations

SCOBOL run units are not automatically archived by RMS. They are recreated as needed.

The DELETE VERSION command does not delete physical versions of SCOBOL rununits in the TCLPROG group because run units can be linked into many TCLPROGgroups. You are responsible for cleaning up TCLPROG groups.

Introduction to RMSSCOBOL TCLPROG Groups


If left unattended, TCLPROG group files can become full. To avoid this situation youshould use a combination of the following procedures:

remove any unnecessary versions

compress the TCLPROG files using SCUP

change the extent allocations associated with the TCLPROG files using FUP or theXPRESS utility available from Data Design Systems.

PNA Rule Database Groups

RMS supports the compilation of object components which are Programmatic NetworkAdministrator (PNA) rules. All such components must be placed in at least one PNA librarygroup component.

The following rules apply to PNA libraries:

PNA rule source components are handled in the same manner as all other standard sourcecomponents.

PNA object components added to a PNALIB must have a language of "PNA", must be oftype OBJECT, and must not have a physical file name. They must exist as children of aPNA library group component.

PNA library group components must have a language of "PNALIB", must be of typeGROUP, and must have a physical file name. The physical file name corresponds to aRULES file name. The file name must be in a form that can be passed to PNA; that is thefile portion of the filename must not exceed five characters. For example, if the managedfile is $DATA.PNA.RULE1, the physical files used by RMS will be$DATA.PNA.RULE1COD, $DATA.PNA.RULE1RUL, $DATA.PNA.RULE1DI0 and$DATA.PNA.RULEDIR. These files will not be stored in the ARCHIVE location.

A PNA object component can appear in any number of PNA library components using theLINK COMPONENT command.

A PNA object component is always compiled into its "principal" PNALIB (i.e. the oneappearing in its path name), regardless of where the object component is linked.

You may compile a PNA library component in its entirety. All PNA rules are firstcompiled into their "principal" PNA library. Any PNA rules for which the principal PNAlibrary is not the PNA library being produced are copied nto the latter PNALIB aftercompilation.

Introduction to RMSPNA Rule Database Groups


PNA library groups can only contain PNA rule object components. This restriction maynot be enforced but must be rigidly followed.

If you will be distributing or installing PNA rule objects, you must not change therelationships between rule numbers and the corresponding events that can be handled. Ifyou do so, you may not be able to successfully rollout rule objects. This is due tolimitations of the PNA rule database in the C20 release of the Programmatic NetworkAdministrator. Future releases of PNA and RMS may correct this limitation.

For more information about Tandem’s Programmatic Network Administrator consult theProgrammatic Network Administrator (PNA) RDL Manual and the Programmatic NetworkAdministrator (PNA) System Management Manual (available from Tandem Computers Inc.)

Management Considerations

PNA rules are not automatically archived by RMS. They are recreated as needed.

The DELETE VERSION command does not delete physical versions of PNA Rules unitsin the PNA rule database because run units can be linked into many PNA databasegroups. You are responsible for cleaning up PNA databases.

If left unattended, PNA database files can become full. To avoid this situation you shoulduse a combination of the following procedures:

remove any unnecessary versions

compress the PNA database files using RMUP

change the extent allocations associated with the PNA databases files using FUP orthe XPRESS utility available from Data Design Systems.

Introduction to RMSPNA Rule Database Groups


DDLDICT Group Component

A DDLDICT component represents a DDL dictionary. These components must be typeGROUP with a LANGUAGE attribute of DDLDICT and a FILE attribute pointing to asubvolume.

Underneath a DDLDICT group component are child components representing files in thedictionary that the user wants to manage.

Note! You must add child components under the DDLDICT group before doing a submit.

The component TYPE should be DATA for all dictionary files (all files starting with "DICT").

Typically, it should include all the files starting with DICT. Other files can be any copylib orheader file outputs for different languages such as TAL, C or COBOL. The names of the childcomponents must match the actual filenames of the dictionary to be managed, e.g., DICTALT,DICTCDF, TALCOPY, etc.

Note! The children components of a DDLDICT component should not use the same subvolume to store itsmanaged file. For instance, if the DDLDICT group has a file attribute of $DATA.DICT, then its childDICTALT should not have a file name of $DATA.DICT.DICTALT. The $DATA.DICT subvolume is used asa working area to where a version of the child components is extracted if required by ENFORMcompiles.

ENFORM programs that reference a DICTIONARY will reference the subvolume of aDDLDICT component.

To submit a DDL dictionary to RMS:

SUBMIT dictionary $ vol.subvol TO ddldict -group-name

Note! Don’t use SUBMIT $ vol.subvol .* TO ddldict- group-name \* to submitdictionaries to DDLDICT components. This will not create a proper version for the Dictionary.

When a DDLDICT component is deleted, RMS will attempt to delete any files residing on the managedsubvolume where the user has the required purge security.

C40-ER00106 Note! When submitting DDLDICT groups, the RMSUBMIT processor adds dependencies to child componentsusing the CHILD dependency kind. Prior releases used SOURCE dependency kind for this function.

Introduction to RMSDDLDICT Group Component


DDL Compile

You must meet these requirements to do a successful DDL compile within RMS:

DDL source must be type SOURCE.

Generated SRCLIBs from a DDL compile must have .ADD-DEPENDENCIES attributes,or the members will not be promoted automatically when the DDLDICT group ispromoted.

Some items to note regarding DDL compiles:

PCRs associated with the DDL source are not passed (linked) to the versions of generatedoutputs.

Both compiled and submitted DDLDICT groups will create child dependencies to thedictionary files and generated copy libraries. All DDLDICT group components have theimplied .ADD-DEPENDENCIES attribute.

Compiled DDLDICT groups are not promotable and must be compiled at the proper state.

Generated sources and SRCLIBS can only be submitted as Latest and then promoted tothe appropriate states, which means no 4-part bugfix version number will be created; thestate of versions are forced to be in sync with the state of the parent. Please refer to thebugfix section of SRCLIB Group lock.

Caution! Don’t work with the Latest state since it may not point to the version you intend to work with.

Produce will fail if any of the children under the DDLDICT group can’t be submitted.

For Submitted DDLs

Bugfixes can be submitted at a state.

The version number of a component is not significant in determining the sequence ofversions. The state marker of the version is the determinant.

All new versions are created based on the latest (or last) version created.

Introduction to RMSDDLDICT Group Component


Example:

Suppose version 1.0 is at PROD and version 2.0 is at LATEST, DEVEL and TEST. In usualprocessing a bugfix version (1.0.0.1) would have to be based on version 1.0. However, whenusing child dependencies, the bugfix version will be based on version 2.0 and will be createdas version 2.1 This version 2.1 will then be promoted (automatically if possible) to the properstate to reflect the bugfix. This means that version 2.1 will be created at LATEST and thenpromoted directly to PROD. Version 2.0 will remain at DEVEL and TEST.

Before Intended Result

1.0 PROD 1.0 1.0 1.0.0.1 PROD

2.0 LATEST,DEVEL,TEST 2.0 LATEST,DEVEL,TEST 2.0 TEST,DEVEL2.1 LATEST,PROD

See DDLDICT Promotion in this section.

Caution! All new versions submitted will be at the Latest state. With bugfix submits, the version will be promotedto the required state, with the resulting version (both group and children) occupying Latest and theintended state. Don’t work with the Latest state for versions with child dependencies.

Note! After the initial submit, the DDLDICT group should always be locked at the DDLDICT group level,instead of locking the components beneath it.

Considerations

A new DDL compile rule must be added. You must create the DDL compiler component (andsubmit it if the component is not type external) in the catalog.

DDLDICT Promotion

Promoting Components With Child Dependencies

Any versions of DDLDICT group components can be promoted into any state regardlessof the progression sequence of the states. This means that the state markers are just like asticker associated with the version. The promote sequence, such as

LATEST -> DEVEL -> TEST -> PROD ... -> OBSOLETE

is irrelevant.

PROMOTE will only be at the group level and all dependent child versions will bepromoted automatically.

Introduction to RMSDDLDICT Promotion


DEMOTE will not be irrelevant in this scenario, except when removing the state markersassociated with the components. DEMOTE must be done on each individual membercomponent and also at the group component level.

SQL DDL Change Management

If an SQL table has been altered by column number or column size, programs referencing thetable may need to be recompiled as well as SQLCOMPed.

The following provides a proposed method of handling this change inside RMS with built-independencies. That is, a change in table layout will automatically cause a recompilation ofaffected programs.

The Database Administrator (DBA) of the application should put all the SQLDDL andINVOKE statements of the application database in a SQLDDL component. This component iscreated as a source library but without any subcomponents, (i.e. no sections are added as childcomponents). The file itself should contain the DDL statements in separate sections. EachINVOKE statement is also contained in its own section. The INVOKE statement then can besourced in by the appropriate programs.

Note! Don’t create any invoke statements on your own. When there is a change on the table, theprograms that are referencing this component will be forced to be recompiled and SQLCOMPedautomatically.

This way, the changes on the application database will be versioned and can be tracked withthe different states, as it can be promoted after it has been fully tested. The DDL statementscan also be put into the pre-install rule for conversion, and even distributed as part of thedocumentation package for the SQL database.

Segmented Source Libraries

RMS supports the management of source components which are divided into distinct sections.Typically, DDL produced libraries and PATHMAKER requestor and server copy libraries aremanaged as segmented source libraries. The current release of RMS only allows sections toappear in one source library.

Segmented Source Libraries operate in one of two modes: generated and non-generated.

Generated Typically used in conjunction with code generators such as DDL.These generators create copy libraries with many sections.Logically associated with these generated copy libraries are theirpre-image source files (also known as processor-input files).Changes to these source files are reflected as changes to the copylibraries through a compilation of the source files by the codegenerator. In this case, RMS automatically determines thesections that have been added, changed, and deleted in thegenerated copy library when the library is submitted. No lockingprotocol is required for this use of segmented source libraries.

Introduction to RMSSQL DDL Change Management


Non-generated Takes advantage of the management of each section of asegmented source library as an individual component (subject toall considerations normally given to RMS source components).These source libraries are typically used to manage source codefragment libraries such as TACL macro libraries. Each sectioncan be extracted and submitted independently of any othersection in the library. Locks are in effect for this type ofcomponent.

There is a certain amount of exclusivity between the two methods, and they should not bemixed. If a section of a segmented source library is locked, whether through the EXTRACTFOR EDIT or LOCK commands, submission of a generated copy library to the groupcomponent representing the segmented library is prohibited. If the lock is released through aSUBMIT or UNLOCK command, such submissions are once again permitted. Note thatchanges made to individual sections will be replaced when the entire library is submitted. TheROLLOUT command may be useful in recovering such changes as the version history of theaffected section is preserved. Locking the group component through EXTRACT FOR EDITor LOCK commands has no effect whatsoever on RMS submission processing of segmentedlibraries. EXTRACT FORMAT EDIT is the preferred method of examining, and if necessary,updating segmented libraries as a whole.

Warning! This practice should be restricted by procedural means as there is risk of desynchronization asdescribed above.

The following rules apply to segmented source libraries:

Segmented source group components must have a language of "SRCLIB", must be oftype GROUP, and must have a physical file name. The physical file name corresponds toa file where the versions of all sections will be held.

Sections of the library appear as separate components within the source group. Thesecomponents must be of type SOURCE, and must not have a physical file name.

The entire library can be submitted if no locks exist on any section components. Anysections not already present in the group as section components are automatically created.This is the preferred method of handling DDL produced libraries. (i.e., we do notrecommend using dictionary maintenance commands).

Individual sections can be extracted, modified, and submitted independently. This is thepreferred method of handling PATHMAKER copy libraries.

References made to an entire copy library from a source component will correspond toreference entries to the source group component.

Dependencies are always placed on versions of section components. There are noversions of source group components.

Source groups can only contain source components without file names. This restrictionmay not be enforced, but should be rigidly followed.

Introduction to RMSSegmented Source Libraries


A section of a segmented library can’t be moved to another segmented library usingLINK and UNLINK. Individual sections can be linked to another segmented library, butthat library is only available for EXTRACT and COMPILE. The SUBMIT operation willbe prohibited.

Segmented source libraries have three optional special components:

.FILE-HEADER

represents the header portion of the segmented source library. This component cannot bedirectly used by a compiler as there is no corresponding ?SECTION in the file. Thissection is only available if the entire library is used without section references. Thiscomponent will always appear at the beginning of the library.

.DEFAULTS

establishes default attributes for automatic component creation. If you submit an entirelibrary, RMS will automatically create any new components using the defaults obtainedfrom this component. For example:

ADD COMP COPYLIB\.DEFAULTS, TYPE SOURCE, LANG COBOL

.ORDER

establishes section ordering within a library. This component contains lines of thefollowing syntax:

section-name [ , base-line-number ]

On extract, sections will appear in the same order of appearance as in this component. Ifbase-line-number is specified, the section will start at that line number. Currently, thiscomponent will have only one setting:

blank

users must manually specify the contents of .ORDER when an ordering change isrequired. RMS does not modify the contents of .ORDER

Note! The TYPE parameter is required when adding the optional special components.

C40-ER00100 Note! The RMS language parser for segmented libraries supports the C-ANSI language. Prior releases ofRMS supported general Tandem ?SECTION constructs and the C language. C-ANSI is handled in thesame manner as C.



Locks on Source Libraries, DATALIBs and DDLDICT Groups

Locks are enforced on the following abstractions, including SRCLIB, DATALIB andDDLDICT groups.

Group Lock

.ADD-DEPENDENCIES attribute must be specified.

Child dependencies are created for each group version submitted. You can view thisdependency by typing:

LIST DEPENDENCY FROM group-comp : version , DETAIL

Lock/submit at group version level only.

You can’t specify a version at submit

PROMOTE must be at group level only. Dependent members will be promotedautomatically. DEMOTE must be done individually for the group version and itsdependent member versions.

Bugfix allowed at group level only. Submitting to a specific state causes RMS to generatebugfix versions for members based on the versions at the specified state. The group andmember versions may be promoted if proper security was provided. If the promote failed,an authorized user can promote the group version to the proper state afterwards. If there isno proper group version to be locked for the bugfix version, RMS will show an error2033.

Group lock should be used by all SRCLIB components generated by DDL compilation.

During a version freeze, the appropriate group version will be selected.

To preserve ordering of SRCLIB, you must specify LANGUAGE AUTO/AUTONUMwith the .ORDER file since it will be submittable in this mode.

During an acquire the .ADD-DEPENDENCIES attribute will be automatically created,but you must create the .ORDER explicitly. For DATALIBS, the .KEY-DESC and.DATA-DESC attributes will be automatically created.

When Group Locks are submitted with a PCR (as in the dual mode) only changedmember versions are linked to the PCR. This means that promoting a PCR with contentswon’t be able to promote these linked versions, since the group must be promotedinstead. Therefore, group version must be promoted first before the PCR. Promotingrelease contents will run into the same situation, in that the group version must bepromoted first.



Dual Mode (Default)

In default mode, no child dependencies are created.

Lock/submit is allowed exclusively either at the group or member level.

PROMOTE or DEMOTE at the member level only. The group version is not promotable,so you need to have RECURSIVE ON for a successful promote.

A new version is created during freeze release to encapsulate all member versions at theappropriate state.

Bugfixes can be submitted at both group and member levels. At the member level,submitting a bugfix is the same as submitting any source component. However, groupsubmits cannot control the version number generated. Therefore, when submitting at astate, the bugfix version can be generated, based on the version at the state as in GroupLock only mode. The changed/new versions submitted at the state will not be promotedas there are no child dependencies, and must be manually promoted one at a time.

.ORDER component can be managed manually. However, when the group is locked, the

.ORDER component can’t be changed (submitted). Therefore, a change in the orderingmust be submitted separately after the group submit.

Switching Between Modes

A SRCLIB without child dependencies can be switched to the Group Lock mode by addingthe .ADD-DEPENDENCIES attribute. However, any component having versions with childdependencies should not be switched to Dual Mode by deleting the attribute, because it willcause immense confusion when group versions were intermixed with and without childdependencies. It may cause undesirable effects when dealing with bugfix versions and statepromotions.

Caution! The version number sequences in the child of a SRCLIB may not reflect the actual life cycle statesequences if it has child dependencies. Promoting versions and handling bugfix versions will beimpossible with a SRCLIB intermxied with both modes, unless no bugfixes are created and all versionsare at the latest state.

Considerations

The locks on the level not intended to be used for future submits must be deleted before anynew submit can execute.



.ORDER Feature Within Segmented Source Files.

A segmented source file that exists must have the selections in a specific order. Thesections are named FIRST, SECOND, THIRD, FOURTH and FIFTH. RMS would normallyorder the sections in alphabetical order (FIFTH, FIRST, FOURTH, SECOND and THIRD).The segmented source component is called PROG1 and it is stored within RMS in the file$RMS.SRCLIB.PROG1, and is written in TAL.

ADD COMP PROG1, TYPE GROUP, LANG SRCLIB, FILE $RMS.SRCLIB.PROG1GROUP PROG1ADD COMP .DEFAULTS, TYPE SOURCE, LANG TALADD COMP .ORDER, TYPE SOURCEGROUP..SET COMMENTInitial Submit.//SUBMIT $DATA.SRCLIB.PROG1 TO PROG1GROUP PROG1

Create a file to submit to .ORDER. The format of the file is:

section name [ line number ]

where

section name

Is the name of the section.

line number

Is the optional edit line number at which to start the section. If the line number is notspecified, then the section will start at a line number based on the increment for thesection, and the previous line number. The line number is useful so that a section willalways start at a line number. Therefore, INSPECT will work even if only one section isextracted.



Considerations

The order of the sections within the .ORDER component determines the order in which thesections will appear in the extracted file. The section names on the .ORDER file are casesensitive and must match the component names of the corresponding sections. (Since allcomponent names are currently in uppercase only, the section names on the .ORDER file mustbe in upper case too).

The contents of the .ORDER file:

FIRST 1SECOND 200THIRD 300FOURTH 400FIFTH 700

SUBMIT ORDER TO .ORDERGR..

== The following extract will pull the sections in the== correct order. With the sections starting at the correct== line numbers.

EXTRACT PROG1



DATALIB - Data Library Extraction

C40-ER00092 DATALIB is a group component similar to a segmented source library or SRCLIBcomponent. It contains a collection of KEYED components which all have the same fileattributes. From an operational point of view, it is a single key-sequenced file whose recordsyou may want to group into generically-related groups or classes. Each KEYED componentname in the DATALIB serves as an index to the generic group or class. Therefore, thecomponent name must be generated based on the primary key of the first record in each groupwhen the file is submitted.

This is done by defining a .KEY-DESC component attribute which specifies a template togenerate component names. The .KEY-DESC template also determines the granularity orresolution of the component name relative to the primary record key. With a higher resolution(i.e., more significant detail) in the template, more KEYED components will be generated.For more information, see Automatic Name Generation (1-34).

DATALIB Example

A key-sequenced file where the primary key consists of three parts with a COBOL definitionas follows:

02 EMPLOYEE-KEY 03 DIVISION PIC X(5) 03 DEPARTMENT-NUMBER PIC 9(3) 03 EMPLOYEE PIC A(15)

You can choose to manage this file in a DATALIB with components grouped by division,department number or employee.

Once it is broken up into DATALIB components, each one is managed in the same way as asegmented source library. Everything you can do with a segmented source library, you can dowith a DATALIB.

Creating a DATALIB Component

A DATALIB group component must have a language of "DATALIB", must be of typeGROUP and must have a physical filename. The physical filename corresponds to a file whereall versions of all records will be held.

Generically-grouped records can appear as separate components within the DATALIB group.These components must be of type KEYED and must not have a physical filename.

RMS will automatically create separate components in the DATALIB group for eachgenerically-related group of records as part of the SUBMIT command. You can also createthese components yourself. This function is similar to the SRCLIB component type. An indexis maintained so RMS knows where in the group the related records are managed.

Introduction to RMSDATALIB - Data Library Extraction


Automatic Name Generation

A primary key template attribute .KEY-DESC is a required attribute on the DATALIB groupcomponent and specifies the contents of a primary key. This template is then used to generatecomponent names:

X An alphanumeric, upshiftable byte in the primary key.

Y An alphanumeric, upshiftable or blank byte in the primary key,where blanks are substituted by a "." Trailing blanks in a Y fieldare removed if a field length is specified (i.e., a number followsthe field - Y10). If individual blanks must be displayed as a ".",specify a "Y" for each character. (e.g. "YYYYY" instead of"Y6").

D A displayable ASCII value. A single byte value to be translatedinto a two byte hexadecimal value.

N A numeric value in the primary key, where the value is aninteger, but translated to two byte hexadecimal value with themost significant byte truncated.

- An ignored byte in the primary key. These would be used torepresent FILLER and leading record class discriminants. Thisfield can also represent fields which are not significant to thecomponent name but distinguish between records which aregenerically related.

Considerations

Generated component names cannot exceed 32 bytes. If they do, the associated SUBMITwill fail.

Ignored fields in primary keys must contain identical data throughout the submitting file.Otherwise, SUBMITs may be rejected because of key duplication. RMS won’t explicitlytest the contents of the data, but will reject submission of a primary key which recurs dueto key ordering associated with the nonidentical data.

Be very careful when modifying .KEY-DESC values after an initial submit has beendone. Note also that primary key attributes cannot change.



Names are generated using the following mapping:

Table 1-1 DATALIB Name Generation

.KEY-DESC byte Example Component Name Translated

X "f" A (exact translation -upshiftedalphanumeric)

"F"

Y "A BC" Same as X mapping"to"

"A.BC"

D "%" H(type byte hexadecimalvalue)

"25"

N 477 HH (two bytehexadecimal valuemapped to a singlehexadecimal value)

"DD"

- "K" ignored n/a

Note! Each KEY-DESC code can be followed by a decimal number indicating the number of repetitions. So"A4D2N8- 10” is a valid .KEY-DESC attribute.

Significance Template

A significance template attribute .DATA-DESC is an optional attribute on the DATALIBgroup component and specifies which bytes of record data are significant or to be ingnored.This template is then used for comparing existing records with those in the file beingsubmitted.



Table 1-2 DATALIB DATA-DESC Attributes

.DATA-DESC byte Example

B Any ASCII byte.

- An ignored ASCII byte.

No mapping takes place for this attribute. All of the above template values can be followed bya field length (i.e., a number following the field).

Considerations

Be very careful when modifying .DATA-DESC values after an initial submit has beendone. It will change the basis for difference comparison for subsequent submits.

If no difference is detected between the current and new version, the current version ofthe record will be used.

Submitting a DATALIB Component

Submitting a DATALIB component is similar to submitting a SRCLIB component. However,you should observe these considerations:

The .KEY-DESC and .DATA-DESC attributes are validated before the SUBMIT proceeds.

The primary key length of the file is not permitted to change.

RMS will delete all records in a component whose corresponding primary keys are notpresent in the file being submitted. This applies whether submission occurs at theDATALIB group or record component level.

For instance, when submitting at the DATALIB level, components are considered"empty” (i.e., all records considered deleted) if no records for specified keys are presentin the file being submitted. The KEEP MISSING ON flag overrides this function bypreserving (without change) components which do not appear in the file being submitted.

Essential file attributes (such as physical record length and alternate key specifications)are kept in versions associated with the .FILE-HEADER component of the DATALIBgroup. This list of attributes includes sufficient information to recreate the primary andalternate key specifications, extents, and record layouts. Note that logical record numbersand relative byte addresses are not preserved.

The .FILE-HEADER component is created automatically during the initial submit, andsubsequent versions will be generated by submits to the DATALIB component. Pleasenote that submits to record components will not generate new versions of the.FILE-HEADER. If a version of .FILE-HEADER is extracted, an empty file will becreated using the file attributes kept with that version. Versions of this component can bemanaged like record components (e.g. promote, demote, rollout, etc.)



When extracting a DATALIB component at a specific state, a valid version of the.FILE-HEADER component must exist at that state.

The locking protocol for Datalib and record components is the same as for source librarycomponents.

Submission to individual record components is permissible under the constraints ofDATALIB’s locking protocol.

Record components are versioned using the same mechanism as KEYED componentsand are subject to the same promotion rules. The state of the DATALIB group has nomeaning.

The use of userchange identifiers (PCRs) for record components is the same as forKEYED components.

Bugfix support for record components is the same as for KEYED components.

As with KEYED components, record lengths are preserved when variable length data issupplied.

As with KEYED components, alternate key definitions are preserved with the DATALIBcomponent.

Working With DATALIB Components in Releases

It is important to observe these considerations when working with releases:

The component attributes .KEY-DESC and .DATA-DESC are essential for the recreationof a DATALIB component. Therefore, these attributes will be written into the manifestduring a FREEZE RELEASE.

As part of an ACQUIRE MANIFEST, these attributes will be recreated along with theDATALIB component. If the component and associated attributes already exist, theattribute values must match the ones on the manifest.

The CONTENTS file created during release distribution will include record components.

Component linkage (e.g., release component selection) functions in the same manner assource libraries.

DATALIB and record component release function operate in the same manner as sourcelibraries.

The ACQUIRE RELEASE function will identify all versions of record componentsalready present in the catalog and will not re-acquire those versions. This condition doesnot differ from the current source or KEYED component acquire functions.

During a FREEZE RELEASE,VERSION command, a new version of a DATALIBcomponent will be created. This new version will select all versions of the childcomponents existing at the release state. A subsequent INSTALL or DISTRIBUTE will



fail if the proper version of .FILE-HEADER was not promoted to the proper statebefore the freeze.

In order to link specific records of a DATALIB to a release, an empty DATALIB must becreated and an appropriate .FILE-HEADER must be linked in or created beforehand.



Managing External Components Within RMS

The main types of external component supplied by Tandem which are candidates formanagement under RMS are:

Source files such as $SYSTEM.SYSTEM.EXTDECS0 for TAL or$SYSTEM.SYSTEM.TALH for C

Object libraries such as $SYSTEM.SYSTEM.COBOLLIB for COBOL

Compilers and processors such as $SYSTEM.SYSTEM.TAL

Subsystem objects and SPI Definitions such as SCF / Telnet / SPI.

Why Should These Files be Managed?

While it is true that these files generally change in an upwardly compatible fashion, theversion of the file used can have a dramatic impact on the ability of a system to work in agiven environment. For example, if the C30 version of ZSPIDEF.ZTNTDDL (a SPI definitionfile) is used to compile a management application, then that application will be able to runonly on a C30 system. If the application must run on a C21 system, declaration files suppliedwith C30 may cause incompatibilities and address traps. With the dramatic changes that willbe occurring in Tandem-supplied software with the release of GUARDIAN D00, and theattendant need to support both C30 and Dxx releases of products for the near future (2 years),it is our opinion that these files should be managed by RMS. Failure to do this may result insubstantial extra work for system management and technical support personnel to diagnoseand eliminate operating system version conflicts.

Additional considerations for managing each of these different component types are asfollows:

External Source Files

External source files are generally declaration files supplied by TANDEM to enable theprogrammer to make use of some feature or subsystem. These files include SPI definitionfiles as well as TAL, C, and PASCAL declarations of the GUARDIAN operating systemprocedures. For the reasons stated above, we recommend that they be managed usingRMS.

The System Manager should notify change management personnel whenever a SYSGENis performed or a patch is installed, as these activities will necessitate the submission ofnew declaration files into RMS. An additional requirement is the promotion of the sourcefiles. Each of the declaration files must be promoted to the appropriate state so that duringa compile, the correct version of the file is retrieved.

Introduction to RMSManaging External Components Within RMS


External Object Libraries

For the same reasons stated with External Source Files it is our opinion that External ObjectLibraries should be managed using RMS and the appropriate promotion strategy be adopted.

External Object Files

RMS provides for the management of processors/compilers with different versions of acompiler being used for different states. See the next page for an example of a suggestedstructure (1-41).



GROUP \ADD COMP TANDEM, TYPE GROUPGROUP TANDEMADD COMP BIND, TYPE OBJECT, FILE $<ALT>.SYSTEM.BIND GROUP BINDADD COMP BINSERV, TYPE OBJECT, FILE $<ALT>.SYSTEM.BINSERVADD COMP PDTERROR, TYPE DATA, FILE $<ALT>.SYSTEM.PDTERRORADD COMP PDTHELP, TYPE DATA, FILE $<ALT>.SYSTEM.PDTHELPGROUP ..

ADD COMP C, TYPE OBJECT, FILE $<ALT>.SYSTEM.C

ADD COMP COBOL85, TYPE OBJECT, FILE $<ALT>.SYSTEM.COBOL85

ADD COMP CROSSREF, TYPE OBJECT, FILE $<ALT>.SYSTEM.CROSSREFGROUP CROSSREFADD COMP SYMSERV, TYPE OBJECT, FILE $<ALT>.SYSTEM.SYMSERVGROUP ..

== Next group of RMSCOM commands adds the data file that tal == needs, and links in the other files that are used as part of== the tal compilation process.

ADD COMP TAL, TYPE OBJECT, FILE $<ALT>.SYSTEM.TALADD COMP EXTDECS0, TYPE SOURCE, FILE & <ALT>.SYSTEM.EXTDECS0GROUP TALADD COMP TALERROR, TYPE DATA, FILE $<ALT>.SYSTEM.TALERRORLINK COMP \TANDEM\BIND\BINSERV TO .LINK COMP \TANDEM\CROSSREF\SYMSERV TO .GROUP ..

== Do SCOBOLADD COMP SCOBOLX, TYPE OBJECT, FILE $<ALT>.SYSTEM.SCOBOLXGROUP SCOBOLXADD COMP SCOBOLX2, TYPE OBJECT, FILE & <ALT>.SYSTEM.SCOBOLX2LINK COMP \TANDEM\CROSSREF\SYMSERV TO .GROUP ..

== Do CADD COMP CEXTDECS, TYPE SOURCE, FILE & $<ALT>.SYSTEM.CEXTDECS GROUP CLINK COMP \TANDEM\BIND\BINSERV TO .LINK COMP \TANDEM\CROSSREF\SYMSERV TO .GROUP ..

== Do COBOLADD COMP COBOLLIB, TYPE OBJECT, FILE $<ALT>.SYSTEM.COBOLLIBADD COMP CBL85UTL, TYPE OBJECT, FILE $<ALT>.SYSTEM.CBL85UTLGROUP COBOL85ADD COMP COBOLEXT, TYPE OBJECT, FILE $<ALT>.SYSTEM.COBOLEXTLINK COMP \TANDEM\BIND\BINSERV TO .LINK COMP \TANDEM\CROSSREF\SYMSERV TO .



ADD COMP SQLCOMP, TYPE OBJECT, FILE $<ALT>.SYSTEM.SQLCOMPADD COMP SQLCOBOL, TYPE OBJECT, FILE $<ALT>.SYSTEM.SQLCOBOL

Install Activities

As new releases of Guardian or of IPMs are installed, new versions of compiler componentsare placed in $SYSTEM.SYSTEM. These compiler components should be submitted to RMS:

GROUP \TANDEMADD PCR "IPM T9255C30^ABB"SUBMIT $SYSTEM.SYSTEM.* TO C,NODIFFOK

There are occasions where a new release of Guardian will not change the version of acompiler. The NODIFFOK option prevents the submit from failing even if no new version isinstalled.

Promotion Activities

There is usually a relationship between the state markers associated with compiler versionsand the target test and production environments. If the production machines are runningDxx-level operating systems, then it is acceptable to have the production state marker pointingto the Dxx-level compilers. However, if the production machines are running Cxx-levels, theuse of a D10 compiler and external declarations could result in incompatibilities. As a result,the running of an INSTALL on a production machine could result in the promotion ofcompiler components.

PROMOTE COMPONENT \TANDEM:TEST TO PROD,RECURSIVE

promotes all compiler versions currently at the test state to the production state.

Supporting Rules

Little change is required for compile rules to support this capability. The following samplerule supports an internally-managed TAL compiler:

GROUP \ALTER RULE TAL,NAME TAL-OLDADD RULE TAL,STEP 0,FILE $<ALT>.SYSTEM.TAL+ Assign^SSVs+ [:rms:processor]/IN [:rms:source],OUT [:rms:list^loc TAL]/ &

[:rms:object];[:rms:tal^options]+ //

The Assign^SSVs macro is appropriate only for TAL, at present. The macro should assign$<ALT>.SYSTEM as SSV0. This macro definition should be placed in the RMSLBASE filein the RMS object subvolume.



Setting Up the RMS Environment

There are two files that assist with RMSMAKE and PRODUCE processing: RMSBASE, andRMSLBASE. These files are TACL MACRO library files (like TACLBASE) with ?SECTIONstatements separating the various routines, macros, and variables. The other RMSenvironment configuration files are listed below.

RMSBASE Contains required RMSMAKE support macros used byPRODUCE/RMSMAKE, INSTALL, DISTRIBUTE, etc. Macrosare also present to define the compiler options for theRMS-supplied compilation rules. RMSBASE is supplied withthe RMS distribution tape and is stored in the same sub-volumeas RMSMAKE.

This file must never be modified for any reason. DDS reservesthe right to replace, drop, or otherwise remove support formacros in this file. The file can, however, serve as a model forcustomizations placed in RMSLBASE.

RMSCSTM Allows you to customize your own individual environment. Youcan put your aliases in here, or change your prompt, for example.It should be in your default volume.subvolume and works likeTACLCSTM. See Appendix D (D-1) for more information.

RMSINI Can be executed when the RMS monitor is started. For example,it initializes the RMS environment to put certain serverparameters in.

RMSLBASE Contains customizations to RMSBASE, and support macros forcustom compilation rules. Typically support macros for SQLcompilation are also stored here. This file is automatically loadedduring RMSMAKE/PRODUCE, INSTALL, DISTRIBUTE, etc.This file is not supplied with the RMS distribution tape. It is anoptional file.

Note! It is a good idea to keep a copy of RMSLBASE managed within RMS.

RMSLOCL Like TACLLOCL, it is executed every time you start an RMSsession. The difference between this and RMSCSTM is that thisdoes the setup for all users. See Appendix D (D-1) for moreinformation.

Introduction to RMSSetting Up the RMS Environment


RMSLSTRT Contains customizations to RMSSTART. This file isautomatically loaded during RMSMAKE/PRODUCE,INSTALL, DISTRIBUTE, etc. This file is not supplied with theRMS distribution tape. It is an optional file.

RMSSTART Contains required TACL commands to set up the environmentneeded by PRODUCE/RMSMAKE, INSTALL, DISTRIBUTE,etc. Supplied with the RMS distribution tape.

The following are the release manifest template files:

RMSMTPLT Contains the default template text used to build a releasemanifest for any kind of release types. You can customize thetext between the labels BEGIN_USER_ and END_USER_.Anything outside of these labels may be changed by RMSwithout notice. This file is supplied with the RMS software.

RMPMTPLR Contains the default template text used to build a releasemanifest for RELEASE type releases. You can use theRMSMTPLT as an example to build this file.

RMPMTPLS Contains the default template text used to build a releasemanifest for SUB-RELEASE type releases. You can use theRMSMTPLT as an example to build this file.

RMPMTPLV Contains the default template text used to build a releasemanifest for VARIANT type releases. You can use theRMSMTPLT as an example to build this file.

Introduction to RMSSetting Up the RMS Environment


22 RMSCOM and RMSMON StartupCommands

This section describes the commands for bringing up and communicating with the RMSsubsystem. There are two parts to the RMS system: the RMS subsystem, and the RMSuser-interface. Each part of the system is brought up separately.

RMSMON manages the complete RMS subsystem and all auxiliary processes. RMSMONprocesses are normally left running at all times.

Figure 2-1 RMS Process Structure

RMSCOM is the principal user-interface to the RMS subsystem. This process is generally runas needed by individual users. RMSCOM can be shut down when no longer needed.

$0RMSCOM

RMSCOMRMSCOMRMSServers

RMSMonitor

#ZSPI

RMS-ManagedFiles

RMSCatalog

RMSCOM and RMSMON Startup Commands


Starting RMSCOM Command

[ADD DEFINE =RMS,CLASS MAP, FILE rms-monitor-process ][ADD DEFINE =RMS_EDITOR,CLASS MAP, FILE editor ]RUN RMSCOM [ / run-option [ , run-option ] / ]

[ rms-monitor-process ] [ ; RMSCOM-command ] ...

RMSCOM

is the object file name of the RMS Command Interpreter program. If RMSCOM is notinstalled in the default search list of the user, then it may need qualification.

run-option

is any of the normal TACL run options. The option listed below is of specific relevance toRMS users.

SWAP volume

is the name of the disk volume where swap space is allocated. RMSCOM needsapproximately 300Kb of swap space to run.

rms-monitor-process

is the RMSMON process ID. This process is the management process for a specific RMScatalogue. The default process name is $RMP.

editor

is the volume, subvolume and filename of an editor (e.g. $SYSTEM.SYSTEM.EDIT).

RMSCOM-command

is any one of the commands described in this manual.

Considerations

RMSCOM, unless otherwise specified on the command line, uses $RMP as its assumedRMSMON process (See Starting RMSMON (2-5).

RMSCOM does not need to be a named process.

RMSCOM will not accept $RECEIVE as an input file. Applications which need tocommunicate in a programmatic fashion should use the Subsystem ProgrammaticInterface (SPI) to the RMS Subsystem as described in the Revision Management System(RMS) Programming Manual.

RMSCOM and RMSMON Startup CommandsStarting RMSCOM Command


If the =RMS define is specified then the rms-monitor-process does not have to bespecified in the run command. This define may be established in a user’s TACLCSTMfile or in the TACLLOCL file.

When the =RMS_EDITOR define is specified, and you are performing commands likeBROWSE or EDIT RULE, RMS will invoke the editor specified in the define. Bydefault, RMS will invoke TEDIT.

If an RMSCOM-Command is given in the command line, RMSCOM will exit aftersuccessfully completing the command. Banners are not displayed in this situation.

RMSCOM is usually started at a TACL or COMINT prompt.

Customization Entities

There are a number of different customization entities that are available with RMS.

RMSCOM customization facilities

RMSMAKE/PRODUCE customization facilities (See Chapter 7 in the RevisionManagement System (RMS) Utilities Reference Manual).

User exit routines.

RMSCOM Customization

There are two files that control the RMSCOM environment: RMSCSTM, and RMSLOCL.Both files are created automatically the first time a user runs RMSCOM. The catalog owner’sRMSCSTM and the system RMSLOCL are both created during the initial RMS installationprocess.

RMSLOCL Contains any RMSCOM or CUI command that is supported bythe RMSCOM command interface. This file is executedimmediately after RMSCOM opens the initial RMSMONprocess (e.g., $RMP). RMSCOM uses an implicit OBEY !command to perform this function. All RMSCOM sessionsprocess this file regardless of the Guardian User ID. Ensure thatthe RMSLOCL is secured for network read access. "NOOO".

RMSLOCL is stored in the same sub-volume as RMSCOM.

RMSCSTM Contains any RMSCOM or CUI command that is supported bythe RMSCOM command interface. This file is executedimmediately after RMSLOCL is processed. RMSCOM uses animplicit OBEY ! command to perform this function.

As the RMSCSTM is user-specific, access can be restricted bythe individual User ID. RMSCSTM is stored in the user’s defaultsub-volume.

RMSCOM and RMSMON Startup CommandsCustomization Entities


Running RMSCOM

$DAT2 NRMS 59> run rmscomRMSCOM Revision Management System - D9020C10 - (10JAN90)COPYRIGHT DATA DESIGN SYSTEMS INCORPORATED 1989, 1990RMS MONITOR - D9020C10 - (04NOV89) CURRENT CATALOG IS $DAT2.NCATALOGRMS 1)

RMSCOM reads two files immediately after the initial open of the RMS monitor process:

RMSLOCL Located in the RMS object subvolume, is read first and generally containssystem-wide custom RMSCOM settings. System-wide search subvolume(SSV) specifications are commonly placed in this file.

RMSCSTM Located in the user’s default subvolume, is read after RMSLOCL andcontains user-specific custom RMSCOM settings. Aliases andSETPROMPT specifications are usually placed in this file.

The above files contain RMSCOM and Data Design Systems Common User Interface (CUI)Commands (see Environment Commands (4-1) in the same format as you would enter at theRMSCOM command prompt.

RMSCOM and RMSMON Startup CommandsRunning RMSCOM


Starting RMSMON

VOLUME catalog-subvolume[ADD DEFINE =_EMS_TEMPLATES, CLASS MAP, FILE rms-vol .DRMSTMPL][ALTER DEFINE =_DEFAULTS, SWAP volume ]RUN RMSMON/NAME name, CPU primary-cpu ,NOWAIT,OUT log , &

run-option /[(+|-)rsc] [(+|-)slave]

The =_EMS_TEMPLATES define is only necessary if events are being logged in TEXTformat.

catalog-subvolume

is the subvolume where the RMS catalog currently exists, or where a new catalog shouldbe placed.

name

is the name of the RMS monitor process. RMSCOM by default looks for the name $RMP.

primary-cpu

is the processor in which RMSMON will initially run.

NOWAIT

is used to start RMSMON in a nowait fashion.

log

is the process, device, or file that the RMS system will use to log to; $0 is therecommended log process.

run-option

is any of the normal TACL run options. The option listed below is of specific relevance toRMS managers.

SWAP volume

is the name of the disk volume where swap space is allocated. This swap volume is used asthe swap volume for all servers managed by RMSMON.

If the define is altered then the run paramater is not needed.

(+|-)rsc

Remote Server Call (a product by Tandem Computers Inc.) Allows access to the RMSMonitor by RSC-based programs, such as RMSWin .

RMSCOM and RMSMON Startup CommandsStarting RMSMON


(+|-)slave

RMS allows you to start a second monitor in slave mode, allowing multiple copies ofRMSMON to access the database. This way, a command executed from the network orRMSWin will not affect users of RMSCOM.

Considerations

If RMSMON has not already created the catalog in this subvolume then a new catalogwill be created with the ID of the creator.

If a catalog already exists in the catalog subvolume then the owner must restartRMSMON. RMSMON will not start on a catalog of a different owner.

If $0 is specified as the log process, RMSMON logs in Event Management System(EMS) format. Otherwise, if some process other than $0 or a file is specified, RMSMONlogs in displayable text format.

RMSMON automatically executes the file RMSINI in its installation subvolume if thefile exists, is not empty, and is secured so that only the local catalog owner can modifythe file (e.g. the Guardian file security string should be "OOOO"). This file can containany valid RMSCOM commands. RMSMON starts RMSCOM as follows to process thisfile:

RMSCOM/IN isv .RMSINI, OUT log , NOWAIT/ name

C40-ER00008 Note! The RMSMON Server class manager supports the use of the CMON facility for controlling whereservers are started. To use this facility, the DEFINE =CMON must be present when RMSMON isstarted. There is no requirement for the CMON process name to be $CMON. As a result, RMS-specificCMON processes can be created without impact on other applications.

C40-ER00031 Note! The RMSMON process verifies component names for lexical validity prior to processing the ADD andALTER COMPONENT commands. Component names must be nonblank, must not start with a blank,must not contain embedded blanks, and may contain any valid identifier characters (A..Z, a..z, 0..9, ., -,_ and ^). The management application (RMSCOM) is still responsible for ensuring case insensitivity.The RMSCOM process always upshifts component names.



RMSNET

Note! RMSNET is shipped with RMSWin.

C40-ER00002 RMSNET is a new server class (managed by RMSMON) which implements variousnetwork-related services, including the USER VALIDATE command processing. This servermust be available for users to obtain access to RMS functions via Remote Server Call (RSC).

Note! To use RSC with RMS, you have to purchase the RMSWin product.

Be aware that RMSNET calls VERIFYUSER to perform the USER VALIDATE command.Users issuing improper user names or passwords could cause RMSNET to be suspended for60 seconds. This will not suspend other RMSMON or asynchronous RMS functions for otherusers. There should be a sufficient pool of RMSNET servers to handle this situationconfigured for a given environment. The default is the same number of servers as theRMSUBMIT server.

This server operates in conjunction with the RMSMON command line parameter +RSC. Thisparameter allows the $ZRSC TDP process to open RMSMON. If this parameter is notspecified, the TDP will be unable to use RMSMON.



Notes:



33 RMSCOM Commands - Overviewand Summary

This section provides:

a description of the general command format of RMSCOM commands

a list of keyword abbreviations

a brief command summary.

The commands described here are relevant only to RMSCOM and do not necessarilycorrespond to the SPI protocol to RMSMON. Please refer to the Revision Management System(RMS) Programming Manual for SPI protocol specifications.

General Command Format

command object item [ , command-parameters ]

command

is a general action to be performed (e.g. ADD, DELETE, LINK).

object

is the type of item or object on which work is being performed (e.g. COMPONENT,RELEASE, USERCHANGE).

item

is an identifier of the object, such as a component name, which is being used. In somecommands, patterns such as "*" are permitted.

command-parameters

are command specific parameters.

RMSCOM Commands - Overview and SummaryGeneral Command Format


Keyword Abbreviations

RMSCOM uses keywords in the syntax of its commands. Most of the keywords haveabbreviations that may be used in place of the full keyword. The abbreviation may be anylength from the shortest acceptable length through the full length of the keyword.

Table 3-1 Keyword Abbreviations - RMS Commands

AD[D] DAY[S] HEAD[INGS] MOD[IFY]

ADJ[UST] DEF[INE] H[ELP] NOA[DD]

ANTE[REQUISITE] DEL[ETE] HIS[TORY] NOD[IFFOK]

ARC[HIVE] DEM[OTE] HOUR[S] NORM[AL]

ATTR[IBUTE] DEP[ENDENCIES] IM[AGE] OBJ[ECT]

BACK[UP] DEPT[H] IMP[ACT] OBS[OLETE]

BLANK[S] DESC[RIPTION] INCL[UDE] PRE[REQUISITE]

BRI[EF] D[ETAIL] INCR[EMENT] PRI[ORITY]

BR[OWSE] DIFF[ERENCES] I[NFO] PROD[UCE]

BUG[FIX] DISC[ONTINUE] INH[ERIT] PROM[OTE]

CHE[CK] DIST[RIBUTE] INST[ALL] QUA[LIFY]

CHG[ATTR] DOC[UMENT] KEY[ED] QUI[ET]

CL[EANUP] DUP[LICATE] LANG[UAGE] R[ECURSIVE]

COMM[ENT] ED[IT] LIC[ENSE] REF[ERENCE]

COMP[ONENT] EDITL[INE] L[IST] REL[EASE]

COMPR[ESS] ERR[ORS] LOC[ATION] REM[OVE]

COND[ENSE] EXP[IRES] MAN[AGER] REN[UMBER]

CONT[ENTS] EXT[ERNAL] MANI[FEST] REQ[UISITE]

CONTI[NUE] EXTR[ACT] MAXSERV[ERS] ROL[LOUT]

CONTR[AREQUISITE] FI[LE] MEM[BERS] SEC[ONDS]

COR[EQUISITE] FORM[AT] MIN[UTES] SECT[ION]

CPU[S] GR[OUP] MISS[ING] SERV[ER]

RMSCOM Commands - Overview and SummaryKeyword Abbreviations


SHO[W] SUBR[ELEASE] TRIG[GER] VER[SIONS]

SIDE[BYSIDE] SUBS[YSTEM] USERC[HANGE] VOL[UME]

SOUR[CE] SUBV[OLUME] VAL[UE] WEIGH[T]

SP[ATH] SUMM[ARY] VAR[IANT]

STAT[US] SW[ITCH] VERB[OSE]

SUB[MIT] SYS[TEM] VERI[FY]

Table 3-2 Keyword Abbreviations - Environment Commands

AL[IAS] FILEI[NFO] SETP[ROMPT]

COMM[ENT] FILEN[AMES] STAT[S]

CONT[INUE] HEAD[INGS] VOL[UME]

D[ETAIL] HIS[TORY]

E[XIT] O[BEY]

Table 3-3 Command Summary

Command Description

! Repeats a previous command.

? Lists a previous command.

ACQUIRE Receives a new release from another location.

ADD Adds an item to the catalog.

ALIAS Creates a command "short cut".

ALLOW Contols error handling.

ALTER Alters an environment parameter.

BROWSE Examines the contents of a component.

CLEANUP Performs house cleaning and garbage collection.

COMMENT Comments in a command file.

CONDENSE Rolls changes together.



DELAY Pauses RMSCOM for a specific period.

DELETE Removes an item from the catalog.

DEMOTE Changes a release marker to a previous state.

DIFFERENCES Compares two versions of a component.

DISCONTINUE Removes support for an entity while retaining historicalinformation.

DISTRIBUTE Moves a release to another location.

DUPLICATE Creates a copy of a catalog item.

EDIT Allows interactive modification of a catalog item.

ENV Lists current log and volume.

EXIT Terminates processing.

EXTRACT Makes a copy of a controlled source file.

FALLBACK Rolls-out a release from an installed library.

FC Modifies or re-executes a previous command.

FILES Displays names of files in a subvolume.

FILEINFO Displays details about files in a subvolume.

FILENAMES Displays names of specified files.

FREEZE Stops changes to a release or creation of servers.

GROUP Changes the current group.

HELP Lists the syntax for commands and information about errormessages.

HISTORY Lists previous commands.

IMPACT Assesses the impact of an operation.

INFO Enquires about items from the catalog.

INSTALL Installs a release into a production or test library.

LINK Joins components or states.

LIST Lists items from the catalog.



LOCK Establishes a lock on a component to prevent submission byanother user.

LOG Opens or closes a log file for commands and responses.

MAP Produces a map of the component tree structure.

OBEY Executes commands from a command file.

OBSOLETE Drops unneeded items.

OPEN Opens an RMSMON process.

OUT Changes the current out file.

PRODUCE Produces an object.

PROMOTE Changes a state marker to a higher state.

RENUMBER Alters the version numbering of a component.

RESET Resets a previously-set item to its default value.

ROLLOUT Undoes new changes.

RUN Runs a program from within RMSCOM.

SECURE Adds or removes security attributes.

SET Sets current values.

SETPROMPT Establishes a new user prompt string.

SHOW Shows current values.

SHUTDOWN Stops RMSMON.

START Starts a server class.

STATUS Obtains information about server classes.

STOP Stops a server class.

SUBMIT Places a module under control of RMS.

SYSTEM Changes to another expand node.

THAW Allows commands to be executed by a server class.

TIME Displays the current time.

UNLINK Unlinks a previously-linked component or state.



UNLOCK Unlocks a previously-locked component.

VERIFY Verifies the integrity of an entity.

VOLUME Changes the current volume for file name expansion.



44 Environment Commands

The environment commands are implemented within RMSCOM to allow the user to interactor query files and processes that are not part of the RMS system. The commands allow a userto redirect the input and output of RMS commands, execute programs, change the defaultvolume, manipulate the command history buffer, display file names, and get help onRMSCOM command syntax.

The following environment commands are supported by RMSCOM:

Table 4-1 Environment Command Summary

Command Description

! Re-executes a command.

? Displays a previous command.

ALIAS Controls command aliases.

ALLOW Controls the number of errors and warnings allowed percommand.

COMMENT Places a comment into a command file.

DELAY Pauses RMSCOM for a specific period.

ECHO Sends text to the output file(s).

ENV Displays and controls current environment settings.

ENV CONTINUE Causes the application program to continue processing inputafter the command line options and commands have beenprocessed.

ENV HEADER Turns the display of page header information on or off when apage break occurs.

ENV HELP Sets the default level of detail associated with help queries.

ENV PAGE Changes the default page size.

ENV PMSG Controls the display of process-control information.

ENV STATS Controls the display of statistics when the command-levelinterface is terminated.

EXIT Terminates RMSCOM processing.

Environment Commands


FC Fixes a previous command.

FILEINFO Displays detailed file information.

FILENAMES Displays names of specified files.

FILES Displays files in a subvolume.

HELP Obtains help.

HISTORY Displays previous commands.

IF Controls conditional command processing.

LOG Logs commands and responses to a file.

OBEY Executes commands from a disk file.

OUT Redirects output to a file.

RUN Runs a program from within RMSCOM.

SETPROMPT Changes the default prompt text.

SYSTEM Changes the default system.

TIME Displays current date and time.

VOLUME Changes the current default volume.

The next section documents RMS-specific variations to Common User Interface (CUI)commands. For general CUI command information, refer to the Common User Interface(CUI) User’s Guide.

Environment Commands


EXIT Command

The EXIT command stops the current RMSCOM process.

EXIT

Considerations

RMSCOM will close the currently-opened RMSMON process just prior to processtermination. If RMSMON is currently attempting to shut down and the last RMSCOM exits(or closes RMSMON), RMSMON will then terminate.

Environment CommandsEXIT Command


SETPROMPT Command

The SETPROMPT command is used to change the prompt string shown by a command- levelinterface.

SETPROMPT "new-prompt-string "

new-prompt-string

is the actual text of the string to be used as a prompt. This string can containmeta-characters which expand to program-specific values. See the Considerations sectionbelow for details.

Considerations

The new prompt string should be short and concise. Excessive amounts of information inthe prompt string can be confusing. (The initial RMSCOM prompt string is "RMS !) ".

The meta-characters described can appear in a prompt string. These characters areexpanded to the indicated values:

Table 4-2 Setprompt Meta Characters

! Expands to the current command number.

$ Expands to the current date (DDMONYYYY).

$T Expands to the current time (HH:MM:SS).

$V Expands to the current disk volume. This string will be innetwork form if the current volume is not of the local node($VOLUME or \NODE.$VOLUME).

$S Expands to the current subvolume (SUBVOL).

$N Expands to the current system name (\NODE).

$U Expands to the current User ID (group.user).

$1 Expands to the current RMS catalog ($VOLUME.SUBVOL).RMSCOM only.

$2 Expands to the current RMS monitor ($RMP). RMSCOM only.

Environment CommandsSETPROMPT Command


$3 Expands to the shortened current RMS group path(\APPL\..\GROUP). This expansion will be at most twentycharacters. RMSCOM only.

$4 Expands to the full RMS group path(\APPL\PROJECT\SERVER\GROUP). Use caution with thisparameter as there is a limit to the prompt size of 80 characters.RMSCOM only.

Other utility programs may have different (or no) values for the numbered parameters(e.g. $1). These parameters are documented in the relevant sections of the RevisionManagement System (RMS) Utilities Reference Manual.

To insert a double quote into a prompt string use \" .

To insert an exclamation mark into a prompt string without expansion use \\!.

To insert a dollar sign into a prompt string without expansion use \\$.

Remember that if you wish a space to appear at the end of the prompt string, just prior tothe user input, you must have a space as the last character of the new prompt.

If the $T parameter is used, the value of the time field in the prompt string displayed inthe HISTORY command has no meaning.

SETPROMPT Examples

RMS 1) setprompt "!" 2) group \APPL\PROJ\EDI 3) setprompt "$2:$3 !) " $RMP:\APPL\PROJ\EDI 4) group SERVER1 $RMP:\APPL\PROJ..\SERVER1 5) group MODULE1 $RMP:\APPL\PROJ..\MODULE1 6) setprompt "$4 !) " \APPL\PROJ\EDI\SERVER1\MODULE1 7) setprompt "$D RMS !)" 21MAY1990 RMS 8) setprompt "RMS !) " RMS 9)



Notes:



55 RMSCOM Control Commands

This section describes commands which control the operational parameters of the RMSMONprocess.

Table 5-1 RMSMON Control Commands Summary

Command Description

ALTER RMS Changes RMS parameters.

CLEANUP RMS Gets rid of any extraneous items in the RMS catalog.

INFO RMS Gets information about RMS parameters or the RMS catalog.

OPEN RMS Establishes a link between RMSCOM and RMSMON.

SHUTDOWN RMS Terminates RMSMON processing.

RMSCOM Control Commands


ALTER RMS Command

The ALTER RMS command changes existing parameters of the RMS environment.

ALTER RMS { BACKUPCPU n }{ CHECK LANGUAGE { ERRORS } }

{ WARNINGS } } { OFF } }

{ LOG log-file }{ LOG FORMAT { EMS| TEXT } }{ PROMPT { ACQUIRE { ON | OFF } } }{ { DISTRIBUTE { ON | OFF } } } { FALLBACK { ON | OFF } } } { INSTALL { ON | OFF } } } { SECURITY " level " }{ USERCHANGE SUBMIT { ON | OFF } }{ USERCHANGE EXTRACT { ON | OFF } }

C40-ER00034 Note! The ALTER RMS command supports the PROMPT option (for example, PROMPT DISTRIBUTE ON).When the PROMPT option is set to ON, RMSCOM will prompt the user for text which will be associatedwith the distribution record for the release(s) being transported to or from the specified location. This issupported by the DREASON-TEXT field of the subsystem programmatic interface (SPI) PAR tokenmaps for each command. See INFO RMS (1-5) and the ACQUIRE (12-4), DISTRIBUTE (12-26), FALLBACK (12-36) and INSTALL (12-47) commands.

C40-ER00035 CHECK LANGUAGE

The ADD and ALTER COMPONENT commands both validate known RMS languages.These commands will return errors or warnings depending on how RMSMON isconfigured. The ALTER RMS CHECK LANGUAGE command will validate theselanguages. See Table 6-2 (Supported Language Settings 6-7) for more information.

ERRORS

causes RMS to report DRMS-ERR-VALIDATION (2900) and reject the request.

WARNINGS

causes RMS to report DRMS-WARN-VALIDATION (1006) if the specified languageis unknown.

OFF

inhibits RMS from performing language validation (default).

RMSCOM Control CommandsALTER RMS Command


LOG log-file

is used to change the destination log file. The specified file must be a fully qualifiedTandem file name.

LOG FORMAT

is used to change the format of the log between the Event Management System (EMS)tokenized format and the text format.

SECURITY "level"

is used to change the security level of protected commands.

level

is one of:

"A" - All local users."G" - All local users in the catalog owner’s group."O" - The catalog owner only."N" - All network users."C" - All network users in the catalog owner’s group."U" - The catalog owner’s network User ID only." - "- Super group only.

USERCHANGE SUBMIT { ON | OFF }

specifies whether user change identifiers are required for all component submissions toRMS. If USERCHANGE SUBMIT ON is specified, the SUBMIT command will berejected if no or an invalid userchange is specified.

USERCHANGE EXTRACT { ON | OFF }

specifies whether user change identifiers are required for all component extractions fromRMS. If USERCHANGE EXTRACT ON is specified, the EXTRACT command will berejected if no or an invalid userchange is specified.

Considerations

Use caution when changing from TEXT to EMS format when the log destination is not $0.Ensure that the log destination is capable of interpreting EMS format messages.

Security Restrictions

This command is considered a protected command. See Security Commands (9-1) for details.

Warning! It is possible to exclude yourself from performing commands using ALTER RMS SECURITY. Forexample, if you are not the owner of the RMS catalog, but change the security level to "O", you will beunable to change back without the owner’s intervention.



C40-ER00110 Note! RMSMON validates the presence of a PCR upon extract and submit (as required by theUSERCHANGE CHECK flags) only if the requester process is a nonRMS server. This allows ACQUIREand FREEZE RELEASE operations to proceed even if the check flags are enabled.



CLEANUP RMS Command

The CLEANUP RMS command directs RMSMON to perform internal house cleaning andgarbage collection.

CLEANUP RMS

Considerations

In the course of its processing, RMSCOM may inadvertently create text items whichcannot be otherwise removed. In the current implementation of RMS, CLEANUPincludes the removal of unreferenced text items.

Cleanup should therefore be run periodically to reduce wasted space in the RMS catalog.A recommended cleanup interval is approximately (1) month.

Note! All other users must logoff from RMS before executing this command.



RMSCOM Control CommandsCLEANUP RMS Command


INFO RMS Command

The INFO RMS command displays the RMS log format, or to display the schema history. Theschema history is updated whenever a new version of RMS is installed.

INFO RMS [,{ HISTORY } ] [ { OPEN } ]

Considerations

The HISTORY option causes RMSCOM to display the revision history of the catalog.This history provides a list of all versions of RMS which have managed the catalog andalso provides a record of the conversions of the catalog from one version of RMS toanother.

The OPEN option causes RMSCOM to display all users and processes using the currentRMS monitor.

C40-ER00034 The INFO RMS command displays the PROMPT status (ON or OFF) for DISTRIBUTE,ACQUIRE, FALLBACK and INSTALL. See ALTER RMS (5-2) and the ACQUIRE(12-4), DISTRIBUTE (12-12), FALLBACK (12-36) and INSTALL (12-47) commands.

INFO RMS Report Format

$RMP2:\ 5> info rmsINFO RMS LOG FORMAT EMS SECURITY "G" OWNER RMS.user CATALOG SUBVOL \DDS1.$ volume.subvolume USERCHANGE SUBMIT OFF USERCHANGE EXTRACT OFF LOG FILE \DDS1.$0 BANNER RMS MONITOR - D9020C40 - (15OCT95) PROMPT DISTRIBUTE OFF PROMPT ACQUIRE OFF PROMPT FALLBACK OFF PROMPT INSTALL OFF CHECK LANGUAGE OFF$RMP2:\ 6>

RMSCOM Control CommandsINFO RMS Command


C40-ER00119 Note! The INFO RMS command reports the options used when RMSMON is started, and the currentRMSMON processing information. The INFO RMS command in the Subsystem Programmatic Interface(SPI) returns the DRMS-MAP-DEF-SC and DRMS-MAP-DEF-SCPROCESS token maps containing thesupporting information for the above report. The reported STATE for RMSMON follows underConsiderations.

Considerations

STOPPED means that an RMS license has been revoked or expired, causing requestfailures.

STOPPING means that a SHUTDOWN RMS request has been issued.

PROCESSING is returned for all other conditions.

The reported START OPTIONS is not exactly what you had entered, but what was reallyderived from the actual options.

RMSCOM Control CommandsINFO RMS Command


OPEN Command

The OPEN command opens an RMSMON process.

OPEN rms-process

rms-process

is a valid local process name (e.g. $RMP) or a valid network process name (e.g.\SYS2.$RMP). The process must be an RMSMON process.

Considerations

The current RMSMON, if any, is closed.

When RMSCOM is started, an implicit OPEN $RMP occurs if no RMS process isspecified on the command line. If a process name is given, $RMP is replaced with thatname. The default monitor process can be overridden by the =RMS Guardian DEFINE.See DEFINE (D-5) for details.

RMSCOM ensures that the specified process is indeed an RMSMON process. It is notpossible, for example, to open a PATHMON process instead of an RMSMON processusing RMSCOM.


This command is not a protected command. As of the C10 version of RMS, any Tandemnetwork user is permitted to open an RMSMON process and to perform a limited set ofqueries. Restriction of this functionality can be performed using Tandem’s SAFEGUARDfacility. Please note that the OPEN command may be restricted in future releases of RMS.

C40-ER00050 Note! RMSCOM supports the .MESSAGE component. This component (typically an EXTERNAL SOURCEcomponent) specifies a file which will be copied to the current RMSCOM OUT file, when using theOPEN or GROUP commands. In other words, it displays the contents of the file when you runRMSCOM and use OPEN or GROUP. It also documents the catalog and how pieces of that catalog areto be used.



This enhancement is motivated by an effort to try and help users new to a catalog understandits contents by being self-documenting. For more information, refer to GROUP (6-38) andSpecial Components (1-3)

RMSCOM Control CommandsOPEN Command


SHUTDOWN RMS Command

The SHUTDOWN RMS command shuts the system down in an orderly manner.

SHUTDOWN RMS [ ! ]

!

closes RMS immediately without waiting for RMSCOM to stop.

Considerations

All servers, both static and dynamic, from all server classes are stopped (as if STOP SERVERcommands were issued). The RMSMON process is not actually stopped until all processingcurrently being done by RMSMON is completed and until all RMSCOM processes usingRMSMON have closed the process.



RMSCOM Control CommandsSHUTDOWN RMS Command


Notes:

RMSCOM Control CommandsSHUTDOWN RMS Command


66 Component Commands

This section describes the commands relevant to the management of components within theRMS system.

The following commands are relevant to components:

Table 6-1 Component Commands Summary

Command Description

ADD COMPONENT Creates a new component.

ADD USERCHANGE Creates a new user-change name.

ALTER COMPONENT Changes attributes or the location of a component.

ALTER USERCHANGE Changes attributes of a user-change name.

ALTER VERSION Changes attributes of a version.

BROWSE Brings up an editor to scan one or two component versions.

CONDENSE Combines several versions into one version.

DELETE COMPONENT Removes an unused component.

DELETE USERCHANGE Removes an unreferenced userchange name.

DELETE VERSION Removes unneeded versions of components.

DIFFERENCES Compares two versions of a component and produces a report ofthe differences.

DISCONTINUE VERSION

Permanently denies usage access to specific component versions.

EXTRACT Examines or signs out a component for modification.

GROUP Changes the current default RMS group.

INFO COMPONENT Obtains information about components.

INFO SSV Obtains information about the current search subvolumedefinitions.

INFO USERCHANGE Obtains information about user-change names.

INFO VERSION Obtains information about ranges of component versions.

Component Commands


LINK COMPONENT Makes a component visible within multiple groups.

LINK VERSION Associates a version with a user-change name.

LIST LOCK Displays current user locks on a component.

LOCK Locks a version of a component as if an EXTRACT FOR EDITwas done.

MAP Displays the heirarchical structure of a group component.

OBSOLETE Removes obsolete versions of a component.

RENUMBER Changes version numbers for a component.

RESET COMMENT Clears the current SUBMIT comments.

RESET COMPONENT Resets component attributes to their defaults.

RESET SSV Clears a search subvolume entry.

ROLLOUT Rolls out changes from latest versions.

SET COMMENT Specifies a persistent SUBMIT comment.

SET COMPONENT Specifies new defaults for component attributes.

SET EXTRACT Specifies component extract parameter defaults.

SET IMAGE Specifies basis information for component selection.

SET SSV Specifies a new search subvolume or replaces an existing one.

SET SUBMIT Specifies component submit parameter defaults.

SHOW COMMENT Displays the current SUBMIT comment.

SHOW COMPONENT Displays the current component attribute defaults.

SHOW EXTRACT Displays the component extract parameter defaults.

SHOW SUBMIT Displays the component submit parameter defaults.

SUBMIT Creates a new version of a component.

UNLINK COMPONENT Removes a component from a group.

UNLINK VERSION Removes a relationship between a version and a user-changename.

UNLOCK COMPONENT Removes extraneous EXTRACT copies and locks on acomponent.

Component Commands


ADD COMPONENT Command

The ADD COMPONENT command creates a new entry in the catalog for a component orgroup.

ADD COMPONENT comp-path[ , TYPE [ { EXTERNAL} ] [ { DATA } ] ] ...[ [ { NORMAL } ] [ { DOCUMENT } ] ][ [ { GROUP } ] ][ [ { KEYED } ] ][ [ { OBJECT } ] ][ [ { SOURCE } ] ][ , FILE file-name ][ , DEFINE define-name ][ , LANGUAGE RMS-language ][ , DESCRIPTION " 80-char-string " ][ , GROUP comp-path ][ , TRIGGER " trigger-char " ][ , INCREMENT edit-line-number ]

comp-path

is the fully- or partially-qualified path name of the component to add.

EXTERNAL

sets the mode of the component to external. Used for creating components notcontrolled by RMS.

NORMAL

sets the mode of the component to normal, the default.

SOURCE

creates a source component.

OBJECT

creates an object component.

DOCUMENT

creates a document component, one which will not be compiled.

GROUP

creates a logical group component.

Component CommandsADD COMPONENT Command


DATA

creates a data file component.

KEYED

creates a keyed data file component.

FILE file-name

the fully-qualified path name of the file in a managed location.

DEFINE define-name

an alias to be used in a source component for compilation purposes.

LANGUAGE RMS-language

the source language of the component, if one exists.

DESCRIPTION "80-char-string"

an 80 character string to describe the component.

GROUP comp-path

the GROUP parameter superceeds the default group using the GROUP command. Notethat the GROUP command resets this parameter.

BUGFIX { ON | OFF }

Is not relevant for the add component command even though it can be specified. SeeALTER COMPONENT (6-14).

TRIGGER "trigger-char"

the default trigger character used during component submission. If this parameter is notspecified, no trigger character is assumed.

INCREMENT edit-line-number

the EDIT line number increment used during component extraction and compilation. Thedefault increment is 1.000. The recommended default for SQL source components is10.000.



Considerations

The ADD COMPONENT command adds a new component entry in the RMS catalog in thespecified group.

The following conditions are necessary for an ADD COMPONENT to succeed:

There must not be any other component in the catalog with the same physical file name.

For NORMAL components: the physical file cannot exist before the add componentunless its file type and file code are the same as the new component’s (e.g.type=UNSTRUCTURED, code=2101 for source components) and its end-of-file iszero(0).

For EXTERNAL components, the physical file must already exist.

There can be no other component in the group which has the same logical name,comp-path, as the one being added.

There can be no other component in the group which has the same base file name (last 8characters) as the component being added.

The user must have sufficient privileges to add the component.

If a define name is supplied then define-name must be unique with respect to the entirecatalog.

C40-ER00103 RMS allows abstraction components (SRCLIB, DATALIB) to be created withinDDLDICT groups. The restrictions still apply for other abstracion types (SRCLIBs can’tbe created within SRCLIBs).

Note! For more information, see segmented source libraries (1-26) considerations

Considerations for Data Files

Alternate-key index files for structured files are not retained in the RMS archive. Thesefiles must be reconstructed during the release installation process. This can beaccomplished using either the RMSALTFB utility or FUP LOADALTFILE.

Data files can be submitted to RMS in the same manner as other components. Versionidentification is based entirely on the last modification time of the file being submitted.Submitting older versions of a data file component will not cause such versions to beconsidered at the LATEST state. Submitted versions of a Data file component can bedeleted with DELETE VERSIONS. See DELETE VERSIONS (6-24) for moreinformation.



Considerations for Keyed Data Files

The KEYED component type represents Guardian key-sequenced files. This type ofcomponent uses delta technology to represent the component’s versions instead of archiveentries (as with type DATA components). Alternate-key index files for these componentsare not explicitly retained in the RMS archive, even though they are preserved in the file’sattributes. These files must either: (i) be reconstructed during the release installationprocess; or (ii) be managed as separate components.The first option can be accomplishedusing either the RMSALTFB utility or FUP LOADALTFILE. The alternate-key fileattribute on the extracted file will use the same subvolume as the extracted file.

KEYED components are stored in Enscribe entry sequenced files with file code 2102. AllGuardian file attributes are supported except for partitioning information. This type ofcomponent can be used in a compilation, but cannot be produced. Version numbering isthe same as for source components. Submitted versions of a KEYED component can bemanaged with ROLLOUT, CONDENSE and OBSOLETE.

C40-ER00092 Considerations for DATALIB Components

see the Considerations for Keyed Data Files above.

the component attribute .KEY-DESC must exist in order to submit a DATALIBcomponent. For more information, see the Submit Considerations (6-85) and.KEY-DESC(1-35).

See .DATA-DESC (1-36).

See a complete overview of DATALIBs (1-33).


This command is subject to inherited security attributes.

The user must have MODIFY access at state "*" to the group of the new component inorder for the add to succeed.

Group Considerations

Since all components, with the exception of releases, are considered groups (e.g., anobject component may have children components which are its sources), adding newgroups is relatively straightforward.

Groups, however, do not have corresponding physical file names or define names.

Release Considerations

Components can be added directly to releases without being part of the normalcomponent hierarchy. Such components are release specific. Otherwise such componentsare treated normally.



Components can only be added to a release if the release is not FROZEN. Only newreleases or releases which have had a THAW RELEASE CONTENTS command issuedwill permit component additions.

Language Considerations

The following languages are supported by RMS:

Table 6-2 Supported Language Settings

BINDER Binder scripts.

C C programming language source.

C-ANSI C language for portable programs.

C40-ER00036

CBL-ANSI Equivalent to the COBOL language processor, except that theinitial settings for the language are ANSI mode (starting columnis 7 and identification fields can be used).

COBOL COBOL 85 programming language source.

COBOL74 COBOL74 programming language source.

C40-ER00092

DATALIB Segmented keyed data library group.

DBOL Databus programming language source.

DDL Data Definition Language source.

DDLDICT Data Dictionary groups.

DEFINE General source supporting Guardian DEFINEs.

DEFINEOP Alternate to DEFINE with optional DEFINE processing.

FORTRAN FORTRAN programming language source.

MUMPS MUMPS programing language source.

PASCAL PASCAL programming language source.

PNA Programmatic Network Administrator RDL source.

PNALIB PNA Rule Database groups.



SCOBOL Screen COBOL programming language source.

C40-ER00037

SQLCOBOL Allows better documentation of COBOL sources. Functionallyequivalent to COBOL. All language parsing is the same.

SRCLIB Segmented source library groups.

TAL Tandem Application Language source.

TBOL SyBOL programming language source.

TCLPROG PATHWAY TCLPROG file groups.

TEMPLATE DSM Template language source.

TGAL TGAL text formatting language source.

Note! Consult on-line help for current updated list.

C40-ER00035 Note! ADD COMPONENT validates known RMS languages. It will return errors or warnings depending onhow RMSMON is configured. The ALTER RMS CHECK LANGUAGE command validates theselanguages. For more information, see ALTER RMS (5-2).

C40-ER00077 Note! RMS has another component type called VOLATILE BLOB (Binary Large OBject). The VOLATILE classof components are those for which RMS will not manage dependencies. These differ from EXTERNALcomponents which have versions represented in the catalog.

VOLATILE BLOBs are processed during release transport operations. They are always moved with arelease during distribution and installation. They appear in release manifests without version entries.They are never purged during any release cleanup operation. The key purpose of these components isto include nonmanaged files on distribution tape, although that is by no means the only application.

Be aware that the ALL option for distribution will not automatically pick up subvolumes in whichVOLATILE BLOBS are stored. These components are most useful if specified directly in release librarysubvolumes.



Component Parameter Requirements

Table 6-3 Add Component Requirements

Type File Lang-uage

Define Desc Group Trigger Incre-ment

Source Source req.

Document Document req.

Object Object req. n/a n/a

Data File Data req. n/a n/a

Keyed Keyed req. n/a n/a

Group Group n/a n/a n/a n/a n/a

Source Library Group req. n/a n/a

Source Library Section Source n/a

DDL Dictionary Group Sub-volume

ddldict n/a n/a

SCOBOL TCLPROG Group req. tclprog n/a n/a

SCOBOL Run Unit Object n/a scobol n/a n/a

PNA Rule Database Group req. pnalib n/a n/a

PNA Rule Object n/a pna n/a n/a

External Component any req. n/a n/a

Data Library Group req. datalib n/a n/a

Data Library Member KEYED n/a n/a n/a

Note! Data Library and Data Library Member were added with C40-ER00092.

The parameters in the above table can be specified using either the ADD COMPONENT orSET COMPONENT command. Parameters indicated with a n/a must not be specified in eithercommand.



Valid Component Names

Component names can be up to 32 characters long and consist of the following ASCIIcharacters:

letters A .. Z

numbers 0 .. 9

special characters ".", "_", "-", "^"

Component names must begin with a letter or a period (.). All component names beginningwith a period have special meaning to RMS (e.g., .FILE-HEADER or .DEFAULTS insegmented source libraries) and are reserved. Like variable names in source programs,component names should be meaningful to the user. Often, they will end up being similar tothe corresponding Tandem file names if the latter have also been chosen meaningfully. Thisshould not cause confusion so long as you remember that the two names (thecomponent-name and tandem-file-name) are independent of each other. Do not usecomponent names with an embedded period (e.g., ABC.123).

Note! If you are communicating with the RMS Monitor through SPI, component names will not bevalidated. Your interface will need to perform the validation.

Make sure the component names conform to RMSCOM standards. If they don’t, some componentsmay not be deletable or queriable.

Add Component Examples

Adding a source component:

RMS) ADD COMPONENT \APPL\SRC\SERSRC,TYPE SOURCE,LANG TAL,FILE &$vol.subvol .servtal

Adding an object component:

RMS) ADD COMPONENT \APPL\OBJ\SERVOBJ,TYPE OBJECT, FILE &$vol.subvol. servobj

Adding a SCOBOL TCLPROG and run unit:

RMS) ADD COMPONENT \APPL\TCLPROG,TYPE GROUP,LANG TCLPROG, FILE &$vol.subvol .pobj



Adding a segmented source copy library:

RMS) ADD COMPONENT \APPL\SRC\COPYLIB,TYPE GROUP,LANG SRCLIB, &FILE $ vol.subvol.copylib

C40-ER00092 Adding a DATALIB component:

RMS)ADD COMPONENT \APPL\SRC\DATALIB,TYPE GROUP,LANG &DATALIB, FILE $ vol.subvol.datalib

Alternate Temporary Work Locations

RMS COMPILE supports alternate temporary work areas organized by group. Locations canbe added to specify work locations. These locations follow the same basic format as theRMS-TEMP locations in the \LOCATIONS group, which is still in effect if no group templocation is present.

Your default subvolume is still the default work location. The locations in the second half ofTable 6-4 can be added and are inherited to subgroups.



ADD USERCHANGE Command

The ADD USERCHANGE command adds a user change reference entry that may be used toassociate one or more component changes with some external document or process.

ADD USERCHANGE ["] user-change-name ["]

user-change-name

The user change name can consist of any characters, but it may not begin with a blank andmust be less than 33 characters in length. If the last character of the user change names is aquestion mark (?), user-change-name is considered a template, as described below.

Considerations

Associated with a user change is a block of text that is entered after the ADDUSERCHANGE command. This block of text is terminated by a line with just // in thefirst two positions of the line.

A quoted user change name is case sensitive. Special characters are only allowed if theuser change name is quoted. Unquoted user change names are not case sensitive.

The keyword PCR is a valid alias for USERCHANGE.

Adding a userchange causes a SET SUBMIT USERCHANGE "user-change-name" and aSET EXTRACT USERCHANGE "user-change-name".

Adding a userchange causes the current comment to be reset.

Automatic Allocation of User Change Names

RMS provides a mechanism for automatically assigning new user change names. In thefollowing example:

Examples

The first example adds a user change name which defines the layout of the user change name:

RMS) ADD USERCHANGE A000001+ This is the first user change assigned.+ //USERCHANGE A000001 ADDED

Component CommandsADD USERCHANGE Command


The second add tells RMS to look for the last user change beginning with A and to assign anew value based on that last value:

RMS) ADD USERCHANGE "A?"+ This is the second+ // USERCHANGE A000002 ADDED

Many such user change names can simultaneously co-exist within RMS. For example,you may have "A-series", "B-series", "ERROR-series", etc., all within one catalog.

RMS is able to handle both letters and numbers. Upper case letters cycle from A throughZ, while numbers cycle from 0 through 9. Both upper and lower case letters are supportedand case is significant.

The assigned user change number is always reported after the user change is successfullyadded.


Component CommandsADD USERCHANGE Command


ALTER COMPONENT Command

The ALTER COMPONENT command changes the value of attributes of a component.

ALTER COMPONENT comp-path, { RESET DEFINE } { RESET DESCRIPTION } { RESET LANGUAGE } { DEFINE define-name } { DESCRIPTION " 80-char-string " } { GROUP comp-path } { LANGUAGE RMS-language } { NAME new-comp-name } { FILE file-name } { BUGFIX { ON | OFF } } { TRIGGER " trigger-char " } { INCREMENT edit-line-number }

comp-path

is the component path name to alter.

RESET DEFINE

clears a define name.

RESET DESCRIPTION

clears a description.

RESET LANGUAGE

clears the language setting.

DEFINE define-name

updates or creates a define name for the component.


updates or creates a description for the component.

GROUP comp-path

changes the parent group of the specified component.


updates or creates a language entry for the component.

Component CommandsALTER COMPONENT Command


NAME new-comp-name

is the new name of the component in the component’s current group. You cannot move acomponent to a different group using this option.

FILE file-name

is the new fully-qualified path name of the file in a managed location.

BUGFIX { ON | OFF }

controls the bugfix flag associated with the component.


is the new default trigger character used during component submission.


is the EDIT line number increment used during component extraction and compilation.The default increment is 1.000. The recommended default for SQL source components is10.000.

Note! If you are communicating with the RMS Monitor through SPI, component names will not bevalidated. Your interface will need to perform the validation.

Make sure the component names conform to RMSCOM standards. If they don’t, some componentsmay not be deletable or queriable.

Considerations

A define name may not be reset if there are any extracted copies of the component.

A define name must be unique across the entire catalog.

The file name may not be reset for a component. A file name may not be added to a groupor release component. RMS takes care of moving all files which may be associated with acomponent.

If a bugfix version is submitted, the BUGFIX flag is turned on. Warning 1003 will bereturned if this flag is on. You should turn off this flag only when you have either rolledthe bugfix version into LATEST or chosen to ignore the post-development change.

The GROUP option can only be used if the specified component, comp-path, is alreadylinked into the group indicated by comp-path. There are different security considerationsfor this command if the GROUP option is used. See Security Commands (9-1) for moreinformation.



C40-ER00018 Note! ALTER COMPONENT restricts the ability to change the actual parent group component for segmentedlibrary sections. This command will report errors if you try to alter the parent group of a section or unlinkthe section from its parent. Alternate links are not affected by this change.

C40-ER00035 Note! ALTER COMPONENT validates known RMS languages. It will return errors or warnings depending onhow RMSMON is configured. The ALTER RMS CHECK LANGUAGE command validates theselanguages. For more information, see ALTER RMS (5-2).

C40-ER00056 Note! ALTER COMPONENT prohibits the modification of the root (\) and \RELEASES components. Neitherthis command nor DELETE COMPONENT will operate on those components and both will return error2049 if those components are supplied.

C40-ER00075 Note! There are different semantics for ALTER COMPONENT renames. Renames are possible unless thecomponent is a member of a source library, data library, a TCLPROG (and has a version) or a PNAlibrary (and has a version).

C40-ER00077 Note! RMS has another component type called VOLATILE BLOB (Binary Large OBject). The VOLATILE classof components are those for which RMS will not manage dependencies. These differ from EXTERNALcomponents which have versions represented in the catalog.

VOLATILE BLOBs are processed during release transport operations. They are always moved with arelease during distribution and installation. They appear in release manifests without version entries.They are never purged during any release cleanup operation. The key purpose of these components isto include nonmanaged files on distribution tape, although that is by no means the only application.

Be aware that the ALL option for distribution will not automatically pick up subvolumes in whichVOLATILE BLOBS are stored. These components are most useful if specified directly in release librarysubvolumes.



ALTER USERCHANGE Command

The ALTER USERCHANGE command changes either the name or associated text of a userchange.

ALTER { USERCHANGE | PCR } ["] user-change-name ["] { , [ NEW [ " ] user-change-name ["] } ... { , [ TEXT [ FROM file ] }

user-change-name

is the name of the user change that is to be altered.

NEW user-change-name

specifies a new name for the user change.

TEXT

specifies that the text associated with a user change is to be replaced. The text is specifedafter the ALTER USERCHANGE command and is terminated with a line consisting ofjust // in the first two positions of the line.

FROM file

instructs RMSCOM to load the text associated with a user change from the specified fileinstead of the standard input file.

Considerations

A quoted user change name is case sensitive. Special characters are only allowed if theuser-change name is quoted. Unquoted user-change names are not case sensitive.


Component CommandsALTER USERCHANGE Command


ALTER VERSION Command

The ALTER VERSION command changes either the user change name or associated text of aversion of a component.

Note! The USERCHANGE and RESET USERCHANGE parameters have been superseded as of releaseC31.16. See LINK VERSION (6-51) and UNLINK VERSION (6-97)

ALTER VERSION comp-path : version-specifier , { USERCHANGE [ " ] user-change-name [ " ] } { RESET USERCHANGE } { TEXT } ...

comp-path

is the full- or partially-qualified name of the component to be altered.

version-spec

is a version of comp-path or a valid state name.

user-change-name

is the user change that is to be associated with the version.

RESET USERCHANGE

causes an existing user-change name to be removed from the specified version.

TEXT

specifies that the text associated with the specified version is to be replaced. The text isspecifed after the ALTER VERSION command and is terminated with a line consisting ofjust // in the first two positions of the line.

Considerations



This command is particularly useful after a CONDENSE command.

Component CommandsALTER VERSION Command


BROWSE Command

The BROWSE command examines the contents of one or two components without extractingthem. It brings up an editor to scan them instead.

BROWSE comp-path [ : version-specifier ] [ , extract-options ] [ + comp-path [ : version-specifier ] [ , extract-options ] ]

comp-path

are the names of the components to be browsed.

version-specifier

are the version numbers or states that are to be examined.

extract-options

are any of the extract options described in EXTRACT (6-33).

Considerations

Even though any extract option is supported, extracts are always done using the FORREAD mode. If a specific format is desired, use the FORMAT extract option.

The second browse component is only relevant on terminals which can be run in blockmode.

BROWSE starts a TEDIT session on block mode terminals and EDIT on conversationalmode terminals. There is no particular relevance to the file names presented to the editors.For TEDIT, window 1 refers to the first component specified, while window 2 refers tothe second. The files are opened using read-access only. Any changes made to these filesare ignored by TEDIT and RMS.

If the terminal port is not configured as a block mode terminal, only one file can bescanned.

Component CommandsBROWSE Command


CONDENSE Command

The CONDENSE command collapses the revision history associated with unneeded distinctversions of a SOURCE, DOCUMENT or KEYED component.

Warning! This command disables access to any distinct change made at a version being condensed. No changesare lost, however. You are simply unable to refer to a collapsed version independently. Do not use thiscommand unless you really intend to remove access to parts of your revision history.

Danger! All bugfix versions (e.g. 1.2.0.1) which are in the range being collapsed are lost during the CONDENSEcommand. If you wish to preserve post-development changes in this range, you must merge thechanges into later versions.

CONDENSE comp-path : low-version TO high-version

comp-path

is the fully- or partially-specified name of the component for which version history is to beremoved.

low-version

is the lowest version (e.g. 1.002) from which history is to be condensed.

high-version

is the highest version (e.g. 1.005) to which history is to be condensed. This version willexist after the CONDENSE terminates and will contain all changes made from versionlow-version through high-version inclusive.

Considerations

This command removes version entries to the point specified from the low-version up tobut not including high-version.

There can be no dependencies on any of the versions that you are condensing other thanhigh-version.

There can be no explicit links referring to any of the versions that you are condensingother than high-version.

None of the versions being condensed, other than high-version, can appear in any versionof a release or can be used by versions or components appearing in a release.

Component CommandsCONDENSE Command


You are not permitted to CONDENSE across state boundaries.

This command applies only to SOURCE, DOCUMENT and KEYED components. Usethe DELETE VERSIONS command to remove versions of other types of components.

Security Considerations

You must have MODIFY access to the component to perform this command.

Example

If \A\B\SRC has versions 1.000, 1.001, 1.002, 1.003, and 1.004:

CONDENSE \A\B\SRC:1.1 TO 1.3

removes versions 1.001 through 1.002 and packs the changes into 1.003.

Component CommandsCONDENSE Command


DELETE COMPONENT Command

The DELETE COMPONENT command removes an entry in the catalog for a component orgroup.

DELETE COMPONENT { comp-path | "*" }

comp-path

is the name of the component or group to delete.

"*"

refers to all components in the group.

Considerations

If the component is referenced by any other component it cannot be deleted.

If the component is part of a release it cannot be deleted.

If the component is a dependent of any other component it cannot be deleted.

Any file or files associated with the component (e.g. CODE 2101 source files) will bedeleted.

Note! Make sure the component names conform to RMSCOM standards. If they don’t, some componentsmay not be deletable or queriable.

C40-ER00056 Note! DELETE COMPONENT prohibits the modification of the root (\) and \RELEASES components. Neitherthis command nor ALTER COMPONENT will operate on those components and both will return error2049 if those components are supplied. DELETE COMPONENT will also not accept a wild-carddeletion at the root component to prevent accidental deletion of reserved component groups.

Note! If you delete the current group, you will remove that group. You can’t resolve further components untila new group is selected using the GROUP command.

Component CommandsDELETE COMPONENT Command


DELETE USERCHANGE Command

The DELETE USERCHANGE command removes a user change entry from the catalog.

DELETE USERCHANGE [ " ] user-change-name [ " ]

user-change-name

consists of any characters, but it may not begin with a blank and must be less than 33characters in length.

Considerations

A quoted user-change name is case sensitive. Special characters are only allowed if theuser-change name is quoted. Unquoted user-change names are not case sensitive.

If the user-change is referenced in any version of any component then it may not bedeleted.


C40-ER00086 Note! You can use DELETE USERCHANGE to perform delete integrity checks to prevent accidentaldeletions. The checks are:

ù No PCR which is linked to a release can be deleted.ù No PCR which has associated versions can be deleted unless it is in an OBSOLETE state.

Component CommandsDELETE USERCHANGE Command


DELETE VERSIONS Command

The DELETE VERSIONS command removes non-referenced versions of object and datacomponents.

DELETE [ / TERM home-terminal /] VERSIONS comp-specifier [ : version-specifier ] [ , { ARCHIVE } ] [ { KEEP LATEST } ]

home-terminal

is used by RMS in case an auxilliary process (e.g., SCUP) is used to delete a version.

comp-specifier

is the name of the component for which the versions should be removed. It can bespecified as either a component name or a pattern including "*". * is used to deleteversions of all components in a group. comp-specifier can be prefixed by a componentpath to operate on components in a group other than the default group.

version-specifier

is a version of comp-specifier or a valid state name for which versions should be removed.

ARCHIVE

causes only the ARCHIVE copy of the version of the component to be removed. Theactual version history, including compile information, is retained.

KEEP LATEST

causes the LATEST version of the component to be retained.

Considerations

This command is only allowed for object and data components.

The version must not be a dependent of any other component.

The version must not be referenced in any release.

If version-specifier is specified as "*" then all versions which can be deleted are removed.

Remember that any archive entries which correspond to the versions are also purged.

The ARCHIVE option is only applicable for compiled versions of components. Youcannot remove the archive entries for uncompiled components without deleting thecorresponding versions.

Component CommandsDELETE VERSIONS Command


C40-ER00107 Note! The DELETE VERSION command performs a LOCKFILE on the DEPREL file before trying to delete aversion of a component. This is in anticipation of large volumes of dependencies being deleted when aversion of a DDLDICT group or DATALIB group is deleted.

Concurrent operations with DELETE VERSION may be impacted.

Component CommandsDELETE VERSIONS Command


DIFFERENCES Command

The DIFFERENCES command lists all changes between two versions of a component.

DIFFERENCES [ / OUT list-file / ]{ comp-path [ : base-version ] }

{ FILE old-file } [ TO { [ COMPONENT alternate-path ]

[ : end-version ] } ] [ { FILE new-file } ] [ , diff-options ] ...

list-file

is the name of the file to list the differences to. If it is not provided the current out file ofRMSCOM is used.

comp-path

is the name of the component to be used as the "old" component in the differencescomparison.

alternate-path

is the optional name of the component to be used as the "new" component in thedifferences comparison. If this parameter is not specified, the comparison is done betweentwo versions of comp-path.

base-version

is the version of the component to use as the base version for comparison purposes.

end-version

is the version of the component to use as the end version for comparison purposes. It doesnot have to be greater than the base-version. If end-version is not specified, LATEST isassumed.

old-file

is the Tandem file name of a disk file which is to be used as the "old" component insteadof comp-path.

new-file

is the Tandem file name of a disk file which is to be used as the "new" component insteadof alternate-path.

Component CommandsDIFFERENCES Command


diff-options

is any of the following in a comma separated list:

LISTING

is the standard report form.

SCRIPT

produces an EDIT compatible list of commands to convert from the first version to thesecond.

SIDEBYSIDE

produces a two-column comparative report of the differences between the twospecified versions.

CONTEXT num-lines

causes num-lines source lines before and after each difference to be shown on thereport to help with the identification of the context of the change. This option only haseffect for the LISTING and SIDEBYSIDE report formats.

VERBOSE

causes all lines in the source files to be output. Differences are still identified in thelisting.

SUMMARY

produces a report of the number of changes.

WIDTH num-columns

specifies the maximum size of the differences report output. Normally, num-columns isderived from the record length of the output device specified by out-file.

IGNORE CASE

causes differences between upper and lower case characters to be ignored.

IGNORE BLANKS

causes differences in blank spacing to be ignored.

EDITLINE

modifies the output of the SCRIPT listing to use EDIT line numbers rather than thedefault ordinal line numbers.



C31-ER00143 FORMAT EDIT

causes the component to be extracted for differences using the format normally usedwhen extracting FOR EDIT, regardless of the actual extract mode.

FORMAT READ

causes the component to be extracted for differences using the format normally usedwhen extracting FOR READ.

FORMAT COMPILE

causes the component to be extracted for differences using the format normally usedwhen extracting FOR COMPILE.

FORMAT DEFINE

causes the component to be extracted for differences with optional defines as specifiedwith ADD COMPONENT. If there is no user-specified define, then theRMS-generated define is used.

FORMAT FILE

causes the file name of the referenced component to be placed in the output.

Note! If the component is COBOL source with ANSI or COLUMN directives, the command may fail if there isnot enough room to expand the define into a fully-qualified filename.

Considerations

The order of versions in the DIFFERENCES command is not significant. New-versioncan actually precede old-version.

New-version and old-version can be specified as state names, version numbers, ordate-form version numbers.

The report formats are subject to change without notice. Please try the various optionsand formats. The DIFFERENCES command is non-destructive and will not modify thecatalog in any way.

There are some key identifiers in the difference reports:

i Refers to inserted lines.

d Refers to deleted lines.

n Indicates that the change is from the newer version (the "TO" version).

o Indicates that the change is from the older version.



Difference Command Examples

To obtain the differences between the old and new versions of a source componentCREATTAL use the following command:

RMS 21) DIFFERENCES CREATTAL:2.40 TO 1.05

To obtain the differences between the latest and production versions of a source componentCRYPTTAL use the following command:

RMS 22) DIFFERENCES CRYPTTAL:LATEST TO PROD

To obtain the differences between a version of a component and a file on disk, use thefollowing command TALSRC:

RMS 23) DIFFERENCES TALSRC:1.5 TO FILE $DATA.MYSRC.TALSRC

C40-ER00092 Note! The DIFFERENCES command supports KEYED and DATALIB components, but only in the file format.This means that the versions must be extracted to temporary files on which the DIFFERENCEScommand will operate.

DIFFERENCES FILE $ file-name TO FILE $ file-name

The DIFFERENCES command options are not supported. The listing format is similar to theoutput produced by:

FUP COPY file ,HEX


The user must have READ access to both versions of the component in order to do aDIFFERENCES command.



C40-ER00094 Note! DIFFERENCES supports a default dependency difference analysis for component types which are notexplicitly handled (SOURCE, DOCUMENT, MANIFEST, KEYED) by the DIFFERENCE engine. Thisincludes OBJECT components.

External and recursive comparisons are not supported.

Considerations

The DRMS-ERR-UNSUPPORTED error (1000) will be reported where there are nodependencies and where the component types aren’t supported.



DISCONTINUE VERSION Command

C40-ER00109 The DISCONTINUE VERSION command permanently denies usage access to specificcomponent versions. It operates the same way as DISCONTINUE RELEASE in thatdependencies from the discontinued version are removed as are compilation history records.

DISCONTINUE VERSION component-path : version-number

component-path

is the fully-qualified path name of the component.

version-number

is the version number which you would like to discontinue.

Note! While the version can’t be used, RMS preserves the modification history. Dependencies from thatversion are removed.

The following conditions must be satisfied to allow the operation:

the version must not have dependencies to it

the version must not be at a state

the component must not have any locked versions

the version must not be linked explicitly.

The following operations are prohibited on discontinued versions:

extracting for edit or work (unless the version is LATEST)

locking (unless the version is LATEST)

promoting

demoting

freezing a release using that version

condensing with the high version being discontinued

compiling a new version of an object using a discontinued version.

Note! The LATEST version of a component cannot be discontinued.

Component CommandsDISCONTINUE VERSION Command


C40-ER00113 DISCONTINUE VERSION With Links

The DISCONTINUE VERSION command is permitted on versions that are explicitly linkedinto releases. However, these versions cannot be frozen into those releases. This retainsreleases for historical purposes without having to modify linkages associated with thosereleases in order to discontinue versions.

Component CommandsDISCONTINUE VERSION Command


EXTRACT Command

The EXTRACT command extracts a file or set of files.

EXTRACT comp-specifier { [ : LATEST ] } { [ : state -name ] } { [ : version - specifier ] } TO file-patt [, extract-options ] ...

comp-specifier

is either a component name or "*" or component pattern. * is used to extract allcomponents in a group. comp-specifier can be prefixed by a component path to extractcomponents in a group other than the default group.

LATEST

is used to extract the latest version of the specified components. It is the default if nostate-name, or version-specifier are specified.

state-name

is the state of the component desired.

version-specifier

is a specific version of the specified components.

file-patt

is a file pattern that specifies the name of the files where the specified components are tobe extracted. If "*" is specified in any position of the file pattern, the corresponding valuefrom the component file name is used.

extract-options

is one or more of the following options:

PURGE [ { ON | OFF } ]

purges any existing file prior to extracting component.

FOR EDIT

extracts the component placing a lock on the version extracted, so no other user canmake changes to it.

Component CommandsEXTRACT Command


FOR READ

extracts a read-only copy of the component.

FOR COMPILE

extracts the file for external compile. Compilation files in RMSMAKE format are alsoprovided.

FOR WORK

extracts the file for modification with shared locks. This option allows simultaneousupdates of the file.

FORMAT READ

causes the component to be extracted using the format normally used when extractingFOR READ, regardless of the actual extract mode.

FORMAT COMPILE

causes the component to be extracted using the format normally used when extractingFOR COMPILE, regardless of the actual extract mode.

FORMAT EDIT

causes the component to be extracted using the format normally used when extractingFOR EDIT, regardless of the actual extract mode.

FORMAT DEFINE

causes the component to be extracted with optional defines as specified with addcomponent. If there is no user specified define then the RMS generated define is used.

FORMAT FILE

causes the file name of the referenced component to be placed in the output. SeeQUALIFY (6-35).

C40-ER00083 APPEND [ { ON | OFF } ]

controls whether data is appended to an existing file during extract processing.Normally, the file is either purged or overwritten. This option allows data to beappended instead. The PURGE option (and in SPI the DOVERWRITE-EXISTINGfield) must be set to FALSE for this option to take effect. The SPI field is calledDAPPEND-EXISTING. The initial support for this option is limited to childcomponents of type GROUP, language DATALIB.



QUALIFY

is used to control how much of the RMS managed file name is to appear in the outputand is only relevant for FORMAT FILE or FOR READ extracts. Level is one of:

SYSTEM Is the fully-qualified network filename.

VOLUME Is the local format filename.

SUBVOL Is the subvolume name.filename.

FILE Is the unqualified name.

USERCHANGE [ " ] user-change-name ["]

provides a previously created user-change-name to be associated with the submit. Ifthe user-change-name contains special characters it must be enclosed in quotationmarks. If it is enclosed in quotation marks it is case sensitive.

Note! All format options are not applicable to extracts of KEYED and DATALIB components. The FORCOMPILE option is also irrelevant for these component types.

Considerations

If the extract is FOR READ or FORMAT READ then macro substitution is carried out.

If the extract is not FOR COMPILE or FOR EDIT, and not FORMAT COMPILE orFORMAT EDIT, then all component file names are converted from an internal defineformat to an external file name form. Otherwise, the component file names arerepresented as GUARDIAN DEFINEs. The form of the DEFINEs depend on whether theDEFINE attribute of the component is specified and the EDIT and FORMAT mode. If aDEFINE is specified, it is used to represent the component. Otherwise, a DEFINE of theform =RMS_COMPcomp-number is generated (e.g., =RMS_COMP0000001342).

The extract operation will fail if an RMSUBMIT server is not available.

The user must have sufficient security to perform the requested operation.

If the extract is not FOR READ or FOR COMPILE, a lock is placed on the versionextracted to prevent other users from making simultaneous changes.

Warning! If the extract is FOR EDIT, FOR WORK, FORMAT EDIT, then the macro and parameter substitution isnot carried out, under the assumption that the version will be resubmitted to RMS. This could result inerroneous information being included in the version if it is used for compilation purposes. Careshould be taken if a compile-type operation is done on components which are extracted in this manner.

Extracts FOR EDIT cause an EDIT lock to be placed on the extracted version of thecomponent. The EDIT lock remains in place until either a SUBMIT or an UNLOCK ofthe extracted version is performed by the user.



Extracts FOR WORK cause a WORK lock to be placed on the extracted version of thecomponent. The WORK lock remains in place until either a SUBMIT or an UNLOCK ofthe extracted version is performed by the user. The WORK lock differs from the EDITlock because it allows other users to also extract the locked version FOR WORK. RMSrecords all WORK locks. You are only allowed to SUBMIT the component when there isonly one WORK lock on the extracted version. The WORK lock mechanism enforcescooperation between developers when simultaneous changes are being made. You canonly perform submission when all developers have agreed to allow the submission.Such agreements are communicated to RMS through the UNLOCK command. Generally,developers will use the RMSMERGE facility to merge all simultaneous changes into onefile, test those changes using RMSMAKE, and then do the submit. It is preferable torequire consent from developers working on modules locked FOR WORK, rather thanrisking the loss of potentially critical changes.

Table 6-4 Summary of Differences Between Extract Modes

FOR READ(default mode)

FOR EDIT FOR COMPILE FOR WORK

No locks added EDIT lock added No locks added WORK lock added

Version macrosexpanded (FORMATREAD)

Version macros notexpanded

Version macrosexpanded (FORMATCOMPILE)

Version macrosexpanded (FORMATEDIT )

File referencesexpanded (FORMATREAD)

DEFINEs notexpanded (FORMATEDIT )

DEFINEs notexpanded (FORMATCOMPILE)

DEFINEs notexpanded (FORMATEDIT )



C40-ER00084 Note! The regular expression pattern processor for component names, location names, userchange identifiersand auxiliary attribute names supports pattern groups. If the first character of a pattern is "{" this featureis turned on. These sample groups illustrate their use:

INFO COMP \APPL\{ABC*|DEF*}

matches all components beginning with ABC and DEF in group \APPL.

INFO PCR "{C40-ER000[78]*|C40-PR0004?}"

matches all PCRs C40-ER0007*, C40-ER0008* and C40-PR0004?

INFO EXTRACT \APPL\{ACOMP*|BCOMP*} TO *

matches all extracted component patterns beginning with ACOMP and BCOMP in group\APPL.

These patterns are not supported for DEFINEs or file names. { } are used with full pattern sets e.g.A{BC*|DE*} won’t work to match ABC* and ADE*. It must be {ABC*|ADE*}.

C40-ER00092 Note! When extracting KEYED and DATALIB components, any existing alternate keys specified on the targetfile won’t be updated. If the file is created by RMS during the extract, all alternate files will be adjustedto point to the same subvolume as the file. For more information, see Extract options (6-33). The onlyoptions not available are read, compile, and all format and qualify options.


C40-PR00109 Note! The EXTRACT command was not correctly processing extracts of DATALIB components when a stateother than LATEST was specified.



GROUP Command

The GROUP command changes the default group within the component trees. Componentname resolution depends on the default group.

GROUP comp-path

comp-path

is the new path name of the group to establish as the default group.

Considerations

The SHOW command displays the current group.

This command affects the default group and default component SET information.

If comp-path is specified as "." (the current group), this command does nothing.

If comp-path is specified as ".." (the parent group), the parent group is established as thecurrent group.

C40-ER00050 Note! RMSCOM supports the .MESSAGE component. This component (typically an EXTERNAL SOURCEcomponent) specifies a file which will be copied to the current RMSCOM OUT file, when using theOPEN or GROUP commands. In other words, it displays the contents of the file when you runRMSCOM and use OPEN or GROUP. It also documents the catalog and how pieces of that catalog areto be used.



This enhancement is motivated by an effort to try and help users new to a catalog understandits contents by being self-documenting. For more information, refer to OPEN (5-8) andSpecial Components (1-28).

Component CommandsGROUP Command


INFO COMPONENT Command

The INFO COMPONENT command provides a variety of report formats for displayinginformation about components.

INFO COMPONENT { [ path ] comp-specifier } { component-id } { FILE "=" file-patt } { "=" define-patt } { NAME "=" comp-specifier } [ { , RECURSIVE } ] [ { , BRIEF [, RECURSIVE ] } ] [ { , DETAIL [, RECURSIVE ] } ] [ { , HISTORY [, DETAIL ] [, RECURSIVE ] } ] [ { , VERSIONS [, DETAIL ] [, RECURSIVE ] } ] [ { , STATE [, RECURSIVE] } ]

comp-specifier

is combination of wild-card characters including "*", "?", "[", and "]". This can appear asthe last part of a component path. If specified with the NAME parameter, RMS performs aglobal catalog search for components matching the specified pattern.

component-id

is the logical identification of a component by number. This number appears in thedetailed component information display as well as in source components as DEFINES ofthe form =RMS_COMPcomponent-id.

file-patt

is a fully- or partially-qualified path name pattern of the file in a managed location. Thisname can include Expand node names. File names are matched only in the RMS catalog.

define-patt

is a Guardian DEFINE name or pattern. This value matches DEFINEs specified in theRMS catalog only.

RECURSIVE

instructs RMS to perform the INFO command on all child groups, not just the the currentgroup, (which is the default).

Component CommandsINFO COMPONENT Command


BRIEF

displays brief component information associated with the specified component(s). Whenused in conjunction with the RECURSIVE option, additional components beneath thespecified component(s) are reported.

DETAIL

displays detailed information about the component.

C40-ER00023 Note! This command reports any links associated with components. The principal path link is not reportedsince it is actually the "real" full path. Only other links (such as to releases) are reported.

HISTORY

displays the reason for change associated with each version of a component.

VERSIONS

displays information about the versions existing for each component specified.

STATE

displays a cross-tablulation of versions by component and state.

C40-ER00029 Note! INFO COMPONENT, DETAIL reports whether any associated REQUISITE relationships (to otherreleases and components respectively) are "OPTIONAL", meaning those requisites which are onlyevaluated when the target location is licensed to receive both items of a relationship. LIST RELEASEalso reports this information.

Considerations

The BUGFIX flag is reported in the INFO COMPONENT, DETAIL report display if the flagis turned on.




INFO PCR "{C40-ER000[78]*|C40-PR0004?}"



Component CommandsINFO COMPONENT Command


INFO COMPONENT Report Formats

RMS 8) INFO COMPONENT comp-name, BRIEF COMPONENT comp-name, TYPE comp-type , FILE file-name

comp-name

is the name of the component

comp-type

is the type of the component, one of: SOURCE, OBJECT, DOCUMENT, GROUP,RELEASE.

file-name

is the name of the file name associated with the component.

INFO COMPONENT comp-name, DETAIL Report

RMS 9) INFO COMPONENT comp-name, DETAIL INFO COMPONENT comp-name

COMPONENT-ID comp-id FULL-NAME comp-path DESCRIPTION description LANGUAGE RMS-language FILE file-name DEFINE define-name TYPE comp-type TRIGGER "trigger-char" INCREMENT increment CREATOR user-name CREATION-DATE create-date LAST-MODIFIED mod-date LAST-ACCESSED accessed-date LATEST-VERSION version LINK link-path

comp-id

is the numeric ID of the component, which is assigned by RMS when the component iscreated.

comp-path

is the component path name of the component.

description

is the description of the component that was entered when the component was created.

Component CommandsINFO COMPONENT Report Formats


RMS-language

is the eight character language that was entered when the component was created.

file-name

is the name of the file associated with a SOURCE, OBJECT, or DOCUMENT component.

define-name

is the name of the user-supplied define that may be used to refer to the component.

comp-type

is the type of the component.

"trigger-char"

is the trigger character for parameter substitution in source files.

increment

is the edit line number increment to use when extracting source components.

user-name

is the Tandem User ID of the user that created the component.

create-date

is the date and time the component was created, in local civic time at the node whereRMSCOM is running.

mod-date

is the last modified date and time of the component in local civic time at the node whereRMSCOM is running.

access-date

is the date and time the component’s contents were last accessed via an EXTRACT,SUBMIT, or COMPILE in local civic time at the node where RMSCOM is running.

version

is the latest version of the component; this is either a timestamp version if the componentis of TYPE OBJECT or a numeric version if the component is of TYPE SOURCE orDOCUMENT.

link-path

shows all the groups to which the component is linked.



INFO COMPONENT comp-name , VERSIONS, DETAIL Report

RMS 10) INFO COMPONENT comp-name, VERSIONS, DETAILCOMPONENT: path-name

version date user-name USER CHANGE change-name ARCHIVE FILE archive-fileSTATE: state-name lock-type LOCK BY lock-user lock-date FROM: src-component : src-version USING rule-name

change-name

is the userchange ID specified when the version was submitted (only present if a userchange was specified).

archive-file

is the name of the file where an archive of the version is stored (only present if the versionis archived).

src-component

is the source file from which the object was compiled.

src-version

is the version of the source file used.

rule-name

is the name of the rule used.

comp-name

is the component name.



path-name

is the component path name.

version

is either the version number or the version date.

date

is the date the version was created in local civic time at the node on which RMSCOM isrunning.

user-name

is the name of the user that created the version.

lock-date

is the date the lock was placed on the version, in local civic time at the node whereRMSCOM is running.

state-name

is the state that the version is at, if it is at a named state.

lock-type

is the type of lock on the version. It is one of EDIT, WORK, or FREEZE.

lock-user

is the GUARDIAN User name that locked the component.



INFO COMPONENT HISTORY Report

RMS 11) INFO COMPONENT comp-name, HISTORY COMPONENT: path-name

version date user text

comp-name

is the name of the component for which the history is desired.

path-name

is the full path name of the component.

version

is the version of the component.

date

is the date the version was created, in local civic time at the node where RMSCOM isrunning.

user

is the Tandem User ID of the user that created the version.

text

is the COMMENT that was entered prior to submitting the version.

INFO COMPONENT STATE Report

RMS 12)INFO COMPONENT comp-name, STATE LATEST DEVEL TEST PROD FALLBACK OBSOLETEcomp-name version version ...

comp-name

is the name of the component for which the state is desired.

Note! The size of version string displayed is only nine characters long. Anything longer than that will betruncated. (e.g., 10.23.0.12 will be displayed as 10.23.0.1).

version

is the version at the appropriate state for the comp-name. If there is no version at the state,the version is blank.



INFO PCR Command

The INFO PCR command displays information on the current PCRs (program changerequests).

INFO PCR "version-number - ER number "




INFO PCR "{C40-ER000[78]*|C40-PR0004?}"



Component CommandsINFO PCR Command


INFO SSV Command

The INFO SSV command displays the current search subvolume settings within RMSCOM.

INFO SSV { ssv-id | "*" }

ssv-id

The ssv-id is the one character specifier corresponding to a search subvolume. SSV’s arenumbered 0..9, A..J, inclusive. "*" refers to all SSV’s currently defined.

Considerations

None.

Info SSV Report Format

RMS 12) INFO SSV ssv-id ASSIGN SSV i, subvolume-name

ssv-id

corresponds to the SSV specifier.

subvolume-name

is the physical disk subvolume where file names are to be resolved.

Component CommandsINFO SSV Command


INFO USERCHANGE Command

The INFO USERCHANGE command provides the name and text of a user change entry.

INFO USERCHANGE [ " ] user-change-name [ " ][, { DETAIL } ] [, { BRIEF } ]

user-change-name

consists of any characters, but it may not begin with a blank and must be less than 33characters in length. If "*" is provided, all user change names are reported. A trailing "*"may be used to do generic reports.

DETAIL

lists the versions of components that were associated with the user change.

BRIEF

causes only the names of the user change entries to be reported.

Considerations

If the user change name is enclosed in quotation marks it may contain special charactersand wild-characters (?, *, []), but it is case-sensitive. Otherwise, user-change-name muststart with a letter and may be followed by up to 21 letters, numbers, dashes, underscores,or carats. The user-change-name is up-shifted.


Info Userchange Report Format

RMS 12) INFO USERCHANGE " user-change-name " text

user-change-name

is the name of the user change.

text

is the text that was entered when the user change was added.

Component CommandsINFO USERCHANGE Command


INFO VERSION Command

The INFO VERSION command provides detailed information about a specific range ofversions.

INFO VERSION comp-path : low-version-specifier [ TO high-version-specifier ]

comp-path

is a fully- or partially-qualified component path corresponding to the component for whichinformation is requested.

low-version-specifier

is the version at which the query starts.

high-version-specifier

is the version at which the query ends. If this parameter is not specified, only the versioncorresponding to low-version-specifier is returned.

Considerations

This command reports the same information returned by both the INFO COMPONENT, VERSION, DETAIL and INFO COMPONENT, HISTORY,DETAIL commands.

If low-version-specifier is higher than high-version-specifier, information is presented inreverse version number order.

C40-ER00047 Note! The INFO VERSION command accepts state names as well as versions. This permits commands suchas:

INFO VERSION \a\b\c:LATEST TO PROD

and

INFO VERSION \a\b\c:PROD

Component CommandsINFO VERSION Command


LINK COMPONENT Command

The LINK COMPONENT command allows a component to be visible within a group otherthan the group in which it was created.

LINK COMPONENT comp-path-1 [: version-specifier ] TOcomp-path-2

comp-path-1

is the full name of the component to be linked into the group specified by comp-path-2.

version-specifier

is the optional version or a valid state of comp-path-1 desired.

comp-path-2

is the full name of the component group in which comp-path-1 is to be visible.

Considerations

This command is subject to the same rules as ADD COMPONENT (6-3).

There cannot already exist a component in the target group, comp-path-2, which has thesame unqualified name (the part of the name from the rightmost "\" to the end) as thecomponent being linked.

There cannot already exist a component in the target group, comp-path-2, which has thesame base file name (last eight characters) as the component being linked.

Component CommandsLINK COMPONENT Command


LINK VERSION Command

The LINK VERSION command associates a version with a user change identifier

LINK VERSION comp-path : version-specifier TO ["] user-change-name ["]

comp-path

is the fully- or partially-qualified name of the component to be associated withuser-change-name.

version-specifier

is a version number of comp-path. State names are not supported.

user-change-name

is the new user change to be associated with the version.

Considerations

A quoted user change identifier is case sensitive. Special characters are only allowed ifthe user change identifier is quoted. Unquoted user change identifiers are not casesensitive.

This command replaces the ALTER VERSION, USERCHANGE command. Thiscommand allows users to specify multiple user change identifiers with a singlecomponent version.

C40-ER00088 Note! The SUBMIT, LINK VERSION and LINK RELEASE commands perform validation on the state of userchange identifiers being linked as part of the command. If the RMS CHECK USERCHANGE STATEattribute is set (through the ALTER RMS command), the user change state must match the current stateof the item to which it is being associated.

The exception is that the SUBMIT command’s state is used for the comparison, if provided.

Component CommandsLINK VERSION Command


LIST LOCK Command

The LIST LOCK command shows all locks on a component.

LIST LOCK comp-path [ USER [ user-specifier ] ] [ ,RECURSIVE ]

comp-path

is the component name for which locks are to be listed or "*".

USER [ user-specifier ]

if specified, causes this command to report locks for only the specified set of users. The"*" character can be used to specify system name, group, or user. user-specifier can bespecified in terms of user names or numbers.

RECURSIVE

causes locks to be listed for all children of the specified component.

Considerations

RMSCOM implements the LIST LOCK command using two query strategies. Normally,RMSCOM traverses components and versions of components in the catalog looking for locks.This type of query is fine for component-specific inquiries. The alternate query form exploitsa broader query mechanism than the normal case. If you request all locks on all components,recursively, from the root group, RMSCOM presents all locks in the catalog fairly quickly.

C40-ER00066 Note! Lock files are represented by convention as either Guardian file names beginning with "\", OSS filenames beginning with "/" or Universal Resource Locators (URLs). RMS assumes these namingconventions.

List Lock Examples

In order to obtain a list of all locks on all components in the catalog, type the followingcommand:

RMS 23) LIST LOCK \*, RECURSIVE

Component CommandsLIST LOCK Command


In order to obtain a list of locks on a specific component, type the following command:

RMS 24) LIST LOCK source-component

In order to obtain a list of all locks for a given group of users anywhere in the network, use:

RMS 25) LIST LOCK \* USER \*.GROUP.*, RECURSIVE

List Lock Report Format

RMS 24) LIST LOCK comp-namePATH VERSION LOCK USER DATE M-------------------------------------------------------------path-name version lock-type user-name date

IN file-name

comp-name

is the name of the component.

path-name

is the full path name of the component.

version

is the version of the component that is locked.

lock-type

is the type of lock that is on the component. One of: READ, EDIT, WORK, FREEZE.

user-name

is the Tandem user name that has the lock on the version.

date

is the date and time the lock was placed on the version.

file-name

is the name of the file containing the copy of the version. This item may not be displayedfor every lock.

Note! If the locked file was modified, the MODIFY field (M) contains a "*" character.

Component CommandsLIST LOCK Command


LOCK Command

The LOCK command adds a lock on a component.

LOCK comp-path [ : state-name ]

comp-path

is the path name of the component which is to be locked.

state-name

is the state or version of the component to be locked. If unspecified, the LATEST versionof the component will be locked.

Considerations

Use this command with discretion. Locking a component will prohibit a subsequentEXTRACT of the version.

This command is equivalent to issuing an EXTRACT FOR EDIT in terms of the lockprotocol and security requirements.

The corresponding lock entry displayed in the LIST LOCK command will not have anassociated file name.

Component CommandsLOCK Command


MAP Command

The MAP command produces a simple map, in the form of an indented list of the specifiedgroup.

MAP [ comp-path ] [ , DEPTH num-levels ] ... [ , GROUP [ * ] ]

comp-path

is the path to use as the root of the tree.

num-levels

is the maximum number of indented levels that will be reported.

Considerations

If no comp-path is specified, then the default group is used.

The GROUP option causes this command to display components of type GROUP only. If"*" is specified, all types of groups are reported.

The DEPTH option limits the query to a maximum number of nested children groups orcomponents. A depth of 1 will cause only components in the current group to be reported.

Map Report Format

RMS 14) MAP comp-path MAP OF COMPONENTS BELOW full-path : comp-name comp-name-1 comp-name-2 . . . . . . . . .

comp-path

specifies the group for which the map is to be displayed.

Component CommandsMAP Command


full-path

is the full path name of the group selected.

comp-name

is the first child of the group described by full-path.

comp-name-1

is the first child of the group described by comp-name.

comp-name-2

is the first child of the group described by comp-name-1.

Component CommandsMAP Command


OBSOLETE Command

The OBSOLETE command removes the revision history associated with OBSOLETEversions of a SOURCE, DOCUMENT or KEYED component.

Warning! This command removes all access to the versions specified. Do not use this command unless youreally intend to remove access to your changes.

OBSOLETE comp-path : version-number

comp-path

is the fully- or partially-specified component name for which version history is to beremoved.

version-number

is the exact version (e.g. 1.002) for which history is to be removed.

Considerations

This command removes older version entries to the point specified by the version number.

There can be no dependencies on any of the versions that you are deleting.

There can be no explicit links refering to any of the versions that you are deleting.

None of the versions being deleted can appear in any version of a release or can be usedby versions or components appearing in a release.

You cannot remove any version which is not exclusively at the OBSOLETE state.

If there is no OBSOLETE state, you can obsolete items only at the LATEST state.

This command applies only to SOURCE and DOCUMENT type components. Use theDELETE VERSIONS command to remove versions of other types of components.

Component CommandsOBSOLETE Command




Example


OBSOLETE \A\B\SRC:1.2

removes versions 1.000 through 1.002.

Component CommandsOBSOLETE Command


RENUMBER Command

The RENUMBER command changes the version numbering for a SOURCE, DOCUMENTor KEYED component.

RENUMBER comp-path : low-version [ , high-version ] TO new-version

comp-path

is the fully- or partially-specified name of the component for which version numbering isto be changed.

low-version

is the first version (e.g. 1.002) to be changed. Following successful completion of thiscommand, low-version will be referred to as new-version.

high-version

is the last version (e.g. 1.007) to be changed. The new value of high-version isautomatically computed. If high-version is not specified, it is set to low-version.

new-version

is the new base version of the renumber operation.

Considerations

This command does not remove any version entries.

There can be no locks on any of the versions that are affected by the renumber.

None of the affected versions may have been distributed, installed, or acquired directly ina release.

Bugfix versions (e.g. 1.2.0.1) are automatically renumbered if their corresponding baseversion (e.g. 1.2) is renumbered.

Component CommandsRENUMBER Command




Example


RENUMBER \A\B\SRC:1.2,1.4 TO 2.0

causes \A\B\SRC to have versions 1.000, 1.001, 2.000, 2.001, and 2.002.

Component CommandsRENUMBER Command


RESET Command

The RESET command clears RMSCOM local settings to their default values.

RESET { COMMENT } { COMPONENT } { EXTRACT } { SSV ssv-id } { SUBMIT }

ssv-id

is the search subvolume specifier which is to be reset. If "*" is specified, all searchsubvolumes are reset.

Considerations

This command does not change default groups.

Component CommandsRESET Command


ROLLOUT Command

The ROLLOUT command removes the revision history associated with LATEST versions of aSOURCE, DOCUMENT or a KEYED component.

Warning! This command removes all access to the versions specified. Do not use this command unless youreally intend to undo your changes.

ROLLOUT comp-path : version-number

comp-path

is the fully- or partially-specified name of the component for which version history is to beremoved.

version-number

is the exact version (e.g. 1.004) from which history is to be removed. The LATEST statemay also be specified here.

Considerations

This command removes version entries from the point specified through to the LATESTversion.

There can be no dependencies on any of the versions that you are deleting.

There can be no explicit links referring to any of the versions that you are deleting.

None of the versions being deleted can appear in any version of a release or can be usedby versions or components appearing in a release.

You are not permitted to rollout any version which is not at the LATEST state, unless thespecified version refers to a bugfix version.

If a bugfix version is specified, all bugfix versions on that bugfix branch, more recent andincluding the specified version are removed. Mainline versions are not affected.

This command applies only to SOURCE, DOCUMENT and KEYED type components.Use the DELETE VERSIONS command to remove versions of other types ofcomponents.

Warning! Be careful when using this command on components with discontinued versions. If all versions beyondthe newest discontinued version are rolled out, the resulting latest version will be discontinued. Nofurther locks on or submits to the component will be permitted on that version.

RMS will not allow you to create new latest versions and this is subject to change or cancellation at anytime.

Component CommandsROLLOUT Command




Example

If \A\B\SRC has versions 1.001, 1.002, 1.003, and 1.004:

ROLLOUT \A\B\SRC:1.2

removes versions 1.002 through 1.004.

Component CommandsROLLOUT Command


SET COMMENT Command

The SET COMMENT command specifies SUBMIT reason text prior to doing a SUBMITcommand.

SET COMMENT [ FROM file-name ]

FROM

this optional clause causes file-name to be read in as the comment. The records are limitedto 80 bytes and there is a limit to the memory available to store them.

Considerations

The SET COMMENT command prompts for a comment using a plus sign (+) until theuser enters end-of-file (CNTRL-Y) or a line consisting of "//" in the first two columns.The comment must contain at least ten non-blank characters for it to be accepted.

The comment stays in effect until a RESET COMMENT command is entered or an ADDUSERCHANGE is entered.

Component CommandsSET COMMENT Command


SET COMPONENT Command

SET COMPONENT command sets component ADD defaults prior to executing a series ofADD COMPONENT commands.

SET COMPONENT comp-path [ , TYPE [ { EXTERNAL} ] [ { DATA } ] ] ... [ [ { NORMAL } ] [ { DOCUMENT } ] ] [ { GROUP } ] ] [ { KEYED } ] ] [ { OBJECT } ] ] [ { SOURCE } ] ] [ , FILE file-name ] [ , DEFINE define-name ] [ , LANGUAGE RMS-language ] [ , DESCRIPTION "80-char-string" ] [ , GROUP comp-path ] [ , TRIGGER "trigger-char" ] [ , INCREMENT edit-line-number ]

comp-path

is the fully- or partially-qualified path name of the component to add.

EXTERNAL

sets the mode of the component to external. Used for creating components notcontrolled by RMS.

NORMAL

sets the mode of the component to normal, the default.

DATA

creates a data file component.

DOCUMENT

creates a document component, one which will not be compiled.

GROUP

creates a logical group component.

KEYED

creates a keyed data file component.

Component CommandsSET COMPONENT Command


OBJECT

creates an object component.

SOURCE

creates a source component.

FILE file-name

the name of the component source file.

DEFINE define-name

an alias to be used in a source component for compilation purposes.


the source language of the component, if one exists.


an 80-character string to describe the component.

GROUP comp-path

The GROUP parameter supercedes the default group set by the GROUP command. Notethat the GROUP command resets this parameter.


The default trigger character used during component submission. If this parameter is notspecified, no trigger character is assumed.


The EDIT line number increment used during component extraction and compilation. Thedefault increment is 1.000. The recommended default for SQL source components is10.000.

Considerations

See ADD COMPONENT (6-3) for more information about these commands.

Component CommandsSET COMPONENT Command


SET EXTRACT Command

The SET EXTRACT command establishes component extract parameter defaults.

SET EXTRACT extract-options [, extract-options ] ...{ APPEND { ON | OFF } }{ FOR { EDIT } }{ { READ } }{ { COMPILE } }{ { WORK } }{ FORMAT { EDIT } }{ { READ } }{ { COMPILE } }{ { DEFINE } }{ { FILE } }{ PURGE [ { ON | OFF } ] }{ USERCHANGE user-change-name } }{ QUALIFY { SYSTEM } } { { VOLUME } } { { SUBVOL } } { { FILE } }

C40-ER00092 APPEND { ON | OFF }

controls whether data is appended to an existing file during extract processing.

FOR EDIT

causes all component extractions to be done using the edit mode, unless overridden by theEXTRACT command options.

FOR COMPILE

causes all component extractions to be done using the read-only compile mode, unlessoverridden by the EXTRACT command options.

FOR WORK

causes all component extractions to be done using the edit-work mode, unless overriddenby the EXTRACT command options.

FOR READ

extracts a read only copy of the component.

FORMAT READ

causes the component to be extracted using the format normally used when extacting FORREAD, regardless of the actual extract mode.

Component CommandsSET EXTRACT Command


FORMAT COMPILE

causes the component to be extracted using the format normally used when extractingFOR COMPILE, regardless of the actual extract mode.

FORMAT EDIT

causes the component to be extracted using the format normally used when extractingFOR EDIT, regardless of the actual extract mode.

FORMAT DEFINE

causes the component to be extracted with optional defines as specified with ADDCOMPONENT. If there is no user specified define then the RMS-generated define is used.

FORMAT FILE

causes the file name of the referenced component to be placed in the output.

QUALIFY level

controls how much of the RMS-managed file name is to appear in the output. Onlyrelevant for FORMAT FILE or FOR READ extracts. Level is one of:

SYSTEM Is the fully qualified network filename

VOLUME Is the local format filename

SUBVOL Is the subvolume name.filename

FILE Is the unqualified name.

USERCHANGE [ " ] user-change-name ["]

provides a previously created user-change-name to be associated with the submit. If theuser-change-name contains special characters it must be enclosed in quotation marks. If itis enclosed in quotation marks it is case sensitive.

PURGE

causes all the target files of a component extraction to be purged before the extraction isdone.

Considerations

See EXTRACT (6-33) considerations for a discussion of component extract parameters.

Component CommandsSET EXTRACT Command


SET IMAGE Command

The SET IMAGE command specifies basis information for component version selections.

SET IMAGE comp-path : version-specifier

comp-path

is any valid component path name.

version-specifier

is a valid version number for the specified comp-path.

Considerations

SET IMAGE is currently used in conjunction with the EXTRACT command for segmentedlibraries. This command directs the extract processor to prepare the segmented library as itappeared during the compile of the specified object version. Only the dependent sections ofthe library are presented as part of the extract. The last modification time of the resulting filecorresponds to that which is valid at compilation time.

Component CommandsSET IMAGE Command


SET SSV Command

The SET SSV command specifies search subvolumes used by the SUBMIT command for filename and component file name resolution.

SET SSV ssv-id , subvolume

ssv-id

is the one character specifier corresponding to a search subvolume. SSV’s are numbered0..9, A..J, inclusive.

subvolume

is the fully-qualified Tandem subvolume to be searched for files or components. Diskvolume names alone are also permitted here.

Considerations

See SUBMIT (6-76) considerations for a discussion of search subvolumes.

Component CommandsSET SSV Command


SET SUBMIT Command

The SET SUBMIT command establishes component submit parameter defaults.

SET SUBMIT submit-options [ , submit-options ] ...[ , [NO]ADD EXTERNAL ][ , [NO]ADD SECTION ][ , KEEP MISSING [ { ON | OFF } ] ][ , IGNORE DUPLICATES [ { ON | OFF } ] ][ , QUALIFY

{ SYSTEM | VOLUME | SUBVOLUME | FILE | OFF } ][ , NODIFFOK [ { ON | OFF } ] ][ , PURGE [ { ON | OFF } ] ][ , SECURE [ { ON | OFF } ] ][ , SOURCEDATE [ { ON | OFF } ] ][ , TRIGGER " trigger-char " ][ , USERCHANGE " user-change-name " ]

Considerations

See component SUBMIT (6-75) options and SUBMIT (6-76) considerations.

Component CommandsSET SUBMIT Command


SHOW Command

The SHOW command displays the current settings of the RMSCOM environment and defaultsettings.

SHOW { COMPONENT } { COMMENT } { LOCATION } { RELEASE } { EXTRACT } { SUBMIT }

C40-ER00097 Note! For SHOW SUBMIT, the SOURCEDATE { ON | OFF } parameter - if you are currently usingEXPERT-MODE to turn this parameter on, you need to add ADMIN security. EXPERT-MODE forthis field is no longer required. See Security (9-1)

SHOW COMPONENT Report Format

RMS 15) SHOW COMPONENT SHOW COMPONENT GROUP comp-path TYPE type FILE file-name DEFINE define-name LANGUAGE RMS-language DESCRIPTION "80-char-string"

comp-path

is either blank if the group has not been set or a group name.

type

is either blank if the type has not been set or a valid component type.

file-name

is either blank if the file name has not been set or the Tandem file name where thecomponent will be stored.

define-name

is either blank if the define name has not been set or the define name associated with thecomponent.

Component CommandsSHOW Command


RMS-language

is either blank if the language has not be set or the eight-character language associatedwith the component.

80-char-string

is either blank if the description has not been set or the 80-character description of thecomponent.

SHOW COMMENT Report Format

RMS 16) SHOW COMMENTCURRENT COMMENT TEXT

text. ..

text

is the current comment text, entered with the SET COMMENT command.

Component CommandsSHOW Command


SUBMIT Command

The SUBMIT command creates a new version of one or more source components. Work filescan optionally be purged after successful submission.

SUBMIT file-patt [ AS { LATEST } ] [ { state-name } ] [ { version-specifier } ] [TO] component-path [, submit-options ]...

file-patt

is the Tandem file name from which the new version of the component will be read.

LATEST

is the new version (the latest version) of the file, as opposed to a bugfix version.

state-name

is the new version is a change at some other state.

version-specifier

is the new version is a bugfix version or a new major version of the component, and theversion is given explicitly (e.g. 1.5.0.3 (bugfix version) or 2.0 (major version) ).

comp-path

is the component name that the new version is for.

Caution! For important information on submitting and locks on source libraries, DDLDICTs and DATALIBs, seeChapter 1.

Component CommandsSUBMIT Command


submit-options

is one of the following:

C40-ER00097 SOURCEDATE { ON | OFF }

allows you (if you have ADMIN access) to use the last modification date of the filebeing submitted as the version time for the new version of the component beingcreated by the submit.

[NO]ADD EXTERNAL

directs RMS to suppress or allow the automatic creation of external components.NOADD EXTERNAL is the default.

[NO]ADD SECTION

directs RMS to suppress or allow the automatic creation of referenced sections ofsegmented source libraries. NOADD SECTION is the default.

KEEP MISSING { ON | OFF }

directs RMS to retain sections (that do not appear in libraries being submitted) in targetlibraries. This option is useful when portions of a segmented library are beingsubmitted to a master library.

IGNORE DUPLICATE { ON | OFF }

directs RMS to ignore duplicate section definitions in libraries being submitted. Onlythe first copy of the section is considered relevant.

NODIFFOK [ { ON | OFF } ]

accepts the submission even if there were no differences from the previous version.Normally, RMS will not allow a submission without changes.

QUALIFY

automatically removes levels of file name qualification within the source file beforeRMS filename resolution is performed. The following qualify options are allowed:

SYSTEM Retains all portions of a file name.

VOLUME Retains a file name in local format.

SUBVOLUME Retains subvolume and base file names.

FILE Removes all portions of the file name except the base file name.

OFF Does not perform any qualification control.




deletes extract file, if any, after submit.

SECURE [ { ON | OFF } ]

secures the file to prevent modication after submit. This option can be used instead of thePURGE option.


sets the macro trigger character to "trigger-char".

C40-ER00127 UNLOCK [ { ON | OFF } ]

allows you to submit to SRCLIB and DATALIB components without a group lock. Thisassumes that all modified components detected in the file being submitted already haveexisting component locks.

USERCHANGE [ " ] user-change-name [ " ]

provides a previously created user-change-name to be associated with the submit. If the user-change-name contains special characters it must be enclosed in quotation marks. If itis enclosed in quotation marks it is case sensitive.

C40-ER00026 Note! SUBMIT reports multiple occurrences of the Bad Contents line prior to aborting.

Considerations

All component submissions are subject to rejection by the user-supplied customizationroutine USER^SUBMIT^VERIFY. The procedure supplied with RMS always acceptssubmissions. The interpretation of rejections by this routine is user defined.

If a bugfix version of a component is created during the SUBMIT, that component’sBUGFIX flag is turned on. The ALTER COMPONENT command can turn this flag onand off manually.

SUBMIT supports submissions of components based on patterns both in component-pathand file-patt. Component-path selects the components to be submitted. It can be prefixedwith a fully or partially-qualified component path representing the group in which thesubmission is to take place. File-patt specifies the names of files to be used for thesubmission.

C40-ER00097 If you are currently using EXPERT-MODE to turn on SOURCEDATE functionality,you will have to add ADMIN security. For more information, see Security (9-1).EXPERT-MODE is no longer required.



C40-ER00127 SUBMIT UNLOCK

The appropriate version at the correct state of each member of the group component beingsubmitted must be locked by the user performing the submit. These versions will be unlockedduring the submit. In addition, any such components for which there are no differences, arealso unlocked automatically.

No locks should exist at the group level, or the submit will fail.

For each section/record number in the submitted file, there must be a lock on theappropriate version based on the state of the submit. These locks will be removed even ifthere are no differences to that section. The locks will only be removed if they belong tothe current user, or the submit will fail.

No locks are required for new components created by the submit.

The .FILE-HEADER component for DATALIB won’t be updated to reflect file attributesfrom the minifile.

You must specify the KEEP MISSING option with the UNLOCK option.

Warning! Don’t use this option with SRCLIB or DATALIB components with .ADD-DEPENDENCIES attributes. Itmay corrupt the managed file

Example - Submit With Patterns

Suppose a group contains two components, ASRC and BSRC, with file names, A and Brespectively. The command:

RMS) SUBMIT $MYVOL.SUBVOL.* TO \ source-group \*SRC

causes files $MYVOL.SUBVOL.A and $MYVOL.SUBVOL.B to be submitted to\src-group\ASRC and \source-group\BSRC, respectively.

Component Extract and Submit Patterns

The following rules of wild-card substitution apply to both submission and extraction ofcomponents:

The "*" wildcard, when specified in a file name, causes the corresponding value from thecomponent’s file name to be inserted into the file name during a submit or extract.

The "?" wildcard, when specified in a file name, causes the corresponding character fromthe component’s file name to be placed into the file name during a submit or extract.

The "*" wildcard, when specified in a component name, matches all characters.

The "?" wildcard, when specified in a component name, matches any single character.



Considerations for Source and Document Components

The file being submitted must be an Edit-format file (code 101).

If the user has not previously done a SET COMMENT command prior to doing thesubmit then he/she will be prompted for the comment text after entering the command.The comment is not retained after the submit command.

The user must have Guardian READ access to the file being submitted.

The user must have previously done an EXTRACT FOR EDIT or LOCK command (mayhave been done in a prior invocation of RMSCOM). This applies only to componentswhich have been previously submitted. The initial submission of a component does notrequire a corresponding extract and does not require the component to be locked to theuser doing the submit.

The version number supplied must be consistent with the version numbering scheme usedby RMS.

No line of the submitted file can have a "]" in column 1 and a "D", "E" or "A" in column2.

The default volume used for file name resolution during the submit is the volume andsubvolume of the component file name being updated by the submit.


Language Considerations

The submit processor parses all commonly-available languages supported by Guardian. Thereare, however, some restrictions in the following areas:

RMS performs some file name substitution in the code when prepared for compilation.Do not depend on the consistent alignment of source lines which contain ?SOURCE,COPY or INCLUDE type of statements, or which use RMS expansion macros.

For COBOL, COBOL85:

Within RMS, the language COBOL refers to the COBOL ’85 standard and thelanguage COBOL74 refers to the COBOL ’74 standard.

Avoid using ANSI format with an identification field (columns 73-80) in linescontaining the FILE (SPECIAL-NAMES) and COPY statements.

Do not use ANSI format with expansion macros and identification fields (columns73-80).

The FILE (SPECIAL-NAMES) statement must use the explicit FILE keyword form(FILE "$a.b.c" IS obj-lib) rather than the implicit form ("c" IS obj-lib). In addition,STATUS is not a valid file name in this statement.



While the CHECKPOINT statement is supported, the CHECKPOINT FILEstatement is not. RMS has no way of distinguishing between the use of the FILEkeyword between this and other usages. If you must use the CHECKPOINT FILEstatement, place it in a separate component whose language is not COBOL and notCOBOL74. Use a COPY statement to use that code fragment in your program.

For SCOBOL:

Avoid using ANSI format with an identification field (columns 73-80) in linescontaining the COPY statement.

For BINDER:

Avoid using the same line for more than one statement.

Remove all BUILD and EXIT statements from the BINDER source file.

All files referenced in source components must exist. These files can either be known internalor external components, or new external components (a known component is one that isalready in the RMS catalog structure).



Differences Between ANSI and Tandem COBOL Processing

The RMS submit processor knows about differences between ANSI and Tandem COBOL74and COBOL85 source reference formats (the columns in which language elements must beplaced). Unless otherwise specified in the source file, RMS assumes that the Tandemreference format is to be used for both COBOL74 and COBOL85. If your source file is inANSI format, you must place the ?ANSI compiler directive in the source file.

COPY libraries are interpreted in a similar manner to full program files. RMS assumes thatsections are to be interpreted in Tandem format unless a ,ANSI is appended to the ?SECTIONdirective in the copy library. Subsequent sections which do not have either a ,TANDEM or,ANSI suffix will be interpreted according to the format assumed for the previous section.

Please remember that the ANSI and Tandem distinction between reference formats usingcompiler directives is an extension to the COBOL language specification. If you aretransporting source code from non-Tandem systems, note that those systems may use eitherANSI or some extended format not known to Tandem COBOL compilers. You will likely berequired to place a ?ANSI directive in the source file before submitting the file to RMS toensure correct interpretation of the source.

COBOL Identification Division Interpretation

RMS does not perform source or object file reference detection in comment entries in theidentification divisions of COBOL74, COBOL85 and SCOBOL language source files. Thefollowing paragraphs are known to contain comment entries: Author, Installation,Date-written, Date-compiled, and Security. If RMS detects these sections in a source file -regardless of whether it is known to be in an identification division or not - the adjoiningcomment entry is not scanned for references.

RMS does not scan for references in any text in a Program-id paragraph. RMS assumes thatthis paragraph is contained entirely on one line in the source program.



Differences Between ANSI and Tandem C Processing

The RMS submit processor knows about differences between ANSI and Tandem C languagesource reference types. The language C refers to components which have file references whichare entirely resolvable on Tandem hosts. There are no "unknown" library header or sourcefiles which have been excluded by preprocessor directives. The language C-ANSI refers tosource components which are written to be portable between hosts of different computermanufacturers and environments. RMS does not require that any library header files beresolvable on Tandem Computers.

The rules for C and C-ANSI are as follows:

Table 6-5 Differences in C and C-ANSI Submit Processing.

C C-ANSI

Library Header Files

#include <file.h> Resolves to$SYSTEM.SYSTEM.fileh

Ignored.

#include<sys\file.h>

Cannot be specified. Ignored.

Standard Source Files

#include "file.h" Resolves through searchsubvolumes to fileh

Resolves through searchsubvolumes to fileh ifpossible, otherwise ignored.

#include"$system.x.fileh"

Resolves to$SYSTEM.x.fileh

Resolves to$system.x.fileh if itexists.

#include"$system.x.file.h"

Resolves to$SYSTEM.x.fileh

Resolves to$system.x.fileh if itexists.



Version Macros

RMS allows the following macros to be embedded in a file for expansion when the version isextracted for READ or COMPILE. Version macros may be case sensitive. Use upper casewhere indicated. The lower case forms are sometimes supported for historic reasons, but maybe replaced without notice. Macro processing differs based on extract formats.

Note! We recommend using ‘ or ~ as trigger characters. Only use trigger characters in sourcecomponents where macro processing is required. If macro processing is not required, do not specify atrigger character. If the trigger character "~" is used as part of the source, the " ~~" macro must beused to preserve the original "~" character.

The following table assumes the trigger character is "~".

Table 6-6 Submit/Extract Source Macros.

~B~ Version.Branch, numeric, two digit (see ~V~).

~C~ The version at which the line was last changed, string, variable.Used in tag string.

~D~ Day of month version created, numeric, two digit.

~F~ Physical File Name, external form, variable length.

~L~ Version.Level, numeric, three digit (see ~V~).

~M~ Month version created, numeric, two digit.

~N~ Month version created, string, three characters.

~P~ The full component path, string, up to 256 characters.

~P2~ Similar to ~P~, but allows for correct processing by C-languagecompilers.

~R~ Version.Release, numeric, variable length (see ~V~).

~S~ Version.Sequence, numeric, two digit (see ~V~).

~T~ Time version created, string, five characters (24 hour clock).

~U~ User name that last modified the line, string, variable length,[\system.]group.user. Used in tag string.

~u~ Short form of ~U~ containing only the user name. Used in tagstring.

~V~ Version being extracted, string, variable length.



~Y~ Year version created, numeric, four digit.

~Z~ Year version created, numeric, two digit.

~~ Expands to ~.

~LL~ Alternate version level number form. For 0 to 99, uses two digitformat. For 100 to 999 uses 3 digit format. The result is zeropadded.

~FN~ The EXAND node name of the physical file name.

~FV~ The volume of the physical file name.

~FS~ The subvolume of the physical file name.

~FF~ The base physical file name.

~PP~ The base component name with no path qualification.

Note! The "~]" character sequence in the source will be expanded to "]". The "~x" character sequence(where x is not an alpha character or not one of the expandable macros) will not be modified.

C40-ER00030 Note! The ~P2~ is similar to the ~P~ macro in that both present the full path of a component. However, inthe case of ~P2~ backslashes are doubled to allow correct processing by C-language compilers. Asample expansion of a ~P2~ parameter would be:

\\APPL\\SRC\\MYMODULE

Search Subvolumes

RMS provides support for search subvolumes for component resolution. During submitprocessing, RMS parses components for new file references. These references are resolvedaccording to Tandem file name resolution standards. The user can provide alternate searchsubvolumes (SSVs) to RMSCOM. Please refer to the TAL Programmer’s Guide for details onthe Tandem usage of SSVs.

RMS uses SSVs as alternate default volumes for the resolution of unqualified file names (i.e.not containing a period) in ?SOURCE, ?SEARCH, COPY, or #include statements. RMSattempts to locate an existing file using each SSV, in order, until a file is located. The defaultsubmit subvolume is used as the last subvolume searched. If a file is not found, the submit isrejected. If a file is found and is not in the catalog, RMS adds the component as a newexternal component in the \EXTERNALS heirarchy if the ADD EXTERNAL option isspecified.



An SSV is specified to RMSCOM using ASSIGN commands from TACL as in the followingexample:

Example - Search Subvolume

TACL 10> ASSIGN SSV0, $SYSTEM.ZGUARD TACL 11> RMSCOM

SSVs are numbered 0 through 9, and A through J, inclusive. They are evaluated starting atSSV0 and ending at SSVJ. Not all SSVs need to be specified and there can be gaps in thenumbering between SSV assigns.

SSVs can also represent disk volumes. If file names in your source components arerepresented in the form subvolume.filename, you may be able to resolve these names intoRMS components by specifying an SSV representing a disk only, as follows:

TACL 12> ASSIGN SSVA, $RMSVOL TACL 13> RMSCOM

Rules for File Name Resolution

You must adhere to the following rules in order to successfully submit a source filecomponent:

All internal components which are referenced by the new version of the component beingsubmitted must already exist as components in the catalog.

All external components which are referenced by the new version of the component beingsubmitted must exist either as external components in the catalog or must be present ondisk.

If a referenced component is partially qualified, it must reside in either the referencingcomponent’s subvolume if no SSVs are provided, or one of the specified SSVs.

Considerations for Object Components

The file being submitted must be an object file component (code 100). The targetcomponent can be an external component. Object components which are linked to asource component using a compile rule can only be modified using the PRODUCEcommand.

In order for object components to be submitted, there must be an active archive locationspecified. See ADD LOCATION (12-14)



C40-ER00126 Here is a list of all supported file types for the RMS type OBJECT:

File Code CISC RISC

100 Old-Style C-series Accelerated Objectsand D-series Objects

700 COFF ObjectsELF Objects

Licensed objects will lose this attribute when they are extracted.

An externally-compiled SCOBOL object can be submitted to a SCOBOL objectcomponent under a TCLPROG. The component name of the SCOBOL object must matchthe program name of the SCOBOL object to be submitted. The file name used should bethe base file name of the TCLPROG where the exernal SCOBOL object resides. (e.g.$DATA.OBJECTS.POBJ).

Considerations for Data File Components

The data file being submitted can be any ENSCRIBE format file. The target componentcan be an external component. Data-file components which are linked to anothercomponent using a compile rule can only be modified using the PRODUCE command.

In order for data file components to be submitted, there must be an active archive locationspecified. See ADD LOCATION (12-14).

Considerations for Keyed Components

The file must be a Key-sequenced file (type K).

You should try to avoid changing the primary key attributes of the file between versions.If they are changed, all records in the file are considered changed.

RMS preserves ENSCRIBE file attributes. However, alternate key files are notautomatically created or loaded when Keyed components are extracted or used in acompile.

If you have not previously done a SET COMMENT command prior to doing the submitthen you will be prompted for the comment text after entering the command. Thecomment is not retained after the submit command.

You must have Guardian READ access to the file being submitted.

You must have previously done an EXTRACT FOR EDIT or LOCK command (mayhave been done in a prior invocation of RMSCOM). This applies only to componentswhich have been previously submitted. The initial submission of a component does notrequire a corresponding extract and does not require the component to be locked to theuser doing the submit.



The version number supplied must be consistent with the version numbering scheme usedby RMS. The numbering scheme used for Keyed components is the same as thenumbering scheme used for Source and Document components.


Considerations for Segmented Source Components

Segmented source components can be submitted in one of two ways:

The entire library, with all sections, can be submitted in one batch by submitting thelibrary source file to the segmented source group component. Any new sections arecreated automatically. Any unchanged sections are untouched. Any sections nolonger in the library are considered empty.

RMS adds any new sections into the library before any submissions occur.References between sections in the same library are permitted.

The NOADD SECTION option is presently ignored for segmented source librarysubmission. The option is only applicable for section references.

Individual sections can be submitted directly to the appropriate sub-component of thesegmented source group.

In all cases, the section specifier (e.g. ?SECTION) line(s) must be present in the source file.

Caution! To submit C language segmented source files to a SRCLIB component, a .DEFAULTS component mustbe added under the SRCLIB component to specify the TYPE (e.g. SOURCE) and LANGUAGE (e.g. C)for all the subcomponents.

Please refer to Segmented Source Libraries (1-26) for more information.

Note! The children components of a DDLDICT component should not use the same subvolume to store itsmanaged file. For instance, if the DDLDICT group has a file attribute of $DATA.DICT, then its childDICTALT should not have a file name of $DATA.DICT.DICTALT. The $DATA.DICT subvolume is used asa bucket area to where a version of the child components are extracted if required by ENFORMcompiles.

ENFORM programs that reference a DICTIONARY will reference the subvolume of aDDLDICT component.

To submit a DDL dictionary to RMS, type:

SUBMIT $ vol.subvol TO ddldict- group-name

Note! Don’t use SUBMIT $ vol.subvol .* TO ddldict- group-name \* to submitdictionaries to DDLDICT components. This will not create a proper version for the dictionary.



Considerations for Referenced Components

RMS can optionally create referenced components for you during a submit. Any externalfiles which are found in the search subvolume list can be created as external componentsin the \EXTERNALS\subvol group. Any sections which are referenced in segmentedsource components which do not exist can be automatically added. The ADD/NOADDparameters of the SUBMIT command control this function.

Sections of segmented source libraries are created using defaults specified by the.DEFAULTS component. If this component is not present in the library, the newcomponent’s language is taken from the language of the component being submitted.

Examples

The following example illustrates the initial submission of a new component:

RMS 1) ADD COMPONENT new-comp , LANGUAGE C, FILE headerhRMS 2) SET COMMENT+ Th is is the initial submission of the header file + containing shared definitions .+ //RMS 3) SUBMIT edith TO headerh

The following example illustrates a normal change process to a component:

RMS 4) EXTRACT headerh TO temph , FOR EDITRMS 5) RUN TEDIT temphRMS 6) SET COMMENT+ Added definitions to support the addition of many+ new programs .+ //RMS 7) SUBMIT temph TO headerh , PURGE

The following example illustrates an aborted change process where the wrong component wasextracted, or the changes were inappropriate:

RMS 8) EXTRACT headerh2 TO temphRMS 9) RUN TEDIT temphRMS 10) UNLOCK headerh2RMS 11) RUN FUP PURGE temph !

The following example illustrates submitting a SCOBOL program (MENU) from an externalTCLPROG (i.e. $data.obj.pobj) to the component MENU under the TCLPROG groupcomponent:

Note! The component name must match the program name.



RMS 16)SET COMMENT+ Submission of SCOBOL program MENU to TCLPROG+ //RMS 17) SUBMIT $data.obj.pobj TO tclprog\menu

The following example illustrates a defect change to a component by version number. Notethat unless 1.3 is the LATEST version, the changes placed in 1.3.0.1 will not be automaticallyincluded in the LATEST version.

RMS 12) EXTRACT headerh:1.3 TO temph , FOR EDITRMS 13) RUN TEDIT temphRMS 14) SET COMMENT+ Fixed incorrect definitions which were detected+ by QA department.+ //RMS 15) SUBMIT temph AS 1.3.0.1 TO headerh , PURGE

The following example illustrates a defect change to a component by state name. Note thatunless the state name resolves to the LATEST version, a bugfix format version number will becreated, and the change will not be automatically included in the LATEST version.

RMS 16) EXTRACT headerh:PROD TO temph , FOR EDITRMS 17) RUN TEDIT temphRMS 18) SET COMMENT+ Fixed definitions which caused the production defect .+ //RMS 19) SUBMIT temph AS PROD TO headerh , PURGE



C40-ER00108 Note! The SUBMIT processor submits abstractions such as DATALIB (except for DDLDICT), and obtainsoptional TM/MP file locks on the DEPREL and VERSENT files.This allows libraries with huge numbersof components to be successfully submitted without having to break up the files into smaller pieces.

C40-PR00104 Note! DATALIB submits were getting an error 45 on a temporary file. It was being created with MAXEXTENTS32 which is corrected to 900.



Figure 6-7 Creating a Bugfix Version at Different States

1.0 1.1

1.1.0.1

1.2

Current States:DEVELTESTPROD

Current State:LATEST

Extract version 1.1 at DEVELMake appropriate changes and unit testSubmit as DEVELPromote to PROD

To create a bugfix version at the PROD state:

1.0 1.1 1.2

Current States:LATESTDEVELTESTPROD

Extract version 1.2 at LATESTMake appropriate changes and unit testSubmit as LATEST (version number will be 1.3)Promote to PROD

To create a bugfix version at the PROD state:



When there is more than one version of a component locked by a user, RMS will assume thatthe version with the highest number is being submitted by default. You must explicitly specify,in the SUBMIT command, a version or state to resolve the lock differently.

RMS will also attempt to avoid creating a bugfix version number as the LATEST version of acomponent. If a user submits a component as a state other than LATEST, but the version beingsubmitted is LATEST, RMS will create a main-line version rather than a bugfix version.

Embedded Pragmatic Expressions

RMS supports the use of embedded pragmatic expressions within source and documentcomponents to control special RMS-specific functions. All source and document pragmas aredocumented here.

Pragmatic expressions are only available to some languages. The following table defines thetext string that must preceed any pragma:

Table 6-7 Language Dependent Embedded Pragmatic Expressions

Language Comment String

BINDER COMMENT ∂PRAGMA pragma-expression1.

C, C-ANSI, and PASCAL

/*PRAGMA pragma-expression∂ ∗/1.

COBOL, COBOL74, and SCOBOL

*PRAGMA pragma-expression2.

DDL *PRAGMA pragma-expression1.

FORTRAN C∂ PRAGMA pragma-expression1.

PNA !PRAGMA pragma-expression1.

TAL --PRAGMA pragma-expression1.

TBOL, and DBOL .PRAGMA pragma-expression1.

TGAL \COMMENT∂ PRAGMA pragma-expression1.

1 pragma comments must start in the first column of text.

2 pragma comments must start in column 1 for ?TANDEM mode and column 7 for ?ANSImode.

∂ Indicates that one and one space only is needed in the syntax.



The following table describes the various pragma expressions that can be specified in a sourcefile and their corresponding actions.

Table 6-8 Embedded Pragmatic Expressions

Pragma Meaning/Action

DISABLE Inhibits source file parsing. When this pragma is encountered, allreference detection is terminated. The ENABLE pragma turnsreference processing back on.

ENABLE Starts source file parsing. When this pragma is encountered,reference detection is started. This pragma is used to nullify theeffects of the DISABLE pragma. Reference processing forsource files is initially enabled.

FAIL Causes the SUBMIT command to reject the source component.This pragma is typically used when reference copies of sourcesare maintained outside of RMS.

LINE edit-line Specifies new edit line number sequencing for componentextracts. The line number of the line containing the LINE pragmawill be set to edit-line. This pragma only has effect for TandemEDIT-format files. This pragma will be ignored if the new editline number cannot be set.

LOG Inserts component history information following the pragma.This history is free format and is prefaced by the appropriatecomment characters. At the end of the history text, the LOG$pragma is inserted. This pragma indicates the end of the historytext. All history text, including the LOG$ pragma is removedduring the submission process.

The format of the history text is subject to change without notice.If access is required to history text, the recommended accessmethod is via the RMS Subsystem Programmatic Interface (SPI)Protocol documented in the Revision Management System (RMS)Programming Manual, Volume 1.

REFERENCE comp-id Causes a reference to be created between the source beingsubmitted and the specified comp-id.



TAG COLUMN col "string"

Places version identification strings starting at the designatedcolumn, col, in each line of an extracted source file. There mustbe no text anywhere in the source file either at or after thespecified column. All text starting at col is removed from thesource file during the submission process. Any version macrocan be specified in the tag string. The macro ~U~ expands to theGuardian user-id who made the specified change. If string isempty or not specified, a default tag is used. This default tag issubject to change without notice. If the COLUMN directive isnot specified, tags are disabled.

Userchange Considerations

If RMSMON has been ALTERed to set USERCHANGE SUBMIT ON, then auserchange name is required. This can be checked by using the INFO RMS command.

The state of the user change must be at the same state as the submit, to be valid.

Examples - Pragmatic Expression Examples

The lines:

--PRAGMA DISABLE?SOURCE $SYSTEM.SYSTEM.EXTDECS0--PRAGMA ENABLE

cause RMS to ignore the reference to the EXTDECS0 file in TAL sources.

The line:

--PRAGMA TAG COLUMN 90 "-- ~C~ ~u~"

causes a version tag to be placed on every line following the pragma. This tag would appear as"-- 1.008 RSB" on lines which were modified at version 1.8 by DEVEL.RSB, for example.



C40-ER00069/67/91

Table 6-9 Auxiliary Attributes for Components

Location Name Meaning

.ARCHIVE-SUBMIT Defines the subvolume where archive entries created duringSUBMIT operations are stored. These are typically long-termarchive items.

.ARCHIVE-PRODUCE Defines the subvolume where archive entries created duringPRODUCE operations are stored. These are typically short-termarchive items, although some entries will have a long-termlifespan.

.TEMP Temporary work subvolume.

.TEMP\state Temporary work subvolume for compiles at state.

.TEMP\node Temporary work subvolume for external compiles.

.TEMP\node\state Temporary work subvolume for external compiles at state.

.FORMAT

.QUALIFYPart of the RMSDIST server, these attributes act as defaultformatting and qualification parameters (if present on releasesand if the FORMAT and QUALIFY distribute and installoptions are not specified). The values are the same as for theFORMAT and QUALIFY options and are not case sensitive.

If the value of the auxiliary attribute is unknown, RMSDISTassumes the NULL value (FORMAT READ, QUALIFY NODE)for the parameters.

RMS reserves all names beginning with ARCHIVE and/or RMS-TEMP.

C40-ER00067 Examples

To add a .TEMP location to the group \APPL, type:

ADD LOCATION \APPL\.TEMP,TARGET $DATA.APLTEMP

C40-ER00069 To add a .ARCHIVE-SUBMIT location to the group \APPL, type:

ADD LOCATION \APPL\.ARCHIVE-SUBMIT, TARGET $DATA.APLARCSU






INFO PCR "{C40-ER000[78]*|C40-PR0004?}"



C40-ER00122 Note! The SUBMIT processor submits the abstraction components SRCLIB and DATALIB at states other thanlatest. Bug fix versions will automatically be created for non-LATEST submits, as necessary.

To effectively promote these components, use child dependencies through the.ADD-DEPENDENCIES group attribute.

C40-ER00121 Note! The SUBMIT command reports the newly-created version number for group submissions. This differsfrom prior releases of RMS where the version number for groups was returned as 0.000.

C40-ER00120 Note! The processing for .ORDER components on SUBMIT allows the automatic update of the .ORDERcomponent when the entire source library is submitted. This is done by checking the language of the.ORDER component. If the language is AUTO then the order will be preserved. If the language isAUTONUM then the order and the initial line number of the section will be preserved from the submittedfile.

Caution! When using AUTONUM, conflicts may arise if line numbering of the submitted file is incompatible withthe respective section components’ line increments. For example, if the original file is submitted with aline increment of 0.01, and the section components have a line increment of 1, then RMS will not beable to preserve line numbers. In such a situation, RMS will ignore conflicting line number entries in the.ORDER component.




C40-PR00108 Note! The SUBMIT command was failing when run units were being submitted to TCLPROG components.This occurred as a result of a problem in RMSMON when processing version timestamps duringTCLPROG submission only. Compiled SCOBOL run units are not affected by this condition

C40-PR00107 Note! The SUBMIT and EXTRACT commands were not correctly computing extent sizes for DATALIBcomponents. Prior to RMS C40.11, RMS occasionally computed a size too small, which resulted inGuardian file system error 45.



UNLINK COMPONENT Command

The UNLINK COMPONENT command allows a component to be removed from a groupwhile still being visible in other groups.

UNLINK COMPONENT comp-path-1 FROM comp-path-2

comp-path-1

is the component path name of the component to be unlinked from group comp-path-2.

comp-path-2

is the component path name of the group which is no longer to contain comp-path-1.

Considerations

Components can’t be deleted using this command.

C40-ER00018 Note! UNLINK COMPONENT restricts the ability to change the actual parent group component for segmentedlibrary sections. This command reports errors if you try to alter the parent group of a section or unlinkthe section from its parent. Alternate links are not affected by this change.

Warning! If a component is unlinked from its original group, an existing linked group is selected as its new parent.The component then inherits new security rules which may be weaker than in the original group.

Component CommandsUNLINK COMPONENT Command


UNLINK VERSION Command

The UNLINK VERSION command removes an association between a version and a userchange identifier.

UNLINK VERSION comp-path : version-specifierFROM ["] user-change-name ["]

comp-path

is the fully- or partially-qualified name of the component to be no longer associated withuser-change-name.

version-specifier

is a version number of comp-path. State names are not supported.

user-change-name

is a user change identifier that is currently associated with the version.

Considerations


This command replaces the ALTER VERSION, RESET USERCHANGE command.

Component CommandsUNLINK VERSION Command


UNLOCK Command

The UNLOCK command removes locks on a component.

UNLOCK comp-path [ : version-specifier ] [ "*" ][ , unlock-options ]

comp-path

is the name of the component which is currently locked.

version-specifier

is an optional version or state of the component to be unlocked. If this parameter is notprovided, LATEST is assumed.

"*"

causes all locks, regardless of the user, to be removed. The user must have MANAGERlevel access to the component being unlocked. If this parameter is not specified, only thelocks for the user (of RMSCOM) are removed.

unlock-options


RECURSIVE

causes locks to be removed for all child components of the one specified.

REMOVE

causes the file where the component was extracted when the lock was established to beremoved.

Considerations

Use this command with discretion. Unlocking a component will prohibit a subsequentSUBMIT.

C40-ER00066 Note! Lock files are represented by convention as either Guardian file names beginning with "\", OSS filenames beginning with "/" or Universal Resource Locators (URLs). RMS assumes these namingconventions.

The REMOVE option will only attempt to remove Guardian file names.

Component CommandsUNLOCK Command


77 State Commands

When the RMS catalog is created the following states are created: LATEST, DEVEL, TEST,PROD, FALLBACK, and OBSOLETE. You are not able to manipulate the LATEST statemarker as it is maintained automatically by RMS whenever a new version of a component iscreated.

The states are linked together in the following manner:

LATEST © DEVEL © TEST © PROD © FALLBACK © OBSOLETE

A component may be promoted along the path shown above as long as the followingrelationships hold true:

OBSOLETE FALLBACK PROD TEST DEVEL LATEST

Version < Version < Version < Version < Version < Version

Table 7-1 State Commands Summary

Command Description

ADD STATE Creates a new state.

ALTER STATE Modifies state attributes.

DELETE STATE Removes an isolated state.

DEMOTE COMPONENT Moves a state marker back.

DEMOTE RELEASE Drops back to a previous release.

LINK STATE Creates a promotion path between states.

LIST STATE Displays information about states.

PROMOTE COMPONENTMoves a state marker forward.

PROMOTE RELEASE Updates a release to contain the new state markers of allcomponents.

RESET RELEASE Clears state defaults.

SET STATE Establishes state defaults.

UNLINK STATE Removes a promotion path between states.

State Commands


ADD STATE Command

The ADD STATE command creates a new state.

ADD STATE state-name [ , WEIGHT relative-weight ]

state-name

is the name of the state to be created. A state name can consist of up to 32 letters andnumbers and must start with a letter.

relative-weight

is the relative priority of the specified state. RMS uses this weight to evaluate securitywhen two or more state markers are placed on a specific version of a component. Thestate with the highest weight is used as the basis of the security evaluation.

Considerations

All state names must be unique. It is not possible to add a state with an existing state name.


The user must have ADD access to the \STATES group in order to add a state.

State CommandsADD STATE Command


ALTER STATE Command

The ALTER STATE command modifies the attributes of an existing state.

ALTER STATE state-name[ ,{ NAME new-state-name } ][ ,{ WEIGHT relative-weight } ]

state-name

is the name of the state to be altered.

new-state-name

is the new name of the state. A state name can consist of up to 32 letters and numbers andmust start with a letter.

relative-weight

is the relative priority of the specified state. RMS uses this weight to evaluate securitywhen two or more state markers are placed on a specific version of a component. The statewith the highest weight is used as the basis of the security evaluation.

Considerations

All state names must be unique.


The user must have MODIFY access to the \STATES group in order to add a state.

State CommandsALTER STATE Command


DELETE STATE Command

The DELETE STATE command removes a state that is no longer needed.

DELETE STATE state-name

state-name

is the name of the state to delete.

Considerations

The state may not be linked to any other state when it is deleted.

This command is not case sensitive. A state-name of QUALITY is equivalent to quality.

Users should check all current security entries to see if any refer to the state prior todeleting the state.


The user must have DELETE access to the \STATES group in order to delete a state.

State CommandsDELETE STATE Command


DEMOTE Command

The DEMOTE command updates the state marker for components or releases to a given priorstate.

DEMOTE { COMPONENT comp-path [: version-specifier ] } { RELEASE release-path } { USERCHANGE ["] user-change-name ["] } TO state-name

Caution! The DEMOTE command doesn’t automatically move children back!

COMPONENT

changes the state of a component.

comp-path

is the component path name.

version-specifier

specifies the version of the component that should be associated with state- name.

state-name

is the present state of the component.

RELEASE

changes the state of a release.

release-path

is the path name of the release that should be changed. Release path resolution isusually automatically qualified by the \RELEASES group. See SET RELEASE (8-31)for details.

state-name

is the new state marker for the release.

USERCHANGE

changes the state of a user-change name.

State CommandsDEMOTE Command


user-change-name

is the userchange that should be changed.

state-name

is the new state marker for the user change identifier.

Considerations

The DEMOTE RELEASE command causes a promoted release to be dropped to aprevious state. It is not possible to demote components associated with a release throughthis command.

The DEMOTE COMPONENT command requires that the version which is specified asthe new state level is compatible with the existing state markers. It is not possible, forexample, to set the PROD state marker to be at a version greater than the TEST statemarker.

Promoting State Markers - In order to remove the highest state marker on a component,specify comp-state as 0.0 or NULL and state-name as the state marker to be removed. Itis only possible to remove the highest state marker. For example, suppose a componentcalled MYSOURCE has the state markers LATEST, DEVEL, TEST and PROD and youwanted to demote the component to LATEST. You can’t remove the TEST state markerwithout first removing the PROD one. The state markers must be removed in order, fromthe highest to the lowest (first remove PROD, then TEST and then DEVEL). The formatof the command is:

RMS) DEMOTE COMPONENT MYSOURCE:0.0 TO PROD

For compiled components, it is possible to drop any state marker at any time, providingthe user has DEMOTE security access.


This command is subject to the security attributes associated with the referenced componentsor releases. The user must have DEMOTE level security to perform this function. See SecurityCommands (9-1) for details.

State CommandsDEMOTE Command


LINK STATE Command

The LINK STATE command links two component states together so a component or a releasemay be promoted from one state to another.

LINK STATE state-name-1 TO state-name-2

state-name-1

is the state of the component prior to being promoted.

state-name-2

is the state of the component after being promoted.

Considerations

A state must not be linked to another state in such a way that a loop occurs in the state linktable. In other words, TEST cannot be linked to DEVEL. RMS does not enforce thisrestriction, however.


The user must have both ADD and MODIFY security to the \STATES group to perform thiscommand.

State CommandsLINK STATE Command


LIST STATE Command

The LIST STATE command displays a list of all states currently in the state table. In addition,the linked states can also be displayed.

LIST STATE { state-name } [ , DETAIL | RECURSIVE ] ... { "*" }

state-name

is the name of the state to list.

"*"

specifies all states.

DETAIL

gets a detailed listing, which includes the immediate predecessor state.

RECURSIVE

gets a listing of all states that may be reached from this state.

List State Report Format

RMS 18) LIST STATE state-name , DETAILLIST STATE state-namestate-name PREDECESSOR STATE: pred-state-name

state-name

is the name of the state to list.

pred-state-name

is the predecessor state name.

State CommandsLIST STATE Command


PROMOTE COMPONENT Command

The PROMOTE COMPONENT command changes the state marker for a component to anewer version. promote-options controls the processing of promote operations. verbose-levelspecifies the amount of detail to be reported as status messages during command processing.

PROMOTE [ / command-options / ] COMPONENT comp-path[: comp-state ] TO state-name [ , promote-options ]command-options

OUT file-name{ COMPONENT { ON | OFF } }{ DEPENDENCIES { ON | OFF } }{ FORCE { ON | OFF } }{ PRODUCE { ON | OFF } }{ RECURSIVE { ON | OFF } }{ RELEASE { ON | OFF } }{ RELEASE CONTENTS { ON | OFF } }{ USERCHANGE { ON | OFF } }{ USERCHANGE CONTENTS { ON | OFF } }{ VERBOSE verbose-level }one of { ALL }

{ BRIEF }{ OFF }

{ PROGRESS } { SELECTION } { WARNINGS } { * }

Note! PROMOTE COMPONENT causes the specified state marker to be placed on the version determined bycomp-state.

If you specify FORCE ON, the PROMOTE COMPONENT operation will proceed regardless of whethera component has its bug fix flag currently set. The use of this option requires MANAGER access.

State CommandsPROMOTE COMPONENT Command


COMPONENT { ON | OFF }

in a PROMOTE COMPONENT operation, causes the specified component to bepromoted. Defaults to ON.

DEPENDENCIES { ON | OFF }

promotes any component versions associated with the item being promoted. Defaults toOFF.

FORCE { ON | OFF }

indicates that the specified item should be promoted regardless of whether the contents ofthat item are consistent or not. Defaults to OFF.

PRODUCE { ON | OFF }

causes a produce to occur on the specified item. Set the PRODUCE options in advance ofexecuting this command. Defaults to OFF.

RECURSIVE { ON | OFF }

causes subcomponents of the specified item to be promoted. Defaults to OFF.

RELEASE { ON | OFF }RELEASE CONTENTS { ON | OFF }

causes the release item to be promoted. This CONTENTS option replaces the formerCONTENTS option of the PROMOTE RELEASE command. Both RELEASE andRELEASE CONTENTS can be specified as separate options. The defaults are ON andOFF, respectively.

USERCHANGE { ON | OFF }USERCHANGE CONTENTS { ON | OFF }

causes the user change item to be promoted. This CONTENTS option replaces the formerCONTENTS option of the PROMOTE USERCHANGE command. BothUSERCHANGE and USERCHANGE CONTENTS can be specified as separate options.These options can be specified in a PROMOTE RELEASE operation. The defaults are ONand OFF, respectively.

VERBOSE verbose-level

specifies how much detail is to be logged.

ALL or *

logs all messages.

BRIEF

gives a summary and error messages.



OFF

gives error messages only.

PROGRESS

gives progress status messages.

SELECTION

gives component selection messages.

WARNINGS

gives warning messages.

C40-ER00114 Note! The RMSSTATE server handles the PROMOTE COMPONENT. This means that you can log thePROMOTE command to an alternate device and that the command will not suspend the RMSMONprocess to the other users.

All promote and demote functions are handled by the RMSSTATE server from C40.09 on. This serveruses a waited mode of I/O operation to ensure the integrity of the catalog. That means, any I/O by theserver will wait until the record it works on is free of record and file locks. This may cause some promoteoperations that promote a lot of individual components to take a long time to complete (for examplePROMOTE COMPONENT, RECURSIVE ON on large segmented libraries or datalibs, PROMOTERELEASE, CONTENT, etc.). In the meantime, all other promote operations will be queued up behind it.

The strategy to avoid this is to associate a PCR with incremental changes to these libraries, whichtypically will promote the change components only. Another strategy is to try to do this kind of promotesonly during quiet periods, or batch the promotes during the slower periods.

Caution! Because PROMOTE commands are handled in the RMSSTATE server, you must ensure that there aresufficient RMSSTATE servers available to handle the maximum number of concurrent PROMOTErequests. If there are not, an RMS error 2039 (NO-RESOURCES) will be returned. Use the ALTERSERVER RMSSTATE,MAXSERVERS max number command to adjust the default value.

Note! The form CONTENTS [ PRODUCE ] [!] is supported for backward compatibility but will be dropped in arelease after RMS C40.



Considerations

The PROMOTE COMPONENT command requires that the version which is specified asthe new state level is compatible with the existing state markers. It is not possible, forexample, to set the PROD state marker to be at a version greater than the TEST statemarker.

Note! The "!" option will not work with the RECURSIVE option. If there are components containing bugfixversions under the comp-path, they must be reset before the recursive option will work.

Comp-state must refer to a state name rather than a version number for the RECURSIVEoption to work. The PROMOTE COMPONENT command applies only to source anddocument type components. Use the PRODUCE command to create a version of anobject at a specific state, as follows:

RMS) PRODUCE object:state


This command is subject to the security attributes associated with the referenced components.The user must have PROMOTE level security to perform this function. See SecurityCommands (9-1) for details.

Error Handling and TM/MP (formerly TMF)

Each of the PROMOTE commands will fail if an error is encountered and if you have notallowed errors. You can, and generally will get RMS error 2101 (invalid transition) oncomponents which are already at the desired state! This should not be considered a problemeven though the command will be terminated prematurely. Simply allow some or ALL errorsand proceed.

Each promote of a component in the PROMOTE COMPONENT and PROMOTEUSERCHANGE, regardless of specified options, is handled in a separate TM/MP transaction.If an error is encountered, all successful promotes will be retained.

Please refer to ALLOW ERRORS (Common User Interface (CUI) User’s Guide).



PROMOTE RELEASE Command

The PROMOTE RELEASE command causes the current release state to be updated to thespecified state. promote-options controls the processing of promote operations. verbose-levelspecifies the amount of detail to be reported as status messages during command processing.

PROMOTE [ / command-options / ] RELEASE release-name TO state-name [ , promote-options ] command-options


{ BRIEF }{ OFF }


Note! If you specify RELEASE CONTENTS ON, RMS will update the state markers for all releasecomponents that are not compiled.

If you specify PRODUCE ON, then RMS executes a PRODUCE of the release at the new state if thePROMOTE succeeds. If a PRODUCE is executed, the current settings made using the SET PRODUCEcommand are in effect.

State CommandsPROMOTE RELEASE Command






C40-ER00128 Note! The PROMOTE RELEASE, DEPENDENCIES ON option attempts to promote compiled objectcomponents. When all dependencies of an object are already at the target state, the object isconsidered to be at that state and is promoted. This significantly increases the speed at which largereleases promote. It also may remove the need to separately produce the release - although that is stilla highly recommended practice.

FORCE { ON | OFF }



causes a produce to occur on the specified item. Set the PRODUCE options beforeexecuting this command. Defaults to OFF.











ALL or *

logs all messages.

BRIEF


OFF


PROGRESS


SELECTION


WARNINGS



C40-ER00079 The /OUT/ option allows RMSCOM to be freed up during long PROMOTE RELEASE,RELEASE CONTENTS ON operations.

Considerations

The PROMOTE RELEASE command causes the release to refer to the new state of allcomponents within the release. If a release of promoted to a PROD state, for example, thenthe PROD versions of the components within the release are considered part of the release.


This command is subject to the security attributes associated with the referenced componentsor releases. The user must have PROMOTE level security to perform this function. SeeSecurity Commands (9-1) for details.



C40-PR00106 Note! Corrected a security problem in the RMSSTATE server. PROMOTE RELEASE and PROMOTE PCRwere only checking security as if the request came from the catalog owner, not the actual requestor.


If no errors are allowed, the entire promotion process is handled in one transaction, regardlessof whether the CONTENTS option is specified. If some or ALL errors are allowed, eachpromotion is handled in a separate step.

Please refer to ALLOW ERRORS in the Common User Interface (CUI) User’s Guide.



PROMOTE USERCHANGE Command

The PROMOTE USERCHANGE command causes the userchange state to be update to thespecified state. promote-options controls the processing of promote operations. verbose-levelspecifies the amount of detail to be reported as status messages during command processing.

PROMOTE [ / command-options / ] USERCHANGE userchange-name TO state-name [ , promote-options ]


{ BRIEF }{ OFF }


Note! If you specify USERCHANGE CONTENTS ON , RMS will update the state markers for appropriateversions of components that are associated with the userchange.

If you specify FORCE ON, the PROMOTE USERCHANGE operation will proceed regardless ofwhether any component has its bugfix flag currently set. The use of this option requires MANAGERaccess.

State CommandsPROMOTE USERCHANGE Command






FORCE { ON | OFF }



causes a produce to occur on the specified item. Set the PRODUCE options in advance ofexecuting this command. Defaults to OFF.









ALL or *

logs all messages.

BRIEF




OFF


PROGRESS


SELECTION


WARNINGS


C40-ER00115 Note! The PROMOTE USERCHANGE command supports the new promote options. This involves a slightchange to the command syntax although SPI still supports older tokens.

PROMOTE USERCHANGE (as for PROMOTE COMPONENT and PROMOTE RELEASE) functions inthe RMSSTATE server for all of its processing rather than in the RMSCOM process. This allows easieraccess to functionality including RECURSIVE, CONTENT and PRODUCE-type operations to behandled without needing detailed processing in front-ends. The changes to the command syntax aredocumented in the on-line help and Revision Management System (RMS) RMSCOM/RMSMONReference Manual as of the C40.09 version of RMS.


Considerations

The PROMOTE USERCHANGE command causes the state of the user change to be updated.The CONTENTS option causes the states of the components associated with a user change tobe updated as well.


This command is subject to the security attributes associated with the referenced userchangenames. The user must have PROMOTE level security to perform this function. See SecurityCommands (9-1) for details.


Each promote of a component in the PROMOTE COMPONENT and PROMOTEUSERCHANGE, regardless of specified options is handled in a separate TM/MP transaction.If an error is encountered, all successful promotes will be retained.



Please refer to ALLOW ERRORS in the Common User Interface (CUI) User’s Guide.



RESET STATE Command

The RESET STATE command clears defaults for state creation.

RESET STATE

Considerations

None.

State CommandsRESET STATE Command


SET STATE Command

The SET STATE command establishes defaults for state creation.

SET STATE WEIGHT relative-weight

relative-weight

is the relative priority of the specified state. RMS uses this weight to evaluate securitywhen two or more state markers are placed on a specific version of a component. The statewith the highest weight is used as the basis of the security evaluation.

Considerations

None.

State CommandsSET STATE Command


UNLINK STATE Command

The UNLINK STATE command is used to break the link between two states so that acomponent may not be promoted or demoted between the two states.

UNLINK STATE state-name-1 FROM state-name-2

state-name-1

is the initial state name.

state-name-2

is the final state name.

Considerations

The two specified states must be currently linked for this command to succeed.


The user must have DELETE and MODIFY access to the \STATES group in order to performthis command.

State CommandsUNLINK STATE Command


Notes:

State CommandsUNLINK STATE Command


88 Release Commands

This section describes commands which assist in the management of releases.

Releases are represented as group components within the RMS catalog structure. The ADDRELEASE command stores releases, by default, in the \RELEASES group.

Releases are initially set up in a THAWED state. Users can either add release-specificcomponents, or link existing components to the release group.

Once a release is CONTENTS FROZEN no subsequent ADD COMPONENT or LINKCOMPONENT commands are permitted within the release. Compiles of the componentswithin a release are still permitted, however. For more info, see FREEZE RELEASE (8-21).

Only after a release is VERSION FROZEN is it ready for distribution. Although developerscan still work on components which are referenced within a release, only the versionsavailable at the time the release was VERSION FROZEN will be included in the release. Formore info, see FREEZE RELEASE (8-21).

Release requisites describe the relationships between releases. Component requisites describerelease-freeze-time relationships between components. This section also covers release andcomponent requisites.

Release Commands


The following commands are relevant to release management:

Table 8-1 Release Commands Summary

Command Description

ADD RELEASE Creates a new release.

ADD REQUISITECOMPONENT

Creates a new relationship between components.

ADD REQUISITERELEASE

Creates a new relationship between releases.

ALTER REQUISITE COMPONENT

Changes component relationship attributes.

ALTER REQUISITERELEASE

Changes release relationship attributes.

CLEANUP RELEASE Purges the contents of a release library.

DELETE RELEASE Removes a dropped release.

DELETE REQUISITECOMPONENT

Removes a relationship between components.

DELETE REQUISITERELEASE

Removes a relationship between releases.

DISCONTINUE RELEASE

Removes content history of a release version.

DUPLICATE RELEASE Creates a copy of a release.

FREEZE RELEASE Prevents modification of a release.

LIST RELEASE Displays the contents of a release.

LINK COMPONENT References an existing component in a release - see LINKCOMPONENT (6-50 )

LINK RELEASE Establishes a relationship between a release and a user changeidentifier.

RESET RELEASE Resets the release attributes to their initial default values.

SET RELEASE Specifies the default release attributes.

UNLINK COMPONENT Removes a component from a release - see UNLINK (6-94).

Release Commands


ADD RELEASE Command

The ADD RELEASE command creates a new release. See LINK COMPONENT (6-50) foradding components to a release.

ADD RELEASE release-name [ , TYPE { RELEASE } ] ... [ { SUBRELEASE } ] [ { SUBSYSTEM } ] [ { VARIANT } ] [ , SUBVOL file-name ] [ , DESCRIPTION " 80-char-string " ] [ , GROUP release-path ] [ , MANIFEST manifest-file-name ]

release-name

is the component name of the release to add.

TYPE RELEASE

is the default and creates a standard release in the \RELEASES group.

TYPE SUBRELEASE

Releases of this type can only appear within another release. Subreleases are used torepresent items which are distributed optionally or after the main release.

TYPE SUBSYSTEM

Release subsystems are groups that contain default release types (TYPE RELEASE)and other release subsystems. Subsystems can either be in the \RELEASES group or ina subsystem group.

TYPE VARIANT

Releases of this type can only appear within another release. Variants representdeviations from base releases and inherit components from base releases.

file-name

specifies the subvolume name that will be used for storing the components of therelease.

80-char-string

describes the purpose of the release.

Release CommandsADD RELEASE Command


release-path

describes the parent of the release (see Considerations).

manifest-file-name

specifies the file name of the manifest file. The manifest file cannot appear in therelease subvolume.

Considerations

The group that the release is added to must be either \RELEASES or must have a mode ofRELEASE (i.e. a release added with this command).

Releases created by this command are initially in a THAWED state.

Security is inherited from the \RELEASES group or a parent release group. You mayhave to add security entries in order to allow release contents to be specified.

The MANIFEST and SUBVOL parameters are required for all release types exceptsubsystems. Subsystems must not be added with these paramaters.

The release-manifest component captures the version information of the release and mustnot be deleted or moved unless the release is deleted.

The group option (when not specified) will use the group parameter in the SETRELEASE command (the default is \RELEASES). If a release is added as a child of asubsystem, or a subrelease/variant is added as a child of a release, the group parametermust be used to specify the parent.

The release manifest will be created by using one of the following template files residingin the RMS subvolume:

Table 8-2 Release Manifest Templates

Template File Name Description Supplied by:

RMSMTPLR Release template forRELEASE-type releases.

User

RMSMTPLS Release template forSUB-RELEASE type releases.

User

RMSMTPLV Release template forVARIANT-type releases.

User

RMSMTPLT Default release template for anytype of release.

RMS



Sub-release and Variants

Releases which are neither sub-releases or variants are known as base releases. These releasesare self-contained.

Sub-releases are generally used to represent releases which are separate but logicallycontained within another release. Post-development changes to selected product componentsare usually represented by sub-releases. Sub-releases can be contained within releases,variants or other sub-releases.

Variants are generally used to represent deviations or options of a base release. Optionalproducts, for example, can be placed in variant releases. Variants inherit all componentversions (dependencies) of the parent release. Variants need only store items which are a partof the "optional" portion of the release. Any required items from the base release areincorporated automatically.

Subsystems

Subsystems provide a grouping mechanism for releases. Generally, a subsystem will representa product (e.g., (RELEASES\RMS). A subsystem contains releases of a product (e.g.,\RELEASES\RMS\C20,\RELEASES\RMS\C30). Subsystems, on their own, cannot bedistributed.

Reserved Attributes

Table 8-3 Reserved Attributes for Releases

Attribute Name Attribute Value Meaning

.DEFINES N/A Specifies that the existingDEFINE name of componentspresent in the release will bespecified in the releasemanifest.

.FORMAT N/A Acts as a default formattingparameter if the FORMATdistribute and install optionsare not specified.

.FULL-PATH N/A Specifies that the full originalpath name of componentspresent in the release will bespecified in the releasemanifest.

.NO-DESCRIPTION N/A Causes the DESCRIPTIONfield in the release manifest tobe omitted.



.NO-LANGUAGE N/A Causes the LANGUAGE fieldin the release manifest to beomitted.

.QUALIFY N/A Acts as a default qualifyingparameter if the QUALIFYdistribute and install optionsare not specified.

Please refer to ADD ATTRIBUTE (12-12) for more information on auxiliary attributes.

Note! The SOURCE ON option causes CHECK to be involved at release freeze time, whether you specify itor not. This ensures that the release is consistent between its objects and sources.

C40-ER00091 Note! The values of the attributes are the same as for the FORMAT and QUALIFY options and are not casesensitive. If the value of the auxiliary attribute is unknown, RMSDIST (The RMS release distributionserver) assumes the NULL value (FORMAT READ,QUALIFY NODE) for the parameters.



ADD REQUISITE COMPONENT Command

The ADD REQUISITE COMPONENT command creates a relationship between components.

ADD { CONTRA }REQUISITE COMPONENT { CO } subject-release-name { PRE }

TO object-release-name { ON { FREEZE | * } } { OPTIONAL { ON | OFF } }

subject-component-nameobject-component-name

are the names of the components involved in the requisite relationship.

requisite-options

is one of the following parameters:

ON { FREEZE | * }

indicates the requisite relationship is to be evaluated whenever a FREEZERELEASE,VERSIONS command is issued.

ON *

indicates the requisite relationship is to be evaluated whenever any of the abovecommands are issued.

OPTIONAL { ON | OFF } (this is reserved for future use).

Considerations

A prerequisite relationship indicates that the subject-component-name must be present inall releases containing object-component-name.

A corequisite relationship indicates that the subject-component-name andobject-component-name must always appear together in all releases. Corequisites arebidirectional, meaning that following two requisites relationships are equivalent:

ADD COREQUISITE COMPONENT A TO BADD COREQUISITE COMPONENT B TO A

Release CommandsADD REQUISITE COMPONENT Command


A contrarequisite relationship indicates that two components cannot be present in thesame release. Contrarequisite relationships are bidirectional.

The ON option indicates when RMS should evaluate the requisite relationship. The onlyvalue currently evaluated is FREEZE indicating that the relationship is evaluated whenthe release is version-frozen.

The OPTIONAL ON option is not currently supported for components.

Requisites are evaluated at the times indicated by the ON option. Since it is not effectiveto detect, and not known by RMS at specification time, RMS does not validate whetherthe specified requisites will cause a loop condition or not. Loop detection and automaticcorrection (if possible) are accomplished at evaluation time.

Release CommandsADD REQUISITE COMPONENT Command


ADD REQUISITE RELEASE Command

The ADD REQUISITE RELEASE command creates a relationship between releases.

ADD { ANTE } REQUISITE RELEASE { CONTRA } subject-release-name TO object-release-name { CO } { PRE }

[, { ON { ACQUIRE | DISTRIBUTE | { { FALLBACK | FREEZE | { { INSTALL | * } } { ON "(" { ACQUIRE } [ "," { ACQUIRE } ] } { DISTRIBUTE } [ { DISTRIBUTE } ] } { FALLBACK } [ { FALLBACK } ] } { FREEZE } [ { FREEZE } ] } { INSTALL } [ { INSTALL } ] } ... ")" } { OPTIONAL { ON | OFF } }

subject-release-nameobject-release-name

are the qualified release names involved in the requisite relationship.

release options

Release options involve one of the following parameters:

ON ACQUIRE

indicates the requisite relationship is to be evaluated whenever an ACQUIRERELEASE command is issued.

ON DISTRIBUTE

indicates the requisite relationship is to be evaluated whenever a DISTRIBUTERELEASE command is issued.

ON FALLBACK

indicates the requisite relationship is to be evaluated whenever a FALLBACKLOCATION command is issued.

ON FREEZE

indicates the requisite relationship is to be evaluated whenever a FREEZERELEASE,VERSIONS command is issued. This option is not supported for releases.

Release CommandsADD REQUISITE RELEASE Command


ON INSTALL

indicates the requisite relationship is to be evaluated whenever an INSTALLRELEASE command is issued.

ON *

indicates the requisite relationship is to be evaluated whenever any of the abovecommands are issued.

OPTIONAL { ON | OFF }

indicates that the requisite relationship is optional. The relationship will only beevaluated if the location to which the release is being distributed is licensed to receivethe optional requisite release.

Considerations

A prequisite relationship indicates that the subject-release-name must be present in ordistributed to the target location before the object-release-name.

A corequisite relationship indicates that the subject-release-name andobject-release-name must be installed together. If one release is already present, it is notreinstalled. Corequisites are bidirectional, meaning that following two requisites areequivalent:

ADD COREQUISITE RELEASE A TO BADD COREQUISITE RELEASE B TO A

A contrarequisite relationship indicates that two releases cannot be installed or distributedtogether. Contrarequisite relationships are bidirectional.

An anterequisite relationship defines release upgrade paths. If the following commandsare specified:

ADD ANTEREQUISITE RELEASE A TO BADD ANTEREQUISITE RELEASE B TO C

then C can be installed only if either: (i) B is installed, or (ii) neither A nor B is installed.Once A is installed, B must be installed before C.

The ON option indicates when RMS should evaluate the requisite relationship.

The OPTIONAL ON option indicates that the requisite is relevant only if the targetlocation is licensed for the release. OPTIONAL OFF is the default.

Requisites can be placed on any release level, including subsystems. Requisites areinherited down to the release level only. (e.g., a contrarequisite between two subsystems



indicates that all releases within the subsystems are respectively exclusive). Subreleasesand variants do not inherit requisite relationships.

Requisites are evaluated at the times indicated by the ON option. Since it is not effectiveto detect, and not known by RMS, at specification time, RMS does not validate whetherthe specified requisites will cause a loop condition or not. Loop detection and automaticcorrection, if possible, is accomplished at evaluation time.



ALTER REQUISITE COMPONENT Command

The ALTER REQUISITE COMPONENT command modifies component requisiterelationships.

ADD { CONTRA } REQUISITE COMPONENT { CO } subject-release-name TO { PRE } object-release-name { ON { FREEZE | * } } { OPTIONAL { ON | OFF } }



requisite-options

Please refer to ADD REQUISITE COMPONENT (8-7) for details on requisite options.

Considerations

It is not possible to change the type of requisite relationship. If, for example, aprerequisite must be changed into a corequisite, the relationship must be deleted andrespecified.

Release CommandsALTER REQUISITE COMPONENT Command


ALTER REQUISITE RELEASE Command

The ALTER REQUISITE RELEASE command is used to modify release requisiterelationships.

ALTER [ ANTE } REQUISITE RELEASE { CONTRA } subject-release-name TO

object-release-name { CO } { PRE }

[, { ON { ACQUIRE | DISTRIBUTE | { { FALLBACK | FREEZE | { { INSTALL | * } } { ON "(" { ACQUIRE } [ "," { ACQUIRE } ] } { DISTRIBUTE } [ { DISTRIBUTE } ] } { FALLBACK } [ { FALLBACK } ] } { FREEZE } [ { FREEZE } ] } { INSTALL } [ { INSTALL } ] } ... ")" } { OPTIONAL { ON | OFF } }



requisite options

Please refer to ADD REQUISITE RELEASE (8-9) for details on requisite options.

Considerations

It is not possible to change the type of requisite relationship. If, for example, a prerequisitemust be changed into a corequisite, the relationship must be deleted and respecified.

Release CommandsALTER REQUISITE RELEASE Command


CLEANUP RELEASE Command

The CLEANUP RELEASE command removes temporary working files from a release’slibrary.

CLEANUP RELEASE qualified-release-name

qualified-release-name

is the qualified release name to clean.

Considerations

All files which are known to the release are removed from the release library. Thetemporary manifest component $vol.A.MANIFEST is also removed.

Any files which are not known to the release are not purged.

This command does not violate the integrity of a release. Only working files are removed.

This command duplicates the functionality of the DISTRIBUTE CLEANUP option.

Release CommandsCLEANUP RELEASE Command


DELETE RELEASE Command

The DELETE RELEASE command removes an inactive release from the catalog.

DELETE RELEASE qualified-release-name


is the qualified release name to delete.

Considerations

The release must either be in an OBSOLETE state, or in a LATEST state and must nothave been distributed or installed.

Any components which are specific to the release being deleted are moved into the\ORPHANS group in a sub-group having the same name as the release. The dependenciesfrom the components to the releases are still in place until the release-manifestcomponent is deleted.

Warning! If there is a name conflict, the component is deleted instead of being moved to the \ORPHANS group.

The DELETE RELEASE command performs an implicit CLEANUP RELEASE beforeactually removing the release from the RMS catalog. If the CLEANUP RELEASE fails,usually resulting from Guardian or SafeGuard security restrictions, DELETE RELEASEwill terminate with an appropriate error and will not remove the release.

Release CommandsDELETE RELEASE Command


DELETE REQUISITE COMPONENT Command

The DELETE REQUISITE COMPONENT command is used to remove component requisiterelationships.

DELETE REQUISITE COMPONENT subject-component-name TO object-component-name



Considerations

Requisite relationships can be removed at any time.

Release CommandsDELETE REQUISITE COMPONENT Command


DELETE REQUISITE RELEASE Command

The DELETE REQUISITE RELEASE command removes release requisite relationships.

DELETE REQUISITE RELEASE subject-release-name TO object-release-name



Considerations

Requisite relationships can be removed at any time.

Release CommandsDELETE REQUISITE RELEASE Command


DISCONTINUE RELEASE Command

The DISCONTINUE RELEASE command discontinues the availability of a vesion of arelease. This prevents distribution, installation, and fallback.

DISCONTINUE RELEASE qualified-release-name : release-version


is the qualified release name to be modified.

release-version

is the actual version for which access is to be removed. A version of a release isrepresented by the version of its release manifest.

Considerations

This command removes all dependencies from the component\RELEASES\release-name\RELEASE-MANIFEST version release-version.

Warning! Use extreme caution when using this command as dependent objects could be available for deletionfollowing the successful execution of this command.

You should ensure that versions of releases that are being discontinued are not or will notbe running in any environment and should no longer be supported.

This command provides managers with a mechanism of retaining release distribution andinstallation history without the need to maintain component version history. As a result,this command should only be used for discontinued release versions.

The LATEST version of the release cannot be discontinued.

It is possible to recover from an inappropriate DISCONTINUE RELEASE command bythawing and re-freezing the specified release.

Warning! Use caution as versions of components selected may not be the same as were originally frozen intothe release.

Release CommandsDISCONTINUE RELEASE Command


DUPLICATE RELEASE Command

The DUPLICATE RELEASE command creates a new copy of a release.

DUPLICATE RELEASE release-name TO new-release-name [ , TYPE { RELEASE } ] ... [ { SUBRELEASE } ] [ { SUBSYSTEM } ] [ { VARIANT } ] [ , SUBVOL file-name ] [ , DESCRIPTION " 80-char-string " ] [ , GROUP release-path ] [ , MANIFEST manifest-file-name ]

release-name

is the name of the source release to be used as a template.

new-release-name

is the name of the new release to be created.

TYPE RELEASE

is the default and creates a standard release in the \RELEASES group.

TYPE SUBRELEASE


TYPE VARIANT

Releases of this type can only appear within another release. Variants representdeviations from base releases and inherit components from base releases.

TYPE SUBSYSTEM

Subsystems are logical groups of releases. While you cannot distribute a subsystemgroup, you can add releases within a subsystem. License attributes can also be added tosubsystems.

file-name

specifies the subvolume name that will be used for storing the components of the release.

80-char-string


Release CommandsDUPLICATE RELEASE Command


release-path

describes the parent of the release (see Considerations).

manifest-file-name

specifies the file name of the manifest file. The manifest file cannot appear in the releasesubvolume.

Considerations

The newly-created release will contain all components that are currently linked into theoriginal source release.

This command is performed in two TM/MP (formerly TMF) transactions. The firstcreates the release. The second duplicates the links. Even if linkage operations fail,new-release-name will be created.

Warning! The DUPLICATE RELEASE command implemented before C40 may not be able to link thecomponents of a subrelease if the subrelease is duplicated to a different parent release. It also maynot be able to link components of a release if the release is duplicated to a different parentsubsystem.

If the new-release-name already exists then only the links from the template are copied tothe new release.

Please refer to ADD RELEASE (8-3) for more considerations.

Release CommandsDUPLICATE RELEASE Command


FREEZE RELEASE Command

The FREEZE RELEASE command prevents modification of release contents and versions ofcomponents, as described below.

FREEZE RELEASE [ / OUT list-file / ] release-name [ , { CONTENTS } ]

[ , { VERSIONS } ] [ , { CHECK { ON | OFF } ] [ , { FORCE { ON | OFF } ] [ , { VERBOSE verbose-level } ]

release-name

is the name of the release to freeze.

CHECK { ON | OFF }

causes this command to verify that the components within the release are up to date andnot in conflict. This is used with the VERSIONS option only.

FORCE { ON | OFF }

causes the VERSIONS freeze to ignore components that do not have versions at the stateof the release and user change identifiers which are only partially contained in the release.This is particularly useful when, for example, new SCOBOL requestors are added to aTCLPROG library and compiled at LATEST without being compiled at PROD.

Release CommandsFREEZE RELEASE Command


C40-ER00042 Multiple Message Levels

VERBOSE verbose-level } verbose-level [ , verbose-level ]...}

one of { ALL } }{ BRIEF } }{ OFF } }{ PROGRESS } }{ SELECTION } }{ WARNINGS } }{ * } }

RMSMAKE supports multiple message levels to control the type and amount of messageslogged during a produce.

ALL or *

logs all messages.

BRIEF


OFF


PROGRESS


SELECTION


WARNINGS


C40-ER00080 Note! FREEZE RELEASE, VERBOSE controls how much information is logged by the RMSRELSE serverduring freeze processing.



C40-ER00015 FREEZE RELEASE,VERSIONS supports these auxiliary attributes for releases:

Table 8-4 Auxiliary Attributes for Rele ases


.DEFINES N/A Specifies that the existingDEFINE name of componentspresent in the release will bespecified in the releasemanifest.

.FULL-PATH N/A Causes new componentsacquired with the release to bestored in the same path as fromthe original catalog. If themanifest does not contain pathnames, this attribute is ignored.

.NO-DESCRIPTION N/A Causes the DESCRIPTIONfield in the manifest to beignored.

.NO-LANGUAGE N/A Causes the LANGUAGE fieldin the manifest to be ignored.

C40-ER00095 Note! FREEZE RELEASE,VERSIONS supports special DOT attributes (.KEY-DESC, .DATA-DESC and thosein the table above) and release requisites in release manifests.

The manifest predicate "ATTRIBUTE" placed on components describes the attribute name and valuefor component attributes. Only .KEY-DESC and .DATA-DESC are included in the manifest.

The manifest predicate "RELEASE_REQUISITE_" replaces the "PRED_RELEASE_" and"PRED_CATALOG_RELEASE_" predicates. There is one predicate for each release requisite of therelease. For PRE- and ANTErequisites, only those releases which are prerequisites and anterequisitesof the release are included. Releases having the release frozen as a prerequisite won’t be listed.

Contra- and corequisites will be listed.



Considerations

The requisites will not necessarily appear on the releases on the acquiring system (whenthat is supported) as they do on the distributing system. The mapping is:

Distribution Acquisition

A pre B sameSubsys A pre B sameA pre Subsys C(contains B) A pre BB pre A ignored in all cases

A co B sameSubsys A co B sameA pre Subsys C(contains B) A co BB co A A co BB co Subsys A A co BSubsys C co A A co B

The rules for ante are the same as for pre. Rules for contra are the same as for co.

FREEZE RELEASE CONTENTS causes RMS to reject any attempt to add or deletecomponents from a release. The release must be in an OPEN state.

FREEZE RELEASE VERSIONS causes RMS to save the current version, at the release’sstate (e.g. PROD), of all components in the release. This information is captured in therelease-manifest with dependency relationships created to the version of the manifestcomponent. Even if subsequent PROMOTE requests cause changes to component states,there will be no effect on the release contents. Users will also be unable to delete anyversions of components listed in a release which is frozen. This option (VERSIONS) isthe default if neither VERSIONS, nor CONTENTS is specified.

C40-ER00004 FREEZE RELEASE, VERSIONS ignores GROUP components which are present in arelease but do not represent component abstractions (e.g., dictionaries, TCLPROGS).

If a FREEZE fails, you should check the manifest for locks.



Note! When a release is version frozen, the version number of the release manifest is increased. Adependency relation is also created for each version of the linked component to the version of themanifest.

If a release has sub-releases or variants, then it must have its versions frozen before anysub-release or variant. It must also have its versions thawed after all sub-releases andvariants.

FREEZE RELEASE VERSIONS reports the component versions being selected as partof the release to the list-file. The release must be in a CONTENT FROZEN state.

FREEZE RELEASE VERSIONS also validates component requisites, and linked userchange identifiers.

Warning! The CHECK ON option should always be used if the release being frozen is at the LATEST state. Thisprevents the accidental inclusion of versions at other states that have been produced more recentlythan appropriate to the LATEST state. FREEZE RELEASE VERSIONS will fail if this option is specifiedand components in the release require compilation.



LINK RELEASE Command

The LINK RELEASE command associates user change identifiers with releases.

LINK RELEASE qualified-release-name TO["] user-change-name ["]


is the qualified release name to which the user change will be associated.

user-change-name

is a valid user change reference

Considerations

Linking a user change name to a release causes FREEZE RELEASE, VERSIONS toverify that the release completely contains the user change. This means that the userchange must:

be at the same promotion state as the release (e.g., PROD)

be linked to the release (through this command)

have all concluding dependent components included in the release. This type ofcomponent can’t have any further dependencies to it (for example, final executableobjects).

The FREEZE RELEASE, VERSIONS command will fail if any user change is linked butdoes not completely satisfy the above requirements, unless the FORCE option is used.

All user change names linked to releases will appear in the release manifest. The sectionin the manifest when the user change names appear depends on whether those names arenewly added to the release or have previously been frozen into the release. These userchange names are also associated with the version of the release manifest at which theyfirst appeared.



Release CommandsLINK RELEASE Command


LIST RELEASE Command

The LIST RELEASE command displays an abridged release manifest. For a complete releasemanifest, extract the RELEASE-MANIFEST component of the release to your terminal orprinter.

LIST RELEASE qualified - release-name


is the qualified release name to list.

List Release Report Format

RMS 20) LIST RELEASE release-nameABRIDGED MANIFEST FOR RELEASE release-name

DESCRIPTION: description PREPARATION SUBVOLUME: sub-volumeCURRENT STATE:current-state FREEZE STATE: freeze-stateINCLUDE SOURCE: on-off-flag[SCHEDULED] CONTENT FREEZE DATE: content-date[SCHEDULED] VERSION FREEZE DATE: version-date[SCHEDULED] DROP DATE: drop-dateLAST PROMOTION DATE: promote-dateREQUISITE OF subject-release-name ON *object-release-name IS REQUISITE ON *... PCR user-change-name . . .COMPONENT : VERSION -----------------------------------------component : ...

release-name

is the name of the release.

description

is the description of the release as it was entered when the release was created.

Release CommandsLIST RELEASE Command


subvolume

is the name of the subvolume where components will be placed during a PRODUCErelease command.

requisite

is the release requisite relationship associated with the release. It can be one ofANTEREQUISITE, COREQUISITE, CONTRAREQUISITE, or PREREQUISITE.

subject-release-name

is the name of the release used as the subject when the release requisite relationship wasadded.

object-release-name

is the name of the release used as the object when the release requisite relationship wasadded.

freeze-state

is the release state: OPEN, CONTENTS FROZEN or DISTRIBUTION.

current-state

is the promote-state: DEVEL, TEST, PROD, etc.

content-date

is the date the contents of the release were frozen or will be frozen. If the date has not beenset or is in the future the word SCHEDULED will appear.

version-date

is the date the versions of the components in the release were or will be frozen. If the datehas not been set or is in the future the word SCHEDULED will appear.

drop-date

is the date the release was or will no longer have to be recreatable. If the date has not beenset or is in the future the word SCHEDULED will appear.

promote-date

is the date the release was last promoted from one state to another.

component

is a component of the release.



on-off-flag

is the flag for the ON or OFF condition.

user-change-name

is the userchange identifier linked to the release.

C40-ER00029 Note! LIST RELEASE reports whether any associated REQUISITE relationships (to other releases andcomponents respectively) are "OPTIONAL", meaning those requisites which are only evaluated whenthe target location is licensed to receive both items of a relationship. INFO COMPONENT,DETAIL alsoreports this information.

Considersations

To list the versions of components in a VERSION FROZEN release, use:

LIST DEPENDENCIES FROM \ release \r elease-manifest

All source dependencies can be displayed using LIST DEPENDENCIES, RECURSIVEfrom the release manifest.



RESET RELEASE Command

The RESET RELEASE command clears the RELEASE parameters back to their defaultvalues.

RESET RELEASE

Considerations

This command adjusts the default location for adding releases back to the \RELEASES group.

Release CommandsRESET RELEASE Command


SET RELEASE Command

The SET RELEASE command specifies defaults for the ADD RELEASE command.

SET RELEASE { TYPE { RELEASE } } { { SUBRELEASE } } { { SUBSYSTEM } } { { VARIANT } } { SUBVOL file-name } { DESCRIPTION " 80-char-string " } { GROUP release-path } { MANIFEST manifest-file-name }

TYPE RELEASE

is the default and is used to create a standard release in the \RELEASES group.

TYPE SUBRELEASE


TYPE VARIANT

Releases of this type can only appear within another release. Variants represent deviationsfrom base releases and inherit components from base releases.

TYPE SUBSYSTEM

Release subsystems are groups that contain default release types (TYPE RELEASE) andother release subsystems. Subsystems can either be in the \RELEASES group or in asubsystem group.

file-name

specifies the subvolume where the release will be stored.

80-char-string


Release CommandsSET RELEASE Command


release-path

specifies the group that the release should be part of. Normally releases are added to the\RELEASES group; however, a sub-release, or release variant is often convenientlyspecified as a child of another release. The default is \RELEASES.

manifest-file-name

specifies the file name of the manifest file. The manifest file cannot appear in the releasesubvolume.

Considerations

Please see ADD RELEASE (8-3) for details on each parameter.

Release CommandsSET RELEASE Command


SHOW RELEASE Command

The SHOW RELEASE command displays the current settings of the release parameters.

SHOW RELEASE

Considerations

None.

Show Release Report Format

RMS 22) SHOW RELEASESHOW RELEASEGROUP groupTYPE typeSUBVOLUME subvolDESCRIPTION descriptionMANIFEST manifest-file-nameSOURCE on-off-flag

group

is the parent group of the release. It is set to \RELEASES after a RESET RELEASEcommand.

type

is the type of the RELEASE. It is set to RELEASE after a RESET RELEASE command.

subvol

is the subvolume work area that RMS will use to assemble the release.

description

is the 80-character description of the release.

manifest-file-name

is the name of the manifest file name.

on-off-flag

is the flag for the ON or OFF condition.

Release CommandsSHOW RELEASE Command


THAW RELEASE Command

The THAW RELEASE command reverses the effects of a FREEZE RELEASE command sothat the components included in a release or their versions may be changed.

THAW RELEASE qualified-release-name [ , { CONTENTS } ] [ , { VERSIONS } ]


is the qualified release name to thaw.

CONTENTS

thaws the contents of the release so they may be changed.

VERSIONS

is used prior to changing the version of a component in a release.

Considerations

THAW RELEASE CONTENTS causes RMS to accept any attempt to add or deletecomponents from a release. This option (CONTENTS) is the default if neitherVERSIONS, nor CONTENTS is specified.

THAW RELEASE VERSIONS causes RMS to allow the update of the versions of allcomponents in the release. This allows changes to versions, as a result of PROMOTErequests, to be incorporated into a release.

If a release has sub-releases or variants, then it must have its versions thawed after allsub-releases and variants. It must also have its versions frozen before any sub-release orvariant.

Release CommandsTHAW RELEASE Command


UNLINK RELEASE Command

The UNLINK RELEASE command associates user change references with releases.

UNLINK RELEASE qualified-release-name FROM["] user-change-name["]


is the qualified release name to which the user change will no longer be associated.

user-change-name

is a valid user change reference currently linked to the release.

Considerations

Removing a link between a user change identifier and a release does not remove the history ofthe association. Validation of the user change is no longer performed by FREEZE RELEASE,VERSIONS, however.

Release CommandsUNLINK RELEASE Command


Notes:

Release CommandsUNLINK RELEASE Command


99 Security Commands

This section describes the security-related commands supported by RMS.

Considerations:

The following considerations are important when using RMS on a Safeguard protected system:

If RMS program objects are secured using Safeguard, special consideration should begiven to any licensed objects. Safeguard will remove the license attribute of an objecteach time the access lists are modified. This can have a negative effect on runningsystems if license is not immediately re-established.

If the $RMP process name (or any monitor process names) are to be protected, theappropriate catalog owner should be the only user able to start the corresponding monitor.

RMS-managed files and catalog files are all created with security "OOOO" or "UUUU"for C30(1.008) and higher. If Safeguard is to be placed on these files, the catalog ownershould be the only user on the access list.

If user default security is set up through Safeguard, establish the RMS catalog ownersecurity as local user or network user only.

If compiled object files are managed using Safeguard, place objects in their ownsubvolumes. Establish default security so that any user authorized within RMS to modifythe objects also has Safeguard purge access to the objects.

If compiled object files are not managed using Safeguard, be aware of user defaultsecurity settings.

The RMS PRODUCE command has the ability to establish security for compiled objectsthrough the use of security masks. See SET PRODUCE (11-) for details.

If RMSMAKE is used from a remote node, all RMS catalog owner files must be securedfor network read access for the network RMS catalog owner user id (e.g.,\*.RMS.OWNER).

Note! ACQUIRE MANIFEST is a frequent source of security violations. The user doing the acquire must havea least network user read/write access in the default security. This permits RMS on the distributing nodeto open and write to the temp file (#nnnn) on the acquiring node.

Security Commands


Table 9-1 Security Commands Summary

Command Description

INFO SECURITY Displays all access control lists from a specified component inthe catalog back to the root entry.

SECURE Modifies the security attributes of a specified component in thecatalog.

Security Commands


How Does RMS Handle Security?

It first searches down the list of allowed attributes and adds them up. Then, it goes up the listand subtracts the list of attributes which are denied.

Figure 9-1 RMS Access Control

The following security attributes are derived from the diagram:

Level 0 Only RMS.MGR has access.

Level 1 RMS.MGR has all access.

Level 2 RMS.MGR has all access.DEVEL.* has READ and PROMOTE access exceptDEVEL.user who has only PROMOTE access.

Level 3 RMS.MGR has all access except PROMOTE.

DEVEL.* has READ and MODIFY access except DEVEL.userwho only has MODIFY access.

Note! RMS.MGR, the catalog owner, is always permitted to change security attributes so this restriction is notbinding.

Allowed Attributes Denied Attributes

rms.mgr + *

devel.* + read devel.user+deny read

devel.* + promote

devel.* + modify *.* + deny promote

0

1

2

3

4

Security CommandsHow Does RMS Handle Security?


Command Security Requirements

The following are the security requirements for all RMSCOM commands. If a command isnot listed here, no security requirements exist for that command.

Table 9-2 Command Security Attribute Cross-Reference

Key:

S State-Level Security is relevant

Y Security at All States is required

Command ADMIN

MANAGER

READ

MODIFY

DELETE

LOCK

CHGATTR

ADD

PROMOTE

DEMOTE

FREEZE

THAW

EXTRACTFOR READ,COMPILEFOR EDIT,WORK

SS S S

ALTER VERSION S

SUBMITSOURCEDATE OPTION

Y

S S

PRODUCE INTERNALEXTERNAL

S SS

UNLOCKSELFOTHER S

SS

SECURE Y1

SHUTDOWN2

ALTER RMS2

Security CommandsCommand Security Requirements


Command ADMIN

MANAGER

READ

MODIFY

DELETE

LOCK

CHGATTR

ADD

PROMOTE

DEMOTE

FREEZE

THAW

CLEANUP RMS2

CLEANUP RELEASE S

ADD RULE Y

ALTER RULE Y

DELETE RULE Y

DISTRIBUTE RELEASE3 S

INSTALL RELEASE3 S

ACQUIRE RELEASE3,4 S

FALLBACK RELEASE S

ADD COMPILESOURCEOBJECT

Y YY

DELETE COMPILEOBJECT Y

ADD REFERENCETO ITEMFROM ITEM

YY

DELETE REFERENCETO ITEMFROM ITEM

YY



Command ADMIN

MANAGER

READ

MODIFY

DELETE

LOCK

CHGATTR

ADD

PROMOTE

DEMOTE

FREEZE

THAW

ADD USERCHANGE\USERCHANGE GROUP

Y

ALTER USERCHANGE\USERCHANGE GROUP

Y

DELETE USERCHANGE\USERCHANGE GROUP Y

ADD STATE\STATES GROUP Y

DELETE STATE\STATES GROUP Y

ALTER STATE\STATES GROUP Y Y

LINK STATE\STATES GROUP Y

UNLINK STATE\STATES GROUP Y

ADD COMPONENT Y

ALTER COMPONENTWITH GROUP OPTION

YY Y

DELETE COMPONENT Y

DELETE VERSIONS Y

CONDENSE Y



Command ADMIN

MANAGER

READ

MODIFY

DELETE

LOCK

CHGATTR

ADD

PROMOTE

DEMOTE

FREEZE

THAW

OBSOLETE Y

ROLLOUT8 Y

PROMOTE COMPONENT S

DEMOTE COMPONENT S

LINK COMPONENTGROUPCOMPONENT Y

Y Y

UNLINK COMPONENT7

GROUPCOMPONENT Y

Y Y

ADD RELEASE Y

DUPLICATE RELEASE Y

DELETE RELEASE Y

PROMOTE RELEASE5 S

DEMOTE RELEASE5 S

FREEZE RELEASE CONTENTS S S

FREEZE RELEASE VERSIONS6 S

THAW RELEASE CONTENTS S S

THAW RELEASE VERSIONS S



Command ADMIN

MANAGER

READ

MODIFY

DELETE

LOCK

CHGATTR

ADD

PROMOTE

DEMOTE

FREEZE

THAW

ADD LOCATION Y

DELETE LOCATION Y

ALTER LOCATION Y

ALTER SERVER\SERVERS GROUP

Y

ADD LICENSERELEASELOCATION

YY

YY

ALTER LICENSERELEASELOCATION

YY

YY

DELETE LICENSERELEASELOCATION

YY

YY

DISCONTINUE RELEASE Y Y

ADD REQUISITE Y Y

ALTER REQUISITE Y Y

DELETE REQUISITE Y Y

ADD ATTRIBUTE Y

DELETE ATTRIBUTE Y



1 The Catalog owner always has CHGATTR security regardless of the actual entries in thecatalog.

2 Guardian security if "A", "G", "O". "N", "C", "U", "-" and corresponds to the securitymechanism imposed based on Guardian User access to given functions. There is only onesecurity entry of this kind per monitor. For example, if the security is "O", then only thecatalog owner can shut down RMS.

3The DISTRIBUTE, INSTALL, and ACQUIRE release commands all require appropriatelevels of access to the components that are part of the release. For example, the user who isdistributing a release requires READ access to the version of the component beingdistributed. It is recommended that the user who performs such operations have READaccess at all states as the state of the components within a release can changeindependently from the release itself.

4The ACQUIRE release command requires read, modify and lock access to thecomponents that are part of the release. The Guardian User doing the ACQUIRE releasemust have read access set to network access on the distributing node.

5The PROMOTE RELEASE command requires PROMOTE access to the componentsthat are part of the release, if the CONTENTS option is used.

6The FREEZE RELEASE VERSIONS command requires READ, MODIFY and LOCKaccess to the RELEASE-MANIFEST component for the release being frozen.

7The UNLINK COMPONENT command may also require the CHGATTR security if theprincipal parent group component will change as a result of the unlink. This is notnormally needed for release processing. However, in a catalog reorganization scenario, theattribute is likely to be required.

8If the version to be rolled out is at the LATEST state, the creator of that version ispermitted to perform the ROLLOUT command.



INFO SECURITY Command

The INFO SECURITY command displays the access control lists of the selected componentor path.

INFO SECURITY comp-path [ : state-name ] [, BRIEF ]

comp-path

is the component on which RMS should report security.

state-name

is the state of the component associated with the query. The LATEST state is assumed ifthis paramater is not specified.

BRIEF

only reports on the specified path and state-name. It does not go up the tree searching forrelevant security entries.

Considerations

In order to obtain security entries for states other than LATEST, the state-name parametermust be specified.

INFO SECURITY Command Examples

To obtain all security entries relevant to a production release called MAKE-C10, type thefollowing command:

RMS 24) INFO SECURITY \RELEASES\MAKE-C10:*

To obtain only the security entries relevant to the PROD state for the above release, type thefollowing command:

RMS 24) INFO SECURITY \RELEASES\MAKE-C10:PROD

In the second of the above examples, the security entries which were added with a state-nameof PROD will be reported. In the first example, all entries are reported regardless of theircorresponding states.

Security entries added without a specific state are only visible if state-name is specified as *or latest.

Security CommandsINFO SECURITY Command


Info Security Report Format

RMS 30) INFO SECURITY comp-pathSECURITY ENTRIES RELEVANT TO comp-path

user [ALLOW sec-atr DENY - sec-atr ] inherit from path

comp-path

is the component path that the security is being reported on.

user

is the TANDEM user name of the the user.

sec-atr

is one of the following security attributes:

blank None (used for deny).

* All (used for allow).

ADD Creates new components/releases.

CHGATTR Changes security attributes.

DELETE Deletes of new components/releases.

DEMOTE Fallback.

FREEZE (FRZ) Freezes release.

LOCK Extracts for edit, compile, work.

MANAGER (MGR) Manager access.

MODIFY Alters.

PROMOTE Promotes component/release.

READ Extracts for read.

THAW Thaws release.

path

the component path where the security was placed on the sub-tree.

Security CommandsINFO SECURITY Command


SECURE Command

The SECURE command modifies the security attributes of a specified component or path.

SECURE comp-path [ : state-name ] , USER user-specifier{ + | - } [ DENY ] { security-attr }{ "(" security-attr [ , security-attr ] ")" }

comp-path

is the name of the component which is to have its security attributes modified.

state-name

is the optional state of the component which is to be secured. This state can be one of thefollowing:

"*" All states of the component.

LATEST Only the latest state of the component. This is the default valuefor this parameter.

state-name A specific state name.

This parameter should be specified as "*" for items which are special RMS-specificcomponents such as RULES, STATES, SERVERS, etc. Components with file names suchas SOURCE, DOCUMENT, OBJECT, GROUP, RELEASE, MANIFEST, etc. can usestate names, "LATEST" or "*".

user-specifier

is composed of an optional system spec followed by a local-user-spec. If the system specis left off the user specification refers to users of the local system only:

[ system-spec . ] local-user-specifier


\system-name if system-name is provided then only users from that system thathave a User ID that matches the user-specifier may perform thefunction.

"*" if "*" is provided then all network and local users that have aUser ID that matches the user-specifier may perform the function.

Security CommandsSECURE Command


local-user-spec


*.* All users on local system.

group-name.* All users in the group on local system.

group-num,* All users in the group on local system.

group-name.user-name

A specific user on local system.

group-num,user-num

A specific user on local system.

security-attr

is one of the following attributes:

* All attributes.

ADD Createsof new components/releases.

CHGATTR Changes security attributes.

DELETE Deletes of new components/releases.

DEMOTE Fallback.

FREEZE (FRZ) Freezes release.

LOCK Extracts for edit, compile, work.

MANAGER(MGR)

Manager level access.

MODIFY Alters.

PROMOTE Promotes component/release.

READ Extracts for read.

THAW Thaws release.



Considerations

The user must have CHGATTR level security on the comp-path component in order toperform this command.

The security attributes altered by this command will be inherited by all child componentsof comp-path.

The evaluation of security attributes proceeds towards the root component (\) from thecomponent level in question. Allowed attributes are logically OR’ed together as theevaluation proceeds until a match of the needed attributes is encountered. If any of theattributes are DENIED or if insufficient attributes are found, the security check fails.

Security entries for specific users are always considered to override entries for generalusers. If comp-path has an entry for DEMO.JOHN with READ access and one forDEMO.* with MODIFY access, DEMO.JOHN only has READ access to that entry(unless a higher level entry grants MODIFY access to the user).

To assign READ access to all components (all versions) in the catalog to all users, enterthe following command:

RMS 20) SECURE \:*, USER \*.*.* + READ

Remember that the state-name parameter defaults to LATEST. For your security entries tohave meaning for items other than the latest versions of components, do not depend onthe default value of state-name.

The + is used to add security attributes. Adding attributes may not create a new securityentry. It may add on the new attributes to an existing entry that is specified by thecomp-path, state-name and user-specifier parameters. Adding attributes to a DENYentryincreases the number of attributes that are denied to the specified user.

The - is used to remove security attributes. Removing attributes may remove an existingsecurity entry if all attributes are removed. Removing attributes from a DENYentrydecreases the number of attributes that are denied to the specified user.



Operating System Interactions

The PRODUCE command has special considerations when operating in a Safeguardenvironment:

In order to identify the version of an object, RMS requires that either the user ofRMSCOM or the catalog owner have read access to that object. If neither user hasaccess, RMS will consistently replace the object each time it is needed. If the object existsin the RMS archive, it is pulled from there; otherwise, the object is recompiled.

The PRODUCE command will fail if newly created objects are not readable by either theuser doing the produce or the catalog owner.

The above PRODUCE considerations apply to standard objects (code 100), TCLPROGfiles, and PNA rule databases.

The above PRODUCE considerations also apply to the production of release libraries inthe DISTRIBUTE RELEASE, INSTALL RELEASE, and FALLBACK LOCATIONcommands.



Notes:



1010 Server Commands

This section discusses commands which control the operation of the RMS server classes.There are seven server classes at present: RMSUBMIT, RMSMAKE, RMSDIST,RMSACQIR, RMSNET, RMSRELSE, and RMSFALBK. None of these servers run withbackup processes. Depending on your system configuration, you may or may not have all ofthese servers.

The RMS servers operate in a manner similar, but not identical to PATHWAY servers. Eachserver process is allocated from a pool of static and dynamic servers defined by theNUMSTATIC and MAXSERVERS attributes, respectively. RMS chooses the processor inwhich new server processes are run from the list of CPUs specified through the ALTERSERVER command. There is no selection priority associated with elements of a cpu-list.

The following commands are supported for servers:

Table 10-1 Server Command Summary

Command Description

ALTER SERVER Changes the operational/running parameters of servers within thespecified server class.

FREEZE SERVER Prevents the allocation of a server class to user requests.

INFO SERVER Obtains information about a server class.

START SERVER Starts the static servers of a server class.

STATUS SERVER Obtains status information about the processes within a serverclass.

STOP SERVER Stops all servers within a server class.

THAW SERVER Allows the allocation of servers from a server class.

Server Commands


ALTER SERVER Command

The ALTER SERVER command changes the running paramaters of servers within thespecified server class(es).

ALTER SERVER server-name [ , CPUS { ( cpu-num [ , cpu-num ] ... ) } { * } { cpu-num } ] [ , OUT log-file-name ] [ , STARTUP " string " ] [ , PRIORITY pri ] [ , NUMSTATIC num-static-servers ] [ , MAXSERVERS max-servers ] [ , DELETEDELAY time { SECONDS } { MINUTES }

{ HOURS } ] [ , TEMPLATE " process-name-template " ] [ , RESET { STARTUP | TEMPLATE } ]

server-name

is one of RMSMAKE, RMSUBMIT, RMSDIST, RMSACQIR, RMSFALBK,RMSRELSE, RMSNET.

cpu-num

is the cpu where the server should execute. There is no allocation priority associatedwith this list. A server may be started in any of the CPUs in the list.

log-file-name

is the file name where log messages will be printed. This file can be $0, EMS or aspool collector, but should not be a physical disc file.

string

is a startup param string for the server class.

pri

is the priority at which the server class will execute.

num-static-servers

is the number of static servers in the server class.

Server CommandsALTER SERVER Command


max-servers

is the maximum number of servers in the server class.

time

is the amount of time, in the units specified, (e.g., hours), during which a dynamicserver with no work will be kept available, after which it will be deleted.

"process-name-template"

is a quoted string specifying a template that RMSMON will use when assigningprocess names. A "?" character is substituted with a decimal digit.

Considerations

In order for the alterations to take effect, the servers within server-name must be stoppedand restarted. This command does not depend on the freeze state of a server class.

Process name templates are used to assign ranges of process names to server classes.

Sample Name Template Name Template Range

"$RMM?" $RMM0 through $RMM9

"$RMM??" $RMM00 through $RMM99

Since RMSMON will attempt to use the lowest possible name when assigning new names.Server classes can share template definitions.

Template Restrictions

"?" characters must be contiguous. "$R?M?" is illegal.

There can be a maximum of three "?" characters yielding a maximum name-space of1000 entries per template.

In the Cxx versions of RMS, templates may be restricted to a maximum of fivecharacters.



RMSUBMIT Server Specific Startup Parameters

ALTER SERVER RMSUBMIT,STARTUP "unique lines, maxlines, mem pages"

unique lines

is the number of unique lines in the file. The maximum value is 2147483647.

max lines

is the maximum number of lines in the source file. The maximum value is 2147483647.

mem pages

is the number of memory pages allocated to store the text from the files.

the defaults for these paramaters are 20000, 25000, 600

Note! If a submit or difference command fails for any of the following errors contact DDS technical support forrecommended settings:

dRMS-ERR-OLD-FILE-TOO-BIGdRMS-ERR-NEW-FILE-TOO-BIGdRMS-ERR-TOO-MANY-UNIQUE-LINES

Limits are subject to available disk space. Swap file size is approximately:

20Kb + (max-lines*32b) + (unique-lines*20b) + (mem-pages*2Kb)

RMSMAKE Server Specific Startup Parameters

ALTER SERVER RMSMAKE,STARTUP "[TACLCSTM][,PFSSIZE &bytes][,NOREFRESH]"

if "TACLCSTM" is present, the user’s TACLCSTM file is executed when TACLstarts up. Otherwise TACL ignores the user’s TACLCSTM.

The PFSSIZE parameter must be greater than 131072.

The NOREFRESH parameter disables calls to REFRESH() on D00 or greaterversions of Guardian. Calling REFRESH() on D-series operating systems has a largeimpact on system performance.

C40-PR00105 Note! Expanding compressed files that are an exact multiple of 28K bytes long in their compressed form wascausing problems. This has existed in all prior versions of RMSUBMIT and RMSMAKE, and is fixed.



C40-ER00041 RMSRELSE Server Specific Startup Parameters

The RMSRELSE server takes two new startup parameters. These parameters are specifiedusing the ALTER SERVER RMSRELSE, STARTUP command option.

ALTER SERVER RMSRELSE,STARTUP "[READTHRU][,NODEPWAIT]"

Note! Please consult the Tandem ENSCRIBE Programmer’s Guide for more information on record and filelocking before attempting to use these parameters.

the READTHRU option causes the server to read through any record locks currentlypresent in the RMS catalog. If this parameter is not present, the server will now wait forrecord locks to be released. This applies to all files other than the DEPREL FILE.

the NODEPWAIT option causes the server to not attempt to wait for a file-level lock onthe DEPREL file. Normally, RMSRELSE will lock the entire DEPREL file due to limitson the total number of record locks permitted on an ENSCRIBE disk volume. Forenvironments with small releases, it may not be necessary to lock the entire file, therebyallowing multiple simultaneous release freezes.



FREEZE SERVER Command

The FREEZE SERVER command disables a particular server class. This prevents RMS fromallocating processes to perform submit, extract, compiles, etc.

FREEZE SERVER server-name-patt

server-name-patt

is either an existing server name or server name pattern of the server(s) to be frozen.

"*"

refers to all servers.

Considerations

The FREEZE SERVER command has no effect on server allocation that RMSMON performson its own behalf. The DISTRIBUTION function of RMS requires services from a number ofservers. These servers are allocated regardless of the freeze state of the required server classes.

Server CommandsFREEZE SERVER Command


INFO SERVER Command

The INFO SERVER command displays the current operating paramaters for RMS serverclasses.

INFO SERVER server-name

server-name

is either a server class name or "*" to obtain information on all servers.

Considerations

Info Server Report Layout

RMS 40) INFO SERVER server-nameINFO SERVER server-name

CPUS { ( cpus ) | * }OUT out-filePRIORITY priNUMSTATIC num-staticMAXSERVERS max-serversDELETEDELAY delete-time unitsOBJECT obj-file-nameIN in-fileDEFAULT-VOLUME default-volumeSTARTUP paramTEMPLATE "process-name-template "

server-name

is the name of the server class.

cpus

is a list of cpus the server class may be run in.

"*" is used to signify all cpus.

out-file

is the file where log messages will be written by the server-class.

pri

is either 0 to signify that the server-class should run at the same priority as the RMSMONprocess or a number between 1 and 199, inclusive.

Server CommandsINFO SERVER Command


num-static

If there are more than num-static simultaneous reports for this server class, RMSMONwill start a new server. The total number of simultaneous requests is limited bymax-servers.

max-servers

is the maximum number of servers of this server class that RMSMON is capable ofdealing with simultaneously. If max-servers servers are running subsequent requests willbe rejected until one of the servers becomes free.

delete-time, units

together describe the amount of time a server will be left running if num-servers is greaterthan num-static.

obj-file-name

is the name of the object file for the server-class.

in-file

is the in-file name of the startup message.

Note! Most server-classes ignore this parameter and read their requests from $RECEIVE.

default-volume

is the default volume portion of the startup message.

Note! Most server-classes use this parameter to locate the RMS catalog.

param

is the text portion of the startup message.

"process-name-template"

is a string specifying a template used when assigning process names.

Server CommandsINFO SERVER Command


START SERVER Command

The START SERVER command starts all static servers for one or all server classes.

START SERVER server-name-patt

server-name-patt

is either a server class name or "*" to start all server classes.

Considerations

This command has no effect for server classes having no static servers(NUMSTATIC = 0). Such server classes are reported as being STARTED even if noservers are actually running.

No servers from a FROZEN server class will be started regardless of the number of staticservers.

Server CommandsSTART SERVER Command


STATUS SERVER Command

The STATUS SERVER command is used to display the status of one of the specified serverclasses along with the process names and cpus that the servers are running in.

STATUS SERVER server-name-patt

server-name-patt

is either a server class name or "*" to start all server classes.

Considerations

None.

Status Server Report Format

RMS 40) STATUS SERVER server-nameSTATUS SERVER server-nam e CPUS cs NUMSTATIC ns NUMRUNNING nr

--PROCESS STATE PCPU BCPU ERROR -- proc stat pc bc err

server-name

is the server name.

cs

is either ’*’ for all cpus or a list of cpus in which the server may run.

ns

is the number of static servers.

nr

is the number of servers running. If there are some servers running the process informationis displayed.

proc

is the process name.

Server CommandsSTATUS SERVER Command


state

is one of:

IDLE If the server is not processing a command.

STARTING If the server is starting.

STOPPING If the server is stopping.

STOPPED If the server is stopped.

PROCESSING If the server is executing a command.

pc

is the primary cpu the process is running in.

bc

is the backup cpu for the process or -1 if there is no backup. Most, if not all, RMS serverswill not have backup processes.

err

is the last error that occurred on the process.

Server CommandsSTATUS SERVER Command


STOP SERVER Command

The STOP SERVER command stops all servers of given server class or all server classes.

STOP SERVER server-name-patt

server-name-patt

is either a server class name or "*" to stop all server classes.

Considerations

A server is not actually stopped until all processing currently being done by the server iscompleted.

A server class does not need to be frozen to be stopped, although it is recommended thatyou do freeze the server class before stopping it.

Server CommandsSTOP SERVER Command


THAW SERVER Command

The THAW SERVER command enables RMS to use a particular server class which has beenpreviously frozen.

THAW SERVER server-name-patt

server-name-patt

is either a server class name or "*" to stop all server classes.

Considerations

A server class must be in a frozen state for the THAW command to have any effect.

Server CommandsTHAW SERVER Command


Notes:

Server CommandsTHAW SERVER Command


1111 Compile Commands

This section describes the RMS compilation facility.

There are a number of parts to the RMS compilation facility: rule specification, programreference management, compilation, and dependency management.

Before programs can be compiled, appropriate compilation rules must be added to the catalogstructure. These rules are TACL commands which run the standard or user-suppliedprocessors which actually perform the compile. RMS is packaged with a number of defaultrules for some of the standard language processors supported on Tandem systems. Please referto the Revision Management System (RMS) Installation Guide for more information aboutthese rules.

Once rules are specified, the user must establish a relationship between a source and an objectcomponent using the ADD COMPILE command. Unless otherwise specified, the rule used ina compile will have the same name as the language of the source component. It is thereforeappropriate to specify the source component attribute LANGUAGE rather than leaving itblank.

Be aware that compile rules cannot be modified if an object exists in the RMS catalog whichwas produced using that rule. RMS enforces this restriction to ensure that objects can alwaysbe reproduced.

Within this facility, RMS does not distinguish between source and object components. Objectcomponents can be compiled into other object components during a BINDER session. In thisway, RMS supports separate compilation of object modules as described in many of thelanguage processors supplied by Tandem.

To perform separate compilation, the user must establish the references that each objectcomponent makes to procedures in other object components. See ADD REFERENCE (11-6)for the considerations for separate compilation.

During the actual compilation phase, RMS executes rules one step at a time. After each step,RMS evaluates the TACL completion code associated with the last program execution withinthe job step. If the completion code is non-zero, the job step is assumed to have failed and thecompilation is terminated.

Before RMS completes the compilation of an object, it constructs the dependency list for thatobject. Dependencies include: all source and object components actually referenced fromwithin RMS, all referenced external components, and the language processors specified ineach rule step. These can be examined using the LIST DEPENDENCIES command butcannot be modified.

Most compile problems occur as a result of poorly formed rules. You should always use carein creating and modifying rules. See ADD RULE (11-8) for rule troubleshooting.

Compile Commands


The following commands are relevant to the RMS compilation facility:

Table 11-1 Compile Commands Summary

Command Description

ADD COMPILE Adds a compile relationship between a source and an objectcomponent.

ADD REFERENCE Adds a reference to a source file from another source file, or toan object file from another object file.

ADD RULE Adds a compilation rule.

ALTER RULE Changes an unreferenced rule.

DELETE COMPILE Deletes a relationship between a source and an object component.

DELETE REFERENCE Removes a reference between two components.

DELETE RULE Deletes an unreferenced rule.

DUPLICATE RULE Creates a copy of a rule.

EDIT RULE Edits an entire rule.

LIST COMPILE Displays compile relationships to or from a component.

LIST DEPENDENCIES Displays items used by RMS to produce an object component.

LIST REFERENCE Displays items references by a component.

LIST RULE Displays the contents of a rule.

PRODUCE Compiles an object.

RESET PRODUCE Clears the current default settings.

SET PRODUCE Establishes current default settings.

SHOW PRODUCE Displays current default settings.

Compile Commands


ADD COMPILE Command

The ADD COMPILE command defines compilation instructions between the principal sourceand object files or between main and executable object files.

ADD COMPILE comp-path [TO] to-comp-path [ USING rule-name ]

comp-path

is the component name of the source file to compile.

to-comp-path

is the component name of the object file resulting from the compile.

rule-name

is the name of the rule to use to perform the compile.

Considerations

If the rule-name parameter is not specified, the rule which has a language the same as thelanguage of the source component is used to produce to-comp-path.

RMS does not bind a specific rule to the produced object until that object is produced.

RMS selects the appropriate rule, based on its name and level in the catalog at compiletime. See Considerations for resolving rules (11-9).

Only one ADD COMPILE command is required to compile source components whichreference source libraries. RMS uses the principal source component’s reference list togather the information necessary for the compile.

It is possible to produce many object components from a given source component.Different rules must be used if this feature is needed.

It is never possible to produce one object from multiple different principal sources.

C40-ER00117 RMS compiles DDL dictionaries and automatically submits them at the end of thecompile. DDL dictionaries must be explicitly compiled. If not, RMS will ignore changesto DDL sources until the dictionary is explicitly compiled. Now you can controlpublication of the change.

Note! SRCLIB components in DDL dictionary groups must have the .ADD DEPENDENCIES Group attribute.This attribute allows RMS to create child dependencies to sections in the generated libraries.

Compile CommandsADD COMPILE Command


C40-ER00105 RMS restricts the type of components being used as the source of a compile relationships. Tosatisfy this restriction, the source of a compile must be a NORMAL non-GROUP component.Other component types can’t be specified as the source of a compile. In addition, abstractionscannot be specified as sources of a compile.

If you want to add this GROUP compile relationship, use this approach to source in the groupin the appropriate language:

Figure 11-1 Adding a GROUP Compile Relationship

Note! ?source extdecs0 contains and references all the sections, then compiles them to TALLIB.

Previously ...

We suggest :

EXTDECS0 TALLIBcompiles

to

?source extdecs0

TALLIB

compilesto



Separate Compilation

The RMS compilation facility supports separately compiled object modules. The standardBIND rule distributed with RMS assumes that the object module containing the program’sMAIN procedure is compiled to the executable object file. For example:

RMS 26) ADD COMPILE mainobj TO execobj USING BINDER

All references to other object modules used by the main object module are expected to be inplace. See the Separate Compilation Considerations for references (11-7).

C40-ER00039 Security Considerations

For ADD COMPILE security restrictions requiring MANAGER access on the target objectcomponent- you need MODIFY access on the object component. READ access on the sourcecomponent is also required.



ADD REFERENCE Command

The ADD REFERENCE command tells RMS to add a new source or object reference to aversion of a component.

ADD REFERENCE referenced-comp-path FROMreferencing-comp-path [ : version-specifier ]

referenced-comp-path

is the referenced component name or path.

referencing-comp-path

is the referencing component name or path.

version-specifier

is an optional version number, or state of the referencing component which is to receivethe reference entry. If no state is specified, LATEST is assumed. There must be at least oneversion of referencing-comp-path in order for this command to succeed.

Considerations

Source components frequently make reference to other components for the purpose ofprogram compilation. For example, TAL programs which interact with Guardian mustreference the $SYSTEM.SYSTEM.EXTDECS0 file. For most common Tandemlanguages, RMS is able to automatically generate appropriate file references. Thesereferences are determined from either ?SOURCE, COPY, or #include statements,depending on the language. The ADD REFERENCES command is designed to augmentthis automatic reference generation facility which RMS invokes each time the SUBMITcommand is processed.

This command also provides a mechanism for supporting components whose sourcelanguage is not supported by RMS. For such languages, you need to manually enter allfile references.

When an object module is compiled, any references recorded for the object areautomatically transferred to the new version. You need to maintain reference lists forobjects produced using implicit binding.

Compile CommandsADD REFERENCE Command


Separate Compilation Considerations

In addition to source component references, RMS retains information about object filereferences. There are two basic strategies for handling references in environments wherethe separate compilation of object modules is used: direct and indirect referencing. Thedifference between the two techniques depends on where object references are specified.

In direct referencing, the object component which contains the MAIN procedurehas a list of all other object files needed to completely BIND an executable objectwithout any undefined externals. This strategy is most appropriate where there arevery few shared object modules or where inter-modular procedure references are notdeeply nested.

In indirect referencing, an object component has a list of all other objectcomponents which contains procedures which are used. A reference list of all objectcomponents is derived automatically by RMS prior to binding the final executableobject. This strategy is particularly useful where there is a high degree of modulesharing. The developer need only specify the objects which are referenced by a givenobject without concern for the references at a lower level.

Both models for object reference management can be used simultaneously; however, it isrecommended that only one be used within a given group if the catalog is organized byapplication or program.

Add Reference Examples

The following commands add references from a "main" object to lower level objects (note thatIO is implicitly referenced through FORMAT):

RMS) ADD REFERENCE \MYAPPL\UTIL FROM \MYAPPL\MAINOBJRMS) ADD REFERENCE \MYAPPL\FORMAT FROM \MYAPPL\MAINOBJRMS) ADD REFERENCE \MYAPPL\IO FROM \MYAPPL\FORMAT

Compile CommandsADD REFERENCE Command


ADD RULE Command

The ADD RULE command creates a new general compilation rule which applies to a groupand all descendant subgroups.

ADD RULE may also be used to add rule steps to existing rules.

ADD RULE rule-name , rule-options [, LANGUAGE rms-language } ]

[, FILE file-name } ] [, GROUP comp-path } ] [, STEP step-num } ]

rule-name

is the name of the rule to add.

rule-options

is one or more of the following:

LANGUAGE RMS-languageFILE file-nameGROUP comp-pathSTEP step-num

RMS-language

is the name of the language that the source module should be to use this rule. This fieldis a maximum of eight bytes long.

file-name

is the name of the language processor or compiler to use to process the sourcecomponents into the object component. This parameter is required if the languageprocessor is to appear as a dependency of the object component.

comp-path

is the name of the group or component that the rule applies to. The rule will be visibleonly below this point in the component tree.

step-num

is the number of the step for which this processor should be invoked in a multi-stepcompile.

Compile CommandsADD RULE Command


Considerations

ADD RULE can be used to either create a new rule or append to an existing rule. Ifstep-num is not provided and the rule already exists at the specified group, a new step isappended onto the end of the existing rule.

After entering the ADD RULE command, RMSCOM will prompt the user for the ruletext with a prompt of "+" until the user enters a line that consists of "//". If the text has amistake use the EDIT RULE command to change it.

If step-num is more than one greater than the last step number in the existing rule, the stepis treated as a simple append. Step-num is ignored in this case.

Rules can be added to any level of the catalog structure.

There can be more than one rule with the same name at different levels in the RMScatalog. The default rules which are packaged with RMS are normally placed at the root(\) component. Rules which are placed at lower levels in the catalog override the defaultrules.

Multiple-Step Rules

RMS checks the TACL completion codes at the end of each compile step. If a non-zerocompletion code is detected, RMS assumes that the compile has failed.

At the end of a rule, RMS ensures that the object component being produced has actuallybeen modified. If no modification has occurred, RMS assumes that an error has occurredin the specification of a rule step. Note that RMS checks to see whether the componentactually needs to be compiled before transmitting the rule information to TACL.

Note! Please contact RMS Technical Support if you have problems creating or working with rules.

SQL Considerations

SQL compiles are treated as multi-step compiles and are supported by RMS. You should placeeach compile phase - pre-processor, compiler, SQLCOMP - in separate rule steps so thatcompile failure detection can work properly.

Note! The most efficient place to put the SQLCOMP compile step is in the DISTRIBUTE, PRE-INSTALL orINSTALL rule.



TACL Support Macros

RMS provides a number of macros and variables to assist with user-specified rules. Allvariables are stored in the :RMS variable directory. Do not modify any variable in thisdirectory . The following macros and routines may be called/referenced by user-specifiedrules:

Table 11-2 RMS Compile Macros and Variables

:RMS:source The principal source input file to be used in the compile. Thismay be a temporary or archive file name.

:RMS:source^file The actual principal source component’s physical file name as itappears in the RMS catalog.

:RMS:source^path The full path name of the source component.

:RMS:object The physical file name of the object file being produced.

:RMS:object^path The full path name of the object component.

:RMS:reference The list of files corresponding to the references of the sourcecomponent. Each component is on a separate line in the variable.Items can be removed from the list using the #EXTRACT TACLbuilt-in function.

:RMS:processor The file name of the processor of the rule step.

:RMS:SQL^Catalog The subvolume of the SQL catalog in which the object has beenregistered. This variable is empty if there is no current catalog.

:RMS:list The standard location where output is to be sent. Thiscorresponds to the listing-file parameter specified in thePRODUCE command.

:RMS:ignore^completion low-compl-code [ TO high-compl-code ]

This routine ignores completion codes in the specified range.

:RMS:set^completion new-compl-code

This routine sets the TACL completion codes to the specifiedvalue.

:RMS:ignore^errors This routine ignores completion codes returned from compilerswhich indicate that there were fatal errors or diagnostics(including warnings).



:RMS:ignore^warnings

This routine ignores completion codes returned from compilerswhich indicates that there were warning diagnostics.

:RMS:set^buildoptionstext

This routine allows the user to specify BINDER instructions forthe BUILD command generated by the :RMS:BIND routine.

:RMS:BIND This routine is a generic BINDER macro which produces anexecutable object based on the variables provided by RMS.

:RMS:component^group

This routine returns the group path name of a full componentpath.

:RMS:component^name

This routine returns the base component name (no "\") of a fullcomponent path.

C40-ER00009

Table 11-3 Language Option Variables

:rms:Talôptions Symbols, INSPECT, NOMAP, NOCODE, NOICODE, Suppress.

:rms:Cobolôptions

Symbols, INSPECT.

:rms:Scobolôptions

Symbols.

:rms:SQLôptions NORECOMPILE.

:rms:Côptions Symbols, INSPECT.

:rms:Fortranôptions

Symbols, INSPECT.

Note! Anything you change here should NOT affect the resulting object. Otherwise, you might jeapordize thereproducibility of an object.

RMSBASE supports the :rms:Fortranôptions variable.



ALTER RULE Command

The ALTER RULE command changes the contents of a rule step.

ALTER RULE rule-name , { STEP { step-num } }{{ *} }{ NAME new-rule-name }

rule-name

is the name of the rule to modify.

step-num

is the number of the step to be modified. Rule steps are numbered from 0 to 63, inclusive.

"*"

alters all steps of a compilation rule.

new-rule-name

specifies a new name for the compilation rule.

Considerations

The rule name specified by this command is subject to the current group withinRMSCOM. See the SHOW (6-72) and GROUP (6-38) commands for details.

The rule must not have been used to produce a currently existing object version if theSTEP option is specified.

Changing a rule’s name using the NAME option does not affect the compilation of anyexisting versions of components compiled using the specified rule. However, subsequentnew compiles (where new versions are created) may be affected by changes to rule names.

Compile CommandsALTER RULE Command


DELETE COMPILE Command

The DELETE COMPILE command removes compilation instructions between the principalsource and object files or between main and executable object files.

DELETE COMPILE source-comp-name { FROM } object-comp-name { TO }

source-comp-name

is the name of the principal source component which is compiled to the target objectcomponent object-comp-name. This parameter can be a fully or partially-qualifiedcomponent path.

object-comp-name

is the name of the object component which is produced from source-comp-name. Thisparameter can be a fully or partially-qualified component path.

Considerations

This command has no effect on compilation instructions associated with previouslycompiled object versions.

DELETE COMPILE Examples

The following example illustrates the correspondence between the ADD COMPILE andDELETE COMPILE commands:

RMS) ADD COMPILE src-comp TO obj-comp USING TALRMS) DELETE COMPILE src-comp TO obj-comp

C40-ER00039 Security Considerations

The DELETE COMPILE security restrictions do not require MANAGER access on the targetobject component. You need MODIFY access on the object component.

Compile CommandsDELETE COMPILE Command


DELETE REFERENCE Command

The DELETE REFERENCE command tells RMS to ignore a target source or objectreferences made by a version of another source or object file.

DELETE REFERENCE to-comp-path [FROM] from-comp-path [ : version-specifier ]

to-comp-path

is the name of the component which is referenced by from-comp-name.

from-comp-path

is the name of the component which is referencing from-comp-name.

version-specifier

is the optional version number, or state of from-comp-path associated with the reference. Ifversion-specifier is not provided, LATEST is assumed. In general, you should explicitlyspecify a version number.

Considerations

This command is generally used for the management of object module references.

Warning! If a reference is removed from a source component, it may not be possible to compile the sourcecomponent into an object. Use caution when performing this operation.

Compile CommandsDELETE REFERENCE Command


DELETE RULE Command

The DELETE RULE command removes a general compilation rule which applies to a groupand all descendant subgroups.

DELETE RULE rule-name , STEP { step-num } { * }

rule-name

is the name of the existing compilation rule to be deleted.

step-num

is the step to delete.

"*"

deletes all steps of a rule.

Considerations


The rule must not have been used to produce a currently existing object version.

When the last remaining step of a rule is deleted, the rule itself is deleted.

RMS renumbers rule steps following the deletion of a specific step.

See EDIT RULE (11-17) for how to change a rule that has been used to create an existingobject.version.

Compile CommandsDELETE RULE Command


DUPLICATE RULE Command

The DUPLICATE RULE command creates a copy of an existing rule.

DUPLICATE RULE rule-name TO new-rule-name [ ,GROUP comp-path ]

rule-name

is the name of the rule to copy.

new-rule-name

is the name of the new rule.

comp-path

is the group where the rule will be added. If this group is not specified, the current group isused.

Considerations


See EDIT RULE (11-17) for examples of use.

Compile CommandsDUPLICATE RULE Command


EDIT RULE Command

The EDIT RULE starts an edit session to modify an entire general compilation rule which isin the catalog.

EDIT RULE rule-name

rule-name

is the name of the rule to be edited.

C40-ER00022 Note! EDIT RULE prevents the editing of rules if the user is not in the group in which the rule is defined. Theuser should change to the appropriate group using the GROUP command prior to editing the desiredrule. An error message indicating that the rule cannot be modified is displayed by RMSCOM if the rulename is not defined in the user’s current group.

Considerations

The rule name specified by this command is subject to the current group withinRMSCOM. You must have, as your current group, the component at which the desiredrule is located. See the SHOW (6-72) and GROUP (6-38) commands for details.

If your terminal is a Tandem 65xx, or IBM 327x, on lines which are configured to handleblock-mode, RMS will attempt to use the TEDIT program in$SYSTEM.SYSTEM.TEDIT. Otherwise, the line-oriented editor, EDIT in$SYSTEM.SYSTEM.EDIT is used.

The rule must not have been used to produce a currently existing object version.

EDIT Rule Compile Example

To change the contents of a rule that has been used to produce an object version:

1. GROUP to the group where the rule is defined.

2. ALTER RULE name, NAME name-OLD

3. DUPLICATE RULE name-OLD to name

4. EDIT RULE name

For more information on any other restrictions to EDIT RULE (11-12)(the Considerations section of the ALTER RULE command).

Compile CommandsEDIT RULE Command


LIST COMPILE Command

The LIST COMPILE command shows the relationship between source and object files orbetween main and executable object files.

LIST COMPILE { TO } comp-path { FROM }

TO comp-path

lists all compile rules which produce the comp-path object component.

FROM comp-path

lists all compile rules which use the comp-path source component.

Considerations

None.

List Compile Report Layout

RMS 40) LIST COMPILE TO obj-pathsrc-path COMPILES TO obj-path USING rule...

obj-path

is the object component full path name.

src-path

is the source component full path name.

rule

is the rule that is used to compile src-path to obj-path.

Compile CommandsLIST COMPILE Command


LIST DEPENDENCIES Command

The LIST DEPENDENCIES command shows all dependencies to or from all versions of acomponent.

LIST DEPENDENCIES { TO } comp-path [ : version-specifier ] { FROM }

[ ,{ DETAIL } ][ ,{ RECURSIVE } ]

TO comp-path

lists all components that are dependent on the specified component name.

FROM comp-path

lists all components that are dependencies of the specified component name.

version-specifier

is a specified state or version of the component. By default, LATEST is assumed.

DETAIL

if specified, the kind of dependency is reported. Dependency kinds include SOURCE,OBJECT, and PROCESSOR.

RECURSIVE

if specified, RMSCOM produces a nested, indented list of all direct and indirectdependencies of comp-path.

Compile CommandsLIST DEPENDENCIES Command


List Dependencies Report Format

RMS 45) LIST DEPENDENCIES TO comp-pathDEPENDENCIES ON COMPONENT comp-path :LATEST

dep-comp : dep-version

comp-path

is the name of the component that the dependencies are to.

dep-comp

the name of the component that depends on comp-path.

dep-version

is the version of the component that depends on comp-path.

Compile CommandsLIST DEPENDENCIES Command


LIST REFERENCE Command

The LIST REFERENCE command shows all source or object references to or from anothersource or object.

LIST REFERENCE { TO comp-path } { FROM comp-path [: version-specifier ]}

TO comp-path

lists all components that reference the specified component name.

FROM comp-path

lists all components that are referenced by the specified component name.

version-specifier

is the state or version number which qualifies the specified comp-path. If unspecified,LATEST is assumed.

List Reference Report Format

RMS 45) LIST REFERENCE FROM comp-path: LATESTREFERENCES MADE BY COMPONENT comp-path:version specifierref-comp...

comp-path

is the name of the component that the references are to.

ref-comp

the name of the component that references comp-name.

Compile CommandsLIST REFERENCE Command


RMS 46) LIST REFERENCE TO comp-pathREFERENCES OF COMPONENT comp-pathref-comp:ref-version...

ref-version

is the version of the component that references comp-name.

Compile CommandsLIST REFERENCE Command


LIST RULE Command

The LIST RULE command shows the contents of a general compilation rule.

LIST RULE { rule-name | "*" } [ , HISTORY ] *[ , query-options ]

rule-name

is the name of the rule to list. If "*" is provided, all rules are listed.

C40-ER00049 HISTORY

displays all object versions created using a particular rule.

query-options

is one of:

INHERIT

reports rules for the current group and all parent groups. If this parameter is notspecified, only rules associated with the current group are reported.

DETAIL

reports the TACL commands associated with the rule(s). If this parameter is notspecified, only rule names and groups are reported.

Compile CommandsLIST RULE Command


List Rule Report Format

RMS 45) LIST RULE rule-name , DETAILRULE rule-name AT comp-path

STEP step-num PROCESSOR file-name -- text ......

rule-name

is the name of the rule.

comp-path

is the component path name at which the rule is defined.

step-num

is the step number of the rule. Each rule can have up to 64 steps.

file-name

is the file name of the processor.

text

are the TACL commands to perform the step.

Compile CommandsLIST RULE Command


PRODUCE Command

The PRODUCE command directs RMS to create a specific object or release at a given state.

PRODUCE [ /{ OUT list-file } , ... / ] { TERM term-file }{ NOWAIT}

{ comp-path [ : version-specifier ]}{ ( comp-path [ : version-specifier ]

[ , comp-path [ : version-specifier ]]... ) }[ TO target-file ][ , produce-options ]

list-file

is the destination where compile listings are sent. The default is the current output file.

term-file

is the home terminal of the TACL which is started to run the compile. This file name canbe a spooler location.

comp-path

is the name of the component to produce. This component name is generally an objectcomponent. If a group component is specified, all objects within the group are produced.

version-specifier

is the state or version at which the comp-path should be created. If a version number isspecified, the object will be exactly recreated. If a state is specified it will be used to selectthe appropriate version of all referenced components. The default is the LATEST state.

target-file

is the file where the resulting object file(s) produced are placed. If this parameter isspecified, no change will occur within the catalog.

produce-options

is one of the set of valid PRODUCE options described in the SET PRODUCEcommand in this chapter.

Compile CommandsPRODUCE Command


Considerations

If multiple comp-paths are specified, only the first version-specifier can refer to a statename. There can be no more than ten comp-paths.

An ADD COMPILE command must already have been issued to establish compilationinstructions for comp-path.

RMS automatically determines, based on existing dependencies, whether a compilation isactually necessary. It is possible to ensure that all objects in a group are at a desired stateby producing the group. RMS will only compile those objects which are out of date orwhich have never been compiled.

If list-file is a Guardian Define, the Define is evaluated in RMSCOM according to theRMSCOM context. List-file can either be a MAP or a SPOOL Define. For spoolerdefines, only the spooler file name is used. This restriction is subject to change in futurereleases of RMS.

If a component state is given, the object component’s state markers are updatedfollowing a successful compile.

If NOWAIT is specified, the PRODUCE command completes immediately. Compilesteps are performed asynchronously and are not reported to the RMSCOM process whichissued the PRODUCE. The TERM parameter should be specified as either a spooler oranother terminal which will receive the compilation output.

No compiles will start if there are missing versions for any referenced componentsinvolved in the compile.


C40-ER00025 READ access is required for any and all components involved in the compile, whether asource section, source file, object or group. MODIFY access is only required forcomponents which are the targets of compilation relationships defined in the RMScatalog.

The RMSMAKE process also reports components for which insufficient securityprivileges have been assigned.



C40-ER00125 Note! The RMSMAKE and PRODUCE command processing of temporary tool locations supports resolution oftemporary tool subvolumes:

\LOCATIONS\RMS-TEMP-TOOLS[\ node-name ][\ state-name ]

In previous releases, RMS required you to specify a node-name for external compilation. It no longerrequires that specification.

Considerations for Concurrent PRODUCE

If more than one user is compiling the same module at the same time (but at a differentstate) there may be conflicts on the versions of sources or intermediate objects to be usedto create each version of the module. The RMSMAKE server tries to make sure theproper versions of sources and/or intermediate objects are used by keeping the requiredversions open until the PRODUCE operation completes. It will also check that when thedependencies are being generated, the correct versions of the sources/object are notreplaced by another version.

Note! You should consider a state-based temporary location if you are going to use this kind of PRODUCEfrequently. See Temporary Work Locations (12-15).

Considerations for SCOBOL Compiles

Normal SCOBOL programs can be compiled using one of two techniques:

Individual SCOBOL object components can be compiled directly. These objectcomponents must have the language attribute set to SCOBOL. In order tosuccessfully compile a SCOBOL program, the object components must be in a groupwith a language of TCLPROG and a file name corresponding to the TCLPROG(POBJ) base file (e.g. $SYSTEM.DEVEL.POBJ). The component name of theSCOBOL object must correspond exactly to the run unit produced by the compile(which is also the PROGRAM-ID in the source component).

The entire TCLPROG file can be produced. This triggers compiles of all SCOBOLobject components within the TCLPROG group. The group must have the languageattribute set to TCLPROG.

In all cases, SCOBOL objects are placed in the TCLPROG corresponding to the principalparent group. The INFO COMPONENT command displays the full path name of componentsusing the principal parent group.

External SCOBOL programs can be compiled subject to the following restrictions:

Individual SCOBOL object components cannot be compiled.

Entire TCLPROG files can be produced from archive copies only.

To compile external SCOBOL source components, a normal TCLPROG groupcomponent and appropriate SCOBOL object child components must be set up.



Considerations for Separate Compilation

The RMS catalog contains sufficient information to determine the heirarchical structureof separately compiled modules in an executable object file. RMS uses this information todetermine the order in which object files need to be compiled to successfully produce thefinal object.

If the user requests the production of an executable object file, RMS automatically checksthat all referenced object files are up to date. If any of those objects require compilation,RMS issues the appropriate instructions to perform the necessary compiles prior tobinding the executable object.

Compiling Programs Using NOWAIT

There are two ways to perform NOWAIT compiles. The first method involves startingRMSCOM in nowait mode. You will likely need to redirect TACL’s output while running yourPRODUCE NOWAIT. The following command, entered at the TACL prompt will perform aNOWAIT compile:

NOWAIT Produce Example Using RMSCOM

TACL> RMSCOM /TERM $S.#RMSCOM.TERM,NOWAIT/; PRODUCE &\MYAPPL\OBJECT-GROUP

The second method involves the use of the /NOWAIT/ option to the PRODUCE command.This technique is described in the above considerations section.



Rule Troubleshooting

This section describes the most likely causes of rule failure other than source file errors.

Table 11-4 Rule Troubleshooting

Problem Encountered Most Likely Cause and Corrective Action

Error 12 on $Xnnn.#ZTACL A program in your rule is attempting to openthe TACL #IN file. You should explicitlyspecify an #IN file to all programs used in yourrules. If no #IN file is needed, do not use thedefault. Use [#MYTERM] instead as follows:

FUP /IN [#MYTERM]/ INFO *

Nothing happens when you use the PRODUCEcommand

1. You must always specify an object or groupcomponent to the PRODUCE command.Producing a source component which isnot the target of a compile has no effect.

2. The object specified is up to date. Nocompile is needed.

Error 2038 is returned to RMSCOM

1. Check your compile listing for problems.

2. If there were warnings that are legitimate inyour listing, a TACL process completioncode of 1 will result. You should either usethe :RMS:ignore^warnings macro inyour rule, or use the appropriate ?NOWARNcompiler directive around the lines in thesource which caused the warning.

3. There may not be a proper rule available.Remember that rules are normally found orinherited through the source component’spath. The SQL-COMP rule is inheritedthrough the object’s component path.



Considerations for Compilation Areas

The RMS-TEMP and/or RMS-TEMP-TOOLS locations can be added to the RMS catalog todefine the Tandem disk subvolumes where RMS will place work files during compilationinstead of in the user’s default subvolume. Please refer to ADD LOCATION (12-14) for a fulldiscussion on how to specify these locations.

C40-ER00069/67










C40-ER00067 Examples

To add a .TEMP location to the group \APPL, type:

ADD LOCATION \APPL\.TEMP,TARGET $DATA.APLTEMP

C40-ER00069 To add a .ARCHIVE-SUBMIT location to the group \APPL, type:

ADD LOCATION \APPL\.ARCHIVE-SUBMIT, TARGET $DATA.APLARCSU



RESET PRODUCE Command

The RESET PRODUCE command resets the current PRODUCE settings to their defaultvalues.

RESET PRODUCE

Considerations

None.

Compile CommandsRESET PRODUCE Command


SET PRODUCE Command

The SET PRODUCE command establishes new PRODUCE command defaults.

SET PRODUCE { CHECK [ { ON | OFF } ] } { COMPRESS { ON | OFF } } { CONTINUE { ON | OFF } } { FORCE [ { ON | OFF } ] } { SECURITY " rwep " } { SECURITY MASK " rwep " } { VERBOSE verbose-level }

CHECK [ { ON | OFF } ]

inhibits the actual compilation of modules. This option determines whether or not acompilation is required for specified modules in a PRODUCE command.

COMPRESS { ON | OFF }

causes the archive copy of successfully compiled objects to be compressed using theRMSPRESS facility.

CONTINUE { ON | OFF }

causes compilation to continue or terminate processing, respectively, when a compilationerror is detected. If CONTINUE ON is specified, RMS will produce as many of theselected components as possible that do not depend on any components for whichcompilation failed. However, CONTINUE ON will have no effect if an error isencountered before any compilation starts.

FORCE [ { ON | OFF } ]

causes a new version of the object to be compiled regardless of whether or not a compile isnecessary.

SECURITY "rwep"

specifies the minimum security vector that compiled objects will obtain when compilationcompletes. The vector "rwep" is a standard Guardian security string where each charactercan be one of "N", "C", "U", "A", "G", "O", "-". See the considerations listed below.

SECURITY MASK "rwep"

specifies the maximum security vector that compiled objects will obtain when compilationcompletes. The vector "rwep" is a standard Guardian security string where each charactercan be one of "N", "C", "U", "A", "G", "O", "-". See the considerations listed below.

Compile CommandsSET PRODUCE Command





RMSMAKE now supports multiple message levels to control the type and amount ofmessages logged during a produce.

ALL or *

logs all messages.

BRIEF


OFF


PROGRESS


SELECTION


WARNINGS


Considerations

Note! The security vector strings are important when more than one person compiles a given objectcomponent. The string allows default security to be set up that allow compilation even if the user’sdefault would not normally. This is illustrated in the example on the next page.



Example of the Use of Security Masks

RMS> SET PRODUCE SECURITY "N--N", SECURITY MASK "AAAA"

The above example illustrates the use of the SECURITY and SECURITY MASK attributes.The attributes are evaluated as follows:

Table 11-6 Security Mask Evaluation

Formula Example

+Security StringUser’s DefaultString

+Security StringUser’s Default

"N--N""GOGO"

-IntermediateSecurity Mask -

IntermediateSecurity Mask

"NOGN""AAAA"

Resulting Security Result "AOGA"

Please see PRODUCE (11-25) for more information.



SHOW PRODUCE Command

The SHOW PRODUCE command displays the current PRODUCE settings.

SHOW PRODUCE

Considerations

None.

Compile CommandsSHOW PRODUCE Command


Notes:

Compile CommandsSHOW PRODUCE Command


1212 Distribution and AcquisitionCommands

This section describes the entities and commands used in the distribution of releases to othersites.

The distribution of software has two main aspects: what are you going to distribute and towhom are you going to distribute it.

Releases represent packages of components that can be transported or installed. Within RMS,only releases can be transported or installed. For more information about the commands tocreate and manage releases - see Release Commands (8-1). Releases can be distributed to oneor more locations.

An RMS location consists of a logical name and an association with a physical location and adescription. Each logical location is unique and multiple logical locations can refer to thesame physical location. A location can be one of three things: a network subvolume or volumename, a tape drive or a network process name.

A network subvolume or volume name is used when the distribution location is onthe same node as the release was created.

A tape drive is used if the node that the release is being distributed to is notconnected to the system the release was created on.

A network process name is used if the release is being distributed to a remote RMS;the network name is the name of the RMS remote monitor.

The following commands are related to distribution and acquisition:

Table 12-1 Distribution and Acquisition Command Summary

Command Description

ACQUIRE MANIFEST Gets a release structure from a location.

ACQUIRE RELEASE Gets the contents of a release.

ADD ATTRIBUTE Defines an auxiliary attribute.

ADD LICENSE Adds a license relationship between releases and locations.

ADD LOCATION Creates a location where releases can be distributed.

ALTER ATTRIBUTE Modifies an existing auxiliary attribute.

Distribution and Acquisition Commands


ALTER LICENSE Modifies a license relationship between releases and locations.

ALTER LOCATION Modifies a location’s attributes.

DELETE ATTRIBUTE Removes an auxiliary attribute.

DELETE LICENSE Removes a license relationship between releases and locations.

DELETE LOCATION Removes a location.

DISTRIBUTE Sends a release and its associated components to a location.

FALLBACK De-installs a release and its associated components from a targetlocation. Re-installs a prior version.

IMPACT RELEASE Assesses the impact of installing a release in a given location.

INFO LOCATION Displays information about releases and/or components whichhave been moved using this location.

INFO RELEASE Displays information about where this release has been sent orreceived.

INFO SPATH Displays information about the current component search paths.

INSTALL Installs a release or component in a target location.

RESET ACQUIRE Resets ACQUIRE parameter defaults.

RESET DISTRIBUTE Resets DISTRIBUTE paramater defaults.

RESET FALLBACK Resets FALLBACK parameter defaults.

RESET INSTALL Resets INSTALL parameter defaults.

RESET SPATH Clears component search paths.

RESET LOCATION Resets location defaults.

SET ACQUIRE Modifies ACQUIRE defaults.

SET DISTRIBUTE Modifies DISTRIBUTE defaults.

SET FALLBACK Modifies FALLBACK defaults.

SET INSTALL Modifies INSTALL defaults.



SET LOCATION Modifies location defaults.

SET SPATH Establishes component search paths.

SHOW ACQUIRE Displays acquire controls.

SHOW DISTRIBUTE Displays distribute controls.

SHOW FALLBACK Displays fallback controls.

SHOW INSTALL Displays install attributes.

SHOW LOCATION Displays location defaults.

VERIFY LOCATION Validates the installation contents of a location.



ACQUIRE Command

The ACQUIRE command accepts a release distribution from a location.

ACQUIRE MANIFEST release-name FROM location-name[,GROUP comp-path ][,SUBVOL default-subvol ]

ALTER RELEASE release-name , ADJUSTACQUIRE RELEASE release-name FROM location-name

[, acquire-options ] { CLEANUP { ON | OFF } } ] { RECOMPILE { ON | OFF } } ] { TAMPER { ON | OFF } } ] { VERBOSE verbose-level } ]

release-name

is the logical name of the previously-created release to be acquired. This release should becreated using the ADD RELEASE command. The release state must be OPEN.

location-name

is the logical name of the location (e.g. DEVELOPMENT) from which a release is to beacquired.

comp-path

is the group in which new components are added before being linked into the releasegroup. Components are only added if no component with the same name is found in anysearch path specified by the SET SPATH command.

default-subvol

is the fully qualified Tandem subvolume where new components are added. Thissubvolume must not correspond to the release library of release-name.

acquire-options

is one of:

CLEANUP { ON | OFF }

causes the distributing RMS to clean up its release library after a successful ACQUIRERELEASE on the acquiring node.

Distribution and Acquisition CommandsACQUIRE Command


RECOMPILE { ON | OFF }

controls whether RMS is permitted to recompile any objects during the acquisitionprocess. If RECOMPILE OFF is specified, ACQUIRE will fail if a recompile isnecessary.

TAMPER { ON | OFF }

allows tampering of release library contents during the acquisition process.





ALL or *

logs all messages.

BRIEF


OFF


PROGRESS


SELECTION


Note! You will only see the components which were not acquired.



WARNINGS


C40-ER00081 ACQUIRE reports the component and specific reason of a failure when the release is not inthe correct state to be acquired. RMSACQIR reports what caused the problem, (for example,an ACQUIRE PENDING flag on a component or a component in the wrong subvolume).

C40-ER00015 ACQUIRE MANIFEST supports the following auxiliary attributes for releases:

Table 12-2 Auxiliary Attributes for Rele ases


.FULL-PATH N/A Causes new componentsacquired with the release to bestored in the same path as fromthe original catalog. If themanifest does not contain pathnames, this attribute is ignored.

.NO-LANGUAGE N/A Causes the LANGUAGE fieldin the manifest to be ignored.

.NO-DESCRIPTION N/A Causes the DESCRIPTIONfield in the manifest to beignored.

Please refer to ADD ATTRIBUTE (12-12) for more information on auxiliary attributes.

C40-ER00095 Note! FREEZE RELEASE,VERSIONS supports special DOT attributes (.KEY-DESC, .DATA-DESC and thosein the table above) and release requisites in release manifests.

The manifest predicate "ATTRIBUTE" placed on components describes the attribute name and valuefor component attributes. Only .KEY-DESC and .DATA-DESC are included in the manifest.

The manifest predicate "RELEASE_REQUISITE_" replaces the "PRED_RELEASE_" and"PRED_CATALOG_RELEASE_" predicates. There is one predicate for each release requisite of therelease. For PRE- and ANTErequisites, only those releases which are prerequisites and anterequisitesof the release are included. Releases having the release frozen as a prerequisite won’t be listed.

Contra- and corequisites will be listed.



Considerations

The requisites will not necessarily appear on the releases on the acquiring system (whenthat is supported) as they do on the distributing system. The mapping is:

Distribution Acquisition

A pre B sameSubsys A pre B sameA pre Subsys C(contains B) A pre BB pre A ignored in all cases

A co B sameSubsys A co B sameA pre Subsys C(contains B) A co BB co A A co BB co Subsys A A co BSubsys C co A A co B

The rules for ante are the same as for pre. Rules for contra are the same as for co.

C40-ER00016 ACQUIRE MANIFEST supports path and file name mapping, based on IMPORTS filesupport . This map file (for relevance to the ACQUIRE MANIFEST command) has thefollowing format:

RELEASE-LIBRARY original-name new-name

RELEASE-LIBRARY Refers to the location on disk from which the release is beingacquired. This is usually a disk volume or volume andsubvolume. This name must be fully qualified with expandnode name and must be in upper case.

original-name Refers to either an expand qualified volume, subvolume or filename, or a qualified RMS path name (e.g., \NODE.$VOL,\APPL\SYS)

new-name Refers to the name which will replace the original-nameparameter. If original-name refers to a disk-type name,new-name must have the same number of levels of qualification.It is not necessary to have the same number of levels iforiginal-name is an RMS path name.

Note! The IMPORTS file is an EDIT, or entry-sequenced file with one record per line. The file is processed in afirst-match manner and as such, the order of records as they appear in the file is important.



Considerations

Acquiring releases is a three part operation.

1. Acquiring the release manifest establishes the contents of the release and validates that itcan actually be received from the specified location. The file names of all componentswill be specified in terms of the release library. These names must be changed.

2. Adjusting the release contents is an interactive process which can either be done throughthe ALTER RELEASE ADJUST command or can be performed by hand using ALTERCOMPONENT and LINK COMPONENT. ALTER RELEASE prompts the user for: adefault subvolume where components are to be relocated, an alternate file name, and analternate component path. You may choose to place the release components in thesubvolumes of your choice, or you can link the components to other components fromother releases or groups. This command is restartable. You can interrupt it at any time,perform other operations such as ALTER COMPONENT, and then re-run the ALTERRELEASE. Following this process, the release will be in a CONTENTS FROZEN state.

The ALTER RELEASE ADJUST phase is only required if the SUBVOL parameter isnot specified. You should attempt, where possible to avoid using the ALTERRELEASE ADJUST command. Use SUBVOL instead.

3. Acquiring the release contents is the last step in the acquisition process. RMS reads themanifest, the current release components’ history and submits any relevant files from therelease to the appropriate components. This operation is also restartable.

C40-ER00058 Note! ACQUIRE MANIFEST removes any version or state information associated with component links fromreleases.

ACQUIRE RELEASE sets version information associated with component links for any version acquiredwhich is not the latest version for the corresponding component.

RMS will not acquire source, document and keyed components which are older (lessrecent) than those in the catalog. An error is generated in this case.

RMS will not acquire components which are the same versions as those in thecatalog. A warning is generated in such a circumstance. Do not be concerned aboutwarnings of this type.

This command constructs a complete release library (regardless of the options selected) toensure that the release is intact, and that any rules will execute consistently.

C40-ER00034 The ACQUIRE command supports "reason" text. RMSCOM will prompt the user, basedon configuration settings in RMS. See ALTER RMS (5-2) for text which will beassociated with the acquisition record for the release(s) being transported to or from thespecified location. This is supported by the DREASON-TEXT field of the subsystemprogrammatic interface (SPI) PAR token maps for each command.

To ACQUIRE releases distributed with the DELTA option from tape, it may first have tobe restored to disk subvolumes where a copy of the release components was previouslyacquired. (This is necessary due to the mandatory use of the RESTORE KEEP option).

C40-ER00054



ACQUIRE RELEASE ignores any warnings from RESTORE when copying files fromtape to disk. This is to deal with any releases shipped with the DELTA option or acquiringDATA components with alternate keys. Any missing files are checked by theRMSACQIR server.

Table 12-3 Release Manifest File Names

Target Location Manifest Filename Used in Acquisition

Another RMS Monitor(e.g. $RMP)

Manifest filename will be the same as the filename used in therelease library of the distributing catalog. If the release library inthe distributing catalog is $DISK.RELLIB, RMS will create themanifest in $DISK.RELLIB.MANIFEST. If the release library isa volume name, (e.g. $DISK) the subvolume of the manifest (e.g.$COMP.SUBVOL.MANIFEST) in the distributing catalog isused (e.g. $DISK.SUBVOL.MANIFEST). The release manifestfile on the acquiring node should also use the matchingsubvolume (e.g. $ACQ.SUBVOL.MANIFEST).

Tape (e.g. $TAPE) On the tape, the file name will be $SYSTEM.A.MANIFEST.

Disk volume andsubvolume(e.g. $DISK.DISTVOL)

Manifest file will be in the form of$DISK.DISTVOL.MANIFEST.

Disk volume only(e.g. $DISK)

The volume name will be $DISK and the subvolume name will bethe subvolume of the manifest file specified within the release(e.g. if $DATA.ACQREL.MANIFEST is the release volume andsubvolume specified and for the acquisition, the manifest file willbe $DISK.ACQREL.MANIFEST).

C40-ER00059 RMSACQUIR has progress logging while acquiring releases, so any problems can berelated to the component you are acquiring. RMSACQUIR also checks for acquiringbugfix versions of source components when no base version exists (for example,acquiring 1.2.0.1 when 1.2 has not been acquired).

C40-ER00060 ACQUIRE MANIFEST has default trigger support. Previously all nongroup componentswere added to the catalog with a tilde as the trigger character. Now the trigger character isbased on the language of the component. If it is blank or unknown to RMS, then notrigger character is set. If the language is C, C-ANSI or TACL, the trigger character is setto "‘ ". Otherwise it is set to "~".



Table 12-4 Acquiring From Another Monitor: Configuration

DistributingMonitor

(e.g. \DEV.$RMP)

Acquiring Monitor(e.g. \PROD.$RMP)

Location Must have a locationpointing to\PROD.$RMP and islicensed for the releaseto be distributed.

Must have a locationpointing to\DEV.$RMP whichwill be used in theACQUIRE commands.License is not required.

Security RMS Local and Networkuser with READ,MANAGER access.

MANAGER, READ,MODIFY and LOCKaccess for the user.

Guardian Remote passwordmust be present for theAcquiring user.

release library At least C, U or NGuardian file securityfor the Acquiring user.

distribute rule If present, Acquiringuser must have RMSREAD access.

Note! If ACQUIRE fails on a group component, then it will fail for all children of that component.

ACQUIRE RELEASE from disk or tape maintains the version time based on the manifest version. To dothis, RMS verifies the timestamp of the source file using the ORIGIN_TZOFFSET_ field in the manifest.However, this will only work for timezones that have an offset divisible by 30 minutes. This results in notneeding to use the TAMPER option when the release is subsequently DISTRIBUTEd or INSTALLed.

C40-ER00061 Note! ACQUIRE RELEASE and ACQUIRE MANIFEST process the entire release so that all errors can becorrected at once. They will be reported to the TERM file.

Note! If a PNALIB component is to be acquired from a disk file which was previously restored from adistribution tape, please make sure the alternate keyfiles are adjusted before performing the ACQUIRERELEASE command.



C40-ER00077 Note! VOLATILE BLOBs are processed during release transport operations. They are always moved with arelease during distribution and installation. They appear in release manifests without version entries.They are never purged during any release cleanup operation. The key purpose of these components isto include nonmanaged files on distribution tape, although that is by no means the only application.

C40-ER00118 Note! The ACQUIRE server RMSACQIR acquires selected component attributes. If the attribute exists inthe acquiring catalog it will be checked and updated to the value from the manifest. If it does not existit will be added. Attributes will never be deleted from the acquiring catalog. At present the .KEY DESCand .DATA DESC attributes are the only ones placed in the manifest at freeze time. These attributes arenecessary for successfully acquiring DATALIB components.



ADD ATTRIBUTE Command

The ADD ATTRIBUTE command defines an auxiliary attribute on an RMS entity. Thisattribute may be a user specified or reserved attribute.

Note! All attribute names beginning with "." are reserved by RMS.

ADD ATTRIBUTE attribute-name{ COMPONENT comp-path }{ LICENSE release-path TO location-path }{ LOCATION location-path }{ RELEASE release-path } }{ USERCHANGE ["] user-change-name ["] }

[ , VALUE quoted-text ]

component-path

is a valid partially- or fully-qualified component name.

release-path

is the release to be licensed. Release-name may be a partially- or fully-qualified name inthe \RELEASES group.

location-path

is the logical name of the location. Location-name may be a partially- or fully-qualifiedname in the \LOCATIONS group.

user-change-name

is a valid user change identifier.

quoted-text

is an arbitrary text string in double quotes.

Considerations

Any of the above entity types can have auxiliary attributes specified. Some entities havereserved attribute names. Please refer to the appropriate ADD command for each entitytype for a list of the reserved names.

It is not necessary that the attributes actually have values. The presence of an attributewithout a value is a valid condition.

Distribution and Acquisition CommandsADD ATTRIBUTE Command


ADD LICENSE Command

The ADD LICENSE command allows releases to be distributed to locations.

ADD LICENSE release-path TO location-name{ [, DENY] }{ [, EXPIRES date-and-time ] }

release-path

is the release to be licensed.

location-name

is the logical name of the location (e.g. NEW-YORK) to be allowed or denies access to therelease. Location-name may be a partially- or fully-qualified name in the \LOCATIONSgroup.

DENY

causes any inherited license relationships between the release and location to be ignored.DENY prohibits access to a release.

EXPIRES date-and-time

indicates that the license relationship only has a limited duration. If EXPIRY is notspecified, the license is unlimited. Date-and-time is specified inDDMONYYYY[ HH:MM] format.

Considerations

License relationships are inherited by both sub-locations and sub-releases and variants.Adding a license relationship between a release and a location also adds implicitrelationships between the release’s variants and that location. This inheritance is inhibitedby using the DENY attribute.

If no license relationship exists between a specific release and location, or their parents,RMS will be unable to distribute or install the release in the location. To allow all releasesto be installed in all locations issue the following command:

RMS) ADD LICENSE \RELEASES TO \LOCATIONS

Distribution and Acquisition CommandsADD LICENSE Command


ADD LOCATION Command

The ADD LOCATION command creates a new software distribution location.

ADD LOCATION location-name[ ,{ TARGET physical-name } ][ { DESCRIPTION " 80-char-string "} ]

location-name

is the logical name of the location (e.g. NEW-YORK). Location-name may be a partiallyor fully qualified name in the \LOCATIONS group.

TARGET physical-name

is a subvolume name (e.g. \NY.$DATA.NEWSTUFF), a tape drive name (e.g. $TAPE), ora network process name (e.g. \NY.$RMP).


is an 80 character quoted string that describes the location.

Considerations

If a subvolume name is specified and distributions are to be sent to that location, then thesubvolume must reside on the same EXPAND node as the RMSMON process.

A tape drive name is used if a backup format tape is to be created for the site because it isnot connected to the current node.

Note! Do not use STATE names as locations to where a release will be installed or distributed. STATE namesas a location have special meaning in RMS and can only be used as directed.

A sublocation can be added as a child of an existing location. For example, to add asublocation (Subloc-B) under the existing location (Loc-A):

ADD LOCATION LOC-A\SUBLOC-B,target $DAT.SUBLOCB

The name LOC-A\SUBLOC-B will always be used to reference this sublocation.

Distribution and Acquisition CommandsADD LOCATION Command


A process name is used to transmit the release to a remote copy of RMS running on thetarget node. The two systems must be connected over an EXPAND network. RMS doesnot validate that the remote process is an RMS process until distribution actually isperformed. The EXPAND link to the remote note only needs to be active during thedistribution.

If no physical name is provided with the command then the current setting of the SETLOCATION name is used.

It is possible to have multiple locations referring to the same physical location. This istypically done when distributing releases by tape. In this case, each destination has itsown RMS distribution location which maps to the same tape drive. It is up to the user toensure that there are no conflicts between locations.

Component Archives

Location names beginning with "ARCHIVE" are reserved by RMS for archive management.You may specifiy archive locations as subvolumes where archive entries are to be stored.RMS will not permit the use of an archive location for distribution purposes. RMS will selectonly the first location which begins with "ARCHIVE".

Work Locations

Table 12-5 RMS Reserved Location Names


ARCHIVE Are reserved for object and data file archives. It is normally adisk subvolume.

RMS-TEMP Is the location to which components are extracted during aproduce command. If it does not exist, then the user’s defaultvolume is used. Files in this subvolume may be purged at anytime. Administrators should periodically remove any files left byRMSMAKE.

RMS-TEMP-TOOLS Is the location to which processor components will be extracted.



Reserved Attributes

The following reserved attributes apply to locations:

Table 12-6 Reserved Attributes for Locations


.BLOCKSIZE tape-block-size The BACKUP BLOCKSIZEparameter value when thelocation is used as a tapeduring distribution.

.FORMAT ARCHIVEDP1DP2

Backup parametersARCHIVEFORMAT,DP1FORMAT, andDP2FORMAT, respectivelywhen the location is used as atape during distribution.

.NOPROMPT Specifies that BACKUP will notprompt on the home terminalfor new tapes when thelocation is used as a tapeduring distribution.

.STATE state-name Optionally restrictsdistributions and installationsto the location to releases at astate matching state-name (e.g.,"PROD"). Note that thisparameter is case sensitive.

.TAPE-DENSITY density-spec The BACKUP tape DENSITYparameter when the location isused as a tape duringdistribution.

.TAPEMODE STARTSTOPSTREAM

Controls the tape streamingmode when the location is usedas a tape during distribution.



Note! Please refer to the Guardian Disk and Tape Utilities Reference Manual for details on BACKUPparameters. See ADD ATTRIBUTE (12-12) for more information on auxiliary attributes.

Temporary Work Locations

RMS-TEMP and RMS-TEMP-TOOLS have special meaning when operating in a network,multi-state environment, or for external compile. The following table summarizes specialsub-locations that can be specified for these locations (referred to by temp):

Table 12-7 Special Sublocations Specified for Temp Locations

Location Name Internal Compile External Compile

temp Source files placed in thissubvolume. Purged aftercompile.

Source files placed in thissubvolume. Purged aftercompile.

temp\node Ignored. Uses temp. All files placed in thissubvolume. Retained aftercompile.

temp\node\state Ignored. Uses temp. All files placed in thissubvolume. Retained aftercompile.

temp\state Source and object files placedin this subvolume. Retainedafter compile.

All files placed in thissubvolume. Retained aftercompile.

Evaluation of which option to use (when conflicting sub-locations are present) is as follows:

1. temp\node\state. This is used only for external compile.

2. temp\node. This is used only for external compile.

3. temp\state.

4. temp

If RMS-TEMP is not present, the user’s saved default subvolume is used as a work areafor source files. Those files are purged after compilation.

If RMS-TEMP-TOOLS is not present, the compilers’ file name, and subvolume, are usedwhere necessary. Tool files are not purged after compilation, in any event.

\temp\state locations are intended to preserve objects in different state streams during andafter concurrent compiles for multiple states. If these locations are present, the managedobject file may not contain object versions created during the PRODUCE.



C40-ER00125 Note! The RMSMAKE and PRODUCE command processing of temporary tool locations supports resolution oftemporary tool subvolumes:

\LOCATIONS\RMS-TEMP-TOOLS[\ node-name ][\ state-name ]

In previous releases, RMS required you to specify a node-name for external compilation. It no longerrequires that specification.



ALTER ATTRIBUTE Command

The ALTER ATTRIBUTE command modifies the value of an auxiliary attribute of an RMSentity.

ALTER ATTRIBUTE attribute-name{ COMPONENT comp-path }{ LICENSE release-path TO location-path }{ LOCATION location-path }{ RELEASE release-path }{ USERCHANGE ["] user-change-name ["] }

[ , VALUE quoted-text ]

comp-path


release-path


location-path


user-change-name


quoted-text


Considerations

The specified attribute name must already exist for the specified entity.

Distribution and Acquisition CommandsALTER ATTRIBUTE Command


ALTER LICENSE Command

The ALTER LICENSE command changes existing release license information.

ALTER LICENSE release-path TO location-name{ , [ RESET ] DENY }{ , { RESET EXPIRES} }{ { EXPIRES date-and-time } }

release-path

is the release licensed to location-name.

location-name

is the logical name of the location licensed to release-path.

DENY

causes any inherited license relationships between the release and location to be ignored.DENY prohibits access to a release.

RESET DENY

drops a DENY attribute from a license relationship.

RESET EXPIRY

drops a time limit from a license relationship.

EXPIRES date-and-time

indicates that the license relationship only has a limited duration. Date-and-time isspecified in DDMONYYYY[HH:MM] format.

Considerations

License relationships are inherited by sub-locations, sub-systems, releases, and variants.Adding a license relationship between a release and a location also adds implicitrelationships between the release’s variants and that location. This inheritance is inhibitedby using the DENY attribute.

RESET will function as described even if there are no existing values for thecorresponding parameters.

Distribution and Acquisition CommandsALTER LICENSE Command


ALTER LOCATION Command

The ALTER LOCATION command changes attributes of locations.

ALTER LOCATION location-name[ , { TARGET physical-name } ][ { DESCRIPTION " 80-char-string " } ]

location-name

is the logical name of an existing location. Location-name may be a partially or fullyqualified name in the \LOCATIONS group.

TARGET physical-name

is the new subvolume name (e.g. \NY.$DATA.NEWSTUFF), or tape drive name (e.g.$TAPE), or network process name (e.g. \NY.$RMP).


is the new description of the location.

Considerations

Please refer to the ADD LOCATION Considerations (12-14).

Distribution and Acquisition CommandsALTER LOCATION Command


DELETE ATTRIBUTE Command

The DELETE ATTRIBUTE command removes an auxiliary attribute from an RMS entity.

DELETE ATTRIBUTE attribute-name{ COMPONENT comp-path }{ LICENSE release-path TO location-path }{ LOCATION location-path }{ RELEASE release-path }{ USERCHANGE ["] user-change-name ["] }

comp-path


release-path


location-path


user-change-name


quoted-text


Considerations

The specified attribute name must already exist for the specified entity.

Distribution and Acquisition CommandsDELETE ATTRIBUTE Command


DELETE DISTRIBUTE Command

C40-ER00085 The DELETE DISTRIBUTE command cleans up old distribution records which are either nolonger needed or were inappropriately present in the history.

DELETE DISTRIBUTE release:version TO location ON { date | * }

Note! Manager access is required on both the release and location to perform this command.

Distribution and Acquisition CommandsDELETE DISTRIBUTE Command


DELETE LICENSE Command

The DELETE LICENSE command removes release licensing information from locations.

DELETE LICENSE release-path { FROM } location-name { TO }

release-path

is the release from which licensing is to be removed.

location-name

is the location to/from which licensing is to be removed.

Considerations

Since license relationships are inherited by both sub-locations and sub-releases and variants,deleting a license relationship may not actually remove the ability to distribute or install arelease to a location. Use caution when deleting license relationships.

Distribution and Acquisition CommandsDELETE LICENSE Command


DELETE LOCATION Command

The DELETE LOCATION command removes a location from the catalog.

DELETE LOCATION location-name

location-name

is the name of the location to delete. Location-name may be a partially- or fully-qualifiedname in the \LOCATIONS group.

Considerations

Once a location is removed, any records relating to distribution history are lost.

Subsequent distributions to the deleted location will not be possible.

Distribution and Acquisition CommandsDELETE LOCATION Command


DISTRIBUTE RELEASE Command

The DISTRIBUTE RELEASE command is used to transfer software to disk or tape.

DISTRIBUTE RELEASE release-name [ : version-number ] TO location-name , [ dist-options ]

[ { ALL [ { ON | OFF } ] } ] ...[ { CLEANUP { ON | OFF } } ][ { COPIES num-copies } ][ { DELTA { RELEASE} } ][ { { COMPONENT} } ][ { { OFF} } ][ { FORMAT extr-fmt-mode } ][ { INFORM [ { ON | OFF } ] } ][ { MAXFILES num-backup-files } ][ { NEEDED { ON | OFF } } ][ { PURGE [ { ON | OFF } ] } ][ { QUALIFY extr-level } ][ { RECOMPILE { ON | OFF } } ][ { RECURSIVE [ { ON | OFF } ] } ][ { SUBVOL [ tape-volume ] } ][ { TAMPER [ { ON | OFF } ] } ][ { UPDATE [ { ON | OFF } ] } ][ { VERBOSE verbose-level } ] } ]

command-options

is one of NOWAIT, OUT, or TERM. If these options are used, use the .NOPROMPTlocation attribute.

release-name

is the name of the release or subsystem component path to distribute.

C40-ER00082 version-number

specifies the release version number. This corresponds to the version number of themanifest component representing the release version being selected for shipment.

Note! In the case where only a single release is shipped, the semantics of the release version is simple: shipthat release version. When a subsystem is specified or there are release requisites which may affectthe number of items actually shipped, the release version specifies the version of the release for allreleases which are shipped. The version numbers of releases which do not have correspondingversion numbers cause shipments to fail.

location-name

is the name of the location to distribute the release to.

Distribution and Acquisition CommandsDISTRIBUTE RELEASE Command


ALL [ { ON | OFF } ]

causes all files in the release library to be distributed regardless of whether they are in therelease.

C40-PR00034 Note! If DELTA RELEASE is set, all files in the release library of the changed release(s) will be distributed. IfDELTA COMPONENT is set, all files in the subvolumes of any changed component in the releaselibrary will be distributed.


indicates whether the release library is purged after distribution. The default is CLEANUPON.

COPIES

allows users to specify the number of copies of the release distribution which will becopied to tape.

DELTA RELEASE

causes entire releases to be shipped only if location-name does not already have the mostrecent version of release-name.

DELTA COMPONENT

causes individual components to be shipped only if location-name does not already havethe specified versions of those components, regardless of release or subsystem beingdistributed.

DELTA OFF

inhibits DELTA processing.

FORMAT extr-fmt-mode

indicates the format mode for parameters and file names that appear in distributed sourcecomponents. Please refer to the EXTRACT FORMAT (6-34) mode documentation foradditional details.

INFORM { ON | OFF }

directs RMS to create a distribution entry only. No distribution of software is actuallyperformed.

C40-ER00032 MAXFILES

allows users to specify the maximum number of files which will be sent to a givenBACKUP process. If the number is exceeded, multiple BACKUPs are run to satisfy thedistribution.



NEEDED { ON | OFF }

controls whether prerequisite releases are shipped if not already present.


indicates whether files in the target location should be purged before distribution. Thisapplies to disk locations only.

QUALIFY extr-level

indicates the level of qualification for file names that appear in distributed sourcecomponents. Please refer to the EXTRACT FORMAT (6-34) mode documentation foradditional details.


controls whether RMS is permitted to recompile any objects during the distributionprocess. If RECOMPILE OFF is specified, DISTRIBUTE will fail if a recompile isnecessary.

RECURSIVE [ { ON | OFF } ]

causes all frozen, licensed, subreleases to be shipped with the indicated release. Thisapplies for tape locations only.

SUBVOL [ tape-volume ]

specifies the name of the disk volume that will appear on the backup tape for tapedistributions. By default $SYSTEM is assumed. If SUBVOL is specified without aparameter, the disk volume of the release library is assumed. If tape-volume is specified,that volume will appear on the backup tape.

TAMPER [ { ON / OFF } ]

allows release contents to be modified by the DISTRIBUTE rule prior to distribution. Ifthis parameter is not specified, the DISTRIBUTE rule is not permitted to modify releasecontents.

UPDATE [ { ON / OFF } ]

causes RMS to assume that files in the release library may be valid. Normally, RMS doesnot trust the contents of a release library. This parameter is particularly useful fordistributions to multiple locations where performance is essential.

C40-ER00046 Note! "POST-DISTRIBUTE" is a rule which (like the "DISTRIBUTE" RULE) is executed by RMS after releasesare moved or distributed to their distribution target location, such as a tape set. With it you can performauxiliary database updates or operations once the distribution has been done.



Caution! As with any other RMS rule, errors during rule processing due to nonzero completion codes, TACLprogramming errors and TACL process failures are sent to the RMSDIST distribution server. Theseerrors will cause the distribution to abort even though the release has been sent to the target locationand EMS has been notified (for subsystem releases and distributions containing more than onerelease).

Do not program your distribution rules to abort on failure unless this effect is something youwant or can tolerate!

C40-ER00077 Note! Volatile BLOBs (Binary Large OBject) are classes of components for which RMS will not managedependencies. These differ from External components which have versions represented in the catalog.They are processed during release transport operations and are always moved with a release duringdistribution and installation. Volatile BLOBs appear in release manifests without version entries. Theyare never purged during any release cleanup operation. The key purpose of these components is toinclude nonmanaged files on distribution tapes, although that is by no means the only application.

Be aware that the ALL option for distribution will not automatically pick up subvolumes in whichVolatile BLOBs are stored. These components are most useful if specified directly in release librarysubvolumes.







ALL or *

logs all messages.

BRIEF


OFF


PROGRESS


SELECTION


WARNINGS




C40-ER00011 Note! Distribution timestamps of all releases shipped or installed in a single operation are the same.

C40-ER00012 DISTRIBUTE RELEASE handles BACKUP FILE SET overflows. Each BACKUP is limited to 1000 files,unless overridden by the PAR-DIST.DMAX-FILES parameter (to take effect in C40). Multiple BACKUPcommands will also be run to handle file sets larger than 1000 entries. Also the temporary filesassociated with the BACKUP now have extent sizes of (16 , 32).

C40-ER00013 DISTRIBUTE RELEASE reports the version numbers of components which it deems to have beendistributed. The "Component Distributed" log message has been affected by this enhancement.

C40-ER00070

CUSTFILE

A CUSTFILE is a list of releases and subsystems that appear on a distribution tape. For anydistribution of either a release or subsystem where more than one release ends up on the tapefor whatever reason, you will get a CUSTFILE. This usually happens when using theRECURSIVE or NEEDED option. It goes in $SYSTEM.A.CUSTFILE.

It also supplies release subsystems (in summary format only) with the release library and path.



Considerations

C40-ER00027 DISTRIBUTE RELEASE detects the presence of a target location and release libraryequivalence. In such a situation, no copy is performed. If the CLEANUP ON option isspecified, it is forced to OFF and a message is logged to the home terminal as part of thedistribute or install log. Remapping of subvolumes by sublocation of the target locationwill also be ignored. See INSTALL RELEASE (12-47).

The release will be produced in the release library prior to being distributed.

The program will invoke either FUP, or BACKUP command to do the actual copying ofthe changes library. To receive the software on a remote, EXPAND-connected RMSsystem, use ACQUIRE instead of DISTRIBUTE.

If BACKUP is invoked the release manifest will be placed on the tape as$SYSTEM.A.MANIFEST, the other files will be placed on the tape as $SYSTEM.*.*.The SUBVOL paremeter can be used to override this default. If multiple releases areshipped during the same distribution, the MANIFEST file is replaced with a CUSTFILE.The CUSTFILE lists all releases on the tape.

It is not possible to distribute a release to location names beginning with "ARCHIVE" or"RMS-TEMP".

If a prerequisite release has not already been distributed to a location and NEEDED OFFis specified (the default), the distribution will fail. Corequisites are not currently affectedby the NEEDED parameter.


C40-ER00034 The DISTRIBUTE command supports "reason" text. RMSCOM will prompt the user,based on configuration settings in RMS. See ALTER RMS (5-2) for text which will beassociated with the DISTRIBUTE record for the release(s) being transported to or fromthe specified location. This is supported by the DREASON-TEXT field of the subsystemprogrammatic interface (SPI) PAR token maps for each command.

C40-ER00077 Note! VOLATILE BLOBs are processed during release transport operations. They are always moved with arelease during distribution and installation. They appear in release manifests without version entries.They are never purged during any release cleanup operation. The key purpose of these components isto include nonmanaged files on distribution tape, although that is by no means the only application.

Site-Specific Considerations

RMS provides for variations in releases from one location to another. RMS automaticallyapplies the rule "DISTRIBUTE" to a release library before it is actually sent to the targetlocation. This distribution rule is inherited, as is any other rule. The actual rule used is theone inherited by the release group being distributed. If a sub-release is being distributed,the distribution rule is inherited from the sub-release group.

The PRE-INSTALL, INSTALL, and FALLBACK rules inherited by a release are copiedinto the version of the release manifest which is distributed.



C40-ER00045 Tape Distribute Considerations

DISTRIBUTE RELEASE prepares a code 180 file containing a list of the release files(including manifests) present in the backup file set. This file is called$SYSTEM.A.CONTENTS. The CONTENTS file is not itself listed. Each line (separated bythe newline character) contains the path, version and file name of each component.

Note! Abstractions (SRCLIB and TCLPROG components) are not decomposed into lower-level componentsin the CONTENTS file.

The following TACL variables are made available to any distribution rule applied to releases:

Table 12-8 TACL variables available to distribution rules.

:RMS:Description The description of the location as it appears in the location’scomponent in the RMS catalog. See INFO COMPONENT,DETAIL (6-40.).

:RMS:Expiry^Date The date on which the license relationship between the releaseand target location expires. This variable is empty if no expirydate exists.

:RMS:license_attr: attribute-name

All attributes associated with the license between the release andlocation are presented as variables of the above form.

:RMS:Location The physical subvolume, tape, or process corresponding to:RMS:Location^Name.

:RMS:location_attr: attribute-name

All attributes associated with the target location are presented asvariables of the above form.

:RMS:Location^Name The logical location name which will receive the release.

C40-ER00057

:RMS:Monitor Contains the RMS monitor process.



:RMS:release_attr: attribute-name

All attributes associated with the release being distributed arepresented as variables of the above form.

:RMS:ReleaseId The component id associated with the release being distributed.This component id can be used in thedRMS^MAP^SEL^RELEASE ordRMS^MAP^SEL^COMPONENT SPI tokens. See the RevisionManagement System (RMS) Programming Manual, Volume 1 fordetails on these tokens and their respective uses.

:RMS:Release^Library

The physical disk location where the release was produced. Thisname corresponds exactly to the release library SUBVOLparameter specified in the ADD RELEASE command. The valueof this variable may be either a fully qualified sub-volume nameor a disk name and can be in network form.

:RMS:Release^Name The logical name of the release being distributed. This name isnot the full path name of the component and therefore may notbe unique. Use :RMS:ReleaseId when uniqueness is desired forrelease identification.

C40-ER00057

:RMS:Release^VersionContains the version of the release being distributed.

:RMS:Sublocation: sub-location-name

All sub-locations of the target location are presented as variablesof the above form.

Note! If the target location is the same volume.subvolume as the release library, RMS automatically turnsCLEANUP to OFF. This ensures that files will exist in the release library (target location) at the end ofthe DISTRIBUTE process.

C40-ER00046 Note! The POST-DISTRIBUTE rule for the DISTRIBUTE RELEASE command: this rule, similar to theDISTRIBUTE rule, is executed by RMS after releases are moved or distributed to their distributiontarget location (e.g., a tape set). This rule offers the benefit of performing auxiliary database updates oroperations once the distribution has been performed.



Caution! As with any other RMS rule, errors during rule processing due to nonzero completion codes, TACLprogramming errors, and TACL process failures are sent to the RMSDIST distribution server. Theseerrors will cause the distribution to abort even though the release has been sent to the target locationand EMS has been notified (for subsystem releases and distributions containing more than onerelease). Do not program your distribution rules to abort on failure unless this effect is desirableor can be tolerated.

C40-ER00069/67/91









.FORMAT






FALLBACK LOCATION Command

The FALLBACK LOCATION command directs RMS to roll out a given release from thespecified location.

FALLBACK LOCATION location-name FROM release-path [ : version-specifier ][ , fallback-options ]

{ INFORM [ { ON | OFF } ]{ RECOMPILE { ON | OFF } ]{ VERBOSE verbose-level } ]

location-name

is the name of the location where the release is to be removed.

release-path

is the name of the release component path to remove.

version-specifier

is the optional version of the release to remove. If you do not specify this parameter, themost recent version of the release installed in location-name will be removed.

fallback-options

is one of:

INFORM { ON | OFF }

directs RMS to create a fallback entry only. No roll-out of software is actuallyperformed. This option is intended to inform RMS that a manual fallback has beenperformed.


controls whether RMS is permitted to recompile any objects during the fallbackprocess. If RECOMPILE OFF is specified, FALLBACK will fail if a recompile isnecessary.

Distribution and Acquisition CommandsFALLBACK LOCATION Command






ALL or *

logs all messages.

BRIEF


OFF


PROGRESS


SELECTION


WARNINGS




Considerations

The release must have already been installed in the specified location.

The contents of the location after fallback will be determined from the installationportion of the locations release distribution history.

Fallback rules, as described below, must exist for all releases being rolled-out. If afallback rule does not exist, fallback is disallowed!

Components which are to be replaced in the target location are extracted from RMSdirectly into the location’s area on disk.

It is not possible to perform a fallback of a release in locations with names beginning with"ARCHIVE" or "RMS-TEMP".


C40-ER00034 The FALLBACK command supports "reason" text. RMSCOM will prompt the user,based on configuration settings in RMS. See ALTER RMS (5-2) for text which will beassociated with the FALLBACK record for the release(s) being transported to or from thespecified location. This is supported by the DREASON-TEXT field of the subsystemprogrammatic interface (SPI) PAR token maps for each command.


RMS provides for variations in releases from one location to another. RMS automaticallyapplies the rule "FALLBACK" to a release library before it is actually removed from thetarget location. This fallback rule is inherited, as is any other rule. The actual rule used isthe one inherited by the release group being installed. If a sub-release is being rolled-out,the fallback rule is inherited from the sub-release group.

Fallback rules provide a means of running appropriate reverse conversion programs ondatabases so that data will be compatible with older releases.

The default FALLBACK rule distributed with RMS always fails. This means that if thereis no fallback rule associated with a release, it is not possible to roll-out that release.



The following TACL variables are made available to any fallback rule applied to releases:

Table 12-10 TACL Variables Available to Fallback Rules

:RMS:Description The description of the location as it appears in the location’scomponent in the RMS catalog. See INFO COMPONENTDETAIL (6-40).







:RMS:Location^Name The logical location name from which the release will beremoved.

C40-ER00057




:RMS:ReleaseId The component id associated with the release being removed.This component id can be used in thedRMS^MAP^SEL^RELEASE ordRMS^MAP^SEL^COMPONENT SPI tokens. See the RevisionManagement System (RMS) Programming Manual, Volume 1 fordetails on these tokens and their respective uses.




The physical location where the release is currently installed.This value corresponds to the device associated with the location.

:RMS:Release^Name The logical name of the release being rolled-out. This name isnot the full path name of the component and therefore may notbe unique. Use :RMS:ReleaseId when uniqueness is desired forrelease identification.

C40-ER00057






IMPACT RELEASE Command

The IMPACT RELEASE command assesses the impact of the installation or distribution of arelease to a location.

IMPACT RELEASE release-name ON location-name

release-name

is the logical name of the release to be reported.

location-name

is the logical name of the location to be reported (e.g. NEW-YORK).Location-name maybe a partially- or fully-qualified name in the \LOCATIONS group.

Considerations

The following information is reported:

A list of all components associated with the new release and the individual impact of eachcomponent on the most recently installed components that will be replaced.

A list of all files associated with the location and the impact of the release on each file.

A summary of the items replaced or preserved for each installed release.

A summary of the number of items that will be replaced or preserved for and by the newrelease.

Distribution and Acquisition CommandsIMPACT RELEASE Command


INFO LOCATION Command

The INFO LOCATION command displays information about distribution locations.

INFO LOCATION location-name [,{ HISTORY } ] [,{ LICENSE } ]

location-name

is the logical name of the location to be reported (e.g. NEW-YORK). If "*" is specified forthis parameter, all locations are reported. Location-name may be a partially or fullyqualified name in the \LOCATIONS group. If a path is specified, "*" can only appear inthe path after the last "\".

HISTORY

a historical report of all releases and components distributed to, installed in, oracquired from the specified location are reported.

LICENSE

a report of all releases which are explicitly licensed to the selected locations arereported.

Considerations

If a specific location is specified, that location must exist.

C40-ER00078 Note! INFO LOCATION supports patterns of the same form supported for INFO LOCATION. These patternswill function for all command options as well (for example, INFO LOCATION ABC*, LICENSE).

The Subsystem Programmatic Interface (SPI) supports this function through the inclusion of theDRMS-TKN-PATTERN token. This token contains the pattern against which to match the location’sname during query processing. Set DRMS-MAP-SEL-LOCATION.DNAME toDRMS-VAL-ALLOCATIONS when using patterns.

Distribution and Acquisition CommandsINFO LOCATION Command


Info Locations Report Format

Location Release Kind Date Userlocation-name release-name distrib-kind date user-id

where

location-name

is the name of the specified location. If all locations were requested, a blank line will beplaced between each location change.

release-name

refers to the release or component which was distributed to the corresponding location.

distrib-kind

is one of ACQUIRE, DISTRIB, FALLBACK, or INSTALL.

date

is the date and time at which the distribution occurred.

user-id

is the Guardian user name of the user who caused the distribution to occur.

Distribution and Acquisition CommandsINFO LOCATION Command


INFO RELEASE Command

The INFO RELEASE command displays distribution history and license information aboutsoftware releases.

INFO RELEASE release-name [ ,{ HISTORY } ] [ ,{ LICENSE } ]

release-name

is the logical name of a release to be reported (e.g. NEW-YORK). If "*" is specified forthis parameter, all releases are reported.

HISTORY

produces an historical report of all locations which have been involved in distributionsof the release.

LICENSE

produces a report of all locations which are licensed to receive this release.

Considerations

If a specific release is specified, that release must exist. The "*" option is not supported in thecurrent release of RMSCOM.

Distribution and Acquisition CommandsINFO RELEASE Command


Info Release History Report Format

Release Location Kind Date Userrelease-name location-name distrib-kind date user-id

where

release-name

is the name of the specified release.

location-name

is the name of the location which was involved in the distribution.

distrib-kind

is one of ACQUIRE, DISTRIB, FALLBACK, or INSTALL.

date

is the date and time at which the distribution occurred.

user-id

is the Guardian user name of the user who caused the distribution to occur.

Distribution and Acquisition CommandsINFO RELEASE Command


INFO SPATH Command

The INFO SPATH command reports all current component search paths.

INFO SPATH { " * " | spath-id }

spath-id

is a number referring to a component search path. This parameter can range from 0through 29, inclusive.

Considerations

None.

Distribution and Acquisition CommandsINFO SPATH Command


INSTALL RELEASE Command

The INSTALL RELEASE command actually places a release in a production library.

C40-ER00017

INSTALL [ / command-options / ] RELEASE release-name version-number TO location-name[ , { CLEANUP { ON | OFF } }][ { DELTA { ON | OFF } }][ { FORMAT extr-fmt-mode }][ { INFORM [ { ON | OFF } ] }][ { PURGE [ { ON | OFF } ] }][ { QUALIFY extr-level } ] }][ { RECOMPILE { ON | OFF } }][ { REQUISITE { ON | OFF } }][ { TAMPER [ { ON | OFF } ] }][ { UPDATE [ { ON | OFF } ] }][ { VERBOSE verbose-level } ] }]

command-options

is one of NOWAIT, OUT, or TERM.

release-name

is the name of the release component path to install.

C40-ER00082 version-number

specifies the release version number. This corresponds to the version number of themanifest component representing the release version being selected for shipment.

Note! In the case where only a single release is shipped, the semantics of the release version is simple: shipthat release version. When a subsystem is specified or there are release requisites which may affectthe number of items actually shipped, the release version specifies the version of the release for allreleases which are shipped. The version numbers of releases which do not have correspondingversion numbers cause shipments to fail.

location-name

is the name of the location where the release is to be installed.


controls whether or not the contents of the release library are purged after installation.CLEANUP ON is the default.

Distribution and Acquisition CommandsINSTALL RELEASE Command


C40-ER00017 DELTA { ON | OFF }

specifies whether components will be installed if the correct versions are already presentin the target location. If no components of a release need to be installed, the installationrules are not run.

FORMAT extr-fmt-mode

indicates the format mode for parameters and file names that appear in installed sourcecomponents. Please refer to the EXTRACT FORMAT (6-34) mode documentation foradditional details.

INFORM [ { ON | OFF } ]

tells RMS that the installation has already been done manually. No actual installation willbe performed.


indicates whether files in the target location should be purged before installation.

QUALIFY extr-level

indicates the level of qualification for file names that appear in installed sourcecomponents. Please refer to the EXTRACT FORMAT (6-34) mode documentation foradditional details.


controls whether RMS is permitted to recompile any objects during the installationprocess. If RECOMPILE OFF is specified, INSTALL will fail if a recompile is necessary.

REQUISITE { ON | OFF }

indicates to RMS to search for any requisites which have already been set up. If they exist,RMS will go and make sure they are distributed and installed first.

TAMPER [ { ON | OFF } ]

allows release contents to be modified by the PRE-INSTALL rule prior to installation. Ifthis parameter is not specified, the PRE-INSTALL rule is not permitted to modify releasecontents.

UPDATE [ { ON | OFF } ]

causes RMS to assume that files in the release library may be valid. Normally, RMS doesnot trust the contents of a release library. This parameter is particularly useful forinstallations to multiple locations where performance is essential.







ALL or *

logs all messages.

BRIEF


OFF


PROGRESS


SELECTION


WARNINGS




Considerations

C40-ER00027 INSTALL RELEASE detects the presence of a target location and release libraryequivalence. In such a situation, no copy is performed. If the CLEANUP ON option isspecified, it is forced to OFF and a message is logged to the home terminal as part of thedistribute or install log. Remapping of subvolumes by sublocation of the target locationwill also be ignored. See DISTRIBUTE RELEASE (12-26).

The release will be produced in the release library prior to being installed to ensure theintegrity of the release.

The program will invoke FUP or will issue an RMS ACQUIREREMOTE command to dothe actual copying of the changes library to the install location.

It is not possible to install a release to location names beginning with "ARCHIVE" or"RMS-TEMP".


This command supports subvolume name mapping at installation time (betweenexecution of the PRE-INSTALL and INSTALL rules). INSTALL RELEASE scans forsublocations having the same name as the subvolume of the existing component. Forexample: if a location and release library are defined using disk volume names only, and asublocation exists (e.g., MYLOC\OBJVOL -> $X.INST) and an object in the release hasa file name of $DATA.OBJVOL.OBJECT, then that object will be installed in$X.INST.OBJECT. There can be multiple subvolume-type locations of this kind.

Note! The INSTALL rule is provided with variables of the form :rms:sublocation:sub-location for allsublocations.

C40-ER00034 The INSTALL command supports "reason" text. RMSCOM will prompt the user, basedon configuration settings in RMS. See ALTER RMS (5-2) for text which will beassociated with the INSTALL record for the release(s) being transported to or from thespecified location. This is supported by the DREASON-TEXT field of the subsystemprogrammatic interface (SPI) PAR token maps for each command.

C40-ER00077 Note! Volatile BLOBs (Binary Large OBject) are classes of components for which RMS will not managedependencies. These differ from External components which have versions represented in the catalog.They are processed during release transport operations and are always moved with a release duringdistribution and installation. Volatile BLOBs appear in release manifests without version entries. Theyare never purged during any release cleanup operation. The key purpose of these components is toinclude nonmanaged files on distribution tapes, although that is by no means the only application.

Be aware that the ALL option for distribution will not automatically pick up subvolumes in whichVolatile BLOBs are stored. These components are most useful if specified directly in release librarysubvolumes.




RMS provides for variations in releases from one location to another. RMS automaticallyapplies the rule "PRE-INSTALL" to a release library before it is actually sent to the targetlocation. RMS automatically applies the rule "INSTALL" to a release library after it isactually sent to the target location. These installation rules are inherited, as are any otherrules. The actual rule used is the one inherited by the release group being installed. If asub-release is being installed, the installation rule is inherited from the sub-release group.

The principal difference between the INSTALL and DISTRIBUTE commands is theorder in which operations are performed on the released components.

C40-ER00011 Note! The distribution timestamps of all releases shipped or installed in a single operation are the same.

If the target location is the same volume.subvolume as the release library, RMS automatically turnsCLEANUP to OFF. This ensures that files will exist in the release library (target location) at the end ofthe INSTALL process.

Table 12-11 Comparison Between DISTRIBUTE and INSTALL

DISTRIBUTE INSTALL

Record of distribution historyretained.

Record of installation history retained.

Release library produced beforedistribution.

Release library produced before installation.

DISTRIBUTE rule executedbefore distribution.

PRE-INSTALL rule executed before installation.

INSTALL rule executed after installation.

Distribution cannot be revokedor rolled-back.

Installation can be revoked or rolled-back usingthe FALLBACK command.

Release manifest produced andcopied with the release library.Manifest is updated withINSTALL and FALLBACKrules.

Release manifest is not involved in the actualinstallation processing.

Supports a tape drive as a targetlocation.

Does not support tape drive as a target location.



The following TACL variables are made available to any installation rule applied to releases:

Table 12-12 TACL Variables Available to Install Rules.

:RMS:Description The description of the location as it appears in the location’scomponent in the RMS catalog. See INFO COMPONENT,DETAIL (6-40).







:RMS:Location^Name The logical location name which will receive the release.

C40-ER00057




:RMS:ReleaseId The component id associated with the release being installed.This component id can be used in thedRMS^MAP^SEL^RELEASE ordRMS^MAP^SEL^COMPONENT SPI tokens. See the RevisionManagement System (RMS) Programming Manual, Volume 1 fordetails on these tokens and their respective uses.




The physical location where the release was stored. This valuecorresponds to the device associated with the location.

:RMS:Release^Name The logical name of the release being installed. This name is notthe full path name of the component and therefore may not beunique. Use :RMS:ReleaseId when uniqueness is desired forrelease identification.

C40-ER00057






C40-ER00069/67/91









.FORMAT






RESET ACQUIRE Command

The RESET ACQUIRE command resets the acquire settings.

RESET ACQUIRE

Considerations

None.

Distribution and Acquisition CommandsRESET ACQUIRE Command


RESET FALLBACK Command

The RESET FALLBACK command resets the fallback settings.

RESET FALLBACK

Considerations

None.

Distribution and Acquisition CommandsRESET FALLBACK Command


RESET LOCATION Command

The RESET LOCATION command resets the current physical name of the location to spaces.

RESET LOCATION

Considerations

This command removes any default physical locations.

Distribution and Acquisition CommandsRESET LOCATION Command


RESET SPATH Command

The RESET SPATH command resets component search paths.

RESET SPATH { " * " | spath-id }

spath-id

is a number referring to an existing component search path.

Considerations

This command removes one or all component search paths.

Distribution and Acquisition CommandsRESET SPATH Command


SET ACQUIRE Command

The SET ACQUIRE command specifies default parameter values for the ACQUIRERELEASE command.

SET ACQUIRE acquire-options [ , acquire-options ] ...

acquire-options is one of:CLEANUP { ON | OFF }RECOMPILE { ON | OFF } TAMPER [ { ON | OFF } ] ...

Considerations

Please refer to ACQUIRE RELEASE (12-4) for a discussion of the values of the ACQUIREparameters.

Distribution and Acquisition CommandsSET ACQUIRE Command


SET DISTRIBUTE Command

The SET DISTRIBUTE command specifies default parameter values for the DISTRIBUTEcommand.

SET DISTRIBUTE distribute-options [ , distribute-options ]...

distribute options is one of:{ ALL [ { ON | OFF } ] }{ CLEANUP { ON | OFF } }{ COPIES num-copies }{ DELTA { RELEASE } }

{ COMPONENT } } { OFF } }

{ FORMAT extr-fmt-mode }{ INFORM [ { ON | OFF } ] }{ MAXFILES num-backup-files }{ NEEDED { ON | OFF } }{ PURGE [ { ON | OFF } }{ QUALIFY extr-level }{ RECOMPILE { ON | OFF } }{ RECURSIVE [ { ON | OFF } ] }{ REQUISITE { ON | OFF } }{ SUBVOL [ tape-volume ] }{ TAMPER [ { ON | OFF } ] }{ UPDATE [ { ON | OFF } ] }{ VERBOSE [ { ON | OFF } ] }

Considerations

Please refer to the DISTRIBUTE RELEASE (12-26) for a discussion of the values of theDISTRIBUTE parameters.

Distribution and Acquisition CommandsSET DISTRIBUTE Command


SET FALLBACK Command

The SET FALLBACK command specifies default parameter values for the ACQUIRERELEASE command.

SET FALLBACK fallback-options [ , fallback-options ] ...

fallback-options is one of:INFORM [ { ON | OFF } RECOMPILE { ON | OFF } VERBOSE verbose-level }

Considerations

None.

For more information on FALLBACK options, see FALLBACK (12-36).

Distribution and Acquisition CommandsSET FALLBACK Command


SET INSTALL Command

The SET INSTALL command specifies default parameters for the INSTALL command.

C40-ER00017

{ CLEANUP { ON | OFF } }{ DELTA { ON | OFF } }{ FORMAT format-mode }{ INFORM [ { ON | OFF } ] }{ PURGE [ { ON | OFF } ] }{ QUALIFY level }{ RECOMPILE { ON | OFF } }{ REQUISITE { ON | OFF } }{ TAMPER [ { ON | OFF } ] }{ UPDATE [ { ON | OFF } ] }{ VERBOSE verbose-leve l }

Considerations

See INSTALL RELEASE (12-47) for a discussion of the INSTALL parameter values.

Distribution and Acquisition CommandsSET INSTALL Command


SET LOCATION Command

The SET LOCATION command specifies a default target location prior to issuing a series ofADD LOCATION commands.

SET LOCATION TARGET { subvol | tape-drive | process-name }

Considerations

This command does not create locations. It simply establishes defaults for the ADDLOCATION command.

Distribution and Acquisition CommandsSET LOCATION Command


SET SPATH Command

The SET SPATH command specifies a search path for component name resolution in theACQUIRE RELEASE command.

SET SPATH { " * " | spath-id } , component-group-path

spath-id

is a number referring to a component search path. This parameter can range from 0through 29, inclusive.

component-group-path

is a partially- or fully-qualified existing group component.

Acquisition Considerations

Component search paths are used by the ACQUIRE MANIFEST command to locate existingcomponents within a target RMS catalog. ACQUIRE MANIFEST scans each search path, inorder, for components matching the TYPE and LANGUAGE attributes of components in therelease manifest. If a suitable component is found, it is linked directly into the release which isthe subject of the ACQUIRE MANIFEST.

Other Considerations

RMS may use component search paths for other commands.

Warning! Use caution if SPATHs are specified in RMSCSTM and RMSLOCL customization files.

Distribution and Acquisition CommandsSET SPATH Command


SHOW Command

The SHOW command displays the current defaults.

SHOW { ACQUIRE } { DISTRIBUTE } { INSTALL } { LOCATION }

Table 12-14 SHOW Command Summary

Command Description

SHOW ACQUIRE Displays acquire controls.

SHOW DISTRIBUTE Displays distribute controls.

SHOW INSTALL Displays install attributes.

SHOW LOCATION Displays location defaults.

Considerations

None.

Distribution and Acquisition CommandsSHOW Command


VERIFY LOCATION Command

The VERIFY LOCATION command audits the integrity of the release history of a location.

VERIFY LOCATION location-name

location-name

is the logical name of the location to be reported (e.g. NEW-YORK). Location-name maybe a partially- or fully-qualified name in the \LOCATIONS group.

Considerations

The following information is validated:

The components of the release are assessed in relation to other releases in the location’shistory. Components of an installed release that have been superseded during theinstallation of another release are reported.

Expected versions of currently relevant components are compared with the contents ofthe target location.

Any files in the target location that are not part of a known release are reported.

A summary of the current status of each element of the installation history is presented.

Distribution and Acquisition CommandsVERIFY LOCATION Command


Appendix AA RMS Monitor Errors

1000 DRMS-ERR-UNSUPPORTED The specified command is not yet supported.DRMS -ERR-UNSUP PORT ED

Cause: The command has not yet been implemented or is not in the version of RMS that is runningon your system.

Effect: The command is rejected.

Recovery: None.

1001 DRMS-ERR-NODATA There are no more responses (to a continuation command).DRMS -ERR-NODATA

Cause: A continuation command reached the end of the responses.

Effect: The command is complete.

Recovery: None, the command is considered complete.

1002 DRMS-ERR-MORERECENTVERSIONS There are more recent versions than in release.DRMS -ERR-MORE RECENT VERSI ONS

Cause: The ACQUIRE has completed successfully but there are versions of components in thecatalog which are more recent than in the release.

Effect: The command is accepted but with warnings. The error list contains a list of component fileswhich caused the warning.

Recovery: Ensure that the newer versions are compatible with the release.

1003 DRMS-WARN-BUG-FIX-PENDING There is a bugfix version present in the version history.DRMS -WARN-BUG-FI X-PE NDING

Cause: A version of the component has been submitted which is considered to be a bugfix version(non-zero sequence number).

Effect: The command on which this warning occurred is still processed.

Recovery: Once the appropriate personnel determine that the bugfix versions do not require furtherattention (after including or ignoring the fix), alter the BUGFIX PENDING flag to FALSE.

RMS Monitor ErrorsDRMS-ERR-UNSUPPORTED

080203 Data Design Systems, Inc. A-1

1004 DRMS-ERR-KIND-UNPROMOTABLE The indicated component is not promotable.DRMS -ERR-KIND- UNPROMOTABL E

Cause: The specified component type is not one that is promotable.


Recovery: None. It is safe, however, to end any TMF transactions.

1005 DRMS-ERR-COMP-COMPILABLE The indicated component is not promotable.DRMS -ERR-COMP -COMPI LABLE

Cause: The specified component version to be promoted was compiled and as such, cannot bepromoted. Use PRODUCE at the indicated state instead.



1006 DRMS-WARN-VALIDATION Attribute validation warning.DRMS -WARN-VALIDATI ON

Cause: Validation of data attributes indicated a potential problem. However, RMS was configured toreport this as a warning.

Effect: The command is accepted.

Recovery: None.

1043 DRMS-WARN-BUFFER-FULL The response buffer is full.DRMS -WARN-BUFFE R-FUL L

Cause: The specified command has generated more data than can be represented in the responsebuffer.

Effect: The command is completed with possible partial results.


RMS Monitor ErrorsDRMS-ERR-KIND-UNPROMOTABLE

A-2 080203 Data Design Systems, Inc.

1045 DRMS-WARN-BUFFER-FULL-NC The response buffer is full.DRMS -WARN-BUFFE R-FUL L-NC

Cause: The specified command has generated more data than can be represented in the responsebuffer.

Effect: The command is partially completed.

Recovery: Retry the same command to complete the remainder of the operation.

2000 DRMS-ERR-DATABASE-CORRUPT The data base is corrupt.DRMS -ERR-DATABASE- CORRUPT

Cause: RMS detected an inconsistency in the catalog.

Effect: The command is aborted.

Recovery: Contact your Data Design Systems’ representative.

2001 DRMS-ERR-FNAME-UNRESOLVABLE The database has a file name which cannot be resolved bythe current node.

DRMS -ERR-FNAME- UNRE SOLVABLE

Cause: A filename with an eight character device name cannot be accessed from another node.

Effect: The current command is aborted.

Recovery: The file name cannot be referenced from other than its home node.

2002 DRMS-ERR-NO-SPACE The database does not have enough space to handle therequest.

DRMS -ERR-NO-S PACE

Cause: See the associated error list for the GUARDIAN file name, and error.


Recovery: Correct the space problem and retry the request.

RMS Monitor ErrorsDRMS-WARN-BUFFER-FULL-NC


2003 DRMS-ERR-NO-SERVER-CLASS The specified server class does not exist.DRMS -ERR-NO-S ERVER-CLAS S

Cause: The command references a server class that does not exist.


Recovery: Correct the name of the server class and retry the command.

2004 DRMS-ERR-INVALID-VER-NUM The specified version number is invalid.DRMS -ERR-INVALI D-VER-NUM

Cause: The version specifed is out of range or a new version could not be added to the specifiedcomponent. Check for an error list for additional information.


Recovery: If the version number is out of range, correct the version number and retry the command, orcorrect the problem causing the associated GUARDIAN error.

2005 DRMS-ERR-CANNOT-ADD Cannot add item.DRMS -ERR-CANNOT-ADD

Cause: The specified item could not be added to the database.


Recovery: See the associated error list.

2006 DRMS-ERR-CANNOT-DELETE Cannot delete item.DRMS -ERR-CANNOT-DE LE TE

Cause: One of the delete consistency checks failed or the item could not be locked prior to deleting it.


Recovery: See the associated error list for more details.

RMS Monitor ErrorsDRMS-ERR-NO-SERVER-CLASS


2007 DRMS-ERR-CANNOT-UPDATE Cannot update item.DRMS -ERR-CANNOT-UP DAT E

Cause: One of the update consistency checks failed or the item could not be locked prior to updatingit.



2008 DRMS-ERR-NOT-LOCKED The component is not currently locked by the user in amode appropriate to the operation.

DRMS -ERR-NOT- LOCKED

Cause: The user failed to extract a component for edit and then attempted to submit the component.


Recovery: See the associated error list, try extracting the component for edit to another file and then retrythe command.

2009 DRMS-ERR-CANNOT-LOCK Cannot lock.DRMS -ERR-CANNOT-L OCK

Cause: The user or subsystem cannot obtain a required lock for a component or version.


Recovery: Determine if the component or version is locked and retry the command at a later time if it is.

2010 DRMS-ERR-CANNOT-PROMOTE The release or component could not be promoted.DRMS -ERR-CANNOT-P ROMOTE

Cause: There are versions at inappropriate states to satisfy the promotion.


Recovery: None.

RMS Monitor ErrorsDRMS-ERR-CANNOT-UPDATE


2011 DRMS-ERR-CANNOT-FALLBACK The fallback of a release or component failed.DRMS -ERR-CANNOT-FAL LBACK

Cause: RMS was unable to effect a successful fallback. There may not be fallback instructions.

Effect: The fallback is aborted.

Recovery: Check the contents of the execution library. There may be extraneous files. Check the error listfor more details.

2012 DRMS-ERR-CANNOT-SUBMIT Component submission failed.DRMS -ERR-CANNOT-S UBMIT

Cause: There are a number of reasons for the failure of a submission.

Effect: The submit is aborted.

Recovery: Consult the error list for more details.

2013 DRMS-ERR-NOT-DISC-FILE Not a disc file.DRMS -ERR-NOT- DISC-FI LE

Cause: The specified file is not a disc file. Only disc files may be submitted.

Effect: The submit command is aborted.

Recovery: Copy the file to a disc file then retry the command.

2014 DRMS-ERR-NOT-EDIT-FILE Not an edit file.DRMS -ERR-NOT- EDIT -FIL E

Cause: The specified file is not an edit file (code 101).


Recovery: Convert the source or document file to an edit format file using the editor and retry thecommand.

RMS Monitor ErrorsDRMS-ERR-CANNOT-FALLBACK


2015 DRMS-ERR-NOT-EMPTY File is not empty.DRMS -ERR-NOT- EMPTY

Cause: The specified file has a non-zero end of file when a file with a zero end of file was expected.

Effect: The initial submit is aborted.

Recovery: Determine the contents of the file, move to another location and create an empty file with filecode 2101, then retry the command.

2016 DRMS-ERR-NO-CHANGES No Changes specified.DRMS -ERR-NO-CHANGE S

Cause: The specified file did not contain any changes from the base version and the parameterNODIFFOK was set to false.


Recovery: Either set the NODIFFOK param to true or make a change to the submitted file and retry thecommand.

2017 DRMS-ERR-CANNOT-EXTRACT Cannot extract.DRMS -ERR-CANNOT-E XTRACT

Cause: The specified component is not a source or document component only source and documentcomponents may be extracted.

Effect: The extract command is aborted.

Recovery: Try to produce the version of the component.

2018 DRMS-ERR-BAD-DIFF-OP Invalid Diff Operation.DRMS -ERR-BAD-DIF F-OP

Cause: An invalid operation was generated by the difference engine.



RMS Monitor ErrorsDRMS-ERR-NOT-EMPTY


2019 DRMS-ERR-BAD-LINE Bad LineDRMS -ERR-BAD-L INE

Cause: Lines of the form ]{A|D|E} are not allowed in managed source or document files.


Recovery: Remove or alter the line specified in the associated error list, then retry the command.

2020 DRMS-ERR-BAD-FILENAME Bad file name.DRMS -ERR-BAD-FI LE NAME

Cause: A SOURCE/SEARCH/COPY/INCLUDE/OBEY directive has an invalid file name.


Recovery: Correct the file name and retry the command.

2021 DRMS-ERR-BAD-RMSCOMP-DEFINE Bad RMS component define.DRMS -ERR-BAD-RMS COMP-DE FINE

Cause: A define name of the form =RMS_COMP was detected but the following characters were nota ten digit number (the component id).


Recovery: Define names of the form =RMS_COMP are reserved within RMS and must have a ten digitcomponent id following them. See the associated error list for the line number where the errorwas detected, correct the define and retry the command.

2022 DRMS-ERR-CANT-FIND-COMPONENT Cannot find Component.DRMS -ERR-CANT-F IND-COMP ONENT

Cause: A component is referred to using a define that begins with =RMS_COMP but the followingten digits do not refer to any component in the catalog.


Recovery: Correct the define and retry the command. See the associated error list for the line number andcolumn position in the file.

RMS Monitor ErrorsDRMS-ERR-BAD-LINE


2023 DRMS-ERR-CANT-RESOLVE-DEFINE Cannot resolve define name.DRMS -ERR-CANT-RE SOLVE -DEF INE

Cause: A define name appears in a SOURCE/SEARCH/COPY/INCLUDE/OBEY directive but nocomponent has that define as an alternate name.


Recovery: Correct the define name and retry the command. See the associated error list for the linenumber where the error was detected.

2024 DRMS-ERR-COMP-NOT-FOUND Component not found.DRMS -ERR-COMP -NOT-F OUND

Cause: A SOURCE/SEARCH/COPY/INCLUDE/OBEY directive refers to an undefined externalcomponent and add on submit was false. A component being submitted is not found.


Recovery: Either remove the reference to the undefined external component, or correct the reference orset add on submit to true. See the associated error list for the line number where the error wasdetected.

2025 DRMS-ERR-CANNOT-ADD-EXTERNAL Could not add an external component.DRMS -ERR-CANNOT-ADD- EXT ERNAL

Cause: The submitted component refers to an external source or object component that does not existin the catalog. When an attempt was was made to add the external component to the catalog,an error occurred.



2026 DRMS-ERR-UNEXPECTED-EOF Unexpected end of file.DRMS -ERR-UNE XPECT ED-E OF

Cause: An unexpected end of file was encountered.


Recovery: If the component is a controlled component, recover it from a backup.

RMS Monitor ErrorsDRMS-ERR-CANT-RESOLVE-DEFINE


2027 DRMS-ERR-KIND-MISMATCH Statement refers to a component of incorrect type.DRMS -ERR-KIND- MIS MATCH

Cause: One of the following:

* a search directive refers to a source component

* a SOURCE/COPY statement refers to a object component

* a promote or demote is attempted on a component of the wrong type.


Recovery: See the associated error list for the line that caused the failure. Correct the line to refer to thecomponent of the the correct type and retry the command.

2028 DRMS-ERR-CANNOT-ADD-REFERENCE Could not add a reference.DRMS -ERR-CANNOT-ADD- RE FE RE NCE

Cause: A reference could not be added from the submitted component.


Recovery: Check the associated error list for a file error.

2029 DRMS-ERR-SEARCH-LIST-OVERFLOW There are too many ?SEARCH directives.DRMS -ERR-SE ARCH- LIS T-OVE RF LOW

Cause: There were more than 100 search directives in a submitted source component.

Effect: The submit is aborted.

Recovery: Use a bind rule to construct the object file.

2030 DRMS-ERR-INVALID-SYNTAX Invalid syntax in directive.DRMS -ERR-INVALI D-SYNTAX

Cause: A COPY/SEARCH/SOURCE/INCLUDE directive has invalid syntax.

Effect: The current command (SUBMIT) is aborted.

Recovery: Correct the line indicated in the assocated error list and retry the command.

RMS Monitor ErrorsDRMS-ERR-KIND-MISMATCH


2031 DRMS-ERR-SUBMIT-FILE-ERR A file error occurred during a submit.DRMS -ERR-SUBMIT-F ILE -E RR

Cause: A Guardian file error occurred while reading or writing the extracted file during a submit.


Recovery: Correct the file error and retry the command.

2032 DRMS-ERR-SUBMIT-OTHER-ERR Submit failed for a non-file error.DRMS -ERR-SUBMIT-OT HER-E RR

Cause: A syntax or semantic error occurred during a submit.


Recovery: See any associated error lists for more details, correct the error described in the error list andretry the command.

2033 DRMS-ERR-UNKNOWN-VERSION Version not found.DRMS -ERR-UNKNOWN-VE RS ION

Cause: The version specified does not exist. This can also occur during a produce when there is noversion at the specified state needed for the compile.


Recovery: See any associated error list for more details, correct the version number and retry thecommand.

2034 DRMS-ERR-CANNOT-UNLOCK Unable to remove specified locks on a component.DRMS -ERR-CANNOT-UNL OCK

Cause: Either a lock does not exist on the component, or the user does not have sufficient securityattributes to perform the operation.

Effect: None.

Recovery: None.

RMS Monitor ErrorsDRMS-ERR-SUBMIT-FILE-ERR


2035 DRMS-ERR-CANNOT-SECURE Unable to change the security attributes for the specifiedcomponent(s).

DRMS -ERR-CANNOT-S ECURE

Cause: The user does not have sufficient security attributes to perform the operation.

Effect: None.

Recovery: None.

2036 DRMS-ERR-IN-USE The RMS object is currently being used.DRMS -ERR-IN- USE

Cause: An attempt was made to perform a command on an object that either already exists, is used byanother object, or is currently being used.


Recovery: Recovery is dependent on the command and object pair being attempted.

2037 DRMS-ERR-OBJ-IN-USE RMS Entity is in use.DRMS -ERR-OBJ- IN-USE

Cause: The item which was specified is currently linked or used by another entry.

Effect: None.

Recovery: It is not possible to perform the desired operation until the link is removed.

2038 DRMS-ERR-CANNOT-COMPILE Unable to perform a compile operation on the specified listof components.

DRMS -ERR-CANNOT-COMPIL E

Cause: A compilation failure occurs during the compile.

Effect: Some components may not have been compiled.

Recovery: Check that appropriate compile rules and links exist. Check the compile listings for errors.

RMS Monitor ErrorsDRMS-ERR-CANNOT-SECURE


2039 DRMS-ERR-NO-RESOURCES The RMS MONITOR is too busy to satisfy the request.DRMS -ERR-NO-RE SOURCE S

Cause: There are no servers currently available to perform the desired operation.

Effect: None.

Recovery: Retry the command at a later time.

2040 DRMS-ERR-TOKENERROR Inappropriate attribute value detected.DRMS -ERR-T OKENE RROR

Cause: A value specified for a token or map field was invalid for the current command.


Recovery: Correct the value of the token or map and retry the command.

2041 DRMS-ERR-TOKENCONFLICT Conflict detected between attribute values.DRMS -ERR-T OKENCONFL ICT

Cause: A value specified for a token or map field was in conflict with other tokens in the command orthe current value of other tokens in the catalog.


Recovery: Correct the value of the token or map and retry the command.

2042 DRMS-ERR-ACQUIRE-PENDING Component acquisition pending.DRMS -ERR-ACQUIRE- PENDI NG

Cause: The requested component is in the process of being acquired. There are attributes of the filewhich are not fully resolved.


Recovery: Complete the acquisition process.

RMS Monitor ErrorsDRMS-ERR-NO-RESOURCES


2043 DRMS-ERR-CANNOT-DELTA Cannot perform delta operation.DRMS -ERR-CANNOT-DE LTA

Cause: The requested delta operation could not be performed.



2044 DRMS-ERR-CANNOT-RENUMBER Cannot perform renumber operation.DRMS -ERR-CANNOT-RE NUMBER

Cause: The requested renumber operation could not be performed.



2045 DRMS-ERR-COMPILE-REQUIRED Unable to perform a required compile operation.DRMS -ERR-COMP ILE -REQUI RE D

Cause: A compilation is required for the specified component but the command options do not permitit to be run.

Effect: No components have been compiled.

Recovery: Change the compile options to permit the compilation to proceed.

2046 DRMS-ERR-EMPTY Empty file detected.DRMS -ERR-E MPT Y

Cause: An operation was attempted where supplying an empty file is considered illegal (e.g., emptysegmented library).

Effect: The operation is rejected.

Recovery: Provide a valid file and retry the comment.

RMS Monitor ErrorsDRMS-ERR-CANNOT-DELTA


2048 DRMS-ERR-SECURITY SECURITY VIOLATION.DRMS -ERR-SE CURI TY

Cause: You are not authorized to perform all of the steps necessary to complete the command.


Recovery: Contact the RMS administrator to be authorized to perform the function.

2049 DRMS-ERR-RELEASE-FROZEN Attempt to modify the contents or versions of contents of arelease which is frozen.

DRMS -ERR-REL EAS E-F ROZ EN

Cause: This error can occur for both CONTENT and VERSION frozen releases. Always use cautionwhen modifying a frozen release. Generally, once a release is frozen, it should never bethawed. This error can also occur when attempting to delete or alter the root (\) or\RELEASES components.

Effect: The modification to the release is rejected.

Recovery: Thaw the release in question and retry the request.

2050 DRMS-ERR-NOT-LICENSED The specified command is not licensed.DRMS -ERR-NOT- LICE NSED

Cause: Your version of RMS is not licensed for the specified command.


Recovery: Contact your Data Design Systems’ representative to arrange for a revision to your licenseagreement.

2051 DRMS-ERR-FILE-ERROR File error occurred.DRMS -ERR-FI LE -ERROR

Cause: A file error occurred while reading or writing a managed or edit file.

Effect: The current command (e.g. EXTRACT, SUBMIT, etc.) is aborted. The error list shouldcontain a guardian file error.

Recovery: Examine the GUARDIAN file error to see if retrying the command would be advisable. If theerror persists contact your System administrator.

RMS Monitor ErrorsDRMS-ERR-SECURITY


2052 DRMS-ERR-ALLOCATESEGMENT Unable to allocate extended data segment.DRMS -ERR-AL LOCAT ES EGMENT

Cause: An error occurred while allocating an extended data segment.

Effect: The current command (e.g. SUBMIT, DIFFERENCES, etc.) is aborted. The error list willcontain the error returned from the GUARDIAN procedure ALLOCATESEGMENT.

Recovery: Examine the error returned and deterimine the cause of the error. If the error persists contactyour System Administrator.

2053 DRMS-ERR-MISSING-USERCHANGE Userchange Identifier required.DRMS -ERR-MISSI NG-USE RCHANGE

Cause: RMS has been configured to require the specification of a valid userchange identifier during asubmit.


Recovery: Specify a userchange identifier and re-submit.

2054 DRMS-ERR-DANGER-DETECTED Danger message encountered.DRMS -ERR-DANGE R- DET ECTE D

Cause: During a produce operation, a DANGER message was encountered.

Effect: Compiles may all have completed but the command is considered failed.

Recovery: Please examine the produce logs and correct the problem.

2100 DRMS-ERR-BAD-TRANSITION Unable to Promote or Demote.DRMS -ERR-BAD-T RANS ITI ON

Cause: There is not direct transition between the current and desired state.


Recovery: Correct the command to appropriate states or link the two states.

RMS Monitor ErrorsDRMS-ERR-ALLOCATESEGMENT


2101 DRMS-ERR-VERSION-CONFLICT Unable to Promote, Demote or Freeze.DRMS -ERR-VE RS ION-CONFL ICT

Cause: There is already a more recent version at the desired state.


Recovery: For PROMOTE or DEMOTE, you are not permitted to perform the operation.

For FREEZE, there are incompatible versions in a release. Thaw the release and correctthe release contents.

2102 DRMS-ERR-INAPPROPRIATE-VERS Unable to Promote or Demote.DRMS -ERR-INAP PROPRIAT E- VERS

Cause: There is either no appropriate version of the component at the old state or the version is not atthe correct old state.


Recovery: Correct the command to an appropriate Promote or Demote state.

2103 DRMS-ERR-BUG-FIX-PENDING There is a bugfix version present in the version history.DRMS -ERR-BUG-FI X-PE NDING

Cause: A version of the component has been submitted which is considered to be a bugfix version(non-zero sequence number). Promotions are rejected.

Effect: The command on which this warning occurred is not processed.

Recovery: Once the appropriate personnel determine that the bugfix versions do not require furtherattention (after including or ignoring the fix), alter the BUGFIX PENDING flag to FALSE.

2104 DRMS-ERR-TIMESTAMP-RESOLVE Timestamp resolution problem.DRMS -ERR-T IME STAMP-RE SOLVE

Cause: RMS was unable to reconcile the timestamp of the object with the version number provided.

Effect: The operation (usually a submit) is rejected.

Recovery: Either the wrong file is being submitted or the version was inconsistent in the source catalog.

RMS Monitor ErrorsDRMS-ERR-VERSION-CONFLICT


2200 DRMS-ERR-NO-SUCH-SECTION Could not find section of segmented source.DRMS -ERR-NO-S UCH- SECT ION

Cause: RMS was unable to locate a specific section of a segmented source component. The offendingsection name is returned in the error list.

Effect: The operation (usually a submit or extract) is rejected.

Recovery: None.

2500 DRMS-ERR-BUILD-REFS Could not build reference list.DRMS -ERR-BUIL D-REFS

Cause: RMS was unable to construct the source component reference list during compilationprocessing.

Effect: The compile is rejected.

Recovery: Perform the following steps:

* If not in RMSCOM, the relevant TMF transaction must be aborted.

* Check the returned error lists for additional information.

* Check the source component’s reference list.

2501 DRMS-ERR-NO-COMPILE No compile for component.DRMS -ERR-NO-COMPIL E

Cause: There is no compile rule for the target object component.


Recovery: Add a compile rule between a source component and the specified object component.

RMS Monitor ErrorsDRMS-ERR-NO-SUCH-SECTION


2502 DRMS-ERR-NO-RULE No rule for component.DRMS -ERR-NO-RUL E

Cause: An appropriate compile rule name was not found for the target object component.


Recovery: Either:

* correct the compile rule between the relevant source component and the specifiedobject component

* add a rule definition which will resolve the compile rule.

2503 DRMS-ERR-NO-SOURCE A version of the source file does not exist at the appropriatestate.

DRMS -ERR-NO-S OURCE

Cause: RMSUBMIT was unable to select an appropriate source version for use in a compile step.


Recovery: Either:

* submit the source component for the first time

* promote the source component to a higher state

* wait until the source component is at a higher state before attempting a compile.

2504 DRMS-ERR-NOCORRESPONDVERSION The specified version date does not correspond to a validcomponent’s version.

DRMS -ERR-NOCORRE SPONDVE RSION

Cause: There is no version of the component appropriate for selection.


Recovery: A more precise date should be specified.

RMS Monitor ErrorsDRMS-ERR-NO-RULE


2505 DRMS-ERR-AMBIGUOUS The specified version date corresponds to more than oneversion.

DRMS -ERR-AMBI GUOUS

Cause: There was more than one version created in the period specified.


Recovery: A more precise date should be specified.

2506 DRMS-ERR-NOCORRESPONDSTATE There is no version at the specified state for the component.DRMS -ERR-NOCORRE SPONDS TAT E

Cause: A state was specified but there is no version corresponding to that state.


Recovery: Correct the state and retry the command.

2510 DRMS-ERR-CREATEPROCESSNAME Could not create process name.DRMS -ERR-CREATE PROCE SSNAME

Cause: A call to CREATEPROCESSNAME failed.


Recovery: If the problem persists contact your System Administrator.

2511 DRMS-ERR-NO-START-TACL Could not start TACL process.DRMS -ERR-NO-S TART -TACL

Cause: A call to NEWPROCESS failed on $SYSTEM.SYSTEM.TACL

Effect: The produce command is aborted.

Recovery: See the error list for more details.

RMS Monitor ErrorsDRMS-ERR-AMBIGUOUS


2512 DRMS-ERR-FREEZE-RESOLVE Could not resolve a version of a component.DRMS -ERR-FRE EZ E-RE SOLVE

Cause: No versions exist for the component or the component has not reached the appropriate stateyet.

Effect: The freeze release command is aborted.

Recovery: Correct the component and retry the command.

2513 DRMS-ERR-CANNOT-DISTRIBUTE RMS could not distribute the release.DRMS -ERR-CANNOT-DI STRIBUT E

Cause: See the error list for details.


Recovery: See the error list for the source of the problem.

2514 DRMS-ERR-INVALID-LOCATION The location specified is not of the correct type.DRMS -ERR-INVALI D-LOCATION

Cause: An attempt was made to distribute a release to an ARCHIVE location.


Recovery: Correct the location name and retry the command.

2515 DRMS-ERR-OLDFILETOOBIG The old version is too large to be compared.DRMS -ERR-OL DFIL ET OOBI G

Cause: The old version contains more than 25,000 lines, the limit of RMS.

Effect: The SUBMIT or DIFFERENCE command is aborted.

Recovery: Break the component into smaller pieces or alter the RMSUBMIT server’s startup parameters.

RMS Monitor ErrorsDRMS-ERR-FREEZE-RESOLVE


2516 DRMS-ERR-NEWFILETOOBIG The new version is too large to be compared.DRMS -ERR-NE WF ILE TOOBIG

Cause: The new version contains more than 25,000 lines, the limit of RMS.

Effect: The SUBMIT or DIFFERENCE command is aborted.

Recovery: Break the component into smaller pieces or alter the RMSUBMIT server’s startup parameters.

2517 DRMS-ERR-TOOMANYUNIQUELINES There are too many unique lines in the file.DRMS -ERR-T OOMANYUNIQUE LI NES

Cause: The tables in the SUBMIT server overflowed. There is only room for 20,000 unique lines.

Effect: The submit or difference command is aborted.

Recovery: Break the file into smaller pieces or perform the difference comparison without the ignoreblank or ignore case option. Or, try altering the RMSUBMIT server’s startup parameters.

2518 DRMS-ERR-SCOBOLMODE Invalid component combination for SCOBOL object.DRMS -ERR-SCOBOLMODE

Cause: RMS detected an invalid combination of SCOBOL object and TCLPROG definitions.SCOBOL object components must be children of a group component with a language of"SCOBOL" and a file name corresponding to the TCLPROG file. That group must have mode= NORMAL.

Effect: The current operation (e.g. PRODUCE) is aborted.

Recovery: Correct the component definition for the TCLPROG component and retry the request.

2519 DRMS-ERR-CANNOT-ACQUIRE RMS could not acquire the release.DRMS -ERR-CANNOT-ACQUIRE

Cause: See the error list for details.


Recovery: See the error list for the source of the problem.

RMS Monitor ErrorsDRMS-ERR-NEWFILETOOBIG


2520 DRMS-ERR-BEEN-DISTRIBUTED The release has been distributed.DRMS -ERR-BEE N-DIS TRIBUTE D

Cause: The release has been distributed, so it cannot be deleted.


Recovery: Promote the release to the OBSOLETE state and retry the command.

2521 DRMS-ERR-INVALID-REL-STATE The release is at an inappropriate state for deleting.DRMS -ERR-INVALI D-REL -STATE

Cause: The release was not at a latest or obsolete state.


Recovery: Promote the release to the obsolete state and retry the command.

2522 DRMS-ERR-CANNOT-LINK-ORPHAN Could not link a component to the \ORPHANS group.DRMS -ERR-CANNOT-L INK-ORPHAN

Cause: Either a release with the same name is already a child of the orphans group or the user doesnot have security to add a component to the orphans group.


Recovery: Check the components in the orphans group and retry the command.

2523 DRMS-ERR-CANNOT-UNLINK Could not unlink a component from the specified group.DRMS -ERR-CANNOT-UNL INK

Cause: The link to the group is the last link to the component.


Recovery: Check the components in the group and use delete component if this is the last link to thecomponent.

RMS Monitor ErrorsDRMS-ERR-BEEN-DISTRIBUTED


2530 DRMS-ERR-BAD-SECURITY-MASK Invalid security mask value specified.DRMS -ERR-BAD-SE CURI TY-MAS K

Cause: The value specified for a security string in a produce parameter does not conform to Guardianspecifications.


Recovery: Correct the security string and retry the command.

2531 DRMS-ERR-BAD-SECURITY-UMASK Invalid security umask value specified.DRMS -ERR-BAD-SE CURI TY-UMAS K

Cause: The value specified for a security mask string in a produce parameter does not conform toGuardian specifications.


Recovery: Correct the security mask string and retry the command.

2599 DRMS-ERR-NOT-LOCAL Cannot distribute to a remote EXPAND subvolume.DRMS -ERR-NOT- LOCAL

Cause: The target location refers to an EXPAND subvolume on a remote node. You must eitherdistribute the release to a MONITOR on the remote node or copy the release across thenetwork yourself.


Recovery: Have RMS installed on your remote node.

RMS Monitor ErrorsDRMS-ERR-BAD-SECURITY-MASK


2600 DRMS-ERR-MANIFEST-BADOS Bad operating system version specifier detected in a releasemanifest.

DRMS -ERR-MANIFE ST-BADOS

Cause: An incorrectly-formatted operating system version specifier token was encountered in arelease manifest. The token is a parameter of either the MIN_OS_ or MAX_OS_ predicate inthe user section of the manifest being processed during the failure. This error can only occur ifthe version specifier token is present.

Effect: The current operation (e.g. ACQUIRE) is aborted.


* Correct the release manifest copy in the release library on disc. DO NOT TOUCH ANYTAPE OR ORIGINAL COPIES OF A MANIFEST.

* Retry the original request with the new manifest.

2601 DRMS-ERR-MANIFEST-BADCOMPNAME Bad component name detected in a release manifest.DRMS -ERR-MANIFE ST-BADCOMP NAME

Cause: A missing or incorrectly specified component name token was encountered in a releasemanifest. The token is a parameter of the COMPONENT_ predicate of the manifest beingprocessed during the failure.



* If the COMPONENT_ predicate is in the user section of the manifest, contact theoriginators of the release and have them correct the release manifest in the originatingcatalog. Once corrected, retry the original request with the new manifest.

* If the COMPONENT_ predicate is not in the user section of the manifest, report theproblem to your Data Design Systems’representative, supplying a reproduceable test case.

RMS Monitor ErrorsDRMS-ERR-MANIFEST-BADOS


2602 DRMS-ERR-MANIFEST-BADLANG Bad language token detected in a release manifest.DRMS -ERR-MANIFE ST-BADL ANG

Cause: An incorrectly specified language token was encountered in a release manifest. The token is aparameter of the COMPONENT_ LANGUAGE predicate of the manifest being processedduring the failure. This can happen if the language is more than eight characters.



* Correct the release manifest copy in the release library on disc. DO NOT TOUCH ANYTAPE OR ORIGINAL COPIES OF A MANIFEST.

* Retry the original request with the new manifest.

2603 DRMS-ERR-MANIFEST-BADTYPE Unsupported component type token detected in a releasemanifest.

DRMS -ERR-MANIFE ST-BADT YPE

Cause: An incorrectly-specified type token was encountered in a release manifest. The token is aparameter of the COMPONENT_ TYPE predicate of the manifest being processed during thefailure. This can happen if the distributing RMS is using a component type which was addedto a version of RMS which is more recent than the acquiring RMS.


Recovery: Either:

* correct the release manifest copy in the release library on disc. DO NOT TOUCH ANYTAPE OR ORIGINAL COPIES OF A MANIFEST and retry the original request with thenew manifest.

* upgrade your copy of RMS to a more recent version

* contact the originators of the release and have it prepared with compatible componenttypes.

RMS Monitor ErrorsDRMS-ERR-MANIFEST-BADLANG


2604 DRMS-ERR-MANIFEST-BADVERSION Bad version specifier detected in a release manifest.DRMS -ERR-MANIFE ST-BADVE RS ION

Cause: An incorrectly-formatted version token was encountered in a release manifest. The token is aparameter of the COMPONENT_ VERSION predicate of the manifest being processed duringthe failure.


Recovery: Either:

* contact the originators of the release to correct the version of the offending component

* if the above step does not remedy the situation, report the problem to your Data DesignSystems’ representative, supplying a reproduceable test case.

2605 DRMS-ERR-BAD-PCR-STATE State mismatch between PCR and submit version.DRMS -ERR-BAD-PCR-ST AT E

Cause: The state of the PCR is different from the state of the submission or submitted version.ers


Recovery: Use an appropriate PCR or create a new one.

2610 DRMS-ERR-DUPLICATE Duplicate entityDRMS -ERR-DUPL ICAT E

Cause: An attempt was made to add an entity or relationship in the RMS catalog which already exists.ers


Recovery: Correct the selected command parameters and retry.

RMS Monitor ErrorsDRMS-ERR-MANIFEST-BADVERSION


2700 DRMS-ERR-BAD-RELEASE-NUM Bad release number in version.DRMS -ERR-BAD-REL EAS E-NUM

Cause: A version specifier within a mananged source file contained a non-numeric release number orthe release number was not three characters long.

Effect: The current operation (e.g. SUBMIT, EXTRACT, etc.) is aborted.


2701 DRMS-ERR-EXPECTING-PERIOD Expecting period in version.DRMS -ERR-E XPECT ING-PE RIOD

Cause: A version specifier within a mananged source file did not contain a period where a period wasexpected.



2702 DRMS-ERR-BAD-LEVEL-NUM Bad level number in version.DRMS -ERR-BAD-L EVE L-NUM

Cause: A version specifier within a mananged source file contained a non-numeric level number orthe level number was not three characters long.



2703 DRMS-ERR-BAD-BRANCH-NUM Bad branch number in version.DRMS -ERR-BAD-BRANCH- NUM

Cause: A version specifier within a mananged source file contained a non-numeric branch number orthe branch number was not two characters long.



RMS Monitor ErrorsDRMS-ERR-BAD-RELEASE-NUM


2704 DRMS-ERR-BAD-SEQUENCE-NUM Bad sequence number in version.DRMS -ERR-BAD-SE QUENCE -NUM

Cause: A version specifier within a mananged source file contained a non-numeric sequence numberor the sequence number was not two characters long.



2705 DRMS-ERR-BAD-VERSION-NUM Bad version number in version marker.DRMS -ERR-BAD-VE RS ION-NUM

Cause: A version specifier within a mananged source file contained a release number greater than 999or a level number greater than 999 or a branch number greater than 99 or a sequence numbergreater th than 99.



2706 DRMS-ERR-BAD-VERSION-HEADER Invalid version header in managed source file.DRMS -ERR-BAD-VE RS ION-HE ADER

Cause: A version header in a managed source file was not of the correct format.



2707 DRMS-ERR-BAD-FILE-HEADER Invalid file header in managed source file.DRMS -ERR-BAD-FI LE -HEADE R

Cause: A file header in a managed source file was not of the correct format.



RMS Monitor ErrorsDRMS-ERR-BAD-SEQUENCE-NUM


2708 DRMS-ERR-DUPLICATE-VERSION A duplicate version was detected.DRMS -ERR-DUPL ICAT E- VERSION

Cause: Due to a prior failure a duplicate version was detected during a submit.

Effect: The current submit is aborted.

Recovery: Increment the version number being submitted by one and retry the command.

2709 DRMS-ERR-BADSECTIONDOTORDER A poorly formatted section name appears in a .ORDERcomponent.

DRMS -ERR-BADSE CT IONDOT ORDE R

Cause: A user has submitted a .ORDER component with invalid data.


Recovery: Correct the .ORDER component using EXTRACT, EDIT, and SUBMIT.

2710 DRMS-ERR-BADLINENUMDOTORDER A poorly formatted starting line number appears in a.ORDER component.

DRMS -ERR-BADLI NENUMDOTORDER

Cause: A user has submitted a .ORDER component with invalid data. The number is not a valid EDITline number.


Recovery: Correct the .ORDER component using EXTRACT, EDIT, and SUBMIT.

2751 DRMS-ERR-SQL-NOT-ALLOWED SQL entities not allowed.DRMS -ERR-SQL -NOT- ALL OWE D

Cause: An attempt was made to submit from or extract to an SQL entity.


Recovery: Use the correct file type.

RMS Monitor ErrorsDRMS-ERR-DUPLICATE-VERSION


2752 DRMS-ERR-MUST-BE-KEYSEQUENCED Only key-sequenced files allowed.DRMS -ERR-MUST-BE -KEYS EQUE NCE D

Cause: An attempt was made to submit from or extract to a file type other than key sequenced.


Recovery: Use the correct file type.

2753 DRMS-ERR-MISSING-KEY-DESC Missing key description.DRMS -ERR-MISSI NG-KEY-DE SC

Cause: The attribute .KEY-DESC must be present on the DATALIB group.


Recovery: Add the appropriate key description and retry the operation.

2754 DRMS-ERR-INVALID-KEY-DESC Invalid key description.DRMS -ERR-INVALI D-KEY-DE SC

Cause: The attribute .KEY-DESC contains invalid characters or is incompatible with thekey-sequenced file.


Recovery: Correct the key description and retry the operation.

2755 DRMS-ERR-TOO-LONG-KEY Key translation generated too long a name.DRMS -ERR-T OO-LONG- KEY

Cause: The attribute .KEY-DESC generated a name which is larger than the maximum componentname size.



RMS Monitor ErrorsDRMS-ERR-MUST-BE-KEYSEQUENCED


2756 DRMS-ERR-INVALID-COMP-NAME Key translation generated a bad name.DRMS -ERR-INVALI D-COMP- NAME

Cause: The attribute .KEY-DESC generated a name which contains invalid characters.



2757 DRMS-ERR-INVALID-KEY-DATA Input key is incompatible with key description.DRMS -ERR-INVALI D-KEY-DATA

Cause: The attribute .KEY-DESC could not map data in the input key data characters.



2758 DRMS-ERR-NOT-KEYED Redirected source is not key sequenced.DRMS -ERR-NOT- KEYE D

Cause: A redirected component points to a file which is not key sequenced during a compile.

Effect: The compile is aborted.

Recovery: Correct the redirection and retry the compile.

2759 DRMS-ERR-INVALID-DATA-DESC Invalid data description.DRMS -ERR-INVALI D-DAT A-DES C

Cause: The attribute .DATA-DESC contains invalid characters or is incompatible with thekey-sequenced file.


Recovery: Correct the data description and retry the operation.

RMS Monitor ErrorsDRMS-ERR-INVALID-COMP-NAME


2760 DRMS-ERR-MULTIPLE-COMPONENTS Multiple components present in input file.DRMS -ERR-MULTI PLE -COMP ONENT S

Cause: A submit was attempted to a section component but there were multiple components detectedin the input file.


Recovery: Submit the file to the group component optionally using the KEEP MISSING ON asappropriate.

2761 DRMS-ERR-DIFFERENT-COMPONENT Different component present in input file.DRMS -ERR-DIF FERE NT-COMP ONENT

Cause: The input file contains data which maps to a different component than the one specified in thesubmit operation.


Recovery: Correct the target component in the submit command and retry.

2762 DRMS-ERR-FILES-NOT-COMPATIBLE File attributes are not compatible.DRMS -ERR-FI LE S-NOT- COMPAT IBLE

Cause: A submit or extract was attempted involving files with different key offsets and/or key lengths.


Recovery: Correct the file attributes and retry the operation.

2900 DRMS-ERR-VALIDATION Attribute validation rejected.DRMS -ERR-VALIDATI ON

Cause: Validation of data attributes indicated a bad attribute.


Recovery: Correct the data and retry the command.

RMS Monitor ErrorsDRMS-ERR-MULTIPLE-COMPONENTS


2999 DRMS-ERR-SERVER-ERROR A non-specific server error occurred.DRMS -ERR-SE RVE R-ERROR

Cause: A problem occurred within one of the server processes.


Recovery: Consult the error list for details. If none exist, contact your Data Design Systems’representative.

3000 DRMS-ERR-USERVERIFY-FAILED A user procedure rejected an item associated with thecommand.

DRMS -ERR-USE RVE RIFY-FAIL ED

Cause: A user procedure rejected an item associated with the command.


Recovery: Correct the item, as per the local specifications for the item and retry the command.

4001 DRMS-ERR-SPI-EXTRATOKEN Extra token.DRMS -ERR-SP I-E XTRAT OKEN

Cause: An extra SPI token was detected.


Recovery: Correct the request buffer and retry.

4002 DRMS-ERR-SPI-INVALIDTOKEN Invalid token.DRMS -ERR-SP I-INVALI DTOKE N

Cause: A invalid SPI token was detected.


Recovery: Check the command contents for consistency with the documented interface protocol.

RMS Monitor ErrorsDRMS-ERR-SERVER-ERROR


4003 DRMS-ERR-SPI-WRONGTOKEN Wrong token.DRMS -ERR-SP I-WRONGTOKE N

Cause: A wrong SPI token was detected.


Recovery: None.

4004 DRMS-ERR-SPI-MISSINGTOKEN Missing token.DRMS -ERR-SP I-MISSI NGTOKE N

Cause: An SPI token is missing from the buffer.


Recovery: Correct the cause of the missing token and retry the command.

4005 DRMS-ERR-SPI-INVALIDFIELD Invalid field.DRMS -ERR-SP I-INVALI DFIE LD

Cause: An SPI field is invalid.

Effect: The command is aborted .

Recovery: Correct the cause of the invalid field and retry the command.

4006 DRMS-ERR-SPI-MISSINGFIELD Missing field.DRMS -ERR-SP I-MISSI NGFIE LD

Cause: An SPI field is missing.


Recovery: Correct the cause of the missing field and retry the command.

RMS Monitor ErrorsDRMS-ERR-SPI-WRONGTOKEN


4009 DRMS-ERR-SPI-INVALIDBUFFER SPI procedures report invalid buffer.DRMS -ERR-SP I-INVALI DBUF FER

Cause: The SPI buffer is invalid.


Recovery: Correct the cause of the invalid buffer and retry the command.

4010 DRMS-ERR-SPI-BADCHECKSUM SPI procedures report bad checksum.DRMS -ERR-SP I-BADCHECKSUM

Cause: A procedure has corrupted the buffer.


Recovery: Locate and correct the corruption of the buffer, then retry the command.

4011 DRMS-ERR-SPI-SSPUT Error on call to SSPUT.DRMS -ERR-SP I-SS PUT

Cause: An error occured during a call to SSPUT.


Recovery: The response buffer is likely to be too small. Increase the size.

4012 DRMS-ERR-SPI-SSGET Error on call to SSGET.DRMS -ERR-SP I-SS GET

Cause: An unexpected error occurred during a call to SSGET.


Recovery: Correct the buffer contents based on the SSGET error code.

RMS Monitor ErrorsDRMS-ERR-SPI-INVALIDBUFFER


4013 DRMS-ERR-SPI-SSINIT Error on call to SSINIT.DRMS -ERR-SP I-SS INIT

Cause: An error occurred during a call to SSINIT.


Recovery: This is a programming error. Contact your Data Design Systems’ representative as soon aspossible.

4014 DRMS-ERR-SPI-SSNULL Error on call to SSNULL.DRMS -ERR-SP I-SS NULL

Cause: An error occurred during a call to SSNULL.



4015 DRMS-ERR-SPI-SSMOVE Error on call to SSMOVE.DRMS -ERR-SP I-SS MOVE

Cause: An error occurred on a call to SSMOVE.



4016 DRMS-ERR-SPI-WRONGSUBSYS Request SSID is not RMS SSID.DRMS -ERR-SP I-WRONGSUBSYS

Cause: The SSID in the buffer did not match the RMS SSID.


Recovery: Correct the SSID used to initialize the buffer, and retry the command.

RMS Monitor ErrorsDRMS-ERR-SPI-SSINIT


4017 DRMS-ERR-SPI-GENERALERR General SPI procedure error.DRMS -ERR-SP I-GE NERALE RR

Cause: An unknown SPI error occurred during command or response processing.


Recovery: Correct the SPI buffer and retry the request. Also, contact your Data Design Systems’representative.

RMS Monitor ErrorsDRMS-ERR-SPI-GENERALERR


Appendix BB RMS Monitor EMS Events

0 DRMS-EVT-RMS-STARTING The RMS subsystem is beginning its initializationsequence.

DRMS -EVT -RMS- STARTING

Cause: The RMS subsystem has started its initial checkout processing.

Effect: None, informative message.

Recovery: None, informative message.

1 DRMS-EVT-RMS-STARTED The RMS subsystem has been successfully initialized.DRMS -EVT -RMS- STARTE D

Cause: The RMS subsystem initialized the catalog, a new catalog was just created.



2 DRMS-EVT-CATALOG-CHECKOUT RMS has detected file format conflicts in the catalog.DRMS -EVT -CATAL OG-CHECKOUT

Cause: A file was not owned by the user who started RMSMON or a file attribute such as file-code,record length, or block length was not the correct value.

Effect: RMSMON or the server ABENDs.

Recovery: Correct the file attribute and restart RMSMON.

3 DRMS-EVT-INIT-CATALOG-FAILED Unable to successfully initialize the catalog.DRMS -EVT -INIT -CATAL OG-FAIL ED

Cause: A CREATE/OPEN/WRITE error occcured while creating or initializing the catalog.

Effect: RMSMON abends.

Recovery: Correct the file problem, purge the paritial catalog and restart RMSMON.

RMS Monitor EMS EventsDRMS-EVT-RMS-STARTING

080203 Data Design Systems, Inc. B-1

4 DRMS-EVT-INIT-CATALOG RMS is initializing the catalog.DRMS -EVT -INIT -CATAL OG

Cause: The catalog is being initialized.

Effect: The catalog is initialized.

Recovery: None, informative messsage.

5 DRMS-EVT-SC-ADD-FAILURE RMS is unable to add a server class.DRMS -EVT -SC-ADD-FAI LURE

Cause: An attempt was made to add more server classes than RMS can accomodate.



6 DRMS-EVT-RMS-SHUTDOWN RMS is terminated.DRMS -EVT -RMS- SHUTDOWN

Cause: A shutdown RMS command was issued.

Effect: RMS is shutting down.


7 DRMS-EVT-SCPROCESS-HALT An RMS sub-server abnormally terminated. See logdetails for more information. SEL^SCPROCESS andDEF^SCPROCESS are provided.

DRMS -EVT -SCPROCESS -HALT

Cause: A server process terminated when it was processing a command.

Effect: Any command it was executing is aborted.

Recovery: Retry the command. If the problem persists contact your Data Design Systems’ representative.

RMS Monitor EMS EventsDRMS-EVT-INIT-CATALOG

B-2 080203 Data Design Systems, Inc.

8 DRMS-EVT-COMPONENT-SUBMIT A component has been submitted.DRMS -EVT -COMPONE NT-S UBMIT

Cause: A submit command was executed.

Effect: The message contains the full component name, User ID, and version.


9 DRMS-EVT-COMPONENT-EXTRACT A component has been extracted.DRMS -EVT -COMPONE NT-E XTRACT

Cause: An extract command was executed.



10 DRMS-EVT-COMPONENT-COMPILE A component has been compiled.DRMS -EVT -COMPONE NT-COMPIL E

Cause: A produce command was executed.



11 DRMS-EVT-CLEANUP RMS processed a cleanup request.DRMS -EVT -CLE ANUP

Cause: A CLEANUP RMS command was executed.

Effect: The command was processed.


RMS Monitor EMS EventsDRMS-EVT-COMPONENT-SUBMIT


12 DRMS-EVT-SCPROCESS-STARTED A server has been successfully initialized.DRMS -EVT -SCPROCESS -STARTE D

Cause: A new server in a server class was started.

Effect: The server was started.


13 DRMS-EVT-SCPROCESS-SHUTDOWN A server is terminated normally.DRMS -EVT -SCPROCESS -SHUT DOWN

Cause: A server was no longer needed due to the combination of NUMSTATIC and DELETEDELAY,or a STOP SERVER command was issued.

Effect: The server is stopped.


14 DRMS-EVT-NOT-LICENSED RMS is not licensed to run on this system.DRMS -EVT -NOT-L ICENS ED

Cause: The system number does not match the system number in the object file or the object file hasbeen tampered with.

Effect: RMSMON abends.

Recovery: Contact Data Design Systems’ representative.

15 DRMS-EVT-LICENSED RMS is licensed to run on this system.DRMS -EVT -LI CE NSE D

Cause: The license check passed.



RMS Monitor EMS EventsDRMS-EVT-SCPROCESS-STARTED


16 DRMS-EVT-COMPILE-STARTED A component compilation has been started.DRMS -EVT -COMPI LE -STARTE D

Cause: The indicated user has issued a command to produce a specific component.



17 DRMS-EVT-COMPILE-FAILED A component compilation has failed.DRMS -EVT -COMPI LE -FAIL ED

Cause: A compile error has occurred during compilation processing of a specific component.


Recovery: The appropriate personnel should correct the compilation problem and recompile.

18 DRMS-EVT-COMPONENT-DELETED A component has been deleted.DRMS -EVT -COMPONE NT-DE LE TE D

Cause: The indicated user deleted a specific component.

Effect: The message contains the full component name, and user id.


19 DRMS-EVT-SUBMIT-FAILED A component submit has failed.DRMS -EVT -SUBMI T-FAIL ED

Cause: A submit error has occurred during submission processing of a specific component.

Effect: The message contains the full component name, user id, and file name.

Recovery: The appropriate personnel should correct the submit problem and resubmit.

RMS Monitor EMS EventsDRMS-EVT-COMPILE-STARTED


47 DRMS-EVT-SECURITY-CHANGE A change to security occurred.DRMS -EVT -SE CURIT Y- CHANGE

Cause: A security entry was added or deleted.

Effect: A change to security occurred.


48 DRMS-EVT-SECURITY-VIOLATION A user attempted to access a component in the RMScatalog which was prohibited to that user.

DRMS -EVT -SE CURIT Y- VIOLATI ON

Cause: A check of the security records relevant to the command failed.


Recovery: The security violation is logged.

49 DRMS-EVT-CMD-SEC-VIOLATION A user attempted to perform a command that wasprohibited to that user.

DRMS -EVT -CMD-S EC-VIOL AT ION

Cause: A check of the security records relevant to the command failed.


Recovery: The security violation is logged.

50 DRMS-EVT-EXTERNAL-COMPILE A component has been compiled using an externalcompile facility (RMSMAKE).

DRMS -EVT -EXT ERNAL -COMPI LE

Cause: RMSMAKE was run outside of RMS on the specified component.

Effect: The message contains the full component name, User ID, and file names involved in thecompile.


RMS Monitor EMS EventsDRMS-EVT-SECURITY-CHANGE


51 DRMS-EVT-DISTRIBUTE-RELEASE A release has been distributed.DRMS -EVT -DIST RIBUTE -REL EASE

Cause: A frozen release was sent to a specific location.

Effect: A release library was created, customized and cut to tape, or sent to a remote RMS or to asubvolume. The release library takes up disk space.


52 DRMS-EVT-INSTALL-RELEASE A release has been installed.DRMS -EVT -INST ALL -REL EASE

Cause: A frozen release was installed in a specific location.

Effect: A release library was created, customized and placed in an execution area. The release librarytakes up disk space.


53 DRMS-EVT-ACQUIRE-RELEASE A release has been acquired.DRMS -EVT -ACQUIRE-RE LE ASE

Cause: An open release was received from a specific location.

Effect: All relevant components have been submitted or archived.


54 DRMS-EVT-FALLBACK-RELEASE A release has been rolled out.DRMS -EVT -FALL BACK- RE LE ASE

Cause: A currently-installed release has been removed from a location.

Effect: The previously-installed release (and components) are about to be reinstalled. A subsequentevent will confirm the installation.


RMS Monitor EMS EventsDRMS-EVT-DISTRIBUTE-RELEASE


55 DRMS-EVT-DISTRIBUTE-COMPONENT A component has been distributed.DRMS -EVT -DIST RIBUTE -COMPONE NT

Cause: A component was sent to a specific location.

Effect: None.


56 DRMS-EVT-INSTALL-COMPONENT A component has been installed.DRMS -EVT -INST ALL -COMPONE NT

Cause: A component was installed in a specific location.

Effect: None.


57 DRMS-EVT-ACQUIRE-COMPONENT A component has been acquired.DRMS -EVT -ACQUIRE-COMPONENT

Cause: A component was received from a specific location.

Effect: The component has been submitted or archived.


58 DRMS-EVT-FALLBACK-COMPONENT A fallback component has been executed.DRMS -EVT -FALL BACK- COMPONE NT

Cause: A currently-installed component has been removed from a location.

Effect: The previously-installed component is about to be reinstalled, if appropriate. A subsequentevent will confirm the installation.


RMS Monitor EMS EventsDRMS-EVT-DISTRIBUTE-COMPONENT


59 DRMS-EVT-PROMOTE-COMPONENT A component has been promoted.DRMS -EVT -PROMOT E- COMPONE NT

Cause: A component has had a promote operation done to one of its versions.

Effect: The relevant state-marker has been moved for the specified component.


60 DRMS-EVT-PROMOTE-USERCHANGE A userchange has been promoted.DRMS -EVT -PROMOT E- USERCHANGE

Cause: A userchange has been promoted to a new state.

Effect: The relevant state-marker has been updated for the specified user change identifier.


61 DRMS-EVT-PROMOTE-RELEASE A release has been promoted.DRMS -EVT -PROMOT E- RE LE ASE

Cause: A release has been promoted to a new state.

Effect: The relevant state-marker has been updated for the specified release.


62 DRMS-EVT-DEMOTE-COMPONENT A component has been demoted.DRMS -EVT -DEMOTE -COMP ONENT

Cause: A component has had a demote operation done to one of its versions.

Effect: The relevant state-marker has been moved for the specified component.


RMS Monitor EMS EventsDRMS-EVT-PROMOTE-COMPONENT


63 DRMS-EVT-DEMOTE-USERCHANGE A userchange has been demoted.DRMS -EVT -DEMOTE -USE RCHANGE

Cause: A userchange has been demoted back to an old state.

Effect: The relevant state-marker has been updated for the specified user change identifier.


64 DRMS-EVT-DEMOTE-RELEASE A release has been demoted.DRMS -EVT -DEMOTE -REL EAS E

Cause: A release has been demoted back to an old state.

Effect: The relevant state-marker has been updated for the specified release.


65 DRMS-EVT-VERSION-DELETED A version of a component has been deleted.DRMS -EVT -VERSI ON-DEL ET ED

Cause: A user issued a DELETE VERSION request on one or more versions of the specifiedcomponent. The version of the component is not used by any other component.

Effect: The indicated version has been deleted.


66 DRMS-EVT-VERSIONS-CONDENSED A collection of versions have been condensed together.DRMS -EVT -VERSI ONS-CONDENS ED

Cause: A user issued a CONDENSE request on two or more versions of the specified component. Theversions of the component which have been condensed are not used by any other component.

Effect: The versions from the first version through (but not including) the second have been madeinaccessible. All source-level changes are incorporated into the second version.


RMS Monitor EMS EventsDRMS-EVT-DEMOTE-USERCHANGE


67 DRMS-EVT-VERSIONS-OBSOLETED A collection of versions have been obsoleted.DRMS -EVT -VERSI ONS-OBSOL ET ED

Cause: A user issued an OBSOLETE request on a version of the specified component. The versionsof the component which have been obsoleted are not used by any other component.

Effect: The versions from the oldest version through the indicated version have been madeinaccessible. All source-level changes are incorporated into the indicated version.


68 DRMS-EVT-VERSIONS-ROLLEDOUT A collection of versions have been rolled-out.DRMS -EVT -VERSI ONS-ROLL EDOUT

Cause: A user issued a ROLLOUT request on a version of the specified component. The versions ofthe component which have been rolled-out are not used by any other component.

Effect: The versions from the indicated version through the LATEST version have been madeinaccessible. All source-level changes have been lost.


69 DRMS-EVT-VERSION-RENUMBERED A version has been assigned a new version number.DRMS -EVT -VERSI ON-RENUMBE RED

Cause: A user issued an ALTER VERSION request indicating a change in version numbers.

Effect: The version number has been reassigned.


70 DRMS-EVT-PROMOTE-COMP-FAILED A component promotion failed.DRMS -EVT -PROMOT E- COMP-FAI LE D

Cause: An invalid promote operation was requested.

Effect: The operation was aborted.

Recovery: Correct the promote command and retry.

RMS Monitor EMS EventsDRMS-EVT-VERSIONS-OBSOLETED


71 DRMS-EVT-PROMOTE-PCR-FAILED A userchange promotion failed.DRMS -EVT -PROMOT E- PCR- FAILE D




72 DRMS-EVT-PROMOTE-REL-FAILED A release promotion failed.DRMS -EVT -PROMOT E- RE L- FAILE D




73 DRMS-EVT-DEMOTE-COMP-FAILED A component demote failed.DRMS -EVT -DEMOTE -COMP -FAIL ED

Cause: An invalid demote operation was requested.


Recovery: Correct the demote command and retry.

74 DRMS-EVT-DEMOTE-PCR-FAILED A userchange demote failed.DRMS -EVT -DEMOTE -PCR-FAIL ED




RMS Monitor EMS EventsDRMS-EVT-PROMOTE-PCR-FAILED


75 DRMS-EVT-DEMOTE-REL-FAILED A release demote failed.DRMS -EVT -DEMOTE -REL -FAIL ED




99 DRMS-EVT-WRONG-RMS-VERSION The RMS catalog is not the same version as the RMSmonitor process.

DRMS -EVT -WRONG- RMS-VE RSION

Cause: Inappropriate RMSMON used on an existing catalog.

Effect: The RMSMON process will abend.

Recovery: Use the appropriate version of RMS or use the relevant conversion programs to upgrade yourcatalog to the current version of RMS.

100 DRMS-EVT-COMPONENT-BUGFIX A component has been submitted as a bugfix version.DRMS -EVT -COMPONE NT-BUGFI X

Cause: A submit command was executed.



101 DRMS-EVT-COMPONENT-LOCKED A component has been locked.DRMS -EVT -COMPONE NT-L OCKED

Cause: A lock command was executed.



RMS Monitor EMS EventsDRMS-EVT-DEMOTE-REL-FAILED


102 DRMS-EVT-COMPONENT-UNLOCKED A component has been unlocked.DRMS -EVT -COMPONE NT-UNL OCKED

Cause: An unlock command was executed.



200 DRMS-EVT-QUEUE-EXTRACT-REQ A component extract queue request has been made.DRMS -EVT -QUEUE -E XTRACT-REQ

Cause: An EXTRACT FOR EDIT command failed because another user had it locked. EXTRACTqueuing was requested.

Effect: This event may have no effect on some systems which do not have the optional RMSEMSMAIL capabilities.

Recovery: Configuration dependent.

300 DRMS-EVT-ADD-USERCHANGE A userchange has been added.DRMS -EVT -ADD-USE RCHANGE

Cause: A new userchange has been added to the catalog.

Effect: A new userchange is available for use by LATEST state submits.


301 DRMS-EVT-DELETE-USERCHANGE A userchange has been deleted.DRMS -EVT -DEL ET E- USERCHANGE

Cause: A userchange has been deleted from the catalog.

Effect: The userchange is no longer visible in the system.


RMS Monitor EMS EventsDRMS-EVT-COMPONENT-UNLOCKED


302 DRMS-EVT-ADD-RELEASE A release has been added.DRMS -EVT -ADD-REL EAS E

Cause: A new release has been added to the catalog.

Effect: A new release is available for construction.


303 DRMS-EVT-DELETE-RELEASE A release has been deleted.DRMS -EVT -DEL ET E- RE LE ASE

Cause: A release has been deleted from the catalog.

Effect: The release is no longer visible in the system.


304 DRMS-EVT-ADD-LOCATION A location has been added.DRMS -EVT -ADD-L OCATI ON

Cause: A new location has been added to the catalog.

Effect: A new location is available for use in release processing.


305 DRMS-EVT-ALTER-LOCATION A location has been modified.DRMS -EVT -ALT ER-L OCATI ON

Cause: An existing location has been modified.

Effect: The location may behave differently during release-processing. Consult the DEF-LOCATIONtokens for differences.


RMS Monitor EMS EventsDRMS-EVT-ADD-RELEASE


306 DRMS-EVT-DELETE-LOCATION A location has been deleted.DRMS -EVT -DEL ET E- LOCAT ION

Cause: A location has been deleted from the catalog.

Effect: The location is no longer visible in the system.


307 DRMS-EVT-DELETE-DISTRIBUTION A distribution history record has been removed.DRMS -EVT -DEL ET E- DIST RI BUT ION

Cause: A user initiated a distribution history record removal.

Effect: The distribution record is not longer visible in the system.


RMS Monitor EMS EventsDRMS-EVT-DELETE-LOCATION


Appendix CC Syntax Summary

! is used to see and reexecute a command from the history buffer.

! [ [-] number ] [ string ]

? is used to display a command from the history buffer.

? [ [-] number ] [ string ] [ SECTION section name ]

The ACQUIRE commands receive components and releases from other RMS catalogs, tapes, orsubvolumes.

The ACQUIRE command has the general form:

ACQUIRE object-type object-specifier options

ACQUIRE MANIFEST is used to prepare a release for acquisition. This command sets up theincoming release group. Components are created or linked (as appropriate).

ACQUIRE MANIFEST release-name FROM location-name [ , acquire-params ] ...

ACQUIRE-PARAMS are attributes of the acquire commands.

{ GROUP component-path } { SUBVOL default-subvol }

Syntax Summary

080203 Data Design Systems, Inc. C-1

ACQUIRE RELEASE is used to actually transfer a release to/from a remote system. If therelease location is a tape drive then a tape will be loaded using restore.

ACQUIRE RELEASE release-name FROM location-name [ , acqrel-options ]

ACQREL-OPTIONS is a comma separated list of any combination of the following:

{ RECOMPILE { ON | OFF } } { TAMPER [ { ON | OFF } ] } { VERBOSE verbose-level }

VERBOSE-LEVEL specifies the amount of detail to be reported as status messages during command processing.

one of { ALL } { BRIEF } { OFF } { PROGRESS } { SELECTION } { WARNINGS } { * }

The ADD command adds new RMS entities and relationships into the RMS catalog.

The ADD command has the general form:

ADD object-type object-specifier, options

ADD ATTRIBUTE defines a user-specified auxiliary attribute to an entity in the RMS catalog.

ADD ATTRIBUTE name attribute-selector [ , VALUE text ]

ATTRIBUTE-SELECTOR specifies the entity on which an attribute name applies:

{ COMPONENT component-path } { RELEASE release-path } { LOCATION location-path } { LICENSE release-path TO location-path } { USERCHANGE userchange-id }

ADD COMPILE defines compilation instructions between the principle source and object filesor between a main and executable object files.

ADD COMPILE src-path [TO] obj-path [ USING rule-name ]

Syntax Summary

C-2 080203 Data Design Systems, Inc.

ADD COMPONENT creates a new entry in the catalog for a component or group.

ADD COMPONENT comp-path [ , comp-param ]

COMP-PARAM is an attribute of a component.

{ TYPE [ { EXTERNAL } ] { SOURCE } } { [ { NORMAL } ] { OBJECT } } { { DOCUMENT } } { { GROUP } } { { DATA } } { { KEYED } } { FILE file-name } { DEFINE define-name } { LANGUAGE RMS-language } { DESCRIPTION " 80-char-string " } { GROUP component-path } { BUGFIX { ON | OFF } } { TRIGGER { "c" | OFF } } { INCREMENT edit-line-number }


BINDER - BINDER scripts C - C programming language source C-ANSI - C language source for portable programs CBL-ANSI - COBOL 85 programming language source (ANSI default) COBOL - COBOL 85 programming language source COBOL74 - COBOL 74 programming language source DATALIB - Data File Library groups DBOL - Databus programming language source DDL - Data Definition Language source DDLDICT - Data Dictionary groups DEFINE - General source supporting Guardian DEFINEs DEFINEOP - Alternate to DEFINE language with optional DEFINE processing ENFORM - ENFORM query language source FORTRAN - FORTRAN programming language source MUMPS - MUMPS programming language source PASCAL - PASCAL programming language source PNA - Programmatic Network Administrator RDL source PNALIB - PNA Rule Database groups SCOBOL - Screen COBOL programming language source SQLCOBOL - COBOL 85 programming language source with SQL SRCLIB - Segmented source library groups TAL - Tandem Application Language source TBOL - SyBOL programming language source TCLPROG - PATHWAY TCLPROG file groups TEMPLATE - DSM Template language source TGAL - TGAL text formatting language source

Other languages can be specified but no automatic reference computation is performed for them.

EDIT-LINE-NUMBER has the following form:

{ integer-part [ . fractional-part ] } { [ integer-part ] . fractional-part }

Syntax Summary


ADD LICENSE allows releases to be distributed to locations.

ADD LICENSE release-name TO location-name [ , license-options ]

LICENSE-OPTIONS is an attribute of a release/location license.

{ DENY } { EXPIRES date-and-time }

ADD LOCATION creates a new software destination location.

ADD LOCATION location-name [ , location-param ]

LOCATION-PARAM is an attribute of a target location.

DESCRIPTION "location-description" TARGET file-name

ADD REFERENCE tells RMS to add a new source or object reference to a version of a component.

ADD REFERENCE ref-path FROM src-path [ : version-specifier ]

VERSION-SPECIFIER is one of the following:

{ version-number } { state-name }

VERSION-NUMBER has the following form:

major-level . minor-level [ . 0 . sequence-number ]

ADD RELEASE creates a new entry in the catalog for a release group.

ADD RELEASE release-name [ , rel-param ]...

REL-PARAM is an attribute of a release.

{ TYPE [ { RELEASE } ] } { [ { VARIANT } ] } { [ { SUBRELEASE } ] } { [ { SUBSYSTEM } ] } { SUBVOL tandem-subvolume-name } { DESCRIPTION " 80-char-string " } { GROUP release-path } { MANIFEST file-name } { SOURCE { ON | OFF } }

Syntax Summary


ADD REQUISITE controls release or component interrelationships.

ADD { ANTE}REQUISITE { RELEASE release-name TO release-name } {CONTRA} { COMPONENT path-name TO path-name } { CO} [ , requisite-options ] { PRE}

REQUISITE-OPTIONS specify requisite evaluation information.

{ ON { ACQUIRE | DISTRIBUTE | } { { FALLBACK | FREEZE | } { { INSTALL | * } } { ON "(" { ACQUIRE } [ "," { ACQUIRE } ] ... ")" } { { DISTRIBUTE } [ { DISTRIBUTE } ] } { { FALLBACK } [ { FALLBACK } ] } { { FREEZE } [ { FREEZE } ] } { { INSTALL } [ { INSTALL } ] } { OPTIONAL { ON | OFF } }

ADD RULE creates a new general compilation rule which applies to a group and all descendantsubgroups.

ADD RULE rule-name , rule-param [ , rule-param ] ...

RULE-PARAM is an attribute of a rule.

LANGUAGE RMS-language FILE file-name GROUP component-path STEP num


BINDER - BINDER scripts C - C programming language source C-ANSI - C language source for portable programs CBL-ANSI - COBOL 85 programming language source (ANSI default) COBOL - COBOL 85 programming language source COBOL74 - COBOL 74 programming language source DATALIB - Data File Library groups DBOL - Databus programming language source DDL - Data Definition Language source DDLDICT - Data Dictionary groups DEFINE - General source supporting Guardian DEFINEs DEFINEOP - Alternate to DEFINE language with optional DEFINE processing ENFORM - ENFORM query language source FORTRAN - FORTRAN programming language source MUMPS - MUMPS programming language source PASCAL - PASCAL programming language source PNA - Programmatic Network Administrator RDL source PNALIB - PNA Rule Database groups SCOBOL - Screen COBOL programming language source SQLCOBOL - COBOL 85 programming language source with SQL SRCLIB - Segmented source library groups TAL - Tandem Application Language source TBOL - SyBOL programming language source TCLPROG - PATHWAY TCLPROG file groups

Syntax Summary


TEMPLATE - DSM Template language source TGAL - TGAL text formatting language source


ADD STATE creates a new component state.

ADD STATE state-name [ , state-params ]

STATE-PARAMS is a comma separated list of any combination of the following:

{ WEIGHT int } { NAME state-name }

ADD USERCHANGE creates a new user change entry.

ADD { USERCHANGE | PCR } ["] user-change-name ["]

The ALIAS command manages the list of aliases supported by this program.

ALIAS [ name [ " text " ] ]

The ALLOW command controls the maximum number of errors or warnings that can occur within acommand before command processing terminates. If the limit is exceeded, the currentcommand, OBEY or IN-file, processing is terminated.

ALLOW [ ALL ] [ ERRORS ] [ NO ] [ WARNINGS ] [ count ]

The ALTER command changes existing parameters of the RMS environment.

The ALTER command has the general form:

ALTER object-type object-specifier, options

ALTER ATTRIBUTE modifies a user-specified auxiliary attribute of an entity in the RMScatalog.

ALTER ATTRIBUTE name attribute-selector [ , VALUE text ]



Syntax Summary


ALTER COMPONENT changes attributes of components and releases.

ALTER COMPONENT comp-path , [ RESET ] alter-comp-param ...

ALTER-COMP-PARAM is an attribute of a component.

{ NAME comp-name } { FILE file-name } { DEFINE define-name } { LANGUAGE RMS-language } { DESCRIPTION " 80-char-string " } { BUGFIX { ON | OFF } } { TRIGGER { "c" | OFF } } { INCREMENT edit-line-number } { GROUP component-path }






Syntax Summary


ALTER LICENSE changes existing release license information.

ALTER LICENSE release-name TO location-name [ , [ RESET ] license-options ] ...

LICENSE-OPTIONS is an attribute of a release/location license.

{ DENY } { EXPIRES date-and-time }

ALTER LOCATION changes attributes of components and releases.

ALTER LOCATION location-name , location-param ...



ALTER RELEASE changes the contents of a release which is being acquired. This command mustbe used after ACQUIRE MANIFEST and before ACQUIRE RELEASE.

ALTER RELEASE release-name , alter-release-param ...

alter-release-param is one of the following:

ADJUST starts an interactive session which prompts the user for release fix-up information. This parameter is the only one supported in this release of RMS and must be provided.

ALTER REQUISITE modifies release interrelationship attributes.

ALTER REQUISITE { RELEASE release-name TO release-name } { COMPONENT path-name TO path-name } [ , requisite-options ]

REQUISITE-OPTIONS specify requisite evaluation information.

{ ON { ACQUIRE | DISTRIBUTE | } { { FALLBACK | FREEZE | } { { INSTALL | * } } { ON "(" { ACQUIRE } [ "," { ACQUIRE } ] ... ")" } { { DISTRIBUTE } [ { DISTRIBUTE } ] } { { FALLBACK } [ { FALLBACK } ] } { { FREEZE } [ { FREEZE } ] } { { INSTALL } [ { INSTALL } ] } { OPTIONAL { ON | OFF } }

Syntax Summary


ALTER RMS changes the running parameters of the RMS monitor.

ALTER RMS rms-param

RMS-PARAM is an environmental setting in the RMS monitor.

{ BACKUPCPU n } { CHECK LANGUAGE { ERRORS } } { { WARNINGS } } { { OFF } } { CHECK USERCHANGE { STATE } } { { OFF } } { LOG file } { LOG FORMAT { EMS | TEXT } } { PROMPT { ACQUIRE { ON | OFF } } } { { DISTRIBUTE { ON | OFF } } } { { FALLBACK { ON | OFF } } } { { INSTALL { ON | OFF } } } { SECURITY " level " } { USERCHANGE SUBMIT { ON | OFF } } { USERCHANGE EXTRACT { ON | OFF } }

ALTER RULE changes the contents of a rule step.

ALTER RULE rule-name , { STEP { * } } { { step-number } } { NAME new-rule-name }

ALTER SERVER changes the running parameters of servers within the specified server class(es).

ALTER SERVER server-name , sc-param ...

SC-PARAM is an attribute of a server class.

{ CPUS cpu-list } { OUT file-name } { STARTUP string } { PRIORITY num } { NUMSTATIC num } { MAXSERVERS num } { DELETEDELAY num { SECONDS } } { { MINUTES } } { { HOURS } } { TEMPLATE " proc-name-template "} { RESET { STARTUP } } { { TEMPLATE } }

CPU-LIST is one of the following:

{ "*" } { cpu-number } { ( cpu-number [ , cpu-number ] ... ) }

Syntax Summary


ALTER STATE changes the attributes of a state marker.

ALTER STATE state-name , state-params ...



ALTER USERCHANGE changes the name and/or text associated with a user change.

ALTER { USERCHANGE | PCR } ["] user-change-name ["] { , NEW user-change-name } ... { , TEXT [ FROM file ] }

ALTER VERSION changes various attributes of a version of a component.

ALTER VERSION comp-path : version-specifier , version-param ...



VERSION-PARAM is a modifiable attribute of a version.

{ TEXT } { USERCHANGE | PCR ["] user-change-name ["] }



Syntax Summary


BROWSE brings up an editor to scan one or two component versions.

BROWSE comp-path [ : version-specifier ] [ , extract-options ] [ + comp-path [ : version-specifier ] [ , extract-options ]



EXTRACT-OPTIONS is a comma separated list of any combination of the following:

{ APPEND { ON | OFF } } { FOR { EDIT } } { { READ } } { { COMPILE } } { { WORK } } { FORMAT { EDIT } } { { READ } } { { COMPILE } } { { DEFINE } } { { FILE } } { PURGE [ { ON | OFF } ] } { USERCHANGE user-change-name } { QUALIFY { SYSTEM } } { { VOLUME } } { { SUBVOLUME } } { { FILE } }



The CLEANUP command directs RMS to remove unneeded items from the catalog or working areas.

The CLEANUP command has the general form:

CLEANUP object-type [ object-specifier ]

The CLEANUP RELEASE command directs RMS to purge all release files from the release library.

CLEANUP RELEASE release-path

The CLEANUP RMS command directs RMS to perform internal house-keeping and garbage collection.

CLEANUP RMS

The COMMENT command provides a mechanism to document files used with RMS.

COMM[ENT] any text == any text

Syntax Summary


The CONDENSE command collects groups of changes into a single version.

CONDENSE comp-path : low-version TO high-version

DELAY pauses the process for a specified length of time.

DELAY n { SECONDS | MINUTES | HOURS }

The DELETE command removes an entity or relationship from the RMS catalog.

The DELETE command has the general form:

DELETE object-type object-specifier [ , options ]

DELETE ATTRIBUTE removes a user-specified auxiliary attribute from an entity in the RMScatalog.

DELETE ATTRIBUTE name attribute-selector



DELETE COMPILE removes compilation instructions between the principle source and objectfiles or between a main and executable object files.

DELETE COMPILE src-comp-name { FROM } obj-comp-name { TO }

DELETE COMPONENT removes an entry in the catalog for a component or group.

DELETE COMPONENT { comp-path | "*" }

DELETE DISTRIBUTE removes a distribution entry from the catalog.

DELETE DISTRIBUTE release-name : release-version TO location-name ON { date-and-time | "*" }

DELETE LICENSE removes release licensing information from locations.

DELETE LICENSE release-name { FROM } location-name { TO }

Syntax Summary


DELETE LOCATION removes a location from the catalog.

DELETE LOCATION location-name

DELETE REFERENCE tells RMS to ignore source or object references made by a version ofanother source or object file.

DELETE REFERENCE target-comp-name [FROM] src-comp-name [ : version-specifier ]





DELETE RELEASE removes a release from the catalog.

DELETE RELEASE release-name

DELETE REQUISITE removes component or release interrelationships.

DELETE REQUISITE { RELEASE release-name TO release-name } { COMPONENT path-name TO path-name }

DELETE RULE removes a general compilation rule which applies to a group and all descendantsubgroups.

DELETE RULE rule-name , STEP { * } { step-number }

DELETE STATE removes an existing unlinked component state.

DELETE STATE state-name

DELETE USERCHANGE removes an unused user change entry.

DELETE { USERCHANGE | PCR } ["] user-change-name ["]

Syntax Summary


DELETE VERSIONS removes non-referenced versions of a component.

DELETE [ / command-options / ] VERSIONS comp-selector [ : version-specifier ] [ , delete-version-options ]

COMMAND-OPTIONS is a comma separated list of any combination of the following:

OUT file-name TERM file-name NOWAIT

COMP-SELECTOR is any valid pattern identifying a component. The following are legitimate selectors:

Component path specifiers: \...\name or \...\pattern [group\...\]name or [group\...\]pattern wild-cards (* and ?) as well as classes [a-z] are allowed.

File name specifiers: FILE=[[[\system].$volume.]subvolume.]filename $volume.subvolume.filename wild-cards (* and ?) are allowed in each field.

Define patterns: =define-name wild-cards (* and ?) are allowed.

Component Identifiers: component-id - INT(32) number

Generic name search specifiers: NAME=pattern wild-cards (* and ?) as well as classes [a-z] are allowed.



DELETE-VERSION-OPTIONS limit the processing of version deletion.

{ ARCHIVE } { KEEP LATEST }



Syntax Summary


The DEMOTE command drops state markers for entities in the RMS catalog to prior levels.

The DEMOTE command has the general form:

DEMOTE object-type object-specifier options

DEMOTE COMPONENT directs RMS to update the state markers for components to an older versionthan the current value.

DEMOTE COMPONENT comp-path [: version-specifier ] TO state-name





DEMOTE RELEASE directs RMS to update the state markers for releases to a valid predecessorstate.

DEMOTE RELEASE release-path TO state-name

DEMOTE USERCHANGE causes the current user change state to be downgraded to the specifiedstate.

DEMOTE USERCHANGE | PCR ["] userchange-name ["] TO state-name

Syntax Summary


DIFFERENCES displays the changes that have occurred between one version of a component andanother.

DIFFERENCES [ / OUT file-name / ] { comp-path [ : version-specifier ] } { FILE file-name } [ TO { [ COMPONENT comp-path ] [ : version-specifier ] } ] [ { FILE file-name } ] [ , diff-options ]



DIFF-OPTIONS specify output formats of difference reports.

{ LISTING } { SCRIPT } { SIDEBYSIDE } { SUMMARY } { CONTEXT num-lines } { VERBOSE } { IGNORE CASE } { IGNORE BLANKS } { WIDTH num-cols } { HEADINGS { ON | OFF } } { EDITLINE } { FORMAT { EDIT } } { { READ } } { { COMPILE } } { { DEFINE } } { { FILE } }



DISCONTINUE is used to discontinue the availability of an RMS entity.

DISCONTINUE has the general form:

DISCONTINUE object-type object-specifier

DISCONTINUE RELEASE is used to discontinue the availability of a version of a release. Thisprevents distribution, installation, and fallback.

DISCONTINUE RELEASE release-name : version-number



Syntax Summary


DISTRIBUTE is used to transfer software to another RMS subsystem.

DISTRIBUTE has the general form:

DISTRIBUTE object-type object-specifier TO location-name [ , options ]

DISTRIBUTE RELEASE is used to transfer software to disk or tape.

DISTRIBUTE RELEASE release-name [: version-number ] TO location-name [ , dist-options ]



DIST-OPTIONS is a comma separated list of any combination of the following:

{ ALL [ { ON | OFF } ] } { CLEANUP { ON | OFF } } { COPIES num-copies } { DELTA { RELEASE } } { { COMPONENT } } { { OFF } } { FORMAT format-mode } { INFORM [ { ON | OFF } ] } { MAXFILES num-backup-files } { NEEDED { ON | OFF } } { PURGE [ { ON | OFF } ] } { QUALIFY level } { RECOMPILE { ON | OFF } } { RECURSIVE [ { ON | OFF } ] } { REQUISITE { ON | OFF } } { SUBVOL [tape-volume] } { TAMPER [ { ON | OFF } ] } { UPDATE [ { ON | OFF } ] } { VERBOSE verbose-level }



The DUPLICATE command creates copies of entities or relationships in the RMS catalog.

The DUPLICATE command has the general form:

DUPLICATE object-type object-specifier [ , options ]

Syntax Summary


DUPLICATE COMPONENT creates a copy of a component with all or part of the component’shistory.

DUPLICATE COMPONENT comp-path TO comp-path [ , comp-param ] ...








Syntax Summary


DUPLICATE RELEASE creates a copy of a release.

DUPLICATE RELEASE release-name TO new-release-name [ , release-params ] ...

DUPLICATE RULE creates a copy of an existing rule.

DUPLICATE RULE rule-name TO new-rule-name [ , GROUP comp-path ]

DUPLICATE VERSION creates a new version number whose contents are identical to the specificversion.

DUPLICATE VERSION comp-path [ : version-specifier ] [TO] new-version-specifier





The ECHO command displays strings upon the current output file.

ECHO " string " ...

The EDIT command is used to interactively modify an item in the RMS catalog.

The EDIT command has the general form:

EDIT object-type object-specifier

EDIT RULE starts an EDIT session to modify an entire compilation rule which is in thecatalog.

EDIT RULE rule-name

Syntax Summary


The ENV command displays and controls operating parameters of the common user interface(CUI).

ENV [ CONTINUE ] [ HEADINGS { ON | OFF } ] [ HELP help-level ] [ PAGE length , width ] [ PMSG { ON | OFF } ] [ STATS { ON | OFF } ]

The EXIT command provides a mechanism to leave RMS if it is processing commandsinteractively or to terminate the processing of an obey or in file.

E[XIT]

The EXTRACT command extracts a version of a component.

EXTRACT comp-patt [: version-specifier ] [ TO file-patt [, extract-options ] ]







Syntax Summary


The FALLBACK command rolls out changes to a processing environment made using the INSTALLcommand.

The FALLBACK command has the general form:

FALLBACK object-type object-specifier options

FALLBACK directs RMS to roll out a given release from the specified location.

FALLBACK LOCATION location-path FROM release-path [: version-number ] [ , fallback-options ]



FALLBACK-OPTIONS is a comma separated list of any combination of the following:

{ INFORM [ { ON | OFF } ] } { RECOMPILE { ON | OFF } } { VERBOSE verbose-level }



The FC command allows you to change or correct any command that is still in your commandhistory buffer.

FC [ [-] number ] [ string ]

The FILEINFO command displays information about the files that match the specified pattern.

FILEI[NFO] [ /OUT list file / ] [ filename template ]

filename-template is formatted as follows:

[[[ \ system . ] $volume. ] subvol. ] filename

Syntax Summary


The FILENAMES command displays the file names that match the specified pattern.

FILEN[AMES] [ /OUT list file / ] [ filename template ]

filename-template is formatted as follows:

[[[ \ system . ] $volume. ] subvol. ] filename

The FILES command displays the file names that match the specified pattern.

F[ILES] [ /OUT list file / ] [ system pattern . ] [ volume pattern . ] [ pattern ]

The FREEZE command disables certain functions the specified RMS entities.

The FREEZE command has the general form:

FREEZE object-type object-specifier [ , options ]

The FREEZE RELEASE command disables modification to the contents or versions of contents ofa release. The default is to freeze versions of contents.

FREEZE RELEASE [ command-options ] release-name { [ , CONTENTS ] } [, freeze-release-options ] { [ , VERSIONS ] }



FREEZE-RELEASE-OPTIONS control the processing of freeze release.

{ CHECK { ON | OFF } } { FORCE { ON | OFF } } { VERBOSE verbose-level }



Syntax Summary


The FREEZE SERVER command disables a particular server class This prevents RMS fromallocating processes to perform submit, extract, compiles, etc.

FREEZE SERVER sc-patt

The GROUP command changes the default group within the component trees.

GROUP component-path

The HELP command provides on-line instructions for command syntax and considerations.

HELP [ /OUT list file / ] [ help topic ] [ , { CONSIDER } ] [ { DETAIL } ] [ { EXAMPLE } ] [ { PREAMBLE } ] [ { SECCOND } ] [ { SEE } ] [ { SYNTAX } ]

If list file is not provided, HELP runs interactively if there are subjects associated with help topic .

CONSIDER gets the considerations section of the help.

DETAIL gets all sections of the help and expands any syntatic elements found in the help.

EXAMPLE gets any example sections of the help topic.

PREAMBLE gets the description of the command.

SECCOND gets any security considerations for the command.

SEE gets any SEE ALSO references in the help for the specified command.

SYNTAX gets the syntax section of the help for the command.

By default, the SYNTAX option is assumed.

The HISTORY command displays the previous commands entered.

HIST[ORY] [ / OUT list file / ] [ { number | RESET } ]

Syntax Summary


The IF command controls conditional execution within an obey input file.

IF [!] value commands [ ELSE commands ] ENDIF

The IMPACT command evaluates the impact of one item on another item in the RMS environment.

The IMPACT command has the general form:

IMPACT object-type object-specifier options

IMPACT RELEASE evaluates the changes to the specified location resulting from aninstallation or distribution of the specified release.

IMPACT RELEASE [ / command-options / ] release-path [: version-number ] ON location-path





The INFO commands obtain information about user-modifiable items within the RMS environment.

The INFO command has the general form:

INFO [/OUT file-name/] object-type object-specifier [ , options ]

Syntax Summary


The INFO COMPONENT command displays information, in various forms, about components managedwithin an RMS catalog.

INFO COMPONENT comp-selector [ { , RECURSIVE } ] [ { , BRIEF [, RECURSIVE ] } ] [ { , DETAIL [, RECURSIVE ] } ] [ { , VERSIONS [, DETAIL ] [, RECURSIVE ] } ] [ { , HISTORY [, DETAIL ] [, RECURSIVE ] } ] [ { , STATE [, RECURSIVE ] } ]

COMP-SELECTOR is any valid pattern identifying a component. The following are legitimate selectors:

Component path specifiers: \...\name or \...\pattern [group\...\]name or [group\...\]pattern wild-cards (* and ?) as well as classes [a-z] are allowed.

File name specifiers: FILE=[[[\system].$volume.]subvolume.]filename $volume.subvolume.filename wild-cards (* and ?) are allowed in each field.

Define patterns: =define-name wild-cards (* and ?) are allowed.

Component Identifiers: component-id - INT(32) number

Generic name search specifiers: NAME=pattern wild-cards (* and ?) as well as classes [a-z] are allowed.

INFO LICENSE reports all licenses in the catalog.

INFO LICENSE

INFO LOCATION displays information about distribution locations.

INFO LOCATION loc-patt [ , { HISTORY } ] [ { LICENSE } ]

INFO RELEASE displays distribution history and license information about software releases.

INFO RELEASE rel-patt , { HISTORY } { LICENSE }

INFO RMS displays information about the RMS operating configuration and catalog history.

INFO RMS [, { HISTORY } ] [ { OPEN } ]

Syntax Summary


INFO SECURITY displays the access control lists for a specific component or group in the RMScatalog.

INFO SECURITY comp-path [ : state-name ] [, BRIEF ]

INFO SERVER displays the current operating parameters for RMS server classes.

INFO SERVER sc-patt

INFO SPATH reports all current component search paths.

INFO SPATH { * | spath-id }

SPATH-ID is in the range 0 .. 29, inclusive.

INFO SSV reports all current search subvolumes.

INFO SSV { "*" | ssv-id }

SSV-ID is one of:

"0".."9", "A".."J".

INFO USERCHANGE displays information about user-defined program change requests currentlyspecified in the RMS catalog.

INFO { USERCHANGE | PCR } user-change-name [ , { BRIEF } ] [ { DETAIL } ]

INFO VERSIONS reports historic information about specific version ranges.

INFO VERSIONS comp-path : low-version-specifier [ TO high-version-specifier ]

INSTALL is used to move a release of software into a local operating environment.

The INSTALL command has the general form:

INSTALL object-type object-specifier options

Syntax Summary


INSTALL RELEASE is used to actually place a release in a production library.

INSTALL RELEASE release-name [: version-number ] TO location-name [ , install-options ]



INSTALL-OPTIONS is a comma separated list of any combination of the following:

{ CLEANUP { ON | OFF } } { DELTA { ON | OFF } } { FORMAT format-mode } { INFORM [ { ON | OFF } ] } { PURGE [ { ON | OFF } ] } { QUALIFY level } { RECOMPILE { ON | OFF } } { REQUISITE { ON | OFF } } { TAMPER [ { ON | OFF } ] } { UPDATE [ { ON | OFF } ] } { VERBOSE verbose-level }



The LINK command logically associates items in the RMS catalog.

The LINK command has the general form:

LINK object-type object-specifier options

LINK COMPONENT allows a component to be visible within a group other than the group in whichit was created.

LINK COMPONENT comp-path [ : version-specifier ] TO comp-path





Syntax Summary


LINK RELEASE associates a release and a user change identifier.

LINK RELEASE release-path TO user-change-name

LINK STATE joins one state as a valid predecessor of a second state.

LINK STATE state-name TO state-name

LINK VERSION associates a version of a component and a user change identifier.

LINK VERSION comp-path [ : version-specifier ] TO user-change-name





The LIST command reports on non-user-modifiable data and relationships between RMS entities.

The LIST command has the general form:

LIST [/OUT file-name/] object-type object-specifier options

LIST COMPILE command shows the relationship between source and object files or between amain and executable object files.

LIST COMPILE { TO comp-name } { FROM comp-name }

Syntax Summary


LIST DEPENDENCIES shows all references to or from all versions of a component.

LIST DEPENDENCIES { TO comp-name } [ : version-specifier ] { FROM comp-name } [, query-options ]



QUERY-OPTIONS one of the following (some options may not apply to all commands:

RECURSIVE - recursively process the query. DETAIL - report extended information. INHERIT - recursively process the query upward.



LIST LOCK shows all locks on a component.

LIST LOCK component-selector [ USER [ user-spec ] ] [ , query-options ]

user-spec is one of:

[ \ system-name . ] group-name . user-name [ \ system-name . ] group-name . * [ \ system-name . ] * . * \* . * . * \* . group-name . user-name \* . group-name . *

[ \ system-name . ] group-num , user-num [ \ system-name . ] group-num , * [ \ system-name . ] * , * \* . * , * \* . group-num , user-num \* . group-num , *



Syntax Summary


LIST REFERENCE shows all source or object references to or from another source or object.

LIST REFERENCE { TO comp-name } { FROM comp-name [ : version-specifier ] }





LIST RELEASE shows the contents of a release. This report is an abridged form of the releasemanifest.

LIST RELEASE release-name [ , SOURCE ]

LIST RULE shows the contents of a general compilation rule.

LIST RULE { rule-name | * } [, HISTORY ][ , query-options ]



LIST STATE shows one or all states.

LIST STATE { state-name | * } [ , query-options ]



Syntax Summary


The LOCK commands adds locks on a version of a component.

LOCK comp-path [ : version-specifier ]





The LOG command provides a mechanism to capture the commands and responses provided by theCUI command interpreter.

LOG [ log file [ ! ] ]

The MAP command produces a simple map, in the form of an indented tree of the specifiedgroup.

MAP [ component-path ] [ , scan-options ]

SCAN-OPTIONS one of the following:

{ DEPTH num } { GROUP [ * ] }

The OBEY command allows the input to be taken from a different file. OBEY commands may notbe nested within an OBEY file.

O[BEY] [!] obey file [ ( section name ) ]

The OBSOLETE command drops the historical information associated with all versions up to andincluding the specified version.

OBSOLETE comp-path : { version-number | OBSOLETE }



Syntax Summary


The OPEN command opens an RMSMON process. The current RMSMON, if any, is closed.

OPEN rms-process

rms-process is a valid local process name (e.g. $RMP) or a valid network process name (e.g. \SYS2.$RMP). The process must be an RMSMON process.

The OUT command provides a mechanism to redirect the output generated by RMS.

OUT [ list file [ ! ] ]

PRODUCE directs RMS to create a specific object or release at a given state.

PRODUCE [ / command-options / ] { comp-path [ : version-specifier ] } { ( comp-path [ : version-specifier ] , comp-path [ : version-specifier ] ... ) } [ TO object-file ] [ , compile-options ]





COMPILE-OPTIONS is a comma separated list of any combination of the following:

{ CHECK [ { ON | OFF } ] } { COMPRESS { ON | OFF } } { CONTINUE { ON | OFF } } { FORCE [ { ON | OFF } ] } { SECURITY "rwep" } { SECURITY MASK "rwep" } { VERBOSE verbose-level }




one of { ALL } { BRIEF } { OFF } { PROGRESS } { SELECTION } { WARNINGS }

Syntax Summary


{ * }

The PROMOTE command moves state markers for entities in the RMS catalog to higher levels.

The PROMOTE command has the general form:

PROMOTE [ / command-options / ] object-type object-specifier options



PROMOTE COMPONENT causes the state marker for a component to be moved to a newer version.

PROMOTE COMPONENT comp-path [: comp-state ] TO state-name [ , RECURSIVE ] [ ! ]

PROMOTE RELEASE causes the current release state to be updated to the specified state.

PROMOTE RELEASE [ / COMMAND-OPTIONS / ] release-name TO state-name [ , PROMOTE-OPTIONS ]



PROMOTE-OPTIONS control the processing of promote operations.

{ COMPONENT { ON | OFF } } { DEPENDENCIES { ON | OFF } } { FORCE { ON | OFF } } { PRODUCE { ON | OFF } } { RECURSIVE { ON | OFF } } { RELEASE { ON | OFF } } { RELEASE CONTENTS { ON | OFF } } { USERCHANGE { ON | OFF } } { USERCHANGE CONTENTS { ON | OFF } } { VERBOSE verbose-level }


one of { ALL } { BRIEF } { OFF } { PROGRESS } { SELECTION } { WARNINGS }

Syntax Summary


{ * }

PROMOTE USERCHANGE causes the current user change state to be updated to the specified state.

PROMOTE USERCHANGE userchange-name TO state-name [ , promote-options ] [ ! ]

PROMOTE-OPTIONS control the processing of promote operations.

{ COMPONENT { ON | OFF } } { DEPENDENCIES { ON | OFF } } { FORCE { ON | OFF } } { PRODUCE { ON | OFF } } { RECURSIVE { ON | OFF } } { RELEASE { ON | OFF } } { RELEASE CONTENTS { ON | OFF } } { USERCHANGE { ON | OFF } } { USERCHANGE CONTENTS { ON | OFF } } { VERBOSE verbose-level }



RENUMBER changes the version numbers associated with a component.

RENUMBER comp-path : low-version [ , high-version ] TO new-version

Syntax Summary


RESET RMSCOM environment default settings.

RESET { ACQUIRE } { COMPONENT } { COMMENT } { DISTRIBUTE } { EXTRACT } { FALLBACK } { IMAGE } { LOCATION } { PRODUCE } { RELEASE } { SPATH { * | spath-id } } { SSV { * | ssv-id } } { STATE } { SUBMIT }


SSV-ID is one of:

"0".."9", "A".."J".

ROLLOUT drops the historical information associated with all versions from and including thespecified version.

ROLLOUT comp-path : version-specifier





The RUN command executes a program from within a common user interface (CUI) program.

RUN filename [ / run-option [, run-option ] / ] [ startup ]

RUN-OPTION is one of: CPU cpu-number PRI priority IN file-name OUT file-name NAME [ process-name ]

Syntax Summary


SECURE modifies the security attributes of a specified component or path.

SECURE comp-path , USER user-spec { + | - } [ DENY ] security-attr

user-spec is one of:

[ \ system-name . ] group-name . user-name [ \ system-name . ] group-name . * [ \ system-name . ] * . * \* . * . * \* . group-name . user-name \* . group-name . *

[ \ system-name . ] group-num , user-num [ \ system-name . ] group-num , * [ \ system-name . ] * , * \* . * , * \* . group-num , user-num \* . group-num , *

security-attr is one of: { ADD | DELETE | MODIFY | READ | FREEZE | LOCK | THAW | CHGATTR | MANAGER | PROMOTE | DEMOTE }

Refer to the RMSCOM/RMSMON reference manual for details about each security attribute and their relationships to variable command.

The SET command specifies default values for ADD commands.

The SET command has the general form:

SET object-type object-specifier [ , attribute value ] ...

SET ACQUIRE specifies default parameters for the ACQUIRE command.

SET ACQUIRE acquire-params

ACQUIRE-PARAMS are attributes of the acquire commands.

{ GROUP component-path } { SUBVOL default-subvol }

The SET COMMENT command is used to specify the change text associated with a submission.

SET COMMENT [ FROM file ]

Syntax Summary


SET COMPONENT specifies component ADD defaults.

SET COMPONENT comp-param








Syntax Summary


SET DISTRIBUTE specifies default parameters for the DISTRIBUTE command.

SET DISTRIBUTE dist-options

DIST-OPTIONS is a comma separated list of any combination of the following:

{ ALL [ { ON | OFF } ] } { CLEANUP { ON | OFF } } { COPIES num-copies } { DELTA { RELEASE } } { { COMPONENT } } { { OFF } } { FORMAT format-mode } { INFORM [ { ON | OFF } ] } { MAXFILES num-backup-files } { NEEDED { ON | OFF } } { PURGE [ { ON | OFF } ] } { QUALIFY level } { RECOMPILE { ON | OFF } } { RECURSIVE [ { ON | OFF } ] } { REQUISITE { ON | OFF } } { SUBVOL [tape-volume] } { TAMPER [ { ON | OFF } ] } { UPDATE [ { ON | OFF } ] } { VERBOSE verbose-level }



SET ERRORS specifies the level of detail to which errors are reported.

SET ERRORS { DETAIL } { QUIET }

Syntax Summary


SET EXTRACT specifies default parameters for the EXTRACT command.

SET EXTRACT extract-options



SET FALLBACK specifies default parameters for the FALLBACK command.

SET FALLBACK fallback-options

FALLBACK-OPTIONS is a comma separated list of any combination of the following:

{ INFORM [ { ON | OFF } ] } { RECOMPILE { ON | OFF } } { VERBOSE verbose-level }



Syntax Summary


SET IMAGE specifies basis information for component specifications.

SET IMAGE image-options

IMAGE-OPTIONS is a component and version specified as follows:

component-path : version-specifier





SET INSTALL specifies default parameters for the INSTALL command.

SET INSTALL install-options

INSTALL-OPTIONS is a comma separated list of any combination of the following:

{ CLEANUP { ON | OFF } } { DELTA { ON | OFF } } { FORMAT format-mode } { INFORM [ { ON | OFF } ] } { PURGE [ { ON | OFF } ] } { QUALIFY level } { RECOMPILE { ON | OFF } } { REQUISITE { ON | OFF } } { TAMPER [ { ON | OFF } ] } { UPDATE [ { ON | OFF } ] } { VERBOSE verbose-level }



Syntax Summary


SET LOCATION specifies location ADD defaults.

SET LOCATION location-param



SET PRODUCE specifies default parameters for the PRODUCE command.

SET PRODUCE compile-options

COMPILE-OPTIONS is a comma separated list of any combination of the following:

{ CHECK [ { ON | OFF } ] } { COMPRESS { ON | OFF } } { CONTINUE { ON | OFF } } { FORCE [ { ON | OFF } ] } { SECURITY "rwep" } { SECURITY MASK "rwep" } { VERBOSE verbose-level }



SET RELEASE specifies release ADD defaults.

SET RELEASE rel-param

REL-PARAM is an attribute of a release.

{ TYPE [ { RELEASE } ] } { [ { VARIANT } ] } { [ { SUBRELEASE } ] } { [ { SUBSYSTEM } ] } { SUBVOL tandem-subvolume-name } { DESCRIPTION " 80-char-string " } { GROUP release-path } { MANIFEST file-name } { SOURCE { ON | OFF } }

Syntax Summary


SET SPATH specifies a search path for component name resolution in the ACQUIRE RELEASEcommand.

SET SPATH SPATH-id , comp-path


SET SSV specifies a search subvolume for file name resolution in the SUBMIT command.

SET SSV ssv-id , subvolume

SSV-ID is one of:

"0".."9", "A".."J".

SET STATE specifies default parameters for the STATE command.

SET STATE state-params



SET SUBMIT specifies default parameters for the SUBMIT command.

SET SUBMIT submit-options

SUBMIT-OPTIONS is a comma separated list of any combination of the following:

{ NODIFFOK [ { ON | OFF } ] } { PURGE [ { ON | OFF } ] } { SECURE [ { ON | OFF } ] } { TRIGGER "c" } { USERCHANGE user-change-name } { [NO]ADD EXTERNAL } { [NO]ADD SECTION } { KEEP MISSING { ON | OFF } } { IGNORE DUPLICATE { ON | OFF } } { QUALIFY { SYSTEM } } { { VOLUME } } { { SUBVOLUME } } { { FILE } } { { OFF } } { UNLOCK [ { ON | OFF } ] }

SETPROMPT " string "

Syntax Summary


The SHOW command displays RMSCOM environment and default settings.

SHOW [ { ACQUIRE } ] [ { COMMENT } ] [ { COMPONENT } ] [ { DISTRIBUTE } ] [ { EXTRACT } ] [ { FALLBACK } ] [ { IMAGE } ] [ { INSTALL } ] [ { LOCATION } ] [ { RELEASE } ] [ { SUBMIT } ]

SHUTDOWN the RMS subsystem.

SHUTDOWN RMS [ ! ]

START all static servers for one or many server classes.

START SERVER sc-patt

STATUS obtains information about one or many server classes.

STATUS SERVER sc-patt [, DETAIL ]

STOP all servers, both static and dynamic from a given server class.

STOP SERVER sc-patt

Syntax Summary


SUBMIT a file or set of files after modification.

SUBMIT file-patt [ AS { LATEST } ] [ { state } ] [ { version } ] [TO] comp-patt [, submit-options ]

SUBMIT-OPTIONS is a comma separated list of any combination of the following:

{ NODIFFOK [ { ON | OFF } ] } { PURGE [ { ON | OFF } ] } { SECURE [ { ON | OFF } ] } { TRIGGER "c" } { USERCHANGE user-change-name } { [NO]ADD EXTERNAL } { [NO]ADD SECTION } { KEEP MISSING { ON | OFF } } { IGNORE DUPLICATE { ON | OFF } } { QUALIFY { SYSTEM } } { { VOLUME } } { { SUBVOLUME } } { { FILE } } { { OFF } } { UNLOCK [ { ON | OFF } ] }

The SYSTEM command is used to change the default system that is used for file name expansion.

SYSTEM [ system name ]

The THAW command enables certain functions for the specified RMS entities.

The THAW command has the general form:

THAW object-type object-specifier options

The THAW RELEASE command enables modification to the contents or versions of a release. Thedefault is to thaw release contents.

THAW RELEASE release-name [ , { CONTENTS } ] { VERSIONS }

The THAW SERVER command enables RMS to use a particular server class which has beenpreviously frozen.

THAW SERVER sc-patt

The TIME command displays the current date and time.

TIME

Syntax Summary


The UNLINK command removes logical associations in the RMS catalog.

UNLINK object-type object-specifier options

UNLINK COMPONENT allows a component to be removed from a group while still being visible inother groups. Components cannot be deleted using this command.

UNLINK COMPONENT comp-path FROM group-path

UNLINK RELEASE disassociates a release and a user change identifier.

UNLINK RELEASE release-path TO user-change-name

UNLINK STATE removes one state as a valid predecessor of a second.

UNLINK STATE state-name FROM state-name

UNLINK VERSION disassociates a version of a component from a user change identifier.

UNLINK VERSION comp-path [ : version-specifier ] FROM user-change-name





Syntax Summary


UNLOCK removes locks on a component.

UNLOCK comp-path [ : version-specifier ] [ * ] [, unlock-options ]



UNLOCK-OPTIONS one of the following:

{ RECURSIVE } { REMOVE }



The VERIFY command checks the integrity on one object compared with another.

The VERIFY command has the general form:

VERIFY object-type object-specifier options

VERIFY directs RMS to check the release history against distribution and installationlocations.

VERIFY LOCATION [ / command-options/ ] location-path

The VOLUME command is used to change the default volume that is used for file name expansion.

VOL[UME] [ system name ] [ , " security-string " ] [ [ system name . ] volume name ] [ [ system name . ] subvol name ]

Syntax Summary


Appendix DD Produce Errors

Informational Messages

The following messages are typically indicators of why compiles are performed or indications of success.

REASON: Force option is on

Explanation: The compile of the target component results from the FORCE option being set to ALL.

Action: If the compile is successful a new version of the component will be created regardless ofwhether it was necessary.

REASON: Force-specified option is on

Explanation: The compile of the target component results from the FORCE option being set to ON.


REASON: No version of component-path exists at given state

Explanation: The compile of the target component results from there not being an existing version of thetarget object. FORCE option being set to ON.


Produce ErrorsInformational Messages

080203 Data Design Systems, Inc. D-1

REASON: Source relationship to component-path is different

Explanation: The source component of a compile relationship has been changed since the last compile ofthe target object component.

Action: A new compile of that component will be done.

REASON: Source component component-path is redirected

Explanation: The specified source component has been redirected as part of external compile by a DEFINEspecification in RMSMAKE’s parent process.

Action: This will cause a new compile of the target component to be done.

REASON: New compile rule will be used

Explanation: The compile rule associated with the source component associated with the next compilebeing done has been modified, replaced, or superseded by a lower level rule.

Action: A new compile is indicated.

REASON: New version of primary source component-path exists

Explanation: The primary source (the source component of the compile relationship) of the next compilebeing done has had a new version added to RMS since the last compile.



D-2 080203 Data Design Systems, Inc.

REASON: New version of referenced component component-path exists

Explanation: The referenced component of either the primary source (the source component of the compilerelationship) or another referenced component of the next compile being done has had a newversion added to RMS since the last compile.


REASON: Expected version of component-path not in file

Explanation: The version that is expected to be in the file associated with the indicated managed componentis not currently present on disk.

Action: No new compile is indicated although a recompile will be done if no archive entry exists.

REASON: Result is not a code 100 file

Explanation: RMSMAKE is expecting the file associated with the next component being compiled to be acode 100 object file. It is not.

Action: A compile, or retrieval from archive will be performed.

REASON: No compile necessary. Version of component-path retrieved fromarchive

Explanation: RMS successfully located and extracted the appropriate version of the specified componentfrom the archive.

Action: No compile is necessary and the object is up to date.



Archive: Entry created for component-path

Explanation: After a successful compile, RMSMAKE has created a new entry for the specified component.

Action: If the component history is examined, in detail, the new archive file name will be presented.

REASON: File for component-path already present on disk

Explanation: No compile is necessary. The correct version of the indicated component is present on disk.

Action: None.

Compilation Successful: Component component-path

Explanation: The specified component has been successfully compiled. Unless this message is displayed,the compile failed regardless of whether the language processor succeeded. Remember thatthere are many reasons for compilation failure beyond the compile phase.

Action: Consult the following WARNINGS and ERRORS sections for details.



Warnings

The following messages are not generally cause for alarm but should be investigated.

Archive: No entry created for component-path

Explanation: Either no archive is defined (missing ARCHIVE location), the disk is full, the disk is securedagainst the catalog owner, or the file created by the compiler is unreadable by the catalogowner.

Action: Verify that the archive exists, is not full and that the catalog owner has appropriate securityaccess to the archive location.

WARNING: Compile of component-path skipped due to lower level compilefailure

Explanation: Even though the specified higher level object component is out of date, it cannot be compiledbecause of the compile failure of a lower level component.

Action: Please consult the compile log that preceeds this message for additional indications of failures.

WARNING: Can’t secure file for component component-path . FILSYS Errorerror-number

Explanation: The file associated with the specified component cannot be secured according to the securityspecification.

Action: The file system error number is reported. Usually it is a 48 (security violation). This will notinterrupt the compilation process and will not prohibit successful compilation. Securityspecifications are made internally through the PRODUCE SECURITY and PRODUCESECURITY MASK fields, and externally through the ProcessFileSecurity of the TACL thatstarts RMSMAKE.

Produce ErrorsWarnings


Errors

The following messages are typically indicators of why compiles have failed.

ERROR: Cannot retrieve component-path from archive. FILSYS Errorerror-number .

Explanation: RMSMAKE was unable to retrieve a file from the archive.

Action: The file system error is reported indicating the cause of the failure. Most errors indicate diskspace and security violations. However the following two errors have special meaning:

zFIL-ERR-EOF(1)

Indicates that there is no archive entry in the RMS catalog for the desired version.This will typically necessitate the recompilation of the object component. RMSdoes not consider this to be a compilation error in the strictest sense, as there arerecovery methods available (such as the automatic recompile).

zFIL-ERR-NOTFOUND(11)

Indicates that while there is an archive entry in the RMS catalog for the desiredversion, the file has been externally removed from the archive. This will typicallynecessitate the recompilation of the object component.

Compilation Failed: Unable to add external version of component-path

Explanation: RMSMAKE was unable to obtain or create a version of an external file. The catalog ownermust have read access to external objects. Typically this does not happen for non-code 100and non-POBJ components. It is also possible that the RMS catalog file VERSENT or itsalternate key files are full.

Action: That condition can be corrected by changing the MAXEXTENTS of the offending file or byreconstructing the file with larger extents using XPRESS.

Produce ErrorsErrors


Compilation Failed: Unable to add dependency to component-path

Explanation: RMSMAKE was unable to add dependencies from the compiled object to the indicated path.This is usually caused by the catalog file DEPREL or its alternate key files being full.

Action: That condition can be corrected by changing the MAXEXTENTS of the offending file or byreconstructing the file with larger extents using XPRESS.

Compilation Failed: Unable to obtain version of component-path

Explanation: RMSMAKE was unable to obtain or create a version of a newly compiled file. The catalogowner must have read access to external objects. Typically this does not happen for non-code100 and non-POBJ components.

Action: A SCOBOL requestor can generate this message when there is a mismatch between thePROGRAM-ID and the component name of that requestor.

Compilation Failed: Object component component-path not modified duringcompilation

Explanation: This error results when the compilation succeeds (i.e., no error code was reported) but thetarget file is unmodified. This often happens when the :RMS:IGNORE TACL MACROS areused during compilation and errors or relevant warnings are ignored. It can also happen if thefile specified for the object component is different from the required :RMS:OBJECT.

Action: A SCOBOL requestor can also generate this message when there is a mismatch between thePROGRAM-ID and the component name of that requestor.



Compilation Failed: Unable to add new version of component-path

Explanation: RMSMAKE was unable to obtain or create a version of a managed component. The catalogowner must have read access to external objects. Typically this does not happen for non-code100 and non-POBJ components. It is also possible that the RMS catalog file VERSENT or itsalternate key files are full.

Action: That condition can be corrected by changing the MAXEXTENTS of the offending file or byreconstructing the file with larger extents using XPRESS. It is also possible that the compileprocessor specified invalid timestamps for the versions of the object components. This cancause a duplication of versions that is disallowed by RMS.

Compilation Failed: File for component component-path has been replaced.

Explanation: The file associated with the specified component has been replaced or removed during theperiod from which RMSMAKE extracted, compiled or otherwise validated the file’s version,and the end of the compile of a higher level object that depends on that file. This may resultfrom two compiles at different states generating new versions of the lower level object.

Abort: Stack overflow. Possible loop for component component-path Ref Stack: component-path

Explanation: There is a reference loop in the source structure for the indicated component. A trace of thereferencing components are reported prior to the compile abort.



Serious Errors

The following messages are typically problems in the RMS environment or catalog outside the control ofRMSMAKE. You should contact RMS Technical Support for most of these indicators.

DANGER: Version of component-path at given state is inaccessible

Explanation: The version information for the component is not available. This may result from TM/MP(formerly TMF) record or file locks on the VERSENT file.

DANGER: Compilation info of component-path inaccessible

Explanation: The compilation information for the component is not available. This may result from TM/MP(formerly TMF) record or file locks on the COMPREL file.

DANGER: Source component component-path not added to context

Explanation: There is insufficient PFS space to add DEFINE context for the specified component. Thiserror can only occur during external compile.

Action: You can increase the PFS space of RMSMAKE using BINDER. You will likely have to alsoincrease the PFS space of TACL. Note that in C30.09 there is an absolute DEFINE limit of64Kb for local RMSMAKE and 32Kb for network MultiDomain RMSMAKE imposed byGuardian.

Produce ErrorsSerious Errors


DANGER: The file for component component-path has gone missing Check its DEFINE for correct assignment

Explanation: Between the time that the DEFINE for the file was added and the time it is needed byRMSMAKE, the file on disc, or the DEFINE specification within RMS has changed.

DANGER: Can’t access version info of component-path

Explanation: The version information for the component is not available. This may result from TM/MP(formerly TMF) record or file locks on the VERSENT or COMPENT files.

DANGER: No dependencies exist for component-path

Explanation: For some reason, there are no dependencies defined from the specified component. This couldresult from a bad prior compile.

Action: There should be at least one dependency from each object - its primary source.

DANGER: Source version of component-path inaccessible

Explanation: The source version of the primary source could not be found.

Action: Contact RMS Technical Support.



DANGER: Source details of component-path inaccessible

Explanation: The source component information of the primary source could not be found.

Action: Contact RMS Technical Support.

DANGER: Multi-domain does not support external components: component-path

Explanation: The version of RMSMAKE does not support external components through Multi-domain.



Notes:



Index

Special Characters

:RMS:Description 12-33, 12-39, 12-52:Expiry^Date 12-33, 12-52:license_attr:attribute-name 12-33, 12-52:Location 12-33, 12-39, 12-52:Location^Name 12-33, 12-39, 12-52:location_attr:attribute-name 12-33, 12-52:Release^Library 12-34, 12-53:Release^Name 12-53:release_attr:attribute-name 12-34, 12-52:ReleaseId 12-34, 12-52:Sublocation:sub-location-name 12-34Release^Name 12-34Sublocation:sub-location-name 12-53

A

AbbreviationsKeyword 3-2

Automatic Allocation of User Names 6-12Auxiliary Attributes 6-93, 12-35, 12-54

B

Bug-FixChanging Flags 6-15Reporting 6-40Turning On 6-76

C

CommandACQUIRE 12-4ADD ATTRIBUTE 12-12ADD COMPILE 11-1, 11-3ADD COMPONENT 6-3ADD LICENSE 12-13ADD LOCATION 12-14ADD REFERENCE 11-6ADD RELEASE 8-3ADD REQUISITE COMPONENT 8-7ADD REQUISITE RELEASE 8-9ADD RULE 11-8ADD STATE 7-2ADD USERCHANGE 6-12ALTER ATTRIBUTE 12-19ALTER COMPONENT 6-14ALTER LICENSE 12-20ALTER LOCATION 12-21ALTER REQUISITE COMPONENT 8-12ALTER REQUISITE RELEASE 8-13ALTER RMS 5-1

ALTER RULE 11-12ALTER SERVER 10-2ALTER STATE 7-3ALTER USERCHANGE 6-17ALTER VERSION 6-18BROWSE 6-19CLEANUP RELEASE 8-14CLEANUP RMS 5-5CONDENSE 6-20DELAY 3-4DELETE ATTRIBUTE 12-22DELETE COMPILE 11-13DELETE COMPONENT 6-22DELETE LICENSE 12-24DELETE LOCATION 12-25DELETE REFERENCE 11-14DELETE RELEASE 8-15DELETE REQUISITE COMPONENT 8-16DELETE REQUISITE RELEASE 8-17DELETE RULE 11-15DELETE STATE 7-4DELETE USERCHANGE 6-23DELETE VERSIONS 6-24DEMOTE 7-5DIFFERENCES 6-26DISCONTINUE RELEASE 8-18DISTRIBUTE RELEASE 12-26DUPLICATE RELEASE 8-19DUPLICATE RULE 11-16EDIT RULE 11-17EXIT 4-1, 4-3EXTRACT 6-33FALLBACK LOCATION 12-36FREEZE RELEASE 8-21FREEZE SERVER 10-6General Command Format 3-1IMPACT RELEASE 12-41INFO COMPONENT 6-39INFO LOCATION 12-42INFO PCR 6-46INFO RELEASE 12-44INFO RMS 5-6INFO SECURITY 9-10INFO SERVER 10-7INFO SPATH 12-46INFO SSV 6-47INFO USERCHANGE 6-48INFO VERSION 6-49INSTALL RELEASE 12-47LINK COMPONENT 6-50LINK RELEASE 8-26LINK STATE 7-7LINK VERSION 6-51LIST COMPILE 11-18LIST DEPENDENCIES 11-19LIST LOCK 6-52LIST REFERENCE 11-21

Index

080203 Data Design Systems, Inc. I-1

LIST RELEASE 8-27LIST RULE 11-23LIST STATE 7-8LOCK 6-54MAP 6-55OBSOLETE 6-57OPEN 5-8PRODUCE 11-25PROMOTE 7-9PROMOTE COMPONENT 7-9PROMOTE RELEASE 7-13PROMOTE USERCHANGE 7-17RENUMBER 6-59RESET 6-61RESET ACQUIRE 12-55RESET FALLBACK 12-56RESET LOCATION 12-57RESET PRODUCE 11-31RESET RELEASE 8-30RESET SPATH 12-58RESET STATE 7-21ROLLOUT 6-62SECURE 9-12Security Requirements 9-4SET ACQUIRE 12-59SET COMPONENT 6-65SET DISTRIBUTE 12-60SET EXTRACT 6-67SET FALLBACK 12-61SET IMAGE 6-69SET LOCATION 12-63SET PRODUCE 11-32SET RELEASE 8-31SET SPATH 12-64SET SSV 6-70SET STATE 7-22SETPROMPT 4-4SHOW 6-72SHOW ACQUIRE 12-65SHOW PRODUCE 11-35SHOW RELEASE 8-33SHUTDOWN RMS 5-9START SERVER 10-9STATUS SERVER 10-10STOP SERVER 10-12SUBMIT 6-74THAW RELEASE 8-34THAW SERVER 10-13UNLINK COMPONENT 6-96UNLINK RELEASE 8-35UNLINK STATE 7-23UNLINK VERSION 6-97UNLOCK 6-98VERIFY LOCATION 12-66

CommandsGROUP 6-38Report Formats 6-41, 6-42, 6-43, 6-44, 6-45SET COMMENT 6-64

COMPILE CommandsADD 11-3ADD REFERENCE 11-6ADD RULE 11-8

ALTER RULE 11-12DELETE 11-13DELETE REFERENCE 11-14DELETE RULE 11-15DUPLICATE RULE 11-16EDIT RULE 11-17LIST COMPILE 11-18LIST DEPENDENCIES 11-19LIST REFERENCE 11-21LIST RULE 11-23PRODUCE 11-25RESET PRODUCE 11-31SET PRODUCE 11-32SHOW PRODUCE 11-35

COMPONENT CommandsADD COMPONENT 6-3ADD USERCHANGE 6-12ALTER COMPONENT 6-14ALTER USERCHANGE 6-17ALTER VERSION 6-18BROWSE 6-19CONDENSE 6-20DELETE COMPONENT 6-22DELETE USERCHANGE 6-23DELETE VERSIONS 6-24DIFFERENCES 6-26EXTRACT 6-33GROUP 6-38INFO COMPONENT 6-39INFO PCR 6-46INFO SSV 6-47INFO USERCHANGE 6-48INFO VERSION 6-49LINK COMPONENT 6-50LINK VERSION 6-51LIST LOCK 6-52LOCK 6-54MAP 6-55OBSOLETE 6-57PROMOTE 7-9PROMOTE RELEASE 7-13PROMOTE USERCHANGE 7-17RENUMBER 6-59RESET 6-61ROLLOUT 6-62SET COMMENT 6-64SET COMPONENT 6-65SET EXTRACT 6-67SET IMAGE 6-69SET SSV 6-70SET SUBMIT 6-71SHOW 6-72SUBMIT 6-74UNLINK COMPONENT 6-96UNLOCK 6-98

Component File Name Macro 6-82Component Parameter Requirements 6-9COMPRESS 11-32

Index


D

DATALIB 1-33, 6-6, 6-7, 6-9, 6-11, 6-29, 6-37DISTRIBUTE commands

ACQUIRE 12-4ADD ATTRIBUTE 12-12ADD LICENSE 12-13ADD LOCATION 12-14ALTER ATTRIBUTE 12-19ALTER LICENSE 12-20ALTER LOCATION 12-21DELETE ATTRIBUTE 12-22DELETE LICENSE 12-24DELETE LOCATION 12-25DISTRIBUTE RELEASE 12-26FALLBACK LOCATION 12-36IMPACT RELEASE 12-41INFO LOCATION 12-42INFO RELEASE 12-44INFO SPATH 12-46INSTALL RELEASE 12-47RESET ACQUIRE 12-55RESET FALLBACK 12-56RESET LOCATION 12-57RESET SPATH 12-58SET ACQUIRE 12-59SET DISTRIBUTE 12-60SET FALLBACK 12-61SET LOCATION 12-63SET SPATH 12-64SHOW ACQUIRE 12-65VERIFY LOCATION 12-66

DISTRIBUTE RELEASESpecial Security Considerations 9-15

DRMS-ERR-ACQUIRE-PENDING(2042) A-13ALLOCATESEGMENT(2052) A-16AMBIGUOUS(2505) A-20BAD-BRANCH-NUM(2703) A-28BAD-DIFF-OP(2018) A-7BAD-FILE-HEADER(2707) A-29BAD-FILENAME(2020) A-8BAD-LEVEL-NUM(2702) A-28BAD-LINE(2019) A-8BAD-PCR-STATE(2605) A-27BAD-RELEASE-NUM(2700) A-28BAD-RMSCOMP-DEFINE(2021) A-8BAD-SECURITY-MASK(2530) A-24BAD-SECURITY-UMASK(2531) A-24BAD-SEQUENCE-NUM(2704) A-29BAD-TRANSITION(2100) A-16BAD-VERSION-HEADER(2706) A-29BAD-VERSION-NUM(2705) A-29BADLINENUMDOTORDER(2710) A-30BADSECTIONDOTORDER(2709) A-30BEEN-DISTRIBUTED(2520) A-23BUG-FIX-PENDING(2103) A-17BUILD-REFS(2500) A-18CANNOT-ACQUIRE(2519) A-22CANNOT-ADD(2005) A-4CANNOT-ADD-EXTERNAL(2025) A-9CANNOT-ADD-REFERENCE(2028) A-10

CANNOT-COMPILE(2038) A-12CANNOT-DELETE(2006) A-4CANNOT-DELTA(2043) A-14CANNOT-DISTRIBUTE(2513) A-21CANNOT-EXTRACT(2017) A-7CANNOT-FALLBACK(2011) A-6CANNOT-LINK-ORPHAN(2522) A-23CANNOT-LOCK(2009) A-5CANNOT-PROMOTE(2010) A-5CANNOT-RENUMBER(2044) A-14CANNOT-SECURE(2035) A-12CANNOT-SUBMIT(2012) A-6CANNOT-UNLINK(2523) A-23CANNOT-UNLOCK(2034) A-11CANNOT-UPDATE(2007) A-5CANT-FIND-COMPONENT(2022) A-8CANT-RESOLVE-DEFINE(2023) A-9COMP-COMPILABLE(1005) A-2COMP-NOT-FOUND(2024) A-9COMPILE-REQUIRED(2045) A-14CREATEPROCESSNAME(2510) A-20DANGER-DETECTED(2054) A-16DATABASE-CORRUPT(2000) A-3DIFFERENT-COMPONENT(2761) A-33DUPLICATE(2610) A-27DUPLICATE-VERSION(2708) A-30EMPTY(2046) A-14EXPECTING-PERIOD(2701) A-28FILE-ERROR(2051) A-15FILES-NOT-COMPATIBLE(2762) A-33FNAME-UNRESOLVABLE(2001) A-3FREEZE-RESOLVE(2512) A-21IN-USE(2036) A-12INAPPROPRIATE-VERS(2102) A-17INVALID-COMP-NAME(2756) A-32INVALID-DATA-DESC(2759) A-32INVALID-KEY-DATA(2757) A-32INVALID-KEY-DESC(2754) A-31INVALID-LOCATION(2514) A-21INVALID-REL-STATE(2521) A-23INVALID-SYNTAX(2030) A-10INVALID-VER-NUM(2004) A-4KIND-MISMATCH(2027) A-10KIND-UNPROMOTABLE(1004) A-2MANIFEST-BADCOMPNAME(2601) A-25MANIFEST-BADLANG(2602) A-26MANIFEST-BADOS(2600) A-25MANIFEST-BADTYPE(2603) A-26MANIFEST-BADVERSION(2604) A-27MISSING-KEY-DESC(2753) A-31MISSING-USERCHANGE(2053) A-16MORERECENTVERSIONS(1002) A-1MULTIPLE-COMPONENTS(2760) A-33MUST-BE-KEYSEQUENCED(2752) A-31NEWFILETOOBIG(2516) A-22NO-CHANGES(2016) A-7NO-COMPILE(2501) A-18NO-RESOURCES(2039) A-13NO-RULE(2502) A-19NO-SERVER-CLASS(2003) A-4NO-SOURCE(2503) A-19NO-SPACE(2002) A-3

Index


NO-START-TACL(2511) A-20NO-SUCH-SECTION(2200) A-18NOCORRESPONDSTATE(2506) A-20NOCORRESPONDVERSION(2504) A-19NODATA(1001) A-1NOT-DISC-FILE(2013) A-6NOT-EDIT-FILE(2014) A-6NOT-EMPTY(2015) A-7NOT-KEYED(2758) A-32NOT-LICENSED(2050) A-15NOT-LOCAL(2599) A-24NOT-LOCKED(2008) A-5OBJ-IN-USE(2037) A-12OLDFILETOOBIG(2515) A-21RELEASE-FROZEN(2049) A-15SCOBOLMODE(2518) A-22SEARCH-LIST-OVERFLOW(2029) A-10SECURITY(2048) A-15SERVER-ERROR(2999) A-34SPI-BADCHECKSUM(4010) A-36SPI-EXTRATOKEN(4001) A-34SPI-GENERALERR(4017) A-38SPI-INVALIDBUFFER(4009) A-36SPI-INVALIDFIELD(4005) A-35SPI-INVALIDTOKEN(4002) A-34SPI-MISSINGFIELD(4006) A-35SPI-MISSINGTOKEN(4004) A-35SPI-SSGET(4012) A-36SPI-SSINIT(4013) A-37SPI-SSMOVE(4015) A-37SPI-SSNULL(4014) A-37SPI-SSPUT(4011) A-36SPI-WRONGSUBSYS(4016) A-37SPI-WRONGTOKEN(4003) A-35SQL-NOT-ALLOWED(2751) A-30SUBMIT-FILE-ERR(2031) A-11SUBMIT-OTHER-ERR(2032) A-11TIMESTAMP-RESOLVE(2104) A-17TOKENCONFLICT(2041) A-13TOKENERROR(2040) A-13TOO-LONG-KEY(2755) A-31TOOMANYUNIQUELINES(2517) A-22UNEXPECTED-EOF(2026) A-9UNKNOWN-VERSION(2033) A-11UNSUPPORTED(1000) A-1USERVERIFY-FAILED(3000) A-34VALIDATION(2900) A-33VERSION-CONFLICT(2101) A-17

DRMS-EVT-ACQUIRE-COMPONENT(57) B-8ACQUIRE-RELEASE(53) B-7ADD-LOCATION(304) B-15ADD-RELEASE(302) B-15ADD-USERCHANGE(300) B-14ALTER-LOCATION(305) B-15CATALOG-CHECKOUT(2) B-1CLEANUP(11) B-3CMD-SEC-VIOLATION(49) B-6COMPILE-FAILED(17) B-5COMPILE-STARTED(16) B-5COMPONENT-BUGFIX(100) B-13COMPONENT-COMPILE(10) B-3

COMPONENT-DELETED(18) B-5COMPONENT-EXTRACT(9) B-3COMPONENT-LOCKED(101) B-13COMPONENT-SUBMIT(8) B-3COMPONENT-UNLOCKED(102) B-14DELETE-DISTRIBUTION(307) B-16DELETE-LOCATION(306) B-16DELETE-RELEASE(303) B-15DELETE-USERCHANGE(301) B-14DEMOTE-COMP-FAILED(73) B-12DEMOTE-COMPONENT(62) B-9DEMOTE-PCR-FAILED(74) B-12DEMOTE-REL-FAILED(75) B-13DEMOTE-RELEASE(64) B-10DEMOTE-USERCHANGE(63) B-10DISTRIBUTE-COMPONENT(55) B-8DISTRIBUTE-RELEASE(51) B-7EXTERNAL-COMPILE(50) B-6FALLBACK-COMPONENT(58) B-8FALLBACK-RELEASE(54) B-7INIT-CATALOG(4) B-2INIT-CATALOG-FAILED(3) B-1INSTALL-COMPONENT(56) B-8INSTALL-RELEASE(52) B-7LICENSED(15) B-4NOT-LICENSED(14) B-4PROMOTE-COMP-FAILED(70) B-11PROMOTE-COMPONENT(59) B-9PROMOTE-PCR-FAILED(71) B-12PROMOTE-REL-FAILED(72) B-12PROMOTE-RELEASE(61) B-9PROMOTE-USERCHANGE(60) B-9QUEUE-EXTRACT-REQ(200) B-14RMS-SHUTDOWN(6) B-2RMS-STARTED(1) B-1RMS-STARTING(0) B-1SC-ADD-FAILURE(5) B-2SCPROCESS-HALT(7) B-2SCPROCESS-SHUTDOWN(13) B-4SCPROCESS-STARTED(12) B-4SECURITY-CHANGE(47) B-6SECURITY-VIOLATION(48) B-6SUBMIT-FAILED(19) B-5VERSION-DELETED(65) B-10VERSION-RENUMBERED(69) B-11VERSIONS-CONDENSED(66) B-10VERSIONS-OBSOLETED(67) B-11VERSIONS-ROLLEDOUT(68) B-11WRONG-RMS-VERSION(99) B-13

DRMS-WARN-BUFFER-FULL(1043) A-2BUFFER-FULL-NC(1045) A-3BUG-FIX-PENDING(1003) A-1VALIDATION(1006) A-2

E

error xi

Index


F

FALLBACK LOCATIONSpecial Security Considerations 9-15

G

generic removal 1-36GUARDIAN xii

I

INFO COMPONENT HISTORY REPORT 6-45INFO COMPONENT Report Format 6-41, 6-42, 6-43,

6-44, 6-45INFO SECURITY Report Format 9-11Info Server Report Layout 10-7INFO USERCHANGE Report Format 6-48INSTALL RELEASE

Special Security Considerations 9-15

K

KeywordAbbreviations 3-2

Commands 3-2

L

List Compile Report Layout 11-18List Dependencies Report Format 11-20LIST LOCK Report Format 6-53List Reference Report Format 11-21List Release Report Format 8-27List Rule Report Format 11-24List State Report Format 7-8

M

MacroComponent File Name 6-82Version Branch 6-82Version Date 6-82Version Level 6-82Version Release 6-82Version Sequence 6-82

Map Command Report Format 6-55

P

Parameter Substitution 6-82PATHMAKER 1-27PRAGMA

DISABLE 6-91ENABLE 6-91

FAIL 6-91LINE 6-91LOG 6-91REFERENCE 6-91TAG 6-92

Processors 11-1PRODUCE

Special Security Considerations 9-15

R

RELEASE CommandsADD 8-3ADD REQUISITE COMPONENT 8-7ADD REQUISITE RELEASE 8-9CLEANUP 8-14DELETE 8-15DELETE REQUISITE COMPONENT 8-16DELETE REQUISITE RELEASE 8-17DISCONTINUE 8-18DUPLICATE 8-19FREEZE 8-21LINK 8-26LIST 8-27RESET 8-30SET 8-31SHOW 8-33THAW 8-34UNLINK 8-35

Report Format 11-24Reserved Locations

RMS-TEMP 11-30RMS Environment 1-43, 1-44RMS Monitor EMS Events DRMS-EVT-

RMS-STARTING B-11 RMS-STARTED B-110 COMPONENT-COMPILE B-3100 COMPONENT-BUGFIX B-13101 COMPONENT-LOCKED B-13102 COMPONENT-UNLOCKED B-1411 CLEANUP B-312 SCPROCESS-STARTED B-413 SCPROCESS-SHUTDOWN B-414 NOT-LICENSED B-415 LICENSED B-416 COMPILE-STARTED B-517 COMPILE-FAILED B-518 COMPONENT-DELETED B-519 SUBMIT-FAILED B-52 CATALOG-CHECKOUT B-1200 QUEUE-EXTRACT-REQ B-143 INIT-CATALOG-FAILED B-1300 ADD-USERCHANGE B-14301 DELETE-USERCHANGE B-14302 ADD-RELEASE B-15303 DELETE-RELEASE B-15304 ADD-LOCATION B-15305 ALTER-LOCATION B-15306 DELETE-LOCATION B-16307 DELETE-DISTRIBUTION B-164 INIT-CATALOG B-2

Index


47 SECURITY-CHANGE B-648 SECURITY-VIOLATION B-649 CMD-SEC-VIOLATION B-65 SC-ADD-FAILURE B-250 EXTERNAL-COMPILE B-651 DISTRIBUTE-RELEASE B-752 INSTALL-RELEASE B-753 ACQUIRE-RELEASE B-754 FALLBACK-RELEASE B-755 DISTRIBUTE-COMPONENT B-856 INSTALL-COMPONENT B-857 ACQUIRE-COMPONENT B-858 FALLBACK-COMPONENT B-859 PROMOTE-COMPONENT B-96 RMS-SHUTDOWN B-260 PROMOTE-USERCHANGE B-961 PROMOTE-RELEASE B-962 DEMOTE-COMPONENT B-963 DEMOTE-USERCHANGE B-1064 DEMOTE-RELEASE B-1065 VERSION-DELETED B-1066 VERSIONS-CONDENSED B-1067 VERSIONS-OBSOLETED B-1168 VERSIONS-ROLLEDOUT B-1169 VERSION-RENUMBERED B-117 SCPROCESS-HALT B-270 PROMOTE-COMP-FAILED B-1171 PROMOTE-PCR-FAILED B-1272 PROMOTE-REL-FAILED B-1273 DEMOTE-COMP-FAILED B-1274 DEMOTE-PCR-FAILED B-1275 DEMOTE-REL-FAILED B-138 COMPONENT-SUBMIT B-39 COMPONENT-EXTRACT B-399 WRONG-RMS-VERSION B-13

RMS Monitor Errors DRMS-ERR-1000 UNSUPPORTED A-11001 NODATA A-11002 MORERECENTVERSIONS A-11004 KIND-UNPROMOTABLE A-21005 COMP-COMPILABLE A-22000 DATABASE-CORRUPT A-32001 FNAME-UNRESOLVABLE A-32002 NO-SPACE A-32003 NO-SERVER-CLASS A-42004 INVALID-VER-NUM A-42005 CANNOT-ADD A-42006 CANNOT-DELETE A-42007 CANNOT-UPDATE A-52008 NOT-LOCKED A-52009 CANNOT-LOCK A-52010 CANNOT-PROMOTE A-52011 CANNOT-FALLBACK A-62012 CANNOT-SUBMIT A-62013 NOT-DISC-FILE A-62014 NOT-EDIT-FILE A-62015 NOT-EMPTY A-72016 NO-CHANGES A-72017 CANNOT-EXTRACT A-72018 BAD-DIFF-OP A-72019 BAD-LINE A-82020 BAD-FILENAME A-8

2021 BAD-RMSCOMP-DEFINE A-82022 CANT-FIND-COMPONENT A-82023 CANT-RESOLVE-DEFINE A-92024 COMP-NOT-FOUND A-92025 CANNOT-ADD-EXTERNAL A-92026 UNEXPECTED-EOF A-92027 KIND-MISMATCH A-102028 CANNOT-ADD-REFERENCE A-102029 SEARCH-LIST-OVERFLOW A-102030 INVALID-SYNTAX A-102031 SUBMIT-FILE-ERR A-112032 SUBMIT-OTHER-ERR A-112033 UNKNOWN-VERSION A-112034 CANNOT-UNLOCK A-112035 CANNOT-SECURE A-122036 IN-USE A-122037 OBJ-IN-USE A-122038 CANNOT-COMPILE A-122039 NO-RESOURCES A-132040 TOKENERROR A-132041 TOKENCONFLICT A-132042 ACQUIRE-PENDING A-132043 CANNOT-DELTA A-142044 CANNOT-RENUMBER A-142045 COMPILE-REQUIRED A-142046 EMPTY A-142048 SECURITY A-152049 RELEASE-FROZEN A-152050 NOT-LICENSED A-152051 FILE-ERROR A-152052 ALLOCATESEGMENT A-162053 MISSING-USERCHANGE A-162054 DANGER-DETECTED A-162100 BAD-TRANSITION A-162101 VERSION-CONFLICT A-172102 INAPPROPRIATE-VERS A-172103 BUG-FIX-PENDING A-172104 TIMESTAMP-RESOLVE A-172200 NO-SUCH-SECTION A-182500 BUILD-REFS A-182501 NO-COMPILE A-182502 NO-RULE A-192503 NO-SOURCE A-192504 NOCORRESPONDVERSION A-192505 AMBIGUOUS A-202506 NOCORRESPONDSTATE A-202510 CREATEPROCESSNAME A-202511 NO-START-TACL A-202512 FREEZE-RESOLVE A-212513 CANNOT-DISTRIBUTE A-212514 INVALID-LOCATION A-212515 OLDFILETOOBIG A-212516 NEWFILETOOBIG A-222517 TOOMANYUNIQUELINES A-222518 SCOBOLMODE A-222519 CANNOT-ACQUIRE A-222520 BEEN-DISTRIBUTED A-232521 INVALID-REL-STATE A-232522 CANNOT-LINK-ORPHAN A-232523 CANNOT-UNLINK A-232530 BAD-SECURITY-MASK A-242531 BAD-SECURITY-UMASK A-24

Index


2599 NOT-LOCAL A-242600 MANIFEST-BADOS A-252601 MANIFEST-BADCOMPNAME A-252602 MANIFEST-BADLANG A-262603 MANIFEST-BADTYPE A-262604 MANIFEST-BADVERSION A-272605 BAD-PCR-STATE A-272610 DUPLICATE A-272700 BAD-RELEASE-NUM A-282701 EXPECTING-PERIOD A-282702 BAD-LEVEL-NUM A-282703 BAD-BRANCH-NUM A-282704 BAD-SEQUENCE-NUM A-292705 BAD-VERSION-NUM A-292706 BAD-VERSION-HEADER A-292707 BAD-FILE-HEADER A-292708 DUPLICATE-VERSION A-302709 BADSECTIONDOTORDER A-302710 BADLINENUMDOTORDER A-302751 SQL-NOT-ALLOWED A-302752 MUST-BE-KEYSEQUENCED A-312753 MISSING-KEY-DESC A-312754 INVALID-KEY-DESC A-312755 TOO-LONG-KEY A-312756 INVALID-COMP-NAME A-322757 INVALID-KEY-DATA A-322758 NOT-KEYED A-322759 INVALID-DATA-DESC A-322760 MULTIPLE-COMPONENTS A-332761 DIFFERENT-COMPONENT A-332762 FILES-NOT-COMPATIBLE A-332900 VALIDATION A-332999 SERVER-ERROR A-343000 USERVERIFY-FAILED A-344001 SPI-EXTRATOKEN A-344002 SPI-INVALIDTOKEN A-344003 SPI-WRONGTOKEN A-354004 SPI-MISSINGTOKEN A-354005 SPI-INVALIDFIELD A-354006 SPI-MISSINGFIELD A-354009 SPI-INVALIDBUFFER A-364010 SPI-BADCHECKSUM A-364011 SPI-SSPUT A-364012 SPI-SSGET A-364013 SPI-SSINIT A-374014 SPI-SSNULL A-374015 SPI-SSMOVE A-374016 SPI-WRONGSUBSYS A-374017 SPI-GENERALERR A-38

RMS Monitor Errors DRMS-WARN-1003 BUG-FIX-PENDING A-11006 VALIDATION A-21043 BUFFER-FULL A-21045 BUFFER-FULL-NC A-3

RMS-TEMP 11-30, 12-17RMS-TEMP-TOOLS 12-17RMSBASE 1-43RMSCSTM 1-43RMSINI 1-43RMSLBASE 1-43RMSLOCL 1-43RMSLSTRT 1-44

RMSSTART 1-44Rules,Special

DISTRIBUTE 12-32FALLBACK 12-38INSTALL 12-51PRE-INSTALL 12-51

S

SAFEGUARD 9-15SECURITY Commands

INFO 9-10Operating System Interactions 9-15SECURE 9-12Special Considerations 9-15

Security RequirementsCommands 9-4

SERVER CommandsALTER 10-2FREEZE 10-6INFO 10-7RMSMAKE 10-4RMSRELSE 10-5RMSUBMIT 10-4START SERVER 10-9STATUS 10-10STOP 10-12THAW 10-13

SHOW COMPONENT Report Format 6-72Show Release Report Format 8-33significance template 1-35Special Components

.DEFAULTS 1-28

.FILE-HEADER 1-28

.ORDER 1-28SSVs 6-84State Commands

ADD 7-2ALTER 7-3DELETE 7-4DEMOTE 7-5LINK 7-7LIST 7-8LIST STATE Report Format 7-8PROMOTE 7-9RESET 7-21SET 7-22UNLINK 7-23

Status Server Report Format 10-10

T

TACL xiiTrigger Character 6-82

Index


U

USERCHANGE CommandsADD 6-12ALTER 6-14DELETE 6-23

V

Valid Component Names 6-10Version Branch Macro 6-82Version Data Macro 6-82Version Level Macro 6-82Version Release Macro 6-82Version Sequence Macro 6-82

Index


rmscom & rmsmon reference manual c40 - emperex · commands and the operational considerations...

Documents