Vault Command Reference - john-j- · PDF fileCommand Reference Optegra® Release 7 ......

Parametric Technology Corporation

VaultCommand Reference

Optegra® Release 7

DOC35223-015

Copyright © 2002 Parametric Technology Corporation. All Rights Reserved.User and training documentation from Parametric Technology Corporation (PTC) is subject to the copyright lawsof the United States and other countries and is provided under a license agreement that restricts copying,disclosure, and use of such documentation. PTC hereby grants to the licensed user the right to make copies inprinted form of this documentation if provided on software media, but only for internal/personal use and inaccordance with the license agreement under which the applicable software is licensed. Any copy made shallinclude the PTC copyright notice and any other proprietary notice provided by PTC. This documentation may notbe disclosed, transferred, modified, or reduced to any form, including electronic media, or transmitted or madepublicly available by any means without the prior written consent of PTC and no authorization is granted to makecopies for such purposes.

Information described herein is furnished for general information only, is subject to change without notice, andshould not be construed as a warranty or commitment by PTC. PTC assumes no responsibility or liability for anyerrors or inaccuracies that may appear in this document.

The software described in this document is provided under written license agreement, contains valuable tradesecrets and proprietary information, and is protected by the copyright laws of the United States and othercountries. It may not be copied or distributed in any form or medium, disclosed to third parties, or used in anymanner not provided for in the software licenses agreement except with written prior approval from PTC.UNAUTHORIZED USE OF SOFTWARE OR ITS DOCUMENTATION CAN RESULT IN CIVIL DAMAGES ANDCRIMINAL PROSECUTION.

Registered Trademarks of Parametric Technology Corporation or a SubsidiaryAdvanced Surface Design, CADDS, Computervision, Computervision Services, Electronic Product Definition,EPD, EPD.Connect, Expert Machinist, Flexible Engineering, HARNESSDESIGN, Info*Engine, InPart, Optegra,Parametric Technology, Parametric Technology Corporation, PHOTORENDER, Pro/DESKTOP, Pro/E,Pro/ENGINEER, Pro/HELP, Pro/INTRALINK, Pro/MECHANICA, Pro/TOOLKIT, PTC, PT/Products,Shaping Innovation, and Windchill.

Trademarks of Parametric Technology Corporation or a Subsidiary3DPAINT, Associative Topology Bus, Behavioral Modeling, CDRS, CounterPart, Create Collaborate Control, CV,CVact, CVaec, CVdesign, CV-DORS, CVMAC, CVNC, CVToolmaker, DataDoctor, DesignSuite, DIMENSION III,DIVISION, DVS, DVSAFEWORK, EDE, e/ENGINEER, Electrical Design Entry, EMX, eNC Explorer,Expert MoldBase, Expert Toolmaker, GRANITE, ISSM, KDiP, Knowledge Discipline in Practice,Knowledge System Driver, ModelCHECK, MoldShop, NC Builder, PartSpeak, Pro/ANIMATE, Pro/ASSEMBLY,Pro/CABLING, Pro/CASTING, Pro/CDT, Pro/CMM, Pro/COLLABORATE, Pro/COMPOSITE, Pro/CONCEPT,Pro/CONVERT, Pro/DATA for PDGS, Pro/DESIGNER, Pro/DETAIL, Pro/DIAGRAM, Pro/DIEFACE, Pro/DRAW,Pro/ECAD, Pro/ENGINE, Pro/FEATURE, Pro/FEM-POST, Pro/FICIENCY, Pro/FLY-THROUGH, Pro/HARNESS,Pro/INTERFACE, Pro/LANGUAGE, Pro/LEGACY, Pro/LIBRARYACCESS, Pro/MESH, Pro/Model.View,Pro/MOLDESIGN, Pro/NC-ADVANCED, Pro/NC-CHECK, Pro/NC-MILL, Pro/NCPOST, Pro/NC-SHEETMETAL,Pro/NC-TURN, Pro/NC-WEDM, Pro/NC-Wire EDM, Pro/NETWORK ANIMATOR, Pro/NOTEBOOK, Pro/PDM,Pro/PHOTORENDER, Pro/PIPING, Pro/PLASTIC ADVISOR, Pro/PLOT, Pro/POWER DESIGN, Pro/PROCESS,Pro/REPORT, Pro/REVIEW, Pro/SCAN-TOOLS, Pro/SHEETMETAL, Pro/SURFACE, Pro/VERIFY, Pro/Web.Link,Pro/Web.Publish, Pro/WELDING, Product Development Means Business, Product First, Products First,ProductView, PTC Precision, Shrinkwrap, The Product Development Company, The Way to Product First,Wildfire, Windchill DynamicDesignLink, Windchill PartsLink, Windchill PDMLink, Windchill ProjectLink, andWindchill SupplyLink.

Third-Party TrademarksAdobe is a registered trademark of Adobe Systems. Advanced ClusterProven, ClusterProven, and theClusterProven design are trademarks or registered trademarks of International Business Machines Corporation inthe United States and other countries and are used under license. IBM Corporation does not warrant and is notresponsible for the operation of this software product. AIX is a registered trademark of IBM Corporation. Allegro,Cadence, and Concept are registered trademarks of Cadence Design Systems, Inc. AutoCAD is a registeredtrademark of Autodesk, Inc. Baan is a registered trademark of Baan Company. CADAM and CATIA are registeredtrademarks of Dassault Systemes. COACH is a trademark of CADTRAIN, Inc. DOORS is a registered trademark

of Telelogic AB. FLEXlm is a registered trademark of GLOBEtrotter Software, Inc. Geomagic is a registeredtrademark of Raindrop Geomagic, Inc. EVERSYNC, GROOVE, GROOVEFEST, GROOVE.NET,GROOVE NETWORKS, iGROOVE, PEERWARE, and the interlocking circles logo are trademarks of GrooveNetworks, Inc. Helix is a trademark of Microcadam, Inc. HOOPS is a trademark of Tech Soft America, Inc. HP-UXis a registered trademark and Tru64 is a trademark of the Hewlett-Packard Company. I-DEAS, Metaphase,Parasolid, SHERPA, Solid Edge, and Unigraphics are trademarks or registered trademarks of Electronic DataSystems Corporation (EDS). InstallShield is a registered trademark and service mark of InstallShield SoftwareCorporation in the United States and/or other countries. Intel is a registered trademark of Intel Corporation. IRIX isa registered trademark of Silicon Graphics, Inc. MatrixOne is a trademark of MatrixOne, Inc. Mentor Graphics andBoard Station are registered trademarks and 3D Design, AMPLE, and Design Manager are trademarks ofMentor Graphics Corporation. Netscape and the Netscape N and Ship’s Wheel logos are registered trademarks ofNetscape Communications Corporation in the U.S. and other countries. Oracle is a registered trademark ofOracle Corporation. OrbixWeb is a registered trademark of IONA Technologies PLC. PDGS is a registeredtrademark of Ford Motor Company. RAND is a trademark of RAND Worldwide. Rational Rose is a registeredtrademark of Rational Software Corporation. RetrievalWare is a registered trademark of Convera Corporation.RosettaNet is a trademark and Partner Interface Process and PIP are registered trademarks of "RosettaNet," anon-profit organization. SAP and R/3 are registered trademarks of SAP AG Germany. SolidWorks is a registeredtrademark of SolidWorks Corporation. All SPARC trademarks are used under license and are trademarks orregistered trademarks of SPARC International, Inc. in the United States and in other countries. Products bearingSPARC trademarks are based upon an architecture developed by Sun Microsystems, Inc. STHENO is atrademark of CAD Schroer GmbH. Sun, Sun Microsystems, the Sun logo, Solaris, UltraSPARC, Java and all Javabased marks, and "The Network is the Computer" are trademarks or registered trademarks of Sun Microsystems,Inc. in the United States and in other countries. VisTools is a trademark of Visual Kinematics, Inc. (VKI).VisualCafé is a trademark of WebGain, Inc. WebEx is a trademark of WebEx Communications, Inc. Microsoft,Windows, Windows NT, Visual Basic, and the Visual Basic logo are registered trademarks of MicrosoftCorporation in the United States and/or other countries.

Licensed Third-Party Technology InformationCertain PTC software products contain licensed third-party technology: Rational Rose 2000E is copyrightedsoftware of Rational Software Corporation. RetrievalWare is copyrighted software of Convera Corporation.VisualCafé is copyrighted software of WebGain, Inc. VisTools library is copyrighted software ofVisual Kinematics, Inc. (VKI) containing confidential trade secret information belonging to VKI. HOOPS graphicssystem is a proprietary software product of, and is copyrighted by, Tech Soft America, Inc. G-POST is copyrightedsoftware and a registered trademark of Intercim. VERICUT is copyrighted software and a registered trademark ofCGTech. Pro/PLASTIC ADVISOR is powered by Moldflow technology. Moldflow is a registered trademark ofMoldflow Corporation. The JPEG image output in the Pro/Web.Publish module is based in part on the work of theindependent JPEG Group. DFORMD.DLL is copyrighted software from Compaq Computer Corporation and maynot be distributed. METIS, developed by George Karypis and Vipin Kumar at the University of Minnesota, can beresearched at http://www.cs.umn.edu/~karypis/metis. METIS is © 1997 Regents of the University of Minnesota.LightWork Libraries are copyrighted by LightWork Design 1990-2001. Visual Basic for Applications andInternet Explorer is copyrighted software of Microsoft Corporation. Adobe Acrobat Reader is copyrighted softwareof Adobe Systems. Parasolid © Electronic Data Systems (EDS). Windchill Info*Engine Server contains IBM XMLParser for Java Edition and the IBM Lotus XSL Edition. Pop-up calendar components Copyright © 1998 NetscapeCommunications Corporation. All Rights Reserved. TECHNOMATIX is copyrighted software and containsproprietary information of Technomatix Technologies Ltd. Apache Server, Tomcat, Xalan, and Xerces aretechnologies developed by, and are copyrighted software of, the Apache Software Foundation(http://www.apache.org/) – their use is subject to the terms and limitations at: http://www.apache.org/LICENSE.txt.UnZip (© 1990-2001 Info-ZIP, All Rights Reserved) is provided "AS IS" and WITHOUT WARRANTY OF ANYKIND. For the complete Info-ZIP license see ftp://ftp.info-zip.org/pub/infozip/license.html. Gecko and Mozillacomponents are subject to the Mozilla Public License Version 1.1 at http://www.mozilla.org/MPL/. Softwaredistributed under the MPL is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, eitherexpress or implied. See the MPL for the specific language governing rights and limitations.Technology "Powered by Groove" is provided by Groove Networks, Inc. Technology "Powered by WebEx" isprovided by WebEx Communications, Inc. Acrobat Reader is Copyright © 1998 Adobe Systems Inc.Oracle 8i run-time, Copyright © 2000 Oracle Corporation. The JavaTM Telnet Applet (StatusPeer.java,TelnetIO.java, TelnetWrapper.java, TimedOutException.java), Copyright © 1996, 97 Mattias L. Jugel,

Marcus Meißner, is redistributed under the GNU General Public License. This license is from the original copyrightholder and the Applet is provided WITHOUT WARRANTY OF ANY KIND. You may obtain a copy of the sourcecode for the Applet at http://www.mud.de/se/jta (for a charge of no more than the cost of physically performing thesource distribution), by sending an e-mail to [email protected] or [email protected]—you are allowed to choose eitherdistribution method. The source code is likewise provided under the GNU General Public License.GTK+The GIMP Toolkit are licensed under the GNU LPGL. You may obtain a copy of the source code athttp://www.gtk.org/, which is likewise provided under the GNU LPGL.

UNITED STATES GOVERNMENT RESTRICTED RIGHTS LEGENDThis document and the software described herein are Commercial Computer Documentation and Software,pursuant to FAR 12.212(a)-(b) (OCT’95) or DFARS 227.7202-1(a) and 227.7202-3(a) (JUN’95), is provided to theUS Government under a limited commercial license only. For procurements predating the above clauses, use,duplication, or disclosure by the Government is subject to the restrictions set forth in subparagraph (c)(1)(ii) of theRights in Technical Data and Computer Software Clause at DFARS 252.227-7013 (OCT’88) or CommercialComputer Software-Restricted Rights at FAR 52.227-19(c)(1)-(2) (JUN’87), as applicable. 110102

Parametric Technology Corporation, 140 Kendrick Street, Needham, MA 02494 USA

Vault Command Reference Contents-v

Table of Contents

PrefaceRelated Documents ________________________________________ xliiiBook Conventions _________________________________________ xlivOnline User Documentation _________________________________ xlvPrinting Documentation ____________________________________ xlvResources and Services ____________________________________ xlviDocumentation Comments ________________________________ xlvi

Description of CommandsVault Commands _______________________________________________ 1-2

Attribute Administration Commands ________________________ 1-2Authority Group Commands _______________________________ 1-2Binder Administration Commands __________________________ 1-3Binder Commands_________________________________________ 1-3Command List Commands _________________________________ 1-3Database Maintenance Commands ______________________ 1-4Distributed Vault Administrative Commands_________________ 1-4Distributed Vault Commands _______________________________ 1-4Entry and Exit Commands _________________________________ 1-6File Access Commands ____________________________________ 1-6File Maintenance Commands _____________________________ 1-7File/Part Attribute Commands ______________________________ 1-7

File Set Commands _______________________________________ 1-7Help Commands __________________________________________ 1-8

Contents-vi Vault Command Reference

Message Commands ______________________________________ 1-8Project Administration Commands __________________________ 1-8Release/Revision Control Commands _______________________ 1-9Revision Code Sequence Commands _______________________ 1-9Status Level Commands ____________________________________ 1-9Storage Pool Maintenance Commands _____________________ 1-9System Maintenance Commands _________________________ 1-10User Administration Commands ___________________________ 1-10User-Defined Table Commands ___________________________ 1-10User List Commands ______________________________________ 1-10

Vault Command Hierarchy __________________________________ 1-11

IQF Commands ________________________________________________ 1-13

Using the Command-Line InterfaceBackground Information for ExecutingCommands ______________________________________________________ 2-2

Command Authority________________________________________ 2-2

Signing On Using the Command-Line Format ______________________ 2-3

CISIGNON Keywords ________________________________________ 2-3

Signing Off_______________________________________________________ 2-4

Viewing an Audit File _____________________________________________ 2-5

Using the Command-Line Format _________________________________ 2-6

Learning Keywords for Commands _____________________________ 2-6

Following Format Rules ________________________________________ 2-6

Using Other Conventions ______________________________________ 2-7

Case Sensitivity________________________________________________ 2-8Determining Case for Vault File and Selection Names ________ 2-8

Using the Return, Arrow, and Function Keys _____________________ 2-8

Running Vault Commands in the Background___________________ 2-9

Entering Commands on the Command Line _____________________ 2-10

Using Single Quotation Marks in a Vault Command Line ____ 2-10Using Special Characters for File Transfer Commandsat a Command Prompt on Windows NT____________________ 2-10Using Special Characters for File Transfer at

Vault Command Reference Contents-vii

the Command Line on UNIX _______________________________ 2-11Continuing a Vault Command Line ________________________ 2-11

Using Uppercase and Lowercase_____________________________ 2-12Case Translation__________________________________________ 2-12Vault Keyword Values That Can Be Stored in Mixed Case ___ 2-12Storing Vault File Names in Mixed Case ____________________ 2-13Selection Scope for CADDS Interface ______________________ 2-14

Changing the Vault User Password ______________________________ 2-15

Example ____________________________________________________ 2-15

Displaying Online Help__________________________________________ 2-16

Displaying Command Help________________________________ 2-16Displaying Message Help__________________________________ 2-16

More About Message Help___________________________________ 2-17

Using the UNIX Email Trigger _____________________________________ 2-18

Attaching a File _____________________________________________ 2-18

Example of Attached File ____________________________________ 2-18

Extra info____________________________________________________ 2-19

Vault CommandsIntroduction_____________________________________________________ 3-6

addadod (DV) __________________________________________________ 3-7

Syntax _______________________________________________________ 3-7

Required Keywords and Parameters __________________________ 3-7

Optional Keywords and Parameters ___________________________ 3-7

Requirements and Special Considerations _____________________ 3-7

Example _____________________________________________________ 3-7

addag__________________________________________________________ 3-8

Syntax _______________________________________________________ 3-8

Required Keywords and Parameters __________________________ 3-8

Optional Keywords and Parameters ___________________________ 3-8

Requirements and Special Considerations _____________________ 3-8

addalias (DV) __________________________________________________ 3-10

Syntax ______________________________________________________ 3-10

Contents-viii Vault Command Reference

Required Keywords and Parameters _________________________ 3-10

Optional Keywords and Parameters __________________________ 3-10

Requirements and Special Considerations ____________________ 3-10

Example ____________________________________________________ 3-10

addaset _______________________________________________________ 3-11

Syntax ______________________________________________________ 3-11




addatrbs (Binder) ______________________________________________ 3-13

Syntax ______________________________________________________ 3-13For Binders Only __________________________________________ 3-13For Binders and Relationships______________________________ 3-13For Relationships Only_____________________________________ 3-13

Required Keywords and Parameters__________________________ 3-14For Binders Only __________________________________________ 3-14For Binders and Relationships______________________________ 3-14For Relationships Only_____________________________________ 3-14



Example ____________________________________________________ 3-15

addattr ________________________________________________________ 3-16

Syntax ______________________________________________________ 3-16




addcl _________________________________________________________ 3-18

Syntax ______________________________________________________ 3-18



Example ____________________________________________________ 3-19

addevals (Binder) ______________________________________________ 3-20

Syntax ______________________________________________________ 3-20


Vault Command Reference Contents-ix



Examples ___________________________________________________ 3-20

addfs __________________________________________________________ 3-21

Syntax ______________________________________________________ 3-21




addmas _______________________________________________________ 3-22

Syntax ______________________________________________________ 3-22




addmfs ________________________________________________________ 3-24

Syntax ______________________________________________________ 3-24




addmul ________________________________________________________ 3-26

Syntax ______________________________________________________ 3-26




addobj (Binder) ________________________________________________ 3-28

Syntax ______________________________________________________ 3-28




Examples ___________________________________________________ 3-29

addp __________________________________________________________ 3-30

Syntax ______________________________________________________ 3-30


Contents-x Vault Command Reference

Optional Keywords and Parameters ________________________ 3-30


addrel (Binder)_________________________________________________ 3-31

Syntax ______________________________________________________ 3-31

Required Keywords and Parameters__________________________ 3-31

Optional Keywords and Parameters _________________________ 3-32


Examples ___________________________________________________ 3-32

addrs__________________________________________________________ 3-33

Syntax ______________________________________________________ 3-33




addrule________________________________________________________ 3-35

Syntax ______________________________________________________ 3-35



adds __________________________________________________________ 3-36

Syntax ______________________________________________________ 3-36




addsp _________________________________________________________ 3-38

Syntax ______________________________________________________ 3-38




addsub (DV) ___________________________________________________ 3-39

Syntax ______________________________________________________ 3-39



Requirements and Special Considerations ____________________ 3-40Events ___________________________________________________ 3-40

Vault Command Reference Contents-xi

Subscribing to Object Events ______________________________ 3-40

Example ____________________________________________________ 3-41

addt___________________________________________________________ 3-42

Syntax ______________________________________________________ 3-42




addu __________________________________________________________ 3-44

Syntax ______________________________________________________ 3-44




addul__________________________________________________________ 3-47

Syntax ______________________________________________________ 3-47




addup_________________________________________________________ 3-48

Syntax ______________________________________________________ 3-48




addusa ________________________________________________________ 3-51

Syntax ______________________________________________________ 3-51




addvault (DV)__________________________________________________ 3-53

Syntax ______________________________________________________ 3-53




Contents-xii Vault Command Reference

Example ____________________________________________________ 3-53

addvlist (DV) ___________________________________________________ 3-54

Syntax ______________________________________________________ 3-54




Example ____________________________________________________ 3-54

addvlmem (DV)________________________________________________ 3-55

Syntax ______________________________________________________ 3-55




Example ____________________________________________________ 3-55

admcopy______________________________________________________ 3-56

Syntax ______________________________________________________ 3-56




archive ________________________________________________________ 3-58

Syntax ______________________________________________________ 3-58




associat _______________________________________________________ 3-61

Syntax ______________________________________________________ 3-61



Requirements and Considerations____________________________ 3-63Attribute File Format ______________________________________ 3-63Audit Information_________________________________________ 3-63

Example ____________________________________________________ 3-63

chgadef (Binder)_______________________________________________ 3-64

Syntax ______________________________________________________ 3-64

Vault Command Reference Contents-xiii




chgag _________________________________________________________ 3-66

Syntax ______________________________________________________ 3-66




chgatrbs (Binder)_______________________________________________ 3-67

Syntax ______________________________________________________ 3-67For Binders Only __________________________________________ 3-67For Relationships Only_____________________________________ 3-67For Binders and Relationships ______________________________ 3-67

Required Keywords and Parameters __________________________ 3-68For Binders Only __________________________________________ 3-68For Relationships Only_____________________________________ 3-68For Binders and Relationships ______________________________ 3-68

Optional Keywords and Parameters __________________________ 3-69For Binders Only __________________________________________ 3-69


Examples ___________________________________________________ 3-69

chgattr ________________________________________________________ 3-70

Syntax ______________________________________________________ 3-70




Restrictions__________________________________________________ 3-71

Example ____________________________________________________ 3-71

chgcl __________________________________________________________ 3-72

Syntax ______________________________________________________ 3-72




chgctl _________________________________________________________ 3-73

Contents-xiv Vault Command Reference

Syntax ______________________________________________________ 3-73




chgdesc (Binder)_______________________________________________ 3-76

Syntax ______________________________________________________ 3-76For All Uses of the Command______________________________ 3-76For Binders Only __________________________________________ 3-76For or Enumerated Lists Only ______________________________ 3-76For Typedefs and Attribute Groups ________________________ 3-76For Attribute Groups Only _________________________________ 3-76For Relationships Only_____________________________________ 3-76

Required Keywords and Parameters__________________________ 3-77All Uses of the Command _________________________________ 3-77For Binders Only __________________________________________ 3-77For Enumerated Lists Only _________________________________ 3-77For Typedefs and Attribute Groups ________________________ 3-77For Attribute Groups Only _________________________________ 3-77For Relationships Only_____________________________________ 3-78

Optional Keywords and Parameters __________________________ 3-78All Uses of the Command _________________________________ 3-78

chgfa _________________________________________________________ 3-79

Syntax ______________________________________________________ 3-79

Required Keywords and Parameters__________________________ 3-79


Requirements and Special Considerations ____________________ 3-80Specifying Selection Scope _______________________________ 3-80Revision Codes ___________________________________________ 3-81Viewing Current Information ______________________________ 3-81Audit Information_________________________________________ 3-81

Restrictions__________________________________________________ 3-81

Example ____________________________________________________ 3-82

chgfcl _________________________________________________________ 3-83

Syntax ______________________________________________________ 3-83



Vault Command Reference Contents-xv

Requirements and Special Considerations ____________________ 3-84File Classification _________________________________________ 3-84Changing a File Classification _____________________________ 3-84Examples of Changing File Classification ___________________ 3-85Changing Revision codes _________________________________ 3-86Selection Scope __________________________________________ 3-86Audit Information _________________________________________ 3-86

Restrictions__________________________________________________ 3-86

Examples ___________________________________________________ 3-87

chgfpw ________________________________________________________ 3-89

Syntax ______________________________________________________ 3-89



Requirements and Special Considerations ____________________ 3-90Changing Revision Code _________________________________ 3-90

Restrictions__________________________________________________ 3-90

Example ____________________________________________________ 3-91

chgfrev ________________________________________________________ 3-92

Syntax ______________________________________________________ 3-92



Requirements and Special Considerations ____________________ 3-92Revision Codes ___________________________________________ 3-93Blank Revision Codes _____________________________________ 3-93

Example ____________________________________________________ 3-93

chgfsc _________________________________________________________ 3-94

Syntax ______________________________________________________ 3-94



Requirements and Special Considerations ____________________ 3-95Example of File Status Code Changes _____________________ 3-95Blank Revision Code ______________________________________ 3-96

Restrictions__________________________________________________ 3-96

Example ____________________________________________________ 3-97

chgfsp_________________________________________________________ 3-98

Contents-xvi Vault Command Reference

Syntax ______________________________________________________ 3-98




Example ____________________________________________________ 3-98

chgmas _______________________________________________________ 3-99

Syntax ______________________________________________________ 3-99




chgp _________________________________________________________ 3-100

Syntax _____________________________________________________ 3-100

Required Keywords and Parameters ________________________ 3-100


Requirements and Special Considerations ___________________ 3-101

chgs__________________________________________________________ 3-102

Syntax _____________________________________________________ 3-102




chgsps _______________________________________________________ 3-104

Syntax _____________________________________________________ 3-104



chgspt________________________________________________________ 3-105

Syntax _____________________________________________________ 3-105



chgu _________________________________________________________ 3-106

Syntax _____________________________________________________ 3-106



Vault Command Reference Contents-xvii


chguattr ______________________________________________________ 3-109

Syntax _____________________________________________________ 3-109



Requirements and Special Considerations ___________________ 3-111Attribute File Name ______________________________________ 3-111Attribute File Format _____________________________________ 3-111Selection Scopes that Include Multiple Files _______________ 3-112

Example ___________________________________________________ 3-112

chgup ________________________________________________________ 3-113

Syntax _____________________________________________________ 3-113




chgupw ______________________________________________________ 3-116

Syntax _____________________________________________________ 3-116




classify________________________________________________________ 3-117

Syntax _____________________________________________________ 3-117



Requirements and Considerations ___________________________ 3-119Audit Information ________________________________________ 3-119

Example ___________________________________________________ 3-119

clst ___________________________________________________________ 3-120

Syntax _____________________________________________________ 3-120




copy _________________________________________________________ 3-121

Contents-xviii Vault Command Reference

Syntax _____________________________________________________ 3-121



Requirements and Special Considerations ___________________ 3-122File Copy Attributes______________________________________ 3-122Revision Codes __________________________________________ 3-123Associated User-defined Attributes _______________________ 3-124COPY Command Messages______________________________ 3-124How the Name of the Copy is Determined ________________ 3-124Examples of Names of Copies____________________________ 3-124Audit Information________________________________________ 3-125

Restrictions_________________________________________________ 3-125

Example ___________________________________________________ 3-126

copyattr ______________________________________________________ 3-127

Syntax _____________________________________________________ 3-127



Example ___________________________________________________ 3-128

defagrp (Binder) ______________________________________________ 3-129

Syntax _____________________________________________________ 3-129




Example ___________________________________________________ 3-130

defatrb (Binder) _______________________________________________ 3-131

Syntax _____________________________________________________ 3-131

Required Keywords and Parameters_________________________ 3-132



Examples __________________________________________________ 3-133

defenum (Binder) _____________________________________________ 3-134

Syntax _____________________________________________________ 3-134



Vault Command Reference Contents-xix


Example ___________________________________________________ 3-134

defotype (Binder) _____________________________________________ 3-135

Syntax _____________________________________________________ 3-135




Example ___________________________________________________ 3-135

deladef (Binder) ______________________________________________ 3-136

Syntax _____________________________________________________ 3-136




delag_________________________________________________________ 3-137

Syntax _____________________________________________________ 3-137


Restrictions_________________________________________________ 3-137

Reference _________________________________________________ 3-137

delagrp (Binder) ______________________________________________ 3-138

Syntax _____________________________________________________ 3-138




delaset _______________________________________________________ 3-139

Syntax _____________________________________________________ 3-139




delatrbs (Binder) ______________________________________________ 3-140

Syntax _____________________________________________________ 3-140For Binders Only _________________________________________ 3-140For Relationships Only____________________________________ 3-140For Binders and Relationships _____________________________ 3-140

Contents-xx Vault Command Reference

Required Keywords and Parameters_________________________ 3-141For Binders Only _________________________________________ 3-141For Relationships Only____________________________________ 3-141For Binders and Relationships_____________________________ 3-141



Examples __________________________________________________ 3-142

delattr ________________________________________________________ 3-143

Syntax _____________________________________________________ 3-143




delcl _________________________________________________________ 3-144

Syntax _____________________________________________________ 3-144



Restrictions_________________________________________________ 3-144

Reference _________________________________________________ 3-144

delenum (Binder) _____________________________________________ 3-145

Syntax _____________________________________________________ 3-145




Example ___________________________________________________ 3-145

delete ________________________________________________________ 3-146

Syntax _____________________________________________________ 3-146




Restriction _________________________________________________ 3-147

Reference_________________________________________________ 3-147

delevals (Binder) ______________________________________________ 3-148

Syntax _____________________________________________________ 3-148

Vault Command Reference Contents-xxi




Restriction__________________________________________________ 3-148

Example ___________________________________________________ 3-148

dellog ________________________________________________________ 3-149

Syntax _____________________________________________________ 3-149



Reference _________________________________________________ 3-150

delobj (Binder) ________________________________________________ 3-151

Syntax _____________________________________________________ 3-151




delotype (Binder) _____________________________________________ 3-152

Syntax _____________________________________________________ 3-152




delov _________________________________________________________ 3-153

Syntax _____________________________________________________ 3-153



Reference _________________________________________________ 3-153

delp __________________________________________________________ 3-154

Syntax _____________________________________________________ 3-154



Restrictions_________________________________________________ 3-154

Reference _________________________________________________ 3-154

delrel (Binder) _________________________________________________ 3-155

Contents-xxii Vault Command Reference

Syntax _____________________________________________________ 3-155




delrs __________________________________________________________ 3-156

Syntax _____________________________________________________ 3-156



Restrictions_________________________________________________ 3-156

Reference _________________________________________________ 3-156

delrule________________________________________________________ 3-157

Syntax _____________________________________________________ 3-157



dels __________________________________________________________ 3-158

Syntax _____________________________________________________ 3-158




Restrictions_________________________________________________ 3-158

delsub (DV) ___________________________________________________ 3-159

Syntax _____________________________________________________ 3-159




delu __________________________________________________________ 3-160

Syntax _____________________________________________________ 3-160



Restrictions_________________________________________________ 3-160

delul _________________________________________________________ 3-161

Syntax _____________________________________________________ 3-161

Vault Command Reference Contents-xxiii



Restrictions_________________________________________________ 3-161

export (DV) ___________________________________________________ 3-162

Syntax _____________________________________________________ 3-162




Example ___________________________________________________ 3-163

get ___________________________________________________________ 3-164

Syntax _____________________________________________________ 3-164



Requirements and Special Considerations ___________________ 3-165Revision Code___________________________________________ 3-166Name of Selection in Your Local Storage Area ____________ 3-166Audit Information ________________________________________ 3-166Local File Name _________________________________________ 3-167User Defined Attributes___________________________________ 3-167Attribute File Name ______________________________________ 3-167Attribute File Format _____________________________________ 3-167Selection Scopes that Include Multiple Files _______________ 3-167Issuing get on a List ______________________________________ 3-168Contents of the List File __________________________________ 3-168Syntax Rules for List Files __________________________________ 3-169

Restrictions_________________________________________________ 3-169Executing the GET Command Twice on the Same File _____ 3-169Files That Cannot be Transferred__________________________ 3-169When files are Not Available _____________________________ 3-169

Recommendations _________________________________________ 3-170

Example ___________________________________________________ 3-170

help __________________________________________________________ 3-171

Syntax _____________________________________________________ 3-171

Command-Line Format and Example________________________ 3-171

ibkup _________________________________________________________ 3-172

Contents-xxiv Vault Command Reference

Syntax _____________________________________________________ 3-172



Requirements and Special Considerations ___________________ 3-172IBKUP and DELOV________________________________________ 3-175

import (DV) ___________________________________________________ 3-176

Syntax _____________________________________________________ 3-176




iqf ____________________________________________________________ 3-178

Syntax _____________________________________________________ 3-178



listdict (Binder) ________________________________________________ 3-179

Syntax _____________________________________________________ 3-179




Examples __________________________________________________ 3-180

Predefined Select Items by Base Class _______________________ 3-180

listdir _________________________________________________________ 3-188

Syntax _____________________________________________________ 3-188



Requirements and Special Considerations ___________________ 3-189List Format ______________________________________________ 3-190Audit Information________________________________________ 3-190

liststru (Binder) ________________________________________________ 3-191

Syntax _____________________________________________________ 3-191




Vault Command Reference Contents-xxv

load __________________________________________________________ 3-192

Syntax _____________________________________________________ 3-192



Requirements and Special Considerations ___________________ 3-194Tape Format ____________________________________________ 3-194File Names ______________________________________________ 3-194Replacing Files __________________________________________ 3-194File Properties ___________________________________________ 3-195Other File Information____________________________________ 3-195Loading Tape Contents __________________________________ 3-195Audit Information ________________________________________ 3-195

Example ___________________________________________________ 3-195

locate (DV) ___________________________________________________ 3-196

Syntax _____________________________________________________ 3-196




Example ___________________________________________________ 3-197

marka ________________________________________________________ 3-198

Syntax _____________________________________________________ 3-198



Requirements and Special Considerations ___________________ 3-198Why Files Are Marked ____________________________________ 3-199Which Files Can be Marked ______________________________ 3-199Marking Files ____________________________________________ 3-200Marking Parts____________________________________________ 3-200Marking Projects_________________________________________ 3-200Marking File Set__________________________________________ 3-200Revision Code of Marked Files____________________________ 3-200Marking Password-Protected Files ________________________ 3-200Audit Information ________________________________________ 3-201

Restrictions_________________________________________________ 3-201

Examples __________________________________________________ 3-201

markd ________________________________________________________ 3-202

Contents-xxvi Vault Command Reference

Syntax _____________________________________________________ 3-202



Requirements and Special Considerations ___________________ 3-202Marking Parts ___________________________________________ 3-203Marking Projects_________________________________________ 3-203Revision Code of Marked Files____________________________ 3-203Marking Password-Protected Files ________________________ 3-204Audit Information________________________________________ 3-204

Restrictions_________________________________________________ 3-204

Example ___________________________________________________ 3-204

markr _________________________________________________________ 3-205

Syntax _____________________________________________________ 3-205



Requirements and Special Considerations ___________________ 3-205Marking Projects_________________________________________ 3-206Marking File Set _________________________________________ 3-206Revision Code of Marked Files____________________________ 3-206Marking Password-Protected Files ________________________ 3-206Audit Information________________________________________ 3-206

Restrictions_________________________________________________ 3-207

Examples __________________________________________________ 3-207

opnt__________________________________________________________ 3-208

Syntax _____________________________________________________ 3-208




purge ________________________________________________________ 3-209

Syntax _____________________________________________________ 3-209




read__________________________________________________________ 3-211

Syntax _____________________________________________________ 3-211

Vault Command Reference Contents-xxvii



Requirements and Special Considerations ___________________ 3-213Saving Your Modifications________________________________ 3-213Copying Signed Out Files ________________________________ 3-213File Names in Vault and Your Local Storage Area__________ 3-213Local File Name _________________________________________ 3-213User-Defined Attributes __________________________________ 3-214Attribute File Name ______________________________________ 3-214Attribute File Format _____________________________________ 3-214Selection Scopes that Include Multiple Files _______________ 3-214Files Marked for Deletion _________________________________ 3-215Deleting a Local File _____________________________________ 3-215Issuing READ on a List ____________________________________ 3-215Contents of the List File __________________________________ 3-215Syntax Rules for List Files __________________________________ 3-216

Example ___________________________________________________ 3-216

readattr ______________________________________________________ 3-217

Syntax _____________________________________________________ 3-217



Requirements and Considerations ___________________________ 3-218Attribute File Output _____________________________________ 3-218Example ________________________________________________ 3-218

readmsg ______________________________________________________ 3-219

Syntax _____________________________________________________ 3-219



Requirements and Special Considerations ___________________ 3-219Responding to a Message with the Command-LineFormat __________________________________________________ 3-220Types of Messages_______________________________________ 3-220

recsf__________________________________________________________ 3-221

Syntax _____________________________________________________ 3-221



Contents-xxviii Vault Command Reference


recsp _________________________________________________________ 3-224

Syntax _____________________________________________________ 3-224



Requirements and Special Considerations ___________________ 3-224Conditions of Files After Executing RECSP _________________ 3-225Using Local Copies to Recreate Latest Versions ___________ 3-226Examples of the RECSP Audit File _________________________ 3-227

register (DV) __________________________________________________ 3-231

Syntax _____________________________________________________ 3-231



Requirements and Special Considerations ___________________ 3-232Prerequisites ____________________________________________ 3-232Considerations __________________________________________ 3-232Registering Parts_________________________________________ 3-232Unregistering Vault Objects ______________________________ 3-233

Example ___________________________________________________ 3-233

remadod (DV) ________________________________________________ 3-234

Syntax _____________________________________________________ 3-234




Example ___________________________________________________ 3-234

remalias (DV) _________________________________________________ 3-235

Syntax _____________________________________________________ 3-235




Example ___________________________________________________ 3-235

remfs _________________________________________________________ 3-236

Syntax _____________________________________________________ 3-236


Vault Command Reference Contents-xxix



remmas_______________________________________________________ 3-237

Syntax _____________________________________________________ 3-237




remmfs _______________________________________________________ 3-238

Syntax _____________________________________________________ 3-238




remmul _______________________________________________________ 3-239

Syntax _____________________________________________________ 3-239




remt __________________________________________________________ 3-240

Syntax _____________________________________________________ 3-240




remuattr ______________________________________________________ 3-241

Syntax _____________________________________________________ 3-241



Requirements and Special Considerations ___________________ 3-242Attribute File Name ______________________________________ 3-242Attribute File Format _____________________________________ 3-243Selection Scopes that Include Multiple Files _______________ 3-243

Example ___________________________________________________ 3-243

remup ________________________________________________________ 3-244

Syntax _____________________________________________________ 3-244

Contents-xxx Vault Command Reference




remusa _______________________________________________________ 3-245

Syntax _____________________________________________________ 3-245




remvault (DV) _________________________________________________ 3-246

Syntax _____________________________________________________ 3-246




Example ___________________________________________________ 3-246

remvlist (DV) __________________________________________________ 3-247

Syntax _____________________________________________________ 3-247




Example ___________________________________________________ 3-247

remvlmem (DV) _______________________________________________ 3-248

Syntax _____________________________________________________ 3-248




Example ___________________________________________________ 3-248

replace_______________________________________________________ 3-249

Syntax _____________________________________________________ 3-249



Requirements and Special Considerations ___________________ 3-250User-Defined Attributes __________________________________ 3-250Attribute File ____________________________________________ 3-250

Vault Command Reference Contents-xxxi

Attribute File Format _____________________________________ 3-251Setting the $$COPYATTRS parameter _____________________ 3-251Selection Scopes that Include Multiple Files _______________ 3-252Audit Information ________________________________________ 3-252Replacing a Part ________________________________________ 3-252Replacing a File Set______________________________________ 3-252Replacing a List _________________________________________ 3-253Contents of the List File __________________________________ 3-253Syntax Rules for List File___________________________________ 3-254

Restrictions_________________________________________________ 3-254

Example ___________________________________________________ 3-254

reqrvw________________________________________________________ 3-255

Syntax _____________________________________________________ 3-255




reserve _______________________________________________________ 3-257

Syntax _____________________________________________________ 3-257



Requirements and Special Considerations ___________________ 3-258Using STORE on a Reserved File Name ____________________ 3-258Reserving a File Name with SIGNOUT______________________ 3-259Signing Out the File Name _______________________________ 3-259Changing Reserved File Name Attributes _________________ 3-259Deleting a Reserved File Name ___________________________ 3-259

Example ___________________________________________________ 3-260

reset__________________________________________________________ 3-261

Syntax _____________________________________________________ 3-261




RESET and SIGNOUT Commands _____________________________ 3-262

REPLACE and UPDATE Commands___________________________ 3-262Unlocking a Binder_______________________________________ 3-262Audit Information ________________________________________ 3-262

Contents-xxxii Vault Command Reference

Restrictions_________________________________________________ 3-262

Example ___________________________________________________ 3-263

restore________________________________________________________ 3-264

Syntax _____________________________________________________ 3-264



Requirements and Special Considerations ___________________ 3-265For archived files whose status code is in-work: ____________ 3-265For archived files whose status code is released: __________ 3-265

rsvp __________________________________________________________ 3-267

Syntax _____________________________________________________ 3-267




scantape _____________________________________________________ 3-269

Syntax _____________________________________________________ 3-269



Requirements and Special Considerations ___________________ 3-269Tape Types______________________________________________ 3-270Output File (SCANTAPE.EDMAUDIT) __________________________ 3-270

sendmsg______________________________________________________ 3-271

Syntax _____________________________________________________ 3-271




signoff ________________________________________________________ 3-272

Syntax _____________________________________________________ 3-272


Reference _________________________________________________ 3-272

signon ________________________________________________________ 3-273

Syntax _____________________________________________________ 3-273


Vault Command Reference Contents-xxxiii



signout _______________________________________________________ 3-274

Syntax _____________________________________________________ 3-274



Requirements and Special Considerations ___________________ 3-275Revision Code___________________________________________ 3-275Executing SIGNOUT ______________________________________ 3-275Audit Information ________________________________________ 3-276Modifying Files___________________________________________ 3-276Modification Access By Other Users_______________________ 3-276Signout of a Binder ______________________________________ 3-276Restrictions ______________________________________________ 3-277

Example ___________________________________________________ 3-277

store__________________________________________________________ 3-278

Syntax _____________________________________________________ 3-278



Requirements and Special Considerations ___________________ 3-280Signing Out a File When You Store It ______________________ 3-280Rules for Using the STORE Command______________________ 3-281Local File Name _________________________________________ 3-281Application Environment _________________________________ 3-282Specifying Selection Scope ______________________________ 3-282Storing CADDS Parts _____________________________________ 3-283Storing Directories _______________________________________ 3-283Authority Information ____________________________________ 3-284Storing a List_____________________________________________ 3-285Contents of the List File __________________________________ 3-285Syntax Rules for List Files __________________________________ 3-285File Password ____________________________________________ 3-286Optional Information ____________________________________ 3-286Attribute File Name ______________________________________ 3-286Attribute File Format _____________________________________ 3-286Selection Scopes that Include Multiple Files _______________ 3-287What is a Part? __________________________________________ 3-287

Contents-xxxiv Vault Command Reference

Storing New Parts________________________________________ 3-288

Rules for Adding a New File to an Existing Part _______________ 3-288Selection Scope and Signout Parameters _________________ 3-288Vault File Name _________________________________________ 3-289Revision Codes __________________________________________ 3-289Part Attributes ___________________________________________ 3-290File Types _______________________________________________ 3-290

Example ___________________________________________________ 3-290

ubkup ________________________________________________________ 3-291

Syntax _____________________________________________________ 3-291



Prerequisites _______________________________________________ 3-293

Requirements and Special Considerations ___________________ 3-293Cleaning the BackUp Table ______________________________ 3-294The Audit Trial File (ubkup.edmaudit)_______________________ 3-294


Restrictions_________________________________________________ 3-295

unload _______________________________________________________ 3-296

Syntax _____________________________________________________ 3-296



Requirements and Special Considerations ___________________ 3-298Transferring Files _________________________________________ 3-298Labeling Tapes __________________________________________ 3-298File Naming Conventions ________________________________ 3-299

Restrictions_________________________________________________ 3-299


Reference _________________________________________________ 3-299

unmark _______________________________________________________ 3-300

Syntax _____________________________________________________ 3-300



Requirements and Special Considerations ___________________ 3-300Unmarking Partially Restored Parts ________________________ 3-301

Vault Command Reference Contents-xxxv

File Sets _________________________________________________ 3-301Audit Information ________________________________________ 3-301

Restrictions_________________________________________________ 3-301Unmarking Parts _________________________________________ 3-301

Examples __________________________________________________ 3-302

update _______________________________________________________ 3-303

Syntax _____________________________________________________ 3-303



Requirements and Special Considerations ___________________ 3-304User-Defined Attributes __________________________________ 3-304Attribute File Name ______________________________________ 3-305Attribute File Format _____________________________________ 3-305Selection Scopes that Include Multiple Files _______________ 3-305Audit Information ________________________________________ 3-306Issuing UPDATE on a List __________________________________ 3-306Contents of the List File __________________________________ 3-306Syntax Rules for List Files __________________________________ 3-307


Restrictions_________________________________________________ 3-307Updating Private Files ____________________________________ 3-307Updating Project Files____________________________________ 3-307

Example ___________________________________________________ 3-308

valatrbs (Binder)_______________________________________________ 3-309

Syntax _____________________________________________________ 3-309For Binders Only _________________________________________ 3-309For Binders and Relationships _____________________________ 3-309For Relationships Only____________________________________ 3-309

Required Keywords and Parameters _________________________ 3-310For Binders Only _________________________________________ 3-310For Binders and Relationships _____________________________ 3-310For Relationships Only____________________________________ 3-310


veruattr _______________________________________________________ 3-311

Syntax _____________________________________________________ 3-311


Contents-xxxvi Vault Command Reference


Requirements and Special Considerations ___________________ 3-311Attribute File Name ______________________________________ 3-311Attribute File Format _____________________________________ 3-312Audit Information________________________________________ 3-312

Example ___________________________________________________ 3-312

IQF CommandsOverview ________________________________________________________ 4-3

BACKWARD ______________________________________________________ 4-4

Syntax _____________________________________________________ 4-4Requirements and Special Considerations ___________________ 4-4Example ___________________________________________________ 4-4

BOTTOM _________________________________________________________ 4-5

Syntax _____________________________________________________ 4-5Requirements and Special Considerations ___________________ 4-5

BREAK ___________________________________________________________ 4-6


COLUMN ________________________________________________________ 4-8


EDIT _____________________________________________________________ 4-9

Syntax _____________________________________________________ 4-9Requirements and Special Considerations ___________________ 4-9Command-Line Format _____________________________________ 4-9

END ___________________________________________________________ 4-10

Syntax ___________________________________________________ 4-10

EXIT or QUIT ____________________________________________________ 4-11

Syntax ___________________________________________________ 4-11

FILE ____________________________________________________________ 4-12

Vault Command Reference Contents-xxxvii

Syntax ___________________________________________________ 4-12Requirements and Special Considerations _________________ 4-12Example _________________________________________________ 4-12

FORMAT _______________________________________________________ 4-13


FORWARD _____________________________________________________ 4-17


HELP ___________________________________________________________ 4-18

Syntax ___________________________________________________ 4-18Requirements and Special Considerations _________________ 4-18

LEFT ___________________________________________________________ 4-19


LIST ____________________________________________________________ 4-20


PRINT __________________________________________________________ 4-21


QUIT or EXIT ____________________________________________________ 4-22

Syntax ___________________________________________________ 4-22

RECALL ________________________________________________________ 4-23


RETRIEVE _______________________________________________________ 4-24

Syntax ___________________________________________________ 4-24

Contents-xxxviii Vault Command Reference

Requirements and Special Considerations _________________ 4-24Example _________________________________________________ 4-24

RIGHT__________________________________________________________ 4-25


RUN ___________________________________________________________ 4-26


SAVE __________________________________________________________ 4-27


SELECT_________________________________________________________ 4-28


SET ____________________________________________________________ 4-29


SHOW _________________________________________________________ 4-31


START __________________________________________________________ 4-32


TOP ___________________________________________________________ 4-34


TYPE ___________________________________________________________ 4-35

Syntax ___________________________________________________ 4-35

Vault Command Reference Contents-xxxix

Requirements and Special Considerations _________________ 4-35Example _________________________________________________ 4-35

Moving Vault Files to and from UNIXUsing Vault File Transfer Commands ______________________________ A-2

Audit Files ____________________________________________________ A-2

Storing UNIX Files and Parts_______________________________________ A-3

Storing a Single UNIX File ___________________________________ A-3Storing Custom Parts _______________________________________ A-3Deleting Local Files in the Process of Storing_________________ A-3

LFNAME Keyword_____________________________________________ A-3

SELNAME Keyword____________________________________________ A-4

Storing All Files in a UNIX Directory ________________________________ A-5

LFNAME Keyword_____________________________________________ A-5


Storing CADDS Files and Parts ____________________________________ A-7

LFNAME Keyword_____________________________________________ A-7


CADDS Attributes for CADDS Files _____________________________ A-9

Default CADDS Attributes for UNIX Files __________________________ A-10

Copying Vault Files to UNIX _____________________________________ A-11

SELNAME Keyword___________________________________________ A-11

Vault File Name Conversions with GET and READ ______________ A-11

File Names for CADDS and Non-CADDS Files __________________ A-11

Copying CADDS Files ________________________________________ A-11

Copying UNIX Files __________________________________________ A-12LFNAME Keyword _________________________________________ A-12

UNIX Names of Copied Files __________________________________ A-13

Artificial Names for Multiple File Transfer ______________________ A-13

Examples of File Name Conversion for GET and READ__________ A-14

Contents-xl Vault Command Reference

Command AbbreviationsVault Command Abbreviations ___________________________________ B-2

IQF Command Abbreviations _____________________________________ B-5

Using CADDS Commands to Access the VaultDatabase

Introduction to CADDS and Vault ________________________________ C-2

Starting the DBMS Process ____________________________________ C-2

Signing On to Vault from Within CADDS ________________________ C-2

CADDS Command Description Format ________________________ C-3Description________________________________________________ C-3Valid Modes ______________________________________________ C-3Syntax ____________________________________________________ C-3Modifiers __________________________________________________ C-3Examples _________________________________________________ C-3

Vault Commands in UNIX and CADDS _________________________ C-4

GET PART _______________________________________________________ C-7

Valid Modes _________________________________________________ C-7

Syntax _______________________________________________________ C-7Modifiers __________________________________________________ C-8

Examples ___________________________________________________ C-10GET PART WING __________________________________________ C-10GET PART WING READ A___________________________________ C-10

PUT PART_______________________________________________________ C-11

Valid Modes ________________________________________________ C-11

Syntax ______________________________________________________ C-12Modifiers _________________________________________________ C-12

Example ____________________________________________________ C-13PUT PART TEST.PART [CR] __________________________________ C-13

UPDATE PART___________________________________________________ C-14

Valid Modes ________________________________________________ C-14


Vault Command Reference Contents-xli

Example ____________________________________________________ C-15UPDATE PART TEST.PART ___________________________________ C-15

GET FILE________________________________________________________ C-16

Valid Modes ________________________________________________ C-16


Example ____________________________________________________ C-18GET FILE AA.HELP _________________________________________ C-18

PUT FILE ________________________________________________________ C-19

Valid Modes ________________________________________________ C-19


Examples ___________________________________________________ C-21PUT FILE HELP NEW PUBLIC SINGLE__________________________ C-21PUT FILE AA.HELP NEW PUBLIC _____________________________ C-21

GET FILESET _____________________________________________________ C-22

Valid Modes ________________________________________________ C-22


Examples ___________________________________________________ C-23GET FILESET TESTFS3 READ AB_______________________________ C-23GET FILESET TESTFS3________________________________________ C-23

PUT FILESET _____________________________________________________ C-24

Valid Modes ________________________________________________ C-24


Examples ___________________________________________________ C-25PUT FILESET TESTFS3 ________________________________________ C-25

Quick Reference for Vault Commands in CADDS_________________ C-26

PUT PART _________________________________________________ C-26GET PART_________________________________________________ C-26UPDATE PART _____________________________________________ C-26GET FILE __________________________________________________ C-26PUT FILE __________________________________________________ C-27GET FILESET _______________________________________________ C-27

Contents-xlii Vault Command Reference

PUT FILESET _______________________________________________ C-27

Glossary

Vault Command Reference xliii

Preface

Vault Command Reference is for experienced users. It provides alphabeticalreference information for all the Vault and Distributed Vault server and clientcommands and the Interactive Query Facility (IQF) commands. Commanddescriptions assume your familiarity with the use of the Optegra Vault Software.

Vault is part of the object-oriented solutions for Enterprise Data Management(EDM). Vault uses a client-server architecture to provide cost-effective datamanagement and release management capabilities to workstation and PC users.

The full screen character-based menu of commands is no longer supported inVault. You must use the command line of the Power interface.

Related Documents

The following documents may be helpful as you use Vault Command Reference:

• Vault Manager Guide

• Vault System Administrator Guide

• Vault Interactive Query Facility Guide

Preface

xliv Vault Command Reference

Book Conventions

The following table illustrates and explains conventions used in writing aboutOptegra applications.

Convention Example Explanation

EPD_HOME cd $EPD_HOME/install(UNIX)

cd %EPD_HOME%\install(Windows)

Represents the default path where the currentversion of the product is installed.

Menu selections Vault > Check Out > Lock Indicates a command that you can choose froma menu.

Command buttons andoptions

Mandatory check box, Add button,Description text box

Names selectable items from dialog boxes:options, buttons, toggles, text boxes, andswitches.

User input and code Wheel_Assy_details

-xvf /dev/rst0

Enter command> plot_config

Enter the text in a text box or on a commandline.

Where system output and user input are mixed,user input is in bold.

System output CT_struct.aename Indicates system responses.

Parameter and variablenames

tar -cvf /dev/rst0 filename Supply an appropriate substitute for eachparameter or variable; for example, replacefilename with an actual file name.

Commands and keywords The ciaddobj command creates aninstance of a binder.

Shows command syntax.

Text string "SRFGROUPA" or ’SRFGROUPA’ Shows text strings. Enclose text strings withsingle or double quotation marks.

Integer n Supply an integer for n.

Real number x Supply a real number for x.

# # mkdir /cdrom Indicates the root (superuser) prompt oncommand lines.

% % rlogin remote_system_name-lroot

Indicates the C shell prompt on commandlines.

$ $ rlogin remote_system_name -lroot

Indicates the Bourne shell prompt on commandlines.

> > copy filename Indicates the MS-DOS prompt on commandlines.

Keystrokes Return or Control-g Indicates the keys to press on a keyboard.

Preface

Vault Command Reference xlv

Online User Documentation

Online documentation for each Optegra book is provided in HTML if thedocumentation CD-ROM is installed. You can view the online documentation froman HTML browser or from the HELP command.

You can also view the online documentation directly from the CD-ROM withoutinstalling it.

From an HTML Browser:

1. Navigate to the directory where the documents are installed. For example,

$EPD_HOME/data/html/htmldoc/ (UNIX)

%EPD_HOME%\data\html\htmldoc\ (Windows NT)

2. Click mainmenu.html. A list of available Optegra documentation appears.

3. Click the book title you want to view.

From the HELP Command:

To view the online documentation for your specific application, click HELP.(Consult the documentation specific to your application for more information.)

From the Documentation CD-ROM:

1. Mount the documentation CD-ROM.

2. Point your browser to:

CDROM_mount_point/htmldoc/mainmenu.html (UNIX)

CDROM_Drive:\htmldoc\mainmenu.html (Windows NT)

Printing Documentation

A PDF (Portable Document Format) file is included on the CD-ROM for eachonline book. See the first page of each online book for the document numberreferenced in the PDF file name. Check with your system administrator if you needmore information.

You must have Acrobat Reader installed to view and print PDF files.

The default documentation directories are:

• $EPD_HOME/data/html/pdf/doc_number.pdf (UNIX)

• %EPD_HOME%\data\html\pdf\doc_number.pdf (Windows NT)

Preface

xlvi Vault Command Reference

Resources and Services

For resources and services to help you with PTC (Parametric TechnologyCorporation) software products, see the PTC Customer Service Guide. It includesinstructions for using the World Wide Web or fax transmissions for customersupport.

Documentation Comments

PTC welcomes your suggestions and comments. You can send feedbackelectronically to [email protected].

Vault Command Reference 1-1

Chapter 1 Description of Commands

This chapter provides a brief description of each Vault and IQF commands.

• Vault Commands

• IQF Commands

Description of CommandsVault Commands

1-2 Vault Command Reference

Vault Commands

Vault commands are listed and defined below in alphabetical order by functionalgroup.

Figure “Command Hierarchy for Vault Administration Command,” on page 1-11,shows the relationships among the Vault commands and the menus from whichyou choose them.

Please note: You can purchase Distributed Vault separately.

Brief definitions of the IQF commands appear at the end of this chapter. See “IQFCommands” on page 1-13.

Attribute Administration Commands

Authority Group Commands

Command Description

ADDASET Adds an attribute set

ADDATTR Adds an attribute

ADDMAS Adds a member to an attribute set

ADDRULE Adds a rule for applying attributes

CHGATTR Associates file/part attributes to a unit of measure or protectionmechanism to files or parts attributes

CHGMAS Changes specification of an attribute

DELASET Deletes an attribute set

DELATTR Deletes an attribute

DELRULE Deletes a rule

REMMAS Removes a member from an attribute set

Command Description

ADDAG Adds an authority group to Vault

CHGAG Changes entries in an authority group

DELAG Deletes an authority group from Vault



Binder Administration Commands

Binder Commands

Command List Commands

Command Description

ADDATRBS Adds attributes

ADDEVALS Adds enumeration values to an enumeration list

CHGADEF Changes an attribute definition

DEFAGRP Defines an attribute group

DEFATRB Adds an attribute to an existing attribute group

DEFENUM Defines a set of enumerated values for use with attributes

DEFOTYPE Defines an object type based on a predefined base class

DELADEF Deletes an attribute from an existing attribute class

DELAGRP Deletes an attribute group definition and correspondingdatabase table

DELATRBS Deletes attribute group instances

DELEVALS Deletes values from an enumeration list

DELOTYPE Deletes an object type definition by base class and object type

Command Description

ADDOBJ Creates an instance of a binder

ADDREL Relates an object instance

CHGATRBS Changes attribute values

CHGDESC Changes the description of the object

DELOBJ Deletes an object instance and its attributes

DELREL Deletes a relationship instance

LISTSTRU Provides a tree hierarchy for the named object

VALATRBS Validates attributes on an object or a relationship without storingthem

Command Description

ADDCL Adds a command list to Vault

CHGCL Changes entries in a command list

DELCL Deletes a command list from Vault



Database Maintenance Commands

Distributed Vault Administrative Commands


Distributed Vault Commands


Command Description

CHGCTL1 Changes command trigger attributes

DELOV Deletes old versions of files

IBKUP Backs up new and modified files

RECSF Recovers a single file

UBKUP Backs up the entire database

1You must have Programming installed to use this command.

Command Description

ADDADOD Makes a Distributed Object Directory known to the local vault inthe DV environment

ADDALIAS Establishes a message designation for a user on each vault in thedistributed vault environment

ADDVAULT Identifies a vault as a participant vault to other vaults in thedistributed vault environment

ADDVLIST Creates a vault list distribute files and parts to multiple vaults in asingle transaction

ADDVLMEM Adds vault IDs to an existing vault list

REMADOD Removes an existing Distributed Object Directory from thedistributed environment

REMALIAS Removes an existing alias

REMVAULT Removes an existing vault from the distributed environment

REMVLIST Removes a vault list for use in the distribution of objects

REMVLMEM Removes a vault ID (member) from an existing vault list

Command Description

ADDSUB Establishes a relationship between an event and an action

DELSUB Deletes an existing subscription

EXPORT Copies registered objects from their source vault to the exportdirectory



IMPORT Transfers exported objects from the export directory of a remotevault to the importing vault

LOCATE Searches for objects within the distributed vault environment

REGISTER Makes objects accessible to users on selected remote vaults



Entry and Exit Commands

File Access Commands

Command Description

EDM Displays the SIGNON command screen

EXIT Returns you to the operating system, you remain signed on toVault

IQF Initiates an IQF session

QUIT Returns you to the operating system, you remain signed on toVault

SIGNON Signs on to Vault or to a different Vault ID

SIGNOFF Ends the current Vault session and exits Vault

Command Description

GET Signs out and copies file(s); modifications

allowed

LISTDIR Lists file(s) on local or remote Vault node

READ Copies file(s); modifications not allowed

REPLACE Saves modified file(s); ability to modify ends

RESERVE Defines and signs out an Vault file name for

future use

RESET Cancels signing out of file(s); changes are lost

SIGNOUT Signs out file(s) to modify; file(s) not copied

STORE Adds a new file(s) to Vault

UPDATE Saves modified file(s); continue modifications



File Maintenance Commands

File/Part Attribute Commands

Command Description

CHGFA Changes file(s) attributes

CHGFCL Changes file(s) classification

CHGFPW Changes file(s) password

CHGFREV Changes file(s) revision code

CHGFSC Changes file(s) status code

CHGFSP Changes file(s) storage pool

COPY Copies file(s) to new Vault file(s)

MARKA Marks file(s) to be archived

MARKD Marks file(s) to be deleted

MARKR Marks file(s) to be restored

UNMARK Unmarks previously marked files

Command Description

ASSOCIAT Associates user-defined attributes to files and parts withouttransferring the object.

CHGUATTR Changes the attribute data on a file or part without transferring theobject

CLASSIFY Evaluates the classification rules defined in the database andproduces a list of user-defined attributes you can associate to theobject

COPYATTR Copies the associated user-defined attributes from one file or partto another file or part

READATTR Reads the attributes associated to a file or part

REMUATTR Removes an associated attribute from an object

VERUATTR Verifies the attribute data by executing the data type rule for theattribute.



File Set Commands

Help Commands

Message Commands

Project Administration Commands

Command Description

ADDFS Adds a file set

ADDMFS Adds a member to a file set

REMFS Removes a file set

REMMFS Removes a member from a file set

Command Description

F1 (Function key 1) Displays help for the current screen

F2 (Function key 2) Displays help for the current message

HELP Displays help for the current screen

Command Description

READMSG Reads messages

SENDMSG Sends messages

Command Description

ADDP Adds a project to Vault

ADDUP Adds a user to a project

CHGP Changes the attributes of a project

CHGUP Changes a user’s project authority

DELP Deletes a project from Vault

REMUP Removes a user from a project



Release/Revision Control Commands

Revision Code Sequence Commands

Status Level Commands

Storage Pool Maintenance Commands

Command Description

ADDUSA Adds an association between a user list and a status code

REMUSA Removes an association between a user list and a statuscode

REQRVW Requests review of file(s)

RSVP Responds to a review request

Command Description

ADDRS Adds a revision sequence to Vault

DELRS Deletes a revision sequence from Vault

Command Description

ADDS Adds a status level to an authority scheme

CHGS Changes the attributes of a status level

DELS Deletes a status level from an authority scheme

Command Description

ADDSP Adds a storage pool to Vault

CHGSPS Changes storage pool status

CHGSPT Changes storage pool type

RECSP Recovers a storage pool



System Maintenance Commands

User Administration Commands

User-Defined Table Commands

User List Commands

Command Description

ARCHIVE Moves files marked for archiving from Vault to tape

DELETE Deletes files marked for deletion

DELLOG Deletes Vault audit log entries

LOAD Loads file(s) from tape to Vault

PURGE Deletes file(s) not previously marked for deletion

RESTORE Restores files from tape to Vault

SCANTAPE Lists the contents of an Vault tape

UNLOAD Unloads file(s) from Vault to tape

Command Description

ADDU Adds a user to Vault

ADMCOPY Copies administrative information

CHGU Changes an Vault user’s attributes and/or authority

CHGUPW Changes your Vault user password

DELU Deletes a user from Vault

Command Description

ADDT Adds a table to the control of Vault

CLST End your access to and cancels your privileges for a tablecontrolled by Vault

OPNT Opens a table previously added to the control of Vault

REMT Removes a table from the control of Vault

Command Description

ADDMUL Adds members to a user list

ADDUL Adds a user list name

DELUL Deletes a user list

REMMUL Removes a member from a user list



Vault Command Hierarchy

The following figure shows the command hierarchy of the Vault commands.

Figure 1-1 Command Hierarchy for Vault Administration Command



Figure 1-2 Command Hierarchy for Vault Database Commands

Description of CommandsIQF Commands


IQF Commands

The following table lists the IQF (Interactive Query Facility) Command Functions:

Command Function

BACKWARD Scrolls the display of the query result backward, toward its beginning

BOTTOM Scrolls the display of the query result so that the end is visible

BREAK Inserts one or more empty lines in the display of the query result

COLUMN Scrolls the display so that the specified column is the leftmost column

EDIT Allows you to type in multiple IQF commands and then execute them atthe same time

END Ends the display of a query result or help text; also ends your ability toenter multiple commands after executing the EDIT command

EXIT Terminates IQF, returns you to the Optegra menu from which youentered IQF if you are using the full screen format, or to the systemprompt if you are using the command line format

FILE Copies the query result to a local file

FORMAT Determines what the result of a query looks like

FORWARD Scrolls the display of the query result forward, toward its end

HELP Displays online documentation for IQF

LEFT Scrolls the display of the query result so that one or more columns tothe left of the current display are visible

LIST Displays the current query

PRINT Sends the result of the current query, or a query stored in a file, to thelocal printer

RECALL Retrieves the last successful SELECT command

RETRIEVE Retrieves the last command entered other than a RETRIEVE orRECALL command

RIGHT Scrolls the display of the query result so that one or more columns tothe right of the current display are visible

RUN Executes the current query

SAVE Copies the current query to a local file

SELECT Specifies the exact information you want to view and the tables fromwhich to extract the information

SET Assigns values to certain format parameters

SHOW Displays the current format parameter settings

START Executes the current query or a stored query

TOP Scrolls the display of the query result to the beginning

TYPE Displays the contents of a file containing IQF commands


Chapter 2 Using the Command-LineInterface

The Vault provides 90 commands to perform data management tasks. Manycommands include various options. This chapter explains how to execute Vaultcommands using the command-line interface.

• Background Information for Executing Commands

• Signing On Using the Command-Line Format

• Signing Off

• Viewing an Audit File

• Using the Command-Line Format

• Entering Commands on the Command Line

• Changing the Vault User Password

• Displaying Online Help

• Using the UNIX Email Trigger

Using the Command-Line InterfaceBackground Information for Executing Commands


Background Information for ExecutingCommands

The following is the information for executing Vault commands:

Command Authority

You can execute only those commands that are in the command list assigned toyour Vault user ID. If your site has not purchased all Vault software, somecommands might not be available.

In this book, it is assumed that you have the commands described available at yoursite and in your command list.

Using the Command-Line InterfaceSigning On Using the Command-Line Format


Signing On Using the Command-Line Format

You can choose command execution method but you must first sign on to Vaultwith a valid Vault user ID and password. The Vault administrator provides userswith this information and also informs them which commands are in theircommand list and which server they should access.

To sign on to Vault using the command-line format:

1. Use your operating system procedures to log on to your workstation or hostoperating system.

2. At your operating system prompt, enter the following command line,substituting your Vault user ID and password and press the processing key. OnSun workstations, you must use lowercase. On other systems you can useuppercase or lowercase.

For example:

cisignon userid=orvillewrigh userpw=kitty

The password appears on the screen as you type. The copyright message isdisplayed, followed by a message that the sign-on procedure was successfullyprocessed and the number of Vault messages that are currently being held foryou.

After the operating system prompt appears on your screen, you can execute Vaultor operating system commands.

CISIGNON Keywords

You can include two other keywords with the CISIGNON command. Both areoptional.

dmserver Keyword:

The DMSERVER keyword indicates which Vault server you want to access. Enterthe name of a Vault server or omit this parameter if you are using the defaultserver.

Using the Command-Line InterfaceSigning Off


Signing Off

Sign off the Vault when you have finished your work. After you end your sessionwith the SIGNOFF command, you cannot execute any Vault command until youagain sign on to the Vault.

To sign off Vault using the command-line format, enter cisignoff at the systemprompt. After you press the processing key, Vault displays the system prompt.

If you sign on to Vault with the SIGNON command, then log out of UNIX withoutexecuting the Vault SIGNOFF command, and subsequently log on to UNIX on thesame terminal as before and with the same UNIX user ID, you are still signed onto Vault. Execute the Vault SIGNOFF command before you log out of UNIX orcreate the line cisignoff in your .logout file. See Vault End User Guide forSIGNON and SIGNOFF command information.

Using the Command-Line InterfaceViewing an Audit File


Viewing an Audit File

When Vault executes a command that accesses files or changes file attributes, itcreates an audit file. For most commands, the audit file contains the informationlisted below for each file that was acted upon.

• Vault file name

• Vault revision code

• Message indicating what happened to the file

For commands that transfer files to local storage, the audit file also contains thelocal file name, including the full path name, that Vault created for the Vault file.

For a command that operates on multiple files, there is an entry for each individualfile transaction. In this way, you can verify that all the files you intended for theoperation were successfully processed.

There is one audit file for each command that generates an audit file. The name ofthe file has the format:

command.EDMAUDIT

For example, the name of the audit file for the ARCHIVE command is:

ARCHIVE.EDMAUDIT

When you execute a command that generates an audit file, there are twoparameters that allow you to determine what Vault does with the audit file.

Every command that generates an audit file has the following keywords:

output=file or messageappend=replace or append audit file?

Use OUTPUT to indicate whether you want Vault to store the audit information in afile or whether you only want to see a message about the success or failure of thetransaction on the screen.

Use APPEND to indicate whether you want to replace the existing audit file with thenew file or to append the new file to the existing file.

After you execute the command, use a local facility to view the audit file.

Using the Command-Line InterfaceUsing the Command-Line Format


Using the Command-Line Format

When you execute Vault commands using the command-line format, the samecommand names are entered with the addition of a ci prefix. For example, the getcommand becomes the ciget command with the command-line format.

To use the command-line format, signon to Vault so that Vault recognizes you as avalid user. At the operating system prompt, enter the command information. OnUNIX machines you must use lowercase for the command name. On othersystems you can use uppercase or lowercase. For example

cisendmsg userid=charles msgtext=hello

This example executes the sendmsg (send a message) command to send themessage HELLO to user CHARLES.

Learning Keywords for Commands

To execute a Vault command using the command-line format, you must know therequired keywords and acceptable values. Locate this information by

• Using online help for the command (see the next module for instructions)

• Reading the description for the command in user documentation

Following Format Rules

The following rules apply to each Vault command executed using thecommand-line format:

• Prefix the name of the command with ci.

• Type in a blank space following the command name.

• Enter required keywords in any order. For example, both the following entriesare correct:

cisendmsg userid=charles msgtext=hellocisendmsg msgtext=hello userid=charles

• Follow each keyword with an equals sign (=) and the parameter value. Do notinsert blank spaces on either side of the equals sign.

• Follow each parameter value with a comma or one or more blank spaces.

cisendmsg userid=charles msgtext=hellocisendmsg userid=charles,msgtext=hello



• Enclose in single quotation marks (’) a character string that contains blankspaces. Some operating systems have additional requirements for quotationmarks. See the chapter for your operating system in this book.

cisendmsg userid=charlesEDM> msgtext=‘how are you?’

• Omit a keyword when you want to use its default value. For example, both thefollowing entries are correct:

ciibkup tapeunit=tape1 tapenum=080888ciibkup tapenum=080888

• Include only those keywords that belong to that command. You must supply avalue for every keyword you include. The value cannot exceed the maximumlength allowed for that parameter.

• If you enter a keyword more than once in the same command, Vault uses the lastoccurrence of the keyword and ignores previous occurrences.

Using Other Conventions

Other conventions (such as how to enter multiple command lines) can depend onhow Vault is implemented on your operating system. See the chapter for youroperating system in this book.

Please note: Command-line format examples include a comma at the end ofany line that continues to the next line. Check the chapter for your operatingsystem in this book to learn whether you must include the comma or anotherspecial character.

You can enter commands interactively or use a batch processor to run them in thebackground.

Some tape commands can only process one tape for each execution of thecommand. This is because Vault cannot prompt you for more information. Youmust reenter the command.

Passwords do appear when you enter them using the command-line format.

After you execute a command with the command-line format, Vault displays theappropriate message on the screen.

In general, you must enclose in single quotation marks any input that containsspecial characters.

You cannot initiate the ci commands directly from the scripts directory.



For more information about using the command-line format, see the chapter foryour operating system in this book.

Case Sensitivity

Whether you can use uppercase and/or lowercase when executing

Vault commands depends on which command you are executing and whichoperating system and input format you are using.

Please note: For more information about case sensitivity for the platform youare using, see the chapter for your operating system in this book.

Determining Case for Vault File and Selection Names

Use the EDM.DEFAULTS file to determine whether or not Vault is case sensitivewith regard to selection names and Vault file names. That is, whether Vault readsboth uppercase and lowercase letters literally or converts all letters to uppercase.The default is to convert to uppercase. For more information about theEDM.DEFAULTS file, see the first chapter in either Vault System AdministratorGuide, Vault Manager Guide, or Vault End User Guide.

When you want Vault to read selection names and Vault file names literally, placethe entry below in the EDM.DEFAULTS file. EDMCASE applies only to selectionnames and Vault file and part names. It does not apply to local file names.

edmcase=mixed

Using the Return, Arrow, and Function Keys

If you are entering Vault commands from a UNIX operating system, you musttake into account the workstation keyboard and the way UNIX treats your input.

When you use the command-line format to enter Vault commands, the functionsperformed using the keypad keys are exactly the same as UNIX.

To use the function keys

• Press the required key.

OR

• Enter the key number at the FUNCTION> prompt, then press return.

Please note: More information on Vault function keys can be found in theprevious chapter.



The table below shows which keys map to Vault function keys on a UNIXworkstation.

Running Vault Commands in the Background

As with any UNIX command, you can run Vault commands in the backgroundwhile you work on something else. To run a Vault command in the background,enter an ampersand (&) at the end of the command line. For example,

% ciget selscope=c selname=tailcat lfname=amelia filepw=tailpwcat level=2 datecrit=s date=01/01/88 output=f append=a &%

Table 2-1 Vault Function Keys on UNIX Workstations

Vault Function Key UNIX Function Key

F1 or ESC1 F1, R1

F2 or ESC2 F2, R2

F3 or ESC3 F3, R3

F4 or ESC4 F4, R4

F5 or ESC5 F5, R5

F6 or ESC6 F6, R6

F7 or ESC7 F7, R7

F8 or ESC8 F8, R8

F9 or ESC9 F9, R9

Using the Command-Line InterfaceEntering Commands on the Command Line


Entering Commands on the Command Line

You can enter Vault commands using the command-line format.

To enter commands using the command-line format, separate keywords by acomma or a space. For example, to sign on to Vault, a user whose Vault user ID isCHARLES can type

% cisignon userid=charles,userpw=chuckpw

You can also enter the Vault command without specifying any keywords on thecommand line. Vault prompts you for the keywords with the interactive prompt(EDM>), as shown below.

% cisignon RETURNEDM> userid=charles,userpw=chuckpw RETURN

Please note: You can enter no more than 255 characters on a UNIXcommand line. If you are entering a Vault command line that can exceed this limit,enter only the command and press the RETURN key. You can then type thekeywords and their values at the EDM> prompt.

You can enter keywords for Vault commands in any order. For example, thefollowing command lines are identical to Vault:

% ciaddalias userid=Carl vaultid=vaultB% ciaddalias vaultid=vaultB userid=Carl

Using Single Quotation Marks in a Vault Command Line

A few Vault keywords accept data with embedded spaces or commas, such data isusually contained in descriptive fields. Vault requires that you enclose data withembedded spaces in single quotation marks (’) as shown below.

% ciaddfs “fsname=engine fsdesc=‘Set 2 contains engine parts.’”

Using Special Characters for File Transfer Commandsat a Command Prompt on Windows NT

To carry out file transfer commands such as store and get on a productstructure file on Windows NT, where the file name contains special characterssuch as an ampersand (&), enclose the file name with a backslash (\) as shownbelow:

C:\>cistore lfname=\"c: testps10.&ps\" selname=\"TESTPS1.&PS\"selscope=f env=cadds CDMSTR1721 The file has been stored.



Using Special Characters for File Transfer atthe Command Line on UNIX

To pass quotation marks and other special characters to the Vault command parserfrom the command line, you must use the escape sequence, \ (backslash). Thequotation mark is necessary when passing a string with spaces. Other specialcharacters that require the escape sequence are &, ", *, (, ), \, |, `, [, ], ;, <, >,and ?.

To pass a single quotation mark ' as a part of the string, the Vault parser requirestwo single quotation marks. For example, to specify the command shown in thefirst line, you must type the string as shown in the second line:

cistore lfname=tara6 filedesc='feet 5' and inches 8".'cistore lfname=tara6 filedesc=\'feet 5\'\' and inches 8\".\'

The single quotation mark after feet 5 is a part of the string, while the singlequotation mark at the beginning and end of the description are the string markers.

The special characters that do not require the escape sequence are @, !, #, $, %, ^,-, /, ~, {, }, :, ,, ., and =.

Continuing a Vault Command Line

UNIX treats your input as one line until you press the RETURN key. If a Vaultcommand line is longer than one screen line, you can type the entire line, allowingit to wrap at the end of each screen line.

Press RETURN at the end of the command line (not at the end of each screen line)as shown below:

% ciget selscope=c selname=tailcat lfname=amelia filepw=tailpwcat level=2 datecrit=s date=01/01/88 output=f append=a RETURN

You can also continue a Vault command line by entering a hyphen (-) or a comma(,) before you press RETURN. These characters elicit the EDM> prompt, allowingyou to enter more keywords on the next line.

Example:

% cisignon userid=charles - RETURNEDM> userpw=chuckpw RETURN

Please note: When you use the hyphen command continuation character atthe UNIX or the EDM> prompt, enter a space before the hyphen if the next line canbegin with a new word.



After you elicit the EDM> prompt, typing a hyphen or a comma can return the EDM>prompt. You can use both command line continuation characters, as shown below:

% cisignon userid=charles - RETURNEDM> userpw=chuckpw, RETURNEDM> dmserver=styx - RETURNEDM> menuprof=y RETURN

The hyphen and comma in any combination produce the same result.

If you omit the hyphen or the comma, an error message indicates that aninsufficient number of keywords has been entered.

To correct typing errors, use the control keys the same as when entering UNIXcommand lines.

Using Uppercase and Lowercase

Enter Vault commands and keywords in uppercase or lowercase. Some values canbe stored in mixed-case. All Vault commands entered at the UNIX prompt must belowercase.

Case Translation

When you use the command-line format, enter Vault command names inlowercase. For example

• CISTORE, Cistore, and ciStore are all unacceptable

• cistore is the only acceptable form

Enter keywords and keyword values in uppercase or lowercase letters. Vaultconverts keywords and most keyword values to uppercase letters. However, certainkeyword values are stored in mixed-case or lowercase letters if you enter them thatway on the UNIX command line.

Vault Keyword Values That Can Be Stored in Mixed Case

The names of most Vault objects (such as user IDs, project IDs, passwords,authority group names, command list names, file set names) are stored inuppercase, whether or not you enter them in lowercase or mixed-case letters.



The exceptions to this rule include:

• User-defined input parameters (listed in the Vault Manager Guide). These inputparameters are optional descriptive fields.

• The MSGTEXT keyword value used with the sendmsg command to send amessage to another Vault user (described in Vault End User Guide).

• The AENAME keyword value used for command triggering (described in VaultProgrammer Guide).

• Names given to files stored in Vault with store, load, reserve, or copy (describedin Vault End User Guide).

Storing Vault File Names in Mixed Case

When you store a file without specifying a Vault file name (SELNAME keyword),the Vault file name defaults to the local file name (LFNAME keyword) exactly asyou entered it except for case. When you store a file in Vault with a name differentfrom the local file name, Vault stores that name in uppercase.

To stop automatic conversion of Vault file names from lowercase (or mixed case)to uppercase, you can add the entry below to the EDM.DEFAULTS file. This entryallows you to create mixed-case Vault file names.

edmcase=mixed

Please note: For a list of other Vault default values that can be set in theEDM.DEFAULTS file, see the Vault Administrator Guide.

The EDM.DEFAULTS file for site-wide variables is located in the$EPD_HOME/data directory.

You can copy the EDM.DEFAULTS file to the $EPD_HOME/data directory oneach client node, and/or to each user’s home directory or current working directoryto allow for individualized defaults.

When you enter a Vault command, Vault checks the EDM.DEFAULTS file in thedata directory and then looks for an EDM.DEFAULTS file in the current workingdirectory. If it is not found in the current working directory, Vault looks in thehome directory.

If a variable is set in both the EDM.DEFAULTS file in the data directory and in thedefaults file in the current or home directory, Vault uses the value defined in thecurrent or home directory. All values set only in one of the locations are also used.



If the EDM.DEFAULTS file contains the entry EDMCASE=MIXED, the case of theVault file name you enter can be respected.

Example:

% cistore lfname=myfile selname=Personal

In this example, the UNIX file myfile is stored in Vault with the name Personal.

Selection Scope for CADDS Interface

The entries SELSCOPE(PS)=P, SELSCOPE(CAMU)=P in the EDM.DEFAULTS fileare only used by EPD.Connect. They identify the location of associated rulebasewhen PS and CAMU objects are listed from local disk.These entries are not usedwhen performing Vault operations.

PS and CAMU objects are stored in the Vault as FILE with env=CADDS andSELSCOPE=F.

Using the Command-Line InterfaceChanging the Vault User Password


Changing the Vault User Password

To change your Vault user password, use the CHGUPW command. You cannot useCHGUPW to change other users’ passwords.

You must enter your current password.

Please note: You cannot use the CHGUPW command if you have forgotten yourcurrent password. Instead, use the CHGU command. See Vault CommandReference.

The new password can have eight or fewer letters and numbers (no specialcharacters are permitted). You must enter a new password. You cannot leave thenew Vault user password field blank.

Your new Vault user password can be in effect the next time you sign on to Vault.

Example

Following is an example of using the Command-Line Format for chgupw

cichgupwEDM> userpw=old nuserpw=new

In this example, the password ‘old’ has changed to ‘new’.

Please note: Both the passwords are displayed.

Table 2-2 CHGUPW Parameters

Prompt Parameter Description

Current EDM user password=userpw Vault user password. Enter 8 or fewer lettersand/or numbers.

New EDM user password=nuserpw New Vault user password. Enter 8 or fewerletters and/or numbers.

Using the Command-Line InterfaceDisplaying Online Help


Displaying Online Help

Vault provides online help for commands and messages.

Displaying Command Help

You can display online help for the command-line format in three ways:

1. Enter the command name (remember the ci prefix) followed by a questionmark

Please note: Because the question mark (?) is a special character underUNIX, you cannot enter ci command ? to obtain online help for Vaultcommands, unless you precede the ? with a \ (backslash) to disable the meaning ofthe question mark (cistore \?). However, you can enter cicommand RETURNto elicit the EDM> prompt and then enter a question mark at the prompt.

For example,

% cigetEDM> ?help messages for the get command

OR

2. Enter the command name followed by the word help: cicommandname help

For example,

% ciget help

OR

3. Enter the cihelp command followed by the command name: cihelpcommandname

For example,

% cihelp get

Displaying Message Help

To display online message help, execute the CIHELP command followed by themessage identifier.

For example,

% cisendmsg msgtext=helloCDMSMG832E An EDM user ID and/or the name of a user list isrequired for this command. Please supply the needed information.

Using the Command-Line InterfaceDisplaying Online Help


% cihelp cdmsmg832eAn EDM user ID and/or the name of a a user list is required forthis command. Please supply the needed information.

EXPLANATION: The name of an EDM user ID and/or the name of a userlist is required for this command and one was not entered.

SYSTEM ACTION: The EDM command was not processed.

USER ACTION: Enter the name of an EDM user ID and/or the name of auser list in the appropriate fields(s) or keyword(s).

More About Message Help

For all messages, you see

• A redisplay of the message text

• An explanation of the displayed message

• What system action was taken

• What you should do in response to the message

Some Vault messages have variable fields in the message text. When the messageis issued, the variable fields are replaced with appropriate values to fully completethe message. When help is obtained for a message that contains variable fields,placeholders (&1, &2, and so forth) or the names of the variable fields (rc, user id,etc.) are displayed instead of the actual values. Definitions for each variable fieldare in the help text.

Message identifiers and their corresponding command names are listed in the VaultManager Guide.

Using the Command-Line InterfaceUsing the UNIX Email Trigger


Using the UNIX Email Trigger

When the UNIX email trigger is activated, users receive UNIX email thatduplicates Vault messages sent to them. In other words, when users execute thereqrvw, rsvp, and sendmsg commands, Vault sends UNIX email as well asVault messages. This allows users to read Vault messages without signing on toVault.

To receive UNIX email by means of the email trigger, users must have the sameuser ID for both Vault and UNIX. Replies to Vault messages that were received asUNIX email are sent only to UNIX email accounts and not to Vault accounts.

Attaching a File

The email trigger allows you to attach a Vault file to the message. You do this byending the message with the following string.

EDM file: EDMfilename

Be sure to include a space between the colon and the first letter of the file name.The Vault appends the content of the named file to the UNIX email message.

Example of Attached File

A Vault message that attaches a Vault file appears below.

huge% cisendmsg USERID=wilbur -EDM> MSGTEXT=’Engineering please review the -EDM> design of bracket xyz1234 used in the model 30. -EDM> For more details see EDM file: MEMO.93525field’CDMSMG334I The message has been sent to the specified users.huge%

When the UNIX email trigger is turned on, the message above would be sent tothe specified Vault user ID and also to the UNIX email account having the sameuser ID. The content of the specified Vault file is appended to the UNIX email butnot to the Vault message. The UNIX email would look like the message on thenext page.

To: wilbur@kittyhawkSubject: Vault Mail MessageStatus: ROSubject: Vault Message from Vault command SENDMSG

Using the Command-Line InterfaceUsing the UNIX Email Trigger


Message sent to your Vault mailbox:

From: berylDate: Wed May 06 at 3:28:39 PMEngineering please review the design of bracket xyz1234 used in themodel 30 product. There have been a number of inservice failures.For more details see EDM file: MEMO.93525field

+ + + + + + + + + + + + + + + + + + + + + + +Contents of EDM file MEMO.93525field+ + + + + + + + + + + + + + + + + + + + + + +Acme Corporation MemoDate: May 25, 1993To: Engineering DepartmentFrom: John Doer (Field Service Florida)Re: Bracket xyz1234 failuresWylie Coyote has had several failures of bracket xyz1234 whileusing our Model 30 product to capture speeding rabbits. Thesefailures have resulted in some minor injuries to Mr. Coyote. Pleasefix the design of this bracket.

As shown in the example, the string EDM file: EDMfilename must be at the endof the message. The EDM file: portion of the string is not case sensitive. The filename, however, must be entered exactly as it appears in the Vault database.

Only the latest revision of the named file is attached to the message. You canconfigure the email trigger with other Vault architectures, but the triggered processmust run on a UNIX system.

Extra info

This interface is particularly appropriate for system administrators, systemanalysts, system installers, and service/support personnel.

For more information about the EDM.DEFAULTS file, see the Vault SystemAdministrator Guide, Vault Manager Guide, or Vault End User Guide.


Chapter 3 Vault Commands

This chapter provides reference information for all Vault commands.

• Introduction

• addadod (DV)

• addag

• addalias (DV)

• addaset

• addatrbs (Binder)

• addattr

• addevals (Binder)

• addfs

• addmas

• addmfs

• addmul

• addobj (Binder)

• addp

• addrel (Binder)

• addrs

• addrule

• adds

• addsp

• addsub (DV)

• addt

Vault Commands


• addu

• addul

• addup

• addusa

• addvault (DV)

• addvlist (DV)

• addvlmem (DV)

• admcopy

• archive

• associat

• chgadef (Binder)

• chgag

• chgatrbs (Binder)

• chgattr

• chgcl

• chgctl

• chgdesc (Binder)

• chgfa

• chgfcl

• chgfpw

• chgfrev

• chgfsc

• chgfsp

• chgmas

• chgp

• chgs

• chgsps

• chgspt

• chgu

• chguattr

• chgup

• chgupw

Vault Commands


• classify

• clst

• copy

• copyattr

• defagrp (Binder)

• defatrb (Binder)

• defenum (Binder)

• defotype (Binder)

• deladef (Binder)

• delag

• delagrp (Binder)

• delaset

• delatrbs (Binder)

• delattr

• delcl

• delenum (Binder)

• delete

• delevals (Binder)

• dellog

• delobj (Binder)

• delotype (Binder)

• delov

• delp

• delrel (Binder)

• delrs

• delrule

• dels

• delsub (DV)

• delu

• delul

• export (DV))

• get

Vault Commands


• help

• ibkup

• import (DV)

• iqf

• listdict (Binder)

• listdir

• liststru (Binder)

• load

• locate (DV)

• marka

• markd

• markr

• opnt

• purge

• read

• readattr

• readmsg

• recsf

• recsp

• register (DV)

• remadod (DV)

• remalias (DV)

• remfs

• remmas

• remmfs

• remmul

• remt

• remuattr

• remup

• remusa

• remvault (DV)

• remvlist (DV)

Vault Commands


• remvlmem (DV)

• replace

• reqrvw

• reserve

• reset

• restore

• rsvp

• scantape

• sendmsg

• signoff

• signon

• signout

• store

• ubkup

• unload

• unmark

• update

• valatrbs (Binder)

• veruattr

Vault CommandsIntroduction


Introduction

This chapter provides reference information for all Vault commands.

1. Vault including Binder commands

2. Distributed Vault commands

3. Programming commands

Please note: Binder commands have (Binder) next to the command name,and Distributed Vault commands have (DV).

The information for each command is presented in the order below. Not allcommands have all topics.

• Brief Description

• Syntax

• Required Keywords and Parameters

• Optional Keywords and Parameters

• Requirements and Special Considerations

• Examples

Please note: For a few commands, the order of information varies. Thisallows the input parameter information to occupy one page, where possible.

If your system administrator has changed the defaults for any commands, thedefaults shown in this section can not be correct for your system.

Vault Commandsaddadod (DV)


addadod (DV)

The ciaddadod command makes a distributed object directory (DOD) known tothe local vault in the distributed vault environment. When a DOD is known to avault, registered objects can be located transparently.

Syntax

ciaddadod vaultid=vaultName type=vaultType node=vaultSystemName

Required Keywords and Parameters

Optional Keywords and Parameters

All are required.

Requirements and Special Considerations

You must be logged on as the Vault installation account to use this command andthe ADDADOD command must be in your public command list. This command isnot available programmatically.

To know about a particular distributed object directory, use the ciaddadod

command on each vault you want. A DOD must be known to Vault for the LOCATEcommand to work.

The ciaddadod command automatically updates the network configuration filesnsm.config and pm.config and also updates the relational databasemanagement system. These updates occur when you shut down and restart Vault.

Example

CIADDADOD VAULTID=VAULTB TYPE=SELF NODE=EIGER

vaultid=vaultName Vault name. Enter a unique vault name, up to 32 case-sensitivealphanumeric characters.

type=vaultType Enter SELF (on this node) or DOD (someplace else).

node=vaultSystemName Name of the system where the DOD resides. Enter up to 32case-sensitive alphanumeric characters.

Vault Commandsaddag


addag

The ciaddag command creates an authority group.

Syntax

ciaddag authgrp=AuthorityGroupName authnums=AuthorityNumbers



All are required.


An authority group consists of a group of authority numbers that determineexactly what read or write authority a user has in Vault.

For example, to give a user read authority to all files stored at a correspondingauthority number of 0 through 50; you can specify for this user a read authoritynumber of 50. Or, you can create an authority group name and specify 1-50as the authority numbers for this authority group. This authority group name canthen be specified for you as a read authority group.

If, however, you do not want to give this user read authority to all files stored at acorresponding authority number of 50, but want this person to be able to read filesat authority numbers 25-50, add an authority group name and specify 25-50 as theauthority numbers for this authority group. This authority group name can then bespecified for you as a read authority group.

In this way, you are permitted to access files at authority numbers of 25-50 and isdenied access to files stored at numbers 0-24.

authgrp=AuthorityGroupName Authority group name. Enter a unique group name up to8 alphanumeric characters.

authnums=AuthorityNumbers List of authority numbers (and/or authority ranges). Entera list of authority numbers up to 300 characters includingnumbers, commas, and hyphens. Separate eachindividual number from the next by a comma (forexample, 5,10,50). Separate each number within a rangeby a hyphen (for example, 10,30-40,50). The list cannotinclude blank spaces. Valid values are 0 through 99.

Vault Commandsaddag


You can specify authority numbers as single integers, separated by commas, or asranges of numbers, separated by hyphens (-). The second number of a range cannotbe less than the first number. (For example, 10-5 is an incorrect range.) There canbe no embedded blanks in your list.

See Vault Manager Guide for more information about this command.

Please note: When using the command-line format, enclose the list ofauthority numbers with single quotation marks (’).

Vault Commandsaddalias (DV)


addalias (DV)

The ciaddalias command establishes a single message designation for a useron each vault in the distributed vault environment.

Syntax

ciaddalias userid=userid vaultid=vaultid



All are required.


Establishing an alias on remote vaults causes messages to be forwarded to a user’shome vault. This allows users to participate in reviews on other vaults and toreceive proper notification from other vaults without having to signon to thosevaults periodically to check for messages.

The ADDALIAS command must be in your public command list.

Example

CIADDALIAS USERID=CARL VAULTID=VAULTB

userid=userid Unique user identifier. Enter an identifier up to 12 case-sensitivealphanumeric characters.

vaultid=vaultid Unique vault name. Enter a vault name up to 32 case-sensitivealphanumeric characters.

Vault Commandsaddaset


addaset

The ciaddset command defines the name of a set of attributes for use with filesand parts stored in Vault.

Syntax

ciaddaset setname=attributeSetName setdesc=setDescription



All are required.


For an attribute to be used with a file, that attribute must belong to a set ofattributes. A set is a convenient way to group attributes. A set can contain singleattributes along with other sets. You can create a set containing a hierarchy of setsas complex as you need it to be.

Having defined sets of attributes, you then define simple rules that determine whena particular set of attributes applies to a particular file. For example, you can set upa rule that instructs Vault to use the attribute set called PROPERTIES with all filesbelonging to the CARGO project.

Follow these steps to implement user-defined attributes

1. Define attribute names.

2. Define attribute set names.

3. Add members to attribute sets. A member can be an attribute or a set.

setname=attributeSetName Name of the attribute set. Enter a name up to 24alphanumeric and/or special (hyphen and underscore)characters.

setdesc=setDescription Description of the attribute set. Enter a description up to 240characters. When using the command-line format, if the fieldcontains embedded blanks, enclose it in single quotationmarks.

Vault Commandsaddaset


4. Define rules for when to apply a particular attribute set to a particular file.

5. Inform users of which attributes apply to which condition (test). Be sure to tellthem the attribute type for each attribute, and what the defaults are. If you wantto use a naming convention (not a requirement) for the name of the file thatcontains the attribute values, be sure to communicate that information as well.

After you have done this, users can create a file in which they specify values forthe attributes. When they execute the STORE, REPLACE, or UPDATE commands,they specify the name of the attribute file. If they do not include an attribute filewhen it is required to do so, Vault does not perform the file transfer.

Vault Commandsaddatrbs (Binder)


addatrbs (Binder)

The ciaddatrbs command adds attributes to an existing object or relationshipinstance. The keywords vary for binders and relationships.

Syntax

For Binders Only

ciaddatrbs baseclass=baseClass oname=objectName revision=revisionCode

For Binders and Relationships

ciaddatrbs atrbdata=attributeData keyfile=keyFile

atrbdata=Attribute Group Name (1-n):atrb_name1=atrb_val1,,atrb_name2=atrb_val2,,...,,atrb_namen=atrb_valn),,

For Relationships Only

ciaddatrbs frombaseclass=FromObjectBaseClass fromoname=FromObjectNamefromrevision=FromRevision tobaseclass=ToObjectBaseClasstooname=ToObjectName torevision=ToRevision toinstid=ToInstanceId

oname=samplebox -atrbdata(1)=”box(eachside=3,volumn=27.0)” -atrbdata(2)=”box(surface=TOP,m_date=09/27/95)”




For Binders Only



baseclass=baseClass Enter a name of the base class of the object instance. Default isBINDER.

oname=objectName Enter a name of the object that you are adding attributes to.

revision=revisionCode Enter a revision code for the object. The default is the currentrevision.

atrbdata=attributeData Enter a name of the attribute group.

Attribute group name (1-n): atrb_name1=atrb_val1,,

atrb_name2=atrb_val2,,...,,

atrb_namen=atrb_valn),,

The sequence number (1-n) is optionally used to specify anorder for assigning the attributes.

keyfile=keyFile Enter a name of the keyword file up to 80 alphanumericcharacters.

frombaseclass=FromObjectBase

Class

Enter a name of the base class of the objectinstance. Default is BINDER.

fromoname=FromObjectName Enter a name of the object that you are addingattributes to.

fromrevision=FromRevision Enter a revision code for the object. The default isthe current revision.

tobaseclass=ToObjectBaseClass Enter a revision code for the object. The default isthe current revision.

tooname=ToObjectName Enter a revision code for the object. The default isthe current revision.

torevision=ToRevision Enter a revision code for the object. The default isthe current revision.

toinstid=ToInstanceId Enter a revision code for the object. The default isthe current revision.




All are required.


Each specification of ATRBDATA on the ADDATRBS command adds a row in thedatabase table for the named attribute group.

The keyfile keyword used with binder commands simplifies the input of largeamounts of data. The following example illustrates the use of keyfile keywordwith the ADDATRBS command:

% ciaddatrbs keyfile=’/home/omaduri/keyfile.dat’

A sample of the keyfile.dat is as follows:

% more keyfile.dat

BASECLASS=BINDERONAME=engine_assyREVISION=1ATRBDATA(1)=Engine_Dimensions(ENGINE_LENGTH=’900’,ENGINE_WIDTH=’300’)ATRBDATA(2)=Engine_Power(FHP=’1800’,BHP=’1800’

Example

CIADDATRBS ONAME=SAMPLEBOX -ATRBDATA(1)=”BOX(EACHSIDE=3,VOLUMN=27.0)” -ATRBDATA(2)=”BOX(SURFACE=TOP,M_DATE=09/27/95)”

This example adds attribute data for a binder called SAMPLEBOX.

Two rows of attribute data are added to the database table named ATR_BOX. Thefirst row adds data for fields EACHSIDE and VOLUMN but not for SURFACE andM_DATE. The second row adds data for SURFACE and M_DATE, but not the othertwo fields.

Vault Commandsaddattr


addattr

The ciaddattr command defines an attribute for use with files and parts storedin Vault. Use the cichgattr command together with the ciaddattr commandto define all attribute-related information.

To assign values use the cistore, cireplace or the ciupdate commands. Youcan also use the ciassociat and cichguattr commands to assign or changevalues.

Syntax

ciaddattr attrname=attributeName attrtype=attributeTypeattrdesc=attributeDescription



All are required.


An attribute is a piece of information related to a file or part. You can set up Vaultso that when users execute the STORE, REPLACE, or UPDATE commands, theyenter attribute values along with the information required for the file transfer.Vault maintains an association between an attribute and the file to which it relates.

You can use attributes to hold information that keeps you informed about yourfiles and parts. You can use IQF to view the attribute values for a given file or part.

attrname=attributeName Name of the attribute. Enter a name up to 24alphanumeric characters (including hyphen, andunderscore).

attrtype=attributeType Type of the attribute. Enter the type as either aCHARACTER, NUMBER, or DATE. If you havedefined your own attribute types, enter up to 24alphanumeric and/or special (hyphen andunderscore) characters.

attrdesc=attributeDescription Description of the attribute. Enter a description up to240 characters. When using the command-lineformat, and the field contains embedded blanks,enclose it in single quotation marks.

Vault Commandsaddattr


An attribute has a name, a type, and a value. You define the names and types ofattributes. Users assign the values when they execute the STORE, REPLACE, orUPDATE commands.

For an attribute to be used with a file, that attribute must belong to a set ofattributes. A set is a convenient way to group attributes. A set can contain singleattributes along with other sets. You can create a set containing a hierarchy of setsas complex as you need it to be.

Follow these steps to implement user-defined attributes:

1. Define attribute names.

2. Define attribute set names.

3. Add members to attribute sets. A member can be an attribute or a set.

4. Define rules for when to apply a particular attribute set to a particular file.

5. Inform users of which attributes apply to which condition (test). Be sure to tellthem the attribute type for each attribute, and what the defaults are. If you wantto use a naming convention (not a requirement) for the name of the file thatcontains the attribute values, be sure to communicate that information as well.

After you have done this, users can create a file in which they specify values for theattributes. When they execute the STORE, REPLACE, or UPDATE commands, theyspecify the name of the attribute file. If they do not include an attribute file when itis required to do so, Vault does not perform the file transfer.

Vault Commandsaddcl


addcl

The ciaddcl command creates a new command list.

Syntax

ciaddcl cmdlist=commandListName allcmds=includeAllCommands?

cmdfile=n/a



When you use the command-line format to execute the ADDCL command, you canindicate with the ALLCMDS parameter field whether to include all or a subset ofVault commands in the list associated with the command list name.

If you want to associate only a subset of Vault commands with the command listname, first create a text file containing the command names you want associatedwith this command list name. Enter N (no) in the ALLCMDS parameter field forthe ADDCL command and the name of your text file in the CMDFILE parameterfield.

cmdlist=commandListName Enter a unique command list name up to 8alphanumeric characters.

allcmds=includeAllCommands? Indicates whether all Vault commands are to beincluded in the command list. Enter Y (yes) or N(no).

cmdfile=n/a If the includeAllCommands? parameter is N(no), enter a local text file name, up to 80alphanumeric characters. This file shouldcontain the command names to be included inthe list.

Vault Commandsaddcl


Example

CIADDCL CMDLIST=GENUSER ALLCMDS=N - CMDFILE=CMD.FILE.A

The contents of CMD.FILE.A for this example can be

STOREREADGETUPDATEREPLACE

Enter only one command per line in the command file, as shown in the exampleabove. See Vault Manager Guide for more information about this command.

Vault Commandsaddevals (Binder)


addevals (Binder)

The ciaddevals command adds enumeration values to an existing enumerationlist.

Syntax

ciaddevals enum=enumerationName values=attributeValues keyfile=keyFile



All are required.


If values are entered in lowercase, they remain so. When users employ theenumerated values, they must enter the value in the case specified here, or thevalue is not recognized.

Examples

CIADDEVALS ENUM=BOND_RATING VALUES=AAACIADDEVALS ENUM=SIDE “VALUES=‘LEFT,RIGHT’”

enum=enumerationName Enter the name of an existing enumeration list.

values=attributeValues Enter a list of case-sensitive values for the attribute:val1, val2, ..., valn.

keyfile=keyFile Name of the file containing command parameters inthe format of keyword=value. Enter a filename up to80 alphanumeric characters.

Vault Commandsaddfs


addfs

The ciaddfs command defines a file set name.

Syntax

ciaddfs fsname=fileSetName [fsdesc=filesetdescription]




To create a file set, choose a unique name with which to associate the members ofthe file set. The ADDFS command adds this name to Vault. You can then use theADDMFS command to add the members to the file set name. To remove a file setname from Vault, use the REMFS command.

See Vault End User Guide for more information about this command.

fsname=fileSetName Unique file set name. Enter a name up to 80alphanumeric characters.

fsdesc=filesetdescription Description of the file set. Enter a description up to30 alphanumeric characters, including blanks.

Vault Commandsaddmas


addmas

The ciaddmas command adds a member to an attribute set. A member can be anattribute or an attribute set. You must define the attribute or attribute set beforeadding it to an attribute set.

Syntax

ciaddmas reqopt=requiredOrOptional amemname=attributeOrSetNameamemtype=memberType setname=setName defaval=default



All are required.

reqopt=requiredOrOptional Indicates whether applying the member is required oroptional. Specify only for attributes being added. Vaultdiscards this value if the member being added is a set.Enter R (Required) or O (Optional). The default is R.

amemname=attributeOrSetName Name of a previously defined attribute or attribute set.Enter a name up to 24 alphanumeric and/or special(hyphen and underscore) characters.

amemtype=memberType Type of the set member being added. Enter A for anAttribute or S for a Set. The default is A.

setname=setName Name of the attribute set to which you are adding theattribute or attribute set. Enter a name up to 24alphanumeric and/or special (hyphen and underscore)characters.

defaval=default Indicates the default value for the attribute being added.The default value must pass the rule defined for theattribute’s data type. Vault uses exactly the data youenter, respecting upper and lowercase. Enter up to 240characters. Specify this value only when the memberbeing added is an attribute. Vault discards this value ifthe member being added is a set. Specify NO-DEFAULTif you do not want a default value.

Vault Commandsaddmas



Vault associates an attribute with an object only once, irrespective of the number ofsets it belongs to.

This allows you to build complex hierarchies of attribute sets within attribute sets.It does not matter if you add set A to set B and then add set B to set A. As Vaultworks through the sets, it ignores an attribute if it has already associated the objectwith that attribute. Since sets are merely a convenient way to group attributes, youcan group them in any way that makes sense.

Vault Commandsaddmfs


addmfs

The ciaddmfs command adds a member to a file set. A member must be underthe control of Vault and can be one of the following:

• File

• CADDS part

• File set

• User-defined entity

Syntax

ciaddmfs fsname=fileSetName memtype=memberType memname=memberNamerevision=revisionCode [memdesc=description]




Vault does not allow recursive file sets. For example, if file set A contains file setB, adding file set A to file set B creates a recursive file set. You can add a reservedfile name as a member of a file set. When you issue the GET or READ command onthe file set, no file is copied to your local storage area for the reserved file name. Amessage appears in the audit file stating that the file is a reserved file.

fsname=fileSetName Existing file set name. Enter a name up to 80 alphanumericcharacters.

memtype=memberType Code for the member type. Enter F (file), P (part), S (file set), orU (user-defined). The default is F.

memname=memberName Name of the file, part, or file set to be added. Enter a name upto 80 alphanumeric characters.

revision=revisionCode Revision code. If member type is F or P, enter a revision codeup to 20 alphanumeric characters. Leave blank for the defaultcurrent revision. If you specify a revision, the member alwayshas this particular revision.

memdesc=description Description information. Enter up to 30 alphanumericcharacters (including blanks).

Vault Commandsaddmfs


When you issue a GET or SIGNOUT on the file set, the reserved file name is signedout. If a file with the same name as the reserved file name exists in your localstorage area, the local file is transferred to Vault when you issue the REPLACE orUPDATE command on the file set.

This allows you to predefine a file set, issue a GET command on the file set, thenissue a REPLACE on the file set, adding the actual file to the file set.

Do not add a member to a file set that is signed out. Otherwise, if you replace thefile set, that member can not be saved in Vault since it was not signed out as part ofthe file set.


Vault Commandsaddmul


addmul

The ciaddmul command adds members to a previously defined user list.

Syntax

ciaddmul userlist=userListName ulmname=memberNameseqnum=sequenceNumber ulmtype=memberType



All are required.


A user list is an ordered list of Vault user IDs (you designate the order) associatedwith a user list name. A user list can also include another user list as one of itsmembers. You can embed user lists for only one level. The list is used with theSENDMSG (send a message) command to designate a list of Vault users to sendnotification messages.

You can add only one member at a time using the command-line format.

A user list can include another user list as one of its members. You can embed userlists for only one level.

Sequence numbers are numerically ordered, positive numbers between 0000 and9999. The sequence numbers establish the order in which members receive reviewmessages from Vault.

userlist=userListName Existing user list name. Enter a user list name up to 24alphanumeric characters.

ulmname=memberName Existing Vault user ID or previously defined user list name.Enter a user ID up to 24 alphanumeric characters.

seqnum=sequenceNumber Establishes order in the user list. Enter a number, 0 through9999. The default is 0000.

ulmtype=memberType Code that indicates the type of member being added to thelist. Enter U for user ID, A for a user list in which all membersmust respond to a review, or O for a user list in which onemember only can respond to a review. The default is U.

Vault Commandsaddmul


The person(s) or user list with the lowest number receives the review message first,followed by the next lowest number.Sequence numbers do not affect notificationmessages.

When assigning sequence numbers, you must consider who should review thework first.

• Assign all users the same sequence number when you want them to review thework at the same time.

• Assign different numbers when you want a serial review, one reviewer finishingbefore the next one starts.

The same Vault user ID or user list name can also be on more than one user list.For example, AMELIA can be on the CARGOUL and the JETUL at the same ordifferent sequence numbers. User list names can be embedded for one level only.


Vault Commandsaddobj (Binder)


addobj (Binder)

The ciaddobj command creates an instance of a binder.

Syntax

ciaddobj otype=objectType oname=objectName [revision=revisionCode]class=fileClassificationCode projid=projectId atrbdata (1-n)=attributeData[desc=description] keyfile=keyFile



otype=objectType Name of an existing object type which must have thebase class of binder.

oname=objectName Unique name for the new object instance. Enter an objectinstance name up to 35 alphanumeric characters(including blanks).

class=fileClassificationCode File classification code. Enter PUB (public), PRO(project), or PRI (private). The default is Public.

projid=projectId Existing project identifier. If PRO, enter a project identifierup to 8 alphanumeric characters. If not, leave blank. Validonly when CLASS=PRO.

atrbdata (1-n)=attributeData Names of the attribute groups, attributes, and attributevalues as defined for the object type.




keyfile=keyFile Name of the file containing command parameters in theformat of keyword=value. Enter a filename up to 80alphanumeric characters.

revision=revisionCode Revision code for the object instance. Enter up to20alphanumeric characters or leave blank for the defaultcurrent revision.

desc=description File contents description. Enter up to 240 alphanumericcharacters (including blanks).

Vault Commandsaddobj (Binder)



You must supply attribute data for attributes that are defined as mandatory whenyou create an object instance. Nonmandatory data can be added when you createthe object or when you add attributes with the ADDATRBS command.

The object name is unique within the base class.

Examples

CIADDOBJ OTYPE=FOLDER ONAME=SAMPLEBOXCIADDOBJ OTYPE=FOLDER ONAME=ANOTHERBOX -ATRBDATA=“BOX(SURFACE=FRONT)”

Vault Commandsaddp


addp

The ciaddp command creates a new project.

Syntax

ciaddp projid=projectId revname=revisionSequenceNameprojname=projectName] [contract=contractNumber] [units=unitOfMeasure][projdesc=description]




You must first define a project with this command before performing any projectrelated tasks, such as adding project authority levels or adding users to the project.


projid=projectId Unique project identifier. Enter an identifier up to 8alphanumeric characters.

revname=revisionSequenceName

Previously defined name of a revision code sequence. Entera revision code up to 8 alphanumeric characters. EnterNONE for no revision sequence.

projname=projectName Project name. Enter a project name up to 15 alphanumericcharacters.

contract=contractNumber Contract number. Enter a number up to 25 alphanumericcharacters.

units=unitOfMeasure Unit of measure code. Enter a code up to 5 alphanumericcharacters, for example, FEET (feet), METER (meters), CM(centimeters).

projdesc=description Project description. Enter a description up to 30alphanumeric characters (including blanks).

Vault Commandsaddrel (Binder)


addrel (Binder)

The ciaddrel command relates an object instance, such as a binder, to anotherbinder, part, or file instance.

Syntax

ciaddrel fromoname=fromObjectName fromrevision=fromRevisiontobaseclass=toBaseClass tooname=toObjectName torevision=toRevisiontoinstid=toInstance otype=objectType reltype=relationshipType atrbdata(1-n)=attributeData [desc=description] keyfile=keyFile


fromoname=fromObjectName Name of the existing object which forms the parent ofthe relationship.

fromrevision=fromRevision Revision code for the parent object. The default is thelatest revision.

tobaseclass=toBaseClass Name of the base class of the child object: binder,part, or file. The default is BINDER.

tooname=toObjectName Name of an existing object to be the child of therelationship.

torevision=toRevision Revision code of the child object. The default is thelatest revision.

toinstid=toInstance Instance number of the relationship between thisparticular parent and child. Required if more thanone relationship is defined between them. Thedefault is 1.

otype=objectType Name of a relationship object type. Default: Objecttype of child object if child object is binder; NULL ifpart or file.

reltype=relationshipType Type of relationship for the object: ASSOCIATION orAGGREGATION. The default is ASSOCIATION.

atrbdata (1-n)=attributeData Name of the attribute group, attribute names, andattribute values as defined for the relationship andobject type.

Attribute group name (1-n):atrb_name1=atrb_val1,,atrb_name2=atrb_val2,,...,,atrb_namen=atrb_valn),,

keyfile=keyFile File containing command parameters in the format ofkeyword=value. Enter a filename up to 80alphanumeric characters.

Vault Commandsaddrel (Binder)




Only one aggregation type relationship can be created to a child object. Partmember files cannot be aggregated, since they are owned by the part. Multipleassociation relationships are allowed. Recursion is never allowed.

Aggregated relationships are allowed only if the child object has the same owner(Project, Public, or Private) as the parent. The aggregated child’s status code mustbe greater than or equal to its parent’s.

Examples

CIADDREL FROMONAME=SAMPLEBOX TOONAME=ANOTHERBOX -RELTYPE=AGGREGATIONCIADDREL FROMONAME=SAMPLEBOX TOONAME=PART1 -TOBASECLASS=PART

desc=description Relationship type description. Enter a description up to 240 alphanumericcharacters (including blanks).

Vault Commandsaddrs


addrs

The ciaddrs command adds a revision code sequence to Vault.

Syntax

ciaddrs revname=revisionSequenceName revfile=n/a



All are required.


When you create a project, you must specify a revision code sequence for theproject to use. You can assign a sequence previously defined with the ADDRScommand, the DEFAULT sequence loaded during software installation, or nosequence indicated by the word NONE.

When you modify the DEFAULT revision sequence, or change the sequenceassociated with a project, the revision codes of previously stored files are notaffected until a version of the file needs a new revision code. Vault then assigns thenext revision code from the new revision sequence.

For example, if the file has the third revision code in the former sequence, Vaultassigns the fourth revision code in the new sequence. Files stored in the Vaultdatabase for the first time receive the first revision code in the new sequence.

Before you execute the ADDRS command with the command-line format, create afile with a local editor. In this file, list the revision codes that can be assigned to therevision sequence you are creating.

revname=revisionSequenceName Unique name you assign to the revision codesequence you are defining. Enter a revisionsequence name up to 8 alphanumeric characters.

revfile=n/a Name of the local file that contains the list of codesassigned to the revision sequence you are creating.Enter a filename up to 80 alphanumeric characters.

Vault Commandsaddrs


Use one line for each revision code. The order of the revision codes in the file isthe order of the codes in the revision code sequence. To execute ADDRS at thesystem prompt, use the following format:

For more information about this command, see Vault Manager Guide. See alsoVault End User Guide for general information about revision codes.

Vault Commandsaddrule


addrule

The ciaddrule command specifies the test parameters that Vault uses todetermine when to use an attribute set. Use the Schema Definition Language todefine more complex rules or to define or modify additional simple rules. (SeeVault Programmer Guide.)

Syntax

ciaddrule rulename=ruleName rulekey=commandKeyword operator=operatortestval=testValue setname=setName


1 USER represents the ID of the user executing the command.


All are required.

rulename=ruleName Name of the rule you are defining. Enter up to 24alphanumeric and/or special (hyphen and underscore)characters.

rulekey=commandKeyword Keyword on which the rule operates. Enter CLASS,FILENAME, PARTNUM, PARTTYPE, PROJID, STATUS,

USER1, USERTYPE or a user-defined keyword.

operator=operator Operator that the rule uses. Enter an equal sign (=) toindicate an exact match, angle brackets (<>) to indicate“not equal to”, or the keyword LIKE to indicate somematching characters. LIKE is an SQL wildcard operator.The default is =.

testval=testValue Exact value on which the rule uses the operator. Thisvalue must match what the keyword expects. Example:you can enter only PRO, PRI, or PUB when thecommand keyword is CLASS. Enter a value up to 240alphanumeric or special characters. When the operator isLIKE, you can include a percent sign (%) to representone or more characters.

setname=setName Name of the attribute set that is applied when the rule iscomplied with. Enter up to 24 alphanumeric and/orspecial (hyphen and underscore) characters.

Vault Commandsadds


adds

The ciadds command creates a status level and adds it to an authority scheme.1

Syntax

ciadds statcd=statusCode projid=projectId seqnum=sequenceNumberauthnum=authorityNumber [statdesc=description] statpc=statusPartitionCode




To add the status level to a public authority scheme, do not define a project ID. Toadd the status level to a project authority scheme, enter the name of an existingproject ID.

statcd=statusCode Unique code that represents a phase of work in an Vaultauthority scheme. Enter a code up to 8 alphanumericcharacters.

projid=projectId Existing project identifier. Enter a project identifier up to 8alphanumeric characters or leave blank for the default publicauthority scheme.

seqnum=sequenceNumber Number code that establishes order in this authority scheme.Enter a number between 0 and 9999.

authnum=authorityNumber Number code that associates a user’s authority with a statuscode. Enter a number between 0 and 99.

statpc=statusPartitionCode Code to distinguish two special status levels within eachauthority scheme. These codes partition the scheme intodormant, in-work, and released status levels. Enter I (for theinitial in-work status) or R (for the initial released status).Leave this parameter blank for all other status levels. Notethat within each authority scheme one status level must beassigned the I status partition code and one must beassigned the R status partition code. The status levelassociated with the R partition code must have a highersequence number than the one associated with the I partitioncode.

statdesc=description A 30-character field (including blank spaces) to describethe phase of work of this status level (or any otherinformation).

Vault Commandsadds


Do not enter a status code or a sequence number that already exists in the authorityscheme.

The status partition codes must be unique within the scheme to which they arebeing added. The sequence number associated with the I status partition code mustbe less than the sequence number associated with the R status partition code.

If you add a status code to an authority scheme that is in use, it can affect thetracking of any file stored under that authority scheme.


Vault Commandsaddsp


addsp

The ciaddsp command adds additional data storage (called a storage pool) toVault.

Syntax

ciaddsp poolname=storagePoolName poolinfo=storagePoolInfo



All are required.


This command adds another storage pool area for use by Vault. This creates morestorage area available for Vault data.

This command is not available on a remote Vault Client node.

Please note: The ADDSP command requires information specific to youroperating system. See the operating system information for your system includedin your software installation guide.

See Vault System Administrator Guide for other privileges you can need to executethis command.

poolname=storagePoolName Enter a unique storage area name up to 8 alphanumericcharacters.

poolinfo=storagePoolInfo Operating system-specific information. Enter information upto 240 alphanumeric characters (including blank spaces).This is needed to access the physical storage area. Seeyour software installation guide.

Vault Commandsaddsub (DV)


addsub (DV)

The ciaddsub command establishes a relationship between an event and anaction. This subscription service allows you to monitor changes to objects in thedatabase. You can include an action template with predefined commands in yoursubscription. Then when object events occur, the actions are implemented. TheADDSUB command must be in your public command list.

Syntax

ciaddsub subname=subscriptionName selscope=selectionScopeselname=selectionName [revision=revisionCode] eventid=eventNameactionid=actionName [expdate=expirationDate] [exptime=expirationTime][expcnt=expirationCount] notify=notificationFlag notifyid=notificationUserNamevaultlst=vaultListName


subname=subscriptionName Unique name for the subscription. Enter asubscription name up to 24 alphanumericcharacters.

selscope=selectionScope F (file) or P (part). The default is F.

selname=selectionName Name for selscope. Enter selscope name up to 80characters.

eventid=eventName Name of an object event from the list of valid objectevents.

actionid=actionName Name of the action template from the list of validactions.

notify=notificationFlag A flag setting of S (successful completion only), F(failure only), B (both—succeed or fail), or N (nomessage) indicating whether to send a messageafter initiating the action. The default is N.

notifyid=notificationUserName Unique user name of the user to inform. Enter username up to 12 alphanumeric characters.

vaultlst=vaultListName Required only if action is EXPORT_READ orUPDATE.





Events

An event is any change to the metadata of a file or part, such as a file update or astatus change. Subscribing to object events saves you from having to check onchanges to an object. A subscription on CHANGE_OBJECT_REVISION cannot beused on objects with NONE revision sequence.Valid events are as follows:

• CHANGE_OBJECT_STATUS

• CHANGE_OBJECT_BINARY

• CHANGE_OBJECT_REVISION

• CHANGE_OBJECT_METADATA

Subscribing to Object Events

You can subscribe to one or more events associated with any part or file on thelocal vault. That is, the vault to which you are signed on. To subscribe to an objectevent, you must have

• A valid user ID and password on the object’s resident vault

• Sufficient access to the object

• The ADDSUB command in your command list

You can subscribe to file and part objects by

• Name only

• Name and character revision

revision=revisionCode Revision code for the object. Enter revision code up to 20alphanumeric characters or leave blank for the default currentrevision or enter ‘*’ for all revisions. Required only if selscope isF or P.

expdate=expirationDate Date subscription expires. For USA use mm/dd/yy as in05/01/95 for May 1, 1995. For Europe use dd.mm.yy as in01.05.95 for 1 May, 1995.

exptime=expirationTime Time subscription expires in the format hh:mm:ss for a 24-hourclock. For example, 09:05:22.

expcnt=expirationCount A 3-digit number for the number of uses for a subscriptionbefore it expires.



You can also subscribe to user events by user ID or as a member of a user list.

Please note: Only registered objects can be transferred to remote vaults.Registration makes local vault objects accessible to remote vaults. Refer to theREGISTER command for more information.

Valid actions are the following:

• SENDMSGU. Requires USERID. It can be aliased to a remote vault. See theADDALIAS command for information on how to add an alias to user.

• SENDMSGL. Requires USERLIST.

• EXPORT_READ_REPLICA. Requires VAULTLST. This transfers a read-onlycopy of the file or part to the specified VAULTLST.

• SYNC_REPLICA_SOURCE. Updates the source object of the write-replacementobject. EXPORT can correctly determine where to send it.

Example

CIADDSUB SUBNAME=EXAMPLE1 SELSCOPE=F -SELNAME=TEST1 EVENTID=CHANGE_OBJECT_REVISION -EXPCNT=1 NOTIFY=F NOTIFYID=RCC ACTIONID=SENDMSGU -USERID=CGM

This example shows a subscription to an event that changes the latest revision ofthe file TEST1. If the file attains a released status, a message is sent to the user IDCGM. If the action cannot be performed, user RCC is notified.

Vault Commandsaddt


addt

The ciaddt command gives access control of an existing user-defined table toVault.

Syntax

ciaddt tblname=tableOrViewName sqlid=tableCreator’sSqlIdsqlpw=tableCreator’sSqlPassword statcd=tableStatusCodeclass=tableClassification projid=projectId



All are required.

tblname=tableOrViewName Name of an existing SQL table. It must have been created inthe supported RDBMS and must conform to the namingconventions of the RDBMS. Enter a table name up to 30characters.

sqlid=tableCreator’sSqlId SQL user ID of the creator of the table. Enter a user ID up to30 characters. (For SQL/DS enter user ID up to 8characters.)

sqlpw=tableCreator’sSql

Password

SQL password of the creator of the table. Enter a passwordup to 30 characters. (For SQL/DS enter a password up to 8characters.)

statcd=tableStatusCode Status code. Enter a status code up to 8 alphanumericcharacters or leave blank for the default initial in-work statuscode.

class=tableClassification Classification code. Enter PUB (public), PRO (project), orPRI (private). The default is PUB.

projid=projectId Existing project identifier. If classification is PRO, enter aproject identifier up to 8 alphanumeric characters. The defaultis Blank.

Vault Commandsaddt



You must have SQL CONNECT authority and a CONNECT password in order toexecute the ADDT command. The status you assign to the table determines whichusers can access the table. If you want to change the status of a table, you mustremove it from Vault with the REMT command and then return it to Vault byexecuting the ADDT command with the new status code.

This command is not available on a remote Vault Client node. .

Vault Commandsaddu


addu

The ciaddu command adds a new user to Vault.

Syntax

ciaddu userid=vaultUserId userpw=vaultUserPasswordcmdlist=commandListName [fullname=userFullName] [lastname=userLastName][userdesc=userDescription] [usergrp=userGroup] [protgrp=protectionGroupName][reada=readAuthorityNumber] [readag=readAuthorityGroupName][writea=writeAuthorityNumber] [writeag=writeAuthorityGroupName][admin=doesUserHaveAdministrativePrivileges?][areada=attributeReadAuthorityNumber] [awritea=attributeWriteAuthorityNumber][areadag=attributeReadAuthorityGroupName][awriteag=attributeWriteAuthorityGroupName] [langpref=language][uompref=preferedUOMSystem]


userid=VaultUserId Unique Vault user identifier. Enter a vault user identifierup to 12 alphanumeric characters.

userpw=optegraUserPassword User password. Enter a password up to 8 alphanumericcharacters.

cmdlist=commandListName Existing command list name. Enter a command listname up to 8 alphanumeric characters.

Vault Commandsaddu



fullname=userFullName User full name. Enter full name up to 25alphanumeric characters, including blanks.

lastname=userLastName User last name. Enter last name up to 15alphanumeric characters.

userdesc=userDescription User description field. Enter a description up to 30alphanumeric characters, including blanks.

usergrp=userGroup User group code. Enter 1 or 2 alphanumericcharacters.

protgrp=protectionGroupName CGOS protection group code. Enter a hexadecimalnumber between 0 and FFFF. The default is 0000.

reada=readAuthorityNumber Read authority number that sets a user’s readauthority limit. Enter a number between 0 and 99unless you enter a read authority group name. Thedefault is 00.

readag=readAuthorityGroupName Existing authority group name. Enter a authoritygroup name up to 8 or fewer letters and or numbersunless you enter a read authority number. Default:None

writea=writeAuthorityNumber Write authority number that sets a user’s writeauthority limit. Enter a number between 0 and 99unless you enter a write authority group name. Thedefault ids 00.

writeag=writeAuthorityGroupName Existing authority group name. Enter authority groupname up to 8 or fewer letters and or numbers unlessyou enter a write authority number. Default: None

admin=doesUserHaveAdministrativePrivileges?

Indicates whether the user is given specialadministrative privileges. Enter Y (yes) or N (no).The default is N

langpref=language Enter your language preference.

areada=attributeReadAuthority

Number

Read authority number that sets the user’s attributeread authority. enter a number between 0 and 99. Anumber entered here means a range from0-number. The default is 0.

areadag=attributeReadAuthority

GroupName

Existing authority group name. Enter a authoritygroup name up to 8 alphanumeric characters unlessyou enter a read authority number.

awritea=attributeWriteAuthority

Number

Write authority number that sets a user’s attributewrite authority limit. Enter a number between 0 and99.A number entered here means a range from0-number. The default is 0.

awriteag=attributeWriteAuthority

GroupName

Existing authority group name. Enter authority groupname up to 8 alphanumeric characters unless youenter a write attribute authority number. If both areentered the authority number is ignored.

uompref=preferedUOMSystem Enter your prefered unit of measure system, e.g.MKS/FPS.

Vault Commandsaddu



Each Vault user must have a unique ID and must be assigned a password. Inaddition, each user requires a command list name and file access authoritynumbers or groups.

Each new user is given two sets of attributes with the ADDU command:

• General information and identification attributes

• Public authority attributes

If both authority numbers and authority groups are assigned to a user, Vault usesthe authority groups and ignores the authority numbers.

Keep in mind that an authority number indicates a range. For example, anauthority number of 50 means the range 0 to 50. An authority group containsspecific numbers and ranges. There must be an exact match between the authoritynumber associated with a file and an authority number in a user’s authority groupfor Vault to allow access.

Users do not have any authority on any projects until they are assigned to eachproject with the ADDUP command. Users with administrative privileges can resetor sign in another user’s files or parts. Command list and authority group namesentered must have been previously defined.


Please note: Because this command can include more than 8 parameters,special considerations can apply.

Vault Commandsaddul


addul

The ciaddul command defines a user list name.

Syntax

ciaddul userlist=userListName [userdesc=userListDesc]




A user list is an ordered list (you designate the order) of Vault user IDs associatedwith a user list name. A user list can also include another user list as one of itsmembers. You can embed user lists for only one level. The list is used with theSENDMSG (send a message) command to designate a list of Vault users to sendnotification messages.

User lists are also used by Vault to send review messages when you initiate areview with the REQRVW command.


userlist=userListName Enter a unique user list name up to 24 alphanumericcharacters.

userdesc=userListDesc Enter a user list description up to 30 characters including blanks.

Vault Commandsaddup


addup

The ciaddup command assigns a user to a project.

Syntax

ciaddup userid=vaultUserId projid=projectId cmdlist=commandListName[reada=readAuthoritNumber] [readag=readAuthoritGroupName][writea=writeAuthoritNumber] [writeag=writeAuthorityGroupName][admin=doesUserHaveAdministrativePrivileges?][areada=attributeReadAuthorityNumber] [awritea=attributeWriteAuthorityNumber][areadag=attributeReadAuthorityGroupName][awriteag=attributeWriteAuthorityGroupName]


userid=optegraUserId Existing Vault user identifier. Enter a user identifier up to12 alphanumeric characters.

projid=projectId Existing project identifier up to 8 alphanumeric characters.

cmdlist=commandListName Existing command list name up to 8 alphanumericcharacters.

Vault Commandsaddup




This command assigns a previously defined Vault user to a previously definedproject. The ADDUP command must be in your public command list. Before youuse this command

• Add the user to Vault (with the ADDU command).

• Add the project name to Vault (with the ADDP command).

reada=readAuthoritNumber Read authority number that sets a user’s readauthority limit. Enter a number between 0 and 99unless you enter a read authority group name. Thedefault is 00.

readag=readAuthoritGroupName Existing authority group name. Enter authority groupname up to 8 or fewer letters and or numbers unlessyou enter a read authority number. Default: None.

writea=writeAuthorityNumber Write authority number that sets a user’s writeauthority limit. Enter a number between 0 and 99unless you enter a write authority group name. Thedefault is 00.

writeag=writeAuthorityGroup

Name

Existing authority group name. Enter authority groupname up to 8 or fewer letters and or numbers unlessyou enter a write authority number. Default: None.


Indicates whether or not the user is given specialadministrative privileges for this project’s files. EnterY (yes) or N (no). The default is N.


Number

Read authority number that sets the user’s attributeread authority. enter a number between 0 and 99. Anumber entered here means a range from0-number. The default is 0.


GroupName

Existing authority group name. Enter a authoritygroup name up to 8 alphanumeric characters unlessyou enter a read authority number.


Number

Write authority number that sets a user’s attributewrite authority limit. Enter a number between 0 and99.A number entered here means a range from0-number. The default is 0.


GroupName

Existing authority group name. Enter authority groupname up to 8 alphanumeric characters unless youenter a write attribute authority number. If both areentered the authority number is ignored.

Vault Commandsaddup


• Define the project command list and authority groups (with the ADDCL andADDAG commands).

• Define the project authority scheme (with the ADDS command)

Each project user is assigned a set of authority attributes for the project. Theseauthorities are only used in relation to:

• the data associated with the project

• the attributes associated with the data

The project read and write authority consist of:

• A read authority number or a read authority group name

• A write authority number or a write authority group name

If you assign both authority numbers and authority groups to a user, Vault uses theauthority groups and ignores the authority numbers. An authority numberindicates a range. For example, an authority number of 50 means the range 0 to 50.An authority group contains specific numbers and ranges.

There must be an exact match between the authority number associated with a fileand an authority number in a user’s authority group for Vault to allow access. Thesame is true for the authority numbers associated with attributes.

The administrative privileges parameter indicates whether the user can reset orsign in other user’s files or parts.


Vault Commandsaddusa


addusa

The ciaddusa command associates a user list with a status code in an authorityscheme. User lists function as review, notification, or post-approval lists.

Syntax

ciaddusa projid=projectId statcd=statusCode userlist=userListNamelisttype=listType termcnt=terminationCount apptype=approvalTyperejcnt=rejectCount



All are required.


The user lists entered must already exist in Vault. The status code entered mustexist in the authority scheme specified.

Only a review list can have a termination count. Termination counts are ignored fornotification and post-approval lists.

projid=projectId Existing project identifier. Enter project identifier up to 8alphanumeric characters or leave blank to associate the userlist with a public status code.

statcd=statusCode Existing code that represents a phase of work in an Vaultauthority scheme. Enter a code up to 8 alphanumericcharacters.

userlist=userListName Existing user list name. Enter a user list name up to 24alphanumeric characters.

listtype=listType Code that specifies how the user list functions. Enter R(review), N (notification), or P (post-approval).

termcnt=terminationCount Number of rejections that causes the review to end. If list typeis R, enter a number, 0 through 999. The default is 0.

apptype=approvalType Code that specifies the type of approval needed. If list type isR, enter U (unanimous), M (majority), or N (number ofrejects).

rejcnt=rejectCount Maximum number of rejections allowed for approval. Whenthis number of rejections is surpassed, the review cancontinue but approval is not possible. If approval type is N,enter a number, 0 through 999. The default is 0.

Vault Commandsaddusa


If a review list is not associated with a status code, then files that are requested forreview at that status code are automatically changed to the next status code.

The same user list can be established as a review, notification, and post-approvallist at the same status. You must input the information three times, for notification,for review, and for post-approval. Also, the same user list can be associated withmore than one status code and in more than one authority scheme.

Enter a project ID to associate the user list with a status code belonging to thatproject. Leave the project ID blank to associate the user list with a public statuscode.

A status code can have more than one notification or post-approval list associatedwith it, but only one review list.

A review list identifies those Vault users who receive review messages for a filereviewed at the associated status level. A notification list identifies those Vaultusers who receive notification messages about a review. A post-approval listidentifies those Vault users who receive notification after a review has beenapproved. Vault does not accept review responses from users on notification orpost-approval lists.

It is recommended to use different user lists for different authority schemes so thatthey can be maintained separately, but it is not a restriction.

The termination count specifies the number of rejections that causes the review toterminate. When the termination count is one, Vault terminates the review afterreceiving one rejection. When the termination count is two, Vault terminates thereview after receiving two rejections, and so on. The default termination count iszero. This causes the review to continue until all reviewers have registered theirapproval or rejection.

The reject count specifies the maximum number of rejections that allow the reviewto be approved. For example, if the reject count is two and 0, 1, or 2 rejections areregistered, the review is approved.

You must be careful about the numbers you specify for termination count andreject count. If you specify three for the reject count and one for the terminationcount, then the review ends after one rejection when there is still the possibility ofapproval. On the other hand, if you specify one for the reject count and three forthe termination count, then after one rejection the review continues even thoughthe result cannot be approval.

Vault Commandsaddvault (DV)


addvault (DV)

The ciaddvault command identifies a vault as a participant vault to other vaultsin the distributed vault environment. Making vaults known to each other allowsyou to share objects with other vaults.

Syntax

ciaddvault vaultid=vaultName type=vaultTypeseqno=SequenceNumberOfVaultNames node=nodeOfVault



All are required.


Use this command on each vault you want to know about a particular remote vaultfor purposes of sharing data.

You must be logged on as the Vault installation account to use this command. Youmust also have the ADDVAULT command in your public command list. Thecommand is available only from the command line interface, notprogrammatically.

ADDVAULT automatically updates the network configuration files (nsm.configand pm.config) and the RDBMS. The changes take affect when you shut downand restart the Vault. The distributed vault installation adds the local (SELF) vault.

Example

CIADDVAULT VAULTID=VAULTB TYPE=SELF NODE=EIGER SEQNO=2

vaultid=vaultName Enter a unique Vault name up to 32 case-sensitivealphanumeric characters.

type=vaultType Enter SELF if the DOD resides on your system or VAULTif it resides someplace else.

seqno=SequenceNumberOfVaultNames

Enter a number between 1 and n representing the orderof vault names in search operations.

node=nodeOfVault Enter the system name up to 32 alphanumericcharacters.

Vault Commandsaddvlist (DV)


addvlist (DV)

The ciaddvlist command creates a vault list to distribute files and parts tomultiple vaults in a single transaction.

Syntax

ciaddvlist vaultlst=vaultListName



All are required.


After you create a vault list, you can then use ADDVLMEM to add members (vaultIDs) to the list.

You can have Vault distribute objects to a list of vaults (with the VAULTLSTparameter) by including the appropriate action template with an object-eventsubscription. Refer to the addsub (DV) command on page 39.

The ADDVLIST command must be in your public command list.

Example

CIADDVLIST VAULTLST=MYSET

vaultlst=vaultListName Enter a unique vault list names up to 24 alphanumericcharacters.

Vault Commandsaddvlmem (DV)


addvlmem (DV)

The ciaddvlmem command is used to add vault IDs to an existing vault list.

Syntax

ciaddvlmem vaultlst=vaultListName vaultid=vaultName



All are required.


The ADDVLMEM command must be in your public command list.

The vault list must exist before adding vault IDs to it and the vault id must alreadybe known to the local vault. See addvlist (DV) on page 54 and addvault(DV) on page 53.

Example

CIADDVLMEM VAULTLST=MYSET VAULTID=VAULTB

vaultlst=vaultListName Enter a name of existing vault list.

vaultid=vaultName Enter a unique vault name of an existing Vault, up to 32case-sensitive alphanumeric characters.

Vault Commandsadmcopy


admcopy

The ciadmcopy command copies administrative data.

Syntax

ciadmcopy copytype=copyType copyfrom=copyFrom copyto=copyTo



All are required.


You can use the ciadmcopy command to copy:

• Authority groups

• Command lists

• Project user information

• Status levels for a project or the public status levels

• User lists

To make a copy of an authority group, you must have ADDAG in your publiccommand list. The new authority group name must not already exist.

To make a copy of a command list, you must have ADDCL in your public commandlist. The new command list name must not already exist.

copytype=copyType Enter the code to represent the copy type: AG(authority group), CL (command list), PU (projectusers), SL (set of status levels), or UL (user list).

copyfrom=copyFrom Enter the copy source up to 24 alphanumericcharacters.

copyto=copyTo Enter the copy target up to 24 alphanumericcharacters.

Vault Commandsadmcopy


To copy the users on a project to a new project, you must have ADDUP in yourpublic command list. The new project ID must already exist in Vault. There cannotbe any users already assigned to the new project.

To make a copy of a set of status levels, the new project ID must already exist inVault. You must have already been assigned to the new project. You must have theADDS command in your command list for the new project. There cannot be anystatus levels already assigned to the new project. To copy the public status levels,enter PUBLIC in the Copy from field.

To make a copy of a user list, you must have ADDUL and ADDMUL in your publiccommand list. The new user list name must not already exist in Vault.


Vault Commandsarchive


archive

The ciarchive command allows you to move files previously marked forarchiving from Vault to tape. You can execute this command only when locallylogged in to the Vault server.

Syntax

ciarchive tapeunit=tapeUnit(s) tapenum=tapeSerialNumber(s)tappend=AppendToTape(s) output=auditDestinationappend=replaceOrAppendAuditFile?



All are required.

tapeunit=tapeUnit(s) Name to represent the tape device. Enter TAPE1,TAPE2, TAPE3, or TAPE4 for a single archive tape.

For more than 1 copy of the archive tapes, tapenumbers should be separated by commas andincluded in quotes. You also have to specify the labelsfor the tapes.

For example:

tapeunit="(TAPE1,TAPE2)”tapenum="(LABEL1,LABEL2)"

where LABEL1 is the tapelabel for TAPE1 and LABEL2is the tapelabel for TAPE2.

Spaces are not allowed. The default is TAPE1.

tapenum=tapeSerialNumber(s) Tape identifier name. Leave blank to use the identifieron the tape or enter up to 6 alphanumeric characters orSCRTCH. Enter two identifiers separated by a commafor two copies of the archive tape. Spaces are notallowed. The default is SCRTCH.

tappend=AppendToTape(s) Indicates whether or not to append the archive data toan existing archive tape. Enter Y for Yes or N for No.The default is N.

output=auditDestination Indicates where to send audit information. At theprompt enter F (file), B (both), or M (message only).When using the command-line format, you can onlyenter F or M. The default is F (Command-line format).

append=replaceOrAppendAudit

File?

Indicates whether to replace or append the audit file. Ifthe audit destination is F or B, enter R (replace) or A(append). Ignored if the audit destination is S or M. Thedefault is R.




Files to be archived must have been previously marked with the MARKA command.

You must be locally logged in to the Vault server to execute the ARCHIVEcommand. The server need not have a local tape device.

When you execute the ARCHIVE command

• The marked files are copied to the archive tape.

• The associated file information is copied to the archived file directory.

• The archived files are deleted from Vault so that the Vault storage pool spaceand the file directory are available for other data after the next IBKUP(incremental backup) and DELOV (delete old file version) commands areexecuted.

A file to be archived must have a revision.

After a file is archived, it cannot be accessed from Vault until it is restored usingthe MARKR (mark for restore) and RESTORE commands. Or, if the file has beenincrementally backed up (with IBKUP), you can use the RECSF command (recoversingle file) to obtain the file.

All Vault archive tapes are uniquely distinguished by the tape serial numberwritten on them. Therefore, the tape serial number you enter must not already existas a label of another Vault tape.

If the tape has already been labeled, the tape serial number entered must match thelabel on the tape. The tape must be labeled before executing the ARCHIVEcommand.

We strongly recommends that you do not use the tapenlabel command toinitialize 1/2-inch tapes. Use the tapelabel command instead.

Exabyte tape drives have a performance problem when writing physical tapemarks. ANSI-standard labeled tapes, which Vault uses, require tape marks.Consequently, the tapenlabel command was developed for use with Exabytetapes. The tapenlabel command reduces the number of physical tape marksrequired for each file. This improves the performance of Exabyte tape drives.

Mount the tape on the specified tape unit before you execute the ARCHIVEcommand.



The tape density is the default tape drive setting.

When the ARCHIVE command has completed execution (or the tape becomes full),the tape is automatically rewound.

When you designate a file as the audit destination,Vault sends the information to afile named ARCHIVE.EDMAUDIT. Use a local editor to view this file.

Please note: The ARCHIVE command can only be used to archive Vault files.It cannot be used to archive tables or other non-file data.

See Vault System Administrator Guide for other privileges you can need to executethis command. See Vault Manager Guide for more information about thiscommand.

Vault Commandsassociat


associat

The ciassociat command associates the attribute data to files and parts withouttransferring the object.

If an attribute has already been associated, then use the ciassociate commandto:

• Create a new instance of an attribute value

For example, consider an attribute attr1 already has two instance valuesattrvalue1 and attrvalue2. You want to add another instanceattrvalue3. Use the ciassociate command to add a new instance toattribute attr1.

• Change the value of an existing instance

For example, if an attribute has an instance value attrvalue2. You want tochange the instance value to attrvalue6. Use the ciassociate commandto change this existing instance value of attribute attr1.

This is illustrated below:

Syntax

ciassociat [object-class=classIdentifier] object-type=objectTypeobject-name=objectName [object-revision=objectRevision][attrfile=attributeFile] [input-attrs=attributeFile]attribute/data=refertothedescription





object-type=objectType Minor group of the object within the class, such asFILE and PART. The object-class and theobject-type parameters together identify specifickinds of objects. For example, a CADDS FILE or aCADDS PART. The default is FILE.

object-name=objectName Name of object. The length of this field depends onthe object type.

attribute/data=refertothe

description

Description of the attributes and the data that is tobe associated to the object. Optional or requireddepending upon whether your system administratorhas defined the attributes as required set members.

Enter a description up to 24 alphanumericcharacters in the form attribute=data.

Single-Instance Attributes

color= purple

material=steel

Multiple-Instance Attributes

color(1)=purple

color(2)=mauve

material(1)=steel

material(2)=jello

object-class=classIdentifier Major group to which the object belongs. Forexample, CADDS identifies a class of objects.

object-revision=objectRevision Identifies character revision of the object. Theobject-class, object-type, object-name, andobject-revision parameters together identify aspecific instance of an object. The length of thisfield depends on the object type. The default is thecurrent revision.

attrfile=attributeFile Name of an output attribute file in which commandresults are written. (Note: You must specify thisparameter to see specific results.) The length of thisfield varies based on your platform.

input-attrs=attributeFile Name of an attrfile that contains the user-definedattributes and their associated data that you want toaffect with this command. The length of this fieldvaries based on your platform.



Requirements and Considerations

If attributes are associated with a file, enter the name of a local file that contains thelist of attributes and assigned values. These values are assigned to attributesassociated with files or parts.

Attribute File Format

The file containing the attributes has one assignment on each line with the formatATTRIBUTE NAME(n)=attribute_value.

The attribute name is uppercase; the value can be mixed case. The value starts afterthe equal sign. Trailing blanks are ignored. The lines starting with ## are treated ascomments and are ignored while processing.

OPERATOR=EricaHOURS=7.5MATERIAL=Dilithium Crystals

The following considerations apply, to specify an attribute file containing values ofattributes:

• Only those attributes are allowed for which you have read/write authoritydepending on the action you want to perform.

Please note: The attributes for which user has read permission, but no writepermission are marked by ## as a first non-blank character, followed ATTRIBUTENAME(n)=attribute_value.

• If the attribute has unit of measure associated with it, you can express theattribute values in any presentation format as defined for the uom-set.

Audit Information

When you designate a file as the audit destination, Vault sends the information to afile named ASSOCIAT.EDMAUDIT. Use a local editor to view this file.

Example

CIASSOCIAT OBJECT-NAME=AA-FILENAME1 -OBJECT-TYPE=FILE,FAVORITEFOOD=CHICKEN -FAVORITESPORT=FISHING

Vault Commandschgadef (Binder)


chgadef (Binder)

The cichgadef command changes an attribute definition for an attribute in anexisting attribute group.

Syntax

cichgadef baseclass=baseClass otype=objectType atrbgrp=attributeGroupatrb=attribute mandatory=mandatoryAttributes datatype=dataTypeenum=enumerationListName default=defaultAttributeValue minval=minimumValuemaxval=maximumValue maxlen=maximumLength earliestdate=earliestDatelatestdate=latestDate [desc=description] keyfile=keyFile

Vault Commandschgadef (Binder)





Some restrictions can apply to changing characteristics of attributes to which datahas already been created.

baseclass=baseClass Name of the base class of the object type. Thedefault is BINDER.

otype=objectType Name of the object type of the attribute group.

atrbgrp=attributeGroup Name of the existing attribute group to change.

atrb=attribute Name of the existing attribute to change.

mandatory=mandatoryAttributes Indicates whether the attribute is required. Enter Y(yes) or N (no). The default is No.

datatype=dataType Specifies INTEGER, REAL, DATE, STRING, orENUM (enumeration). The default is STRING.

enum=enumerationListName Name of existing enumeration list.

default=defaultAttributeValue Default attribute value. Default depends on datatype: 0 if numeric and blank if string. The default is 0or blank

minval=minimumValue Minimum value for the data types INTEGER andREAL. The default is 0.

maxval=maximumValue Maximum value for the data types INTEGER andREAL.

maxlen=maximumLength Maximum length for the STRING and INTEGER datatypes. The default is 255(string) 38 (integer).

earliestdate=earliestDate Earliest date for the DATE data type. For USA usemm/dd/yy or mm/dd/yyyy as in 05/01/95 for May 1,1995.

For Europe use dd.mm.yy or dd.mm.yyyy as in01.05.1995 for 1 May, 1995.

latestdate=latestDate Latest date for the DATE data type. (See above forformat.)

keyfile=keyFile Name of the file containing command parameters inthe format of keyword=value.

desc=description Attribute name description. Enter a description up to 240alphanumeric characters (including blanks).

Vault Commandschgag


chgag

The cichgag command changes the numbers in an authority group.

Syntax

cichgag authgrp=authorityGroupName authnums=authorityNumbers



All are required.


To view the current authority numbers of an authority group before changingthem, enter an existing authority group name and press the processing key. Typeover the authority numbers you want to change and press the processing key asecond time.

The authority numbers displayed on the screen are condensed to show theminimum number of exclusive ranges and single authorities previouslyentered.You can specify authority numbers as single integers, separated bycommas, or as ranges of numbers, separated by a hyphen (-). The second numberof a range cannot be less than the first number (for example, 10-5 is an incorrectrange). There can be no embedded blanks in your list. See Vault Manager Guidefor more information about this command.

Please note: The CHGAG command directly affects what files users canaccess. If you change an authority group already assigned to one or more users, amessage is displayed to warn you of the scope of users and projects the change canaffect.

authgrp=authorityGroupName Existing authority group name. Enter a group name up to8 alphanumeric characters.

authnums=authorityNumbers List of authority numbers (and/or authority ranges). Enternumbers up to 300 characters, including numbers,commas, and hyphens. Separate each individualnumber from the next by a comma (for example,5,10,50). Separate each number within a range by ahyphen (for example, 10,30-40,50). The list cannotinclude blank spaces. Valid values are 0 through 99.

Vault Commandschgatrbs (Binder)


chgatrbs (Binder)

The cichgatrbs command changes attribute values for attributes on an object orrelationship instance.

Syntax

cichgatrbs

For Binders Only

cichgatrbs baseclass=baseClass oname=objectName [revision=revisionCode]


cichgatrbs frombaseclass=baseClass fromoname=fromObjectNamefromrevision=fromRevision tobaseclass=toBaseClass tooname=toObjectNametorevision=toRevision toinstid=toInstanceId


cichgatrbs atrbdata=attributeData keyfile=keyFile




For Binders Only



baseclass=baseClass Enter the name of the base class of the objectinstance. The default is BINDER.

oname=objectName Enter the name of the object.

frombaseclass=froObjectBaseClass

Enter the name of the base class of the parentobject: binder, part, or file. The default is BINDER.

fromoname=fromObjectName Enter the name of the parent object in therelationship.

fromrevision=fromRevision Enter the revision code of the parent object. Thedefault is the latest revision.

tobaseclass=toBaseClass Enter the name of the base class of the child object:binder, part, or file. The default is BINDER.

tooname=toObjectName Enter the name of the child object in the relationship.

torevision=toRevision Enter the revision code of the child object. Thedefault is the latest revision.

toinstid=toInstance Enter the instance number for the relationshipbetween this particular parent and child. Required ifmore than one exists. The default is 1.

atrbdata (1-n)=attributeData Enter the name of the attribute group.




The (1-n) specifies the order for changes to beapplied, not the instance of the data. Use a numberwhen changing more than one set of attribute data inone transaction. The default is (1).

keyfile=keyFile Enter the name of the keyword file for input. Enter aname up to 80 alphanumeric characters.




For Binders Only


Attributes are kept in a database table named for the attribute group. An object orrelationship instance can have one or more rows of data for a given attribute group.When you use the CHGATRBS command, the specific attributes you mention arechanged for all rows of attribute data in the named attribute group unless yourestrict the change to those rows with a certain attribute value.

Examples

CICHGATRBS ONAME=SAMPLEBOX - ATRBDATA=“FAMILY(DAUGHTER=JANE,WIFE=,DOG=FIDO)”

This example changes all rows of attribute data in the table ATR_FAMILY for thebinder named SAMPLEBOX as follows:

• Adds (or changes) the daughter’s name to JANE

• Sets wife’s name to NULL

• Adds (or changes) the dog’s name to FIDO

CICHGATRBS ONAME=SAMPLEBOX - ATRBDATA“(1)=CAR(MODEL=450SL COLOR=BLACK)”

This example changes the car model name to 450SL for all cars with color black.The blank preceding color indicates that it is a qualifier that limits the change tothose rows with the specified value. Without the blank, all rows would be changed.

revision=revisionCode Enter the revision code for the object. Enter a codeup to 20 alphanumeric characters of leave blank forthe default current revision.

Vault Commandschgattr


chgattr

The cichgattr command associates:

• file or part attributes to a unit of measure, where you can define the unit ofmeasure associated with the attribute.

• protection mechanism to files or parts attributes. The protection mechanismspecifies the security level of the attribute and compares it with the attributeauthority of the users.

This command is used with the ciaddattr command to define thecharacteristics of user-defined attributes.

Syntax

cichgattr attrname=attributeName [uomset=unitOfMeasure][precision=precisionvalue] [storeuom=storeuom] [presentuom=presentationuom][protectstate=protectionstate]


attrname=attributeName Enter the name of an existing attribute up to 24alphanumeric and special (hyphen andunderscore) characters.

Vault Commandschgattr




Atleast one of the optional keyword and values should be specified. You can assigna number to the attributes to be protected. If you are assigned an attribute readauthority group, for the project, which is the same as the protection level ofattribute, you can read the attribute. To write or modify the attribute, you must beassigned attribute write authority.

The storage and presentation UOM should be a member of the UOM set associatedwith the user attribute.

Restrictions

The Storage UOM and uomset after assigned to the attribute cannot be changed. Ifyou need to change it, delete the attribute and add it with another UOM. Use thiswith caution as this can delete all the existing values for that attribute.

Example

CICHGATTR ATTRNAME=ELAPSED_TIME UOMSET=DURATION-SETPROTECTLEVEL=66

uomset=unitOfMeasure Enter LENGHT, TEMPERATURE, or WEIGHT as the unitof measurement.

precision=precisionvalue Precision of the attribute value. Enter the precision (0-9),in terms of the number of digits after the decimal.

storeuom=storeuom The unit of measure used for storing the attribute value inthe database. This parameter specifies how UOM isstored internally in the database. The default is asdefined for uomset. If there is no default storage uomdefined for uomset, storeuom should be specified for theattribute.

NOTE: When uomset=WEIGHT, enter grams, kilograms,ounces or pounds.

presentuom=presentationuom The unit of measure used for presenting the attributevalue. The default is the storeuom. If there is no defaultstorage uom defined for uomset, presentuom should bespecified for the attribute. For example; Length isrepresented in meters.

NOTE: When uomset=WEIGHT, enter grams, kilograms,ounces or pounds.

protectlevel=protectionlevel Specifies the security level of the attribute and comparesit with the attribute authority of the users. Enter a numberfrom 0-99.

Vault Commandschgcl


chgcl

The cichgcl command removes and/or adds commands in a previously definedcommand list.

Syntax

cichgcl cmdlist=commandListName chgtype=inputField cmdfile1=NotApplicable


1 Used only with the command-line format


All are required.


When you use the command-line format to execute the CHGCL command, create afile that contains the commands to be added or removed and specify CHGTYPE=Aor CHGTYPE=R.

To change a command list that includes the special command ALL, delete the ALLcommand and add each command that you want to include.

The CHGCL command allows you to add commands to a command list thatincludes the ALL keyword. When you view the entry for the command list in theCOMMAND_LIST table, you see ALL along with any other commands you addedwith the CHGCL command. You can ignore commands listed with ALL; you haveaccess to all Vault commands. See Vault Manager Guide for more informationabout this command.

cmdlist=commandListName Existing command list name. Enter command listname up to 8 alphanumeric characters.

chgtype=inputField Indicates the type of action to be performed on thelist. Enter A (to add the commands) or R (to removethe commands).

cmdfile 1=NotApplicable Enter a local text file name, up to 80 alphanumericcharacters, that contains the command names to beadded or removed from the command list.

Vault Commandschgctl


chgctl

The cichgctl command changes the attributes of a command trigger list. Usethis command to maintain the list of Vault commands that trigger user-definedprocesses.

Please note: You must have Programming installed to use this command.

Syntax

cichgctlcommand=optegraCommandName active=active begin=triggerAtBeginningwbtime=timeout end=triggerAtEndm wetime=timeout aename=applicationEntityName



All are required.

command=optegraCommandName Name of an Vault command. Enter a vaultcommand name up to 8 letters or the specialcommand, ALL.

active=active Flag that indicates whether or not Vault shouldconnect to the triggered process. Enter Y (yes) orN (no). The default is Y.

begin=triggerAtBeginning Flag that indicates whether or not Vault shouldconnect to the triggered process at the beginningof command execution. Enter Y (yes) or N (no).

wbtime=timeout Maximum number of seconds Vault waits for atriggered process to return a response beforeVault command execution. Enter 0 to indicatetrigger and proceed without waiting. Otherwiseenter a number from 1 through 32767. The defaultis 0.

end=triggerAtEnd Flag that indicates whether or not Vault shouldconnect to the triggered process at the end ofcommand execution. Enter Y (yes) or N (no).

wetime=timeout Maximum number of seconds Vault waits for atriggered process to return a response after Vaultcommand execution. Enter 0 to indicate triggerand proceed without waiting. Otherwise enter anumber from 1 through 32767. The default is 0.

aename=applicationEntityName Application entity name of the triggered process inthe NSM configuration file. Enter as many as 32alphanumeric characters.




A command trigger is the ability to send a message to a separate user-writtenprocess at one or two points during Vault command execution—before and after.A triggered process is a detached user exit called by an Vault command to performuser-written logic. The exit is considered to be detached because it is not linked toVault code.

The triggered process is code that you write. When specified Vault commands areexecuted, Vault triggers the process you defined. You can set up triggeredprocesses for all Vault commands except UBKUP (universal backup), SIGNOFF(sign off from Vault), IQF (Interactive Query Facility), and CHGCTL (changecommand trigger list).

Use the CHGCTL command to maintain the list of Vault commands that triggeruser-defined processes. Each Vault command can trigger only one process.Multiple Vault commands can trigger the same process. You cannot remove acommand from the command trigger list with CHGCTL. You can only modify theattributes for any of the triggered processes. This command is not available on aremote Vault Client node.

The triggered process cannot alter the input data to the Vault command. Atriggered process can reside on any platform, must be defined in the NSMconfiguration file, and cannot contain an Vault command.

When a trigger and wait process is initiated, the server is not available for otherVault users until the process is completed. The triggered process cannot invoke theVault programmatic interface.

Vault refers to the command trigger list to know when to trigger a process. EachVault server can have one command trigger list. For each triggered process the listprovides the following information:

• Vault command name that triggers the process

• Whether or not to trigger the process

• Whether or not to trigger the process before command execution

• Maximum number of seconds to wait for a response from the triggered processbefore command execution

• Whether or not to trigger the process after command execution

• Maximum number of seconds to wait for a response from the triggered processafter command execution

• Application entity name of the triggered process in the NSM configuration file



Command triggers and the Vault programmatic interface provide similar functionsbut are independent of each other. With the programmatic interface you cancustomize applications so they initiate Vault functions. With command triggers,you initiate a process before and/or after Vault command processing.

For a triggered process to use the Vault programmatic interface, the triggeredprocess must communicate with another process that calls the programmaticinterface. How this communication takes place depends on your operating system.For the programmatic interface to use a triggered process, the programmaticinterface must call an Vault command that has a command trigger. When acommand includes a trigger, the triggered process is executed no matter whichVault interface (command, or programmatic) is used to execute the command.

To activate all triggers, enter ALL as the command name when you execute theCHGCTL command. Also, enter Y for Active. To clear all triggers, enter ALL as thecommand name and N for Active.

The Vault command trigger structure has a field that contains the overall success orfailure status of the Vault command. Depending on the selection scope used(F=file, P=part, S=fileset,etc.), the status code can have different interpretations.For example, if a selection scope of F (single file) is used and the store of the filefails, the command status code that is passed to the trigger is unsuccessful. Vaultselection scopes are classified as all or nothing or partial is OK.

All or nothing selection scopes are

• F—single file

• P—CADDS part

• S—file set

See Vault Programmer Guide for more information about command trigger lists.

Vault Commandschgdesc (Binder)


chgdesc (Binder)

The cichgdesc command changes the description of a binder, relationship,typedef, attribute group, or enumerated list.

Syntax

For All Uses of the Command

cichgdesc baseclass=baseClass [desc=description] keyfile=keyFile

For Binders Only

cichgdesc oname=objectName revision=revisionCode

For or Enumerated Lists Only

cichgdesc enum=enumerationListName

For Typedefs and Attribute Groups

cichgdesc otype=objectType

For Attribute Groups Only

cichgdesc atrbgrp=attributeGroup


cichgdesc otype=objectType from-baseclass=fromObjectBaseClassfromoname=fromObjectName fromrevision=fromRevisiontobaseclass=toBaseClass tooname=toObjectName torevision=toRevisiontoinstid=toInstance




All Uses of the Command

For Binders Only

For Enumerated Lists Only

For Typedefs and Attribute Groups

For Attribute Groups Only

baseclass=baseClass Enter BINDER, TYPEDEF, ATTRGRP,ENUMSET, or omit when changing arelation. The default is BINDER.

keyfile=keyFile Name of the file containing commandparameters in the format ofkeyword=value.

oname=objectName Name of the existing binder.

revision=revisionCode Revision code for the binder. The defaultis the default current revision.

enum=enumerationListName Name of existing enumeration list.

otype=objectType Name of the existing typedef to change.

atrbgrp=attributeGroup Name of an existing attribute group.





All Uses of the Command

otype=objectType Name of the existing typedef to change.

from-baseclass=fromObjectBaseClass Name of the base class of the parentobject: binder, part, or file. The default isBINDER.

fromoname=fromObjectName Name of the parent object in therelationship.

fromrevision=fromRevision Revision code of the parent object. Thedefault is the latest revision.

tobaseclass=toBaseClass Name of the base class of the childobject: binder, part, or file. The default isBINDER.

tooname=toObjectName Name of the child object in therelationship.

torevision=toRevision Revision code for the child object. Thedefault is BINDER.

toinstid=toInstance Instance number of the relationshipbetween this particular parent and child.Required if more than one exists. Thedefault is 1.

desc=description Description of the output file. Enter adescription up to 240 alphanumericcharacters (including blanks).

Vault Commandschgfa


chgfa

The cichgfa command changes file attributes1..

Syntax

cichgfa selscope=selectionScope selname=selectionNamerevision=revisionCode filepw=filesPassword output=auditDestinationappend=replaceOrAppendAuditFile? vaultid=vaultName


selscope=selectionScope Indicates the entity you are changing. Enter F(file), P (part), S (file set), or A (all of aproject). The default is F. Note that catalogsupport is not available for all the Vaultcommands. Hence, the usage ofselscope=C is invalid.

selname=selectionName Selection name. Enter a name up to 80alphanumeric characters.

revision=revisionCode Revision code. Enter a revision code up to 20alphanumeric characters or leave blank forthe default current revision.

filepw=file(s)Password File password. If file has password, enter upto 8 alphanumeric characters.

output=auditDestination Indicates where audit information is to besent. At the prompt enter F (file), B (both), orM (message only). For the keyword, enter For M. The default is F (Com- mand-lineformat). The default is F (Command-lineformat).

append=replaceOrAppendAuditFile? Indicates whether to replace or append theaudit file (CHGFA.EDMAUDIT). If auditdestination is F or B, enter R (replace) or A(append). Ignored if the audit destination is Sor M. The default is R.

vaultid=vaultName Enter a unique vault name up to 32case-sensitive alphanumeric characters.

Vault Commandschgfa




You can use this command to change the attributes of a file, part, project, or fileset.

You can change the following file attributes, which consist of the file’s systemtype, user-defined type, description, part number, group technology code, and filetype. These parameters are optional; that is, Vault does not require these fileattributes. In some cases, you cannot specify the attributes when you add the file toVault. In these cases, use the CHGFA command to specify attributes.

Change at least one attribute displayed. To enter new information, type overexisting field information. To remove contents and leave field blank, enter a # asthe first character in the field.

This command can be used only for files stored on your local node. For files onremote nodes, you must sign on to the remote node and execute the commandthere.

Specifying Selection Scope

When you select a CADDS part to be changed, if any of the files that make up theCADDS part cannot be changed (because they are signed out or locked, forexample), none of the part files are changed.

If you select all project files (of a specified project) to be changed, you must beassigned to the project and have the CHGFA command in your command list forthat project. All of the available files within the project are changed.

systype=system type System type code. Enter 8 or fewer alphanumericcharacters. Default: None

usertype=user type User-defined type code. Enter 8 or fewer alphanumericcharacters. Default: None

filedesc=file description File contents description. Enter 25 or feweralphanumeric characters (including blanks). Default:None

partnum=part number Part description. Enter 20 or fewer alphanumericcharacters (including blanks). Default: None

gtcode=group technology code Further file contents description or group technologycode. Enter 32 or fewer alphanumeric characters(including blanks). Default: None

Vault Commandschgfa


Revision Codes

You can specify a revision code for a particular version of a file to be changed.Otherwise, the current revision is changed. If you select a group of files to bechanged, only those files with the password you specify and those that are notpassword protected are changed. That is, you cannot use this command to changethe properties of a group of files with varying passwords.

When you use the command-line format and enter a file password, it is shown asyou type it and remains on the screen until you press the processing key.

Viewing Current Information

To view the current file information before executing the CHGFA command, use theLISTDIR command or the interactive query facility.

Audit Information

When you designate a file as the audit destination, Vault sends the information to afile named CHGFA.EDMAUDIT. Use a local editor to view this file.

Restrictions

When you select a file set to be changed, and if any of the files that make up the fileset cannot be changed (because they are signed out or locked, for example), noneof the file set members can be changed.

You must have write access to the file(s) you are changing. To change theproperties of a project file, you must be on the project. To change the properties ofa private file, you must be the owner of the file. You can not change the propertiesof a file that is in use.

Vault Commandschgfa


Example

You do not need to include entries for attributes that remain unchanged. However,you must change at least one attribute. See examples below.

Example 1:CICHGFAEDM> SELNAME=WINGDESC,EDM> FILEDESC=‘File updated 11/07/92.’

In this example, the file description for the WINGDESC file at the current revisionlevel is changed.

Please note: The single quotation marks (’) are needed because thedescription includes blank spaces.

Example 2:CICHGFAEDM> SELSCOPE=F SELNAME=WINGDESC REVISION=RE,EDM> FILEPW=WG FILEDESC=‘File updated 11/07/92.’,EDM> OUTPUT=S

In this example, the file description for the WINGDESC file at the RE revision levelis changed. The other attributes remain unchanged.

Please note: The file password is displayed.

Example 3:CICHGFAEDM> SELSCOPE=F SELNAME=WINGDESC REVISION=RE,EDM> FILEPW=WG FILEDESC=# OUTPUT=S

In this example, the file description for the WINGDESC file at the RE revision levelis erased (with the # character) and not replaced with new information. The otherattributes remain unchanged.

Vault Commandschgfcl


chgfcl

The cichgfcl command changes a file from one classification to another (public,project, or private) or from one project to another.

Syntax

cichgfcl selscope=selectionScope selname=selectionNamerevision=revisionCode filepw=file(s)Password class=newClassification

projid=projectId output=auditDestination append=replaceOrAppendAuditFile?vaultid=vaultName



All are required.

selscope=selectionScope Indicates the entity you are changing. Enter F(file), P (part), S (file set), B (binder), or A (allof a project). The default is F.


revision=revisionCode Revision code. Enter a string up to 20alphanumeric characters or leave blank forthe default current revision.

filepw=file(s)Password File password. If file has password, enter astring up to 8 alphanumeric characters.

class=newClassification New file classification code. Enter PUB(public), PRO (project), or PRI (private).

projid=projectId New project identifier. If new classification isPRO, enter up to 8 alphanumeric characters.Leave blank for new classification of PUB orPRI.

output=auditDestination Indicates where audit information is to besent. At the prompt enter F (file), B (both), orM (message only). For the keyword, enter For M. The default is F (Command-line format).

append=replaceOrAppendAuditFile? Indicates whether to replace or append theaudit file (CHGFA. EDM AUDIT). If auditdestination is F or B, enter R (replace) or A(append). Ignored if the audit destination is Sor M. The default is R.





You can use this command to change the classification of a file, part, project,binder, or file set. You can use the CHGFCL command to change objects from oneclassification to another and/or from one project to another.

This command can be used for files stored on local or remote nodes.

File Classification

A file can be classified as public (PUB), project (PRO), or private (PRI). Fileclassification determines file ownership.

• A private file has a user as an owner.

• A project file has a project as an owner.

• A public file has no designated owner.

Changing a File Classification

You can change a classification if all of the following are true:

• The current file status code exists under the new classification.

• You have the CHGFCL command in your command list for the project underwhich the file or part is stored

• You have write access to the file or part. You do not need to have authorityunder the new classification.

You do not need authority under the new classification.

For example, if a public file has a status code of AB and is going to be changed toa project file for the JET project, the status code AB must also exist in the JETproject authority scheme.

The status code, however, does not have to have the same authority numberassociated with it under the project authority scheme as it has under the publicauthority scheme.

You cannot change the classification of a registered object to a project that has‘NONE’ revision sequence.



To change a private file to a public file, the following must be true:

• The person doing the change must be the owner of the private file.

• The status code of the file must exist in the public authority scheme.

To change the classification of a file that is a member of a part, you must changethe classification of the whole part.

Please note: If the status code does not exist under the new classification, youmust first add it to the new classification authority scheme (at least temporarily) inorder to change a classification.

Examples of Changing File Classification

Example1:

File name: ENGINECurrent classification: PROProject ID: JETStatus code: IW (associated with authority number of 10)Change classification to PRO for CARGO project

Amelia can change the classification because she has a write authority of 90 (itmust be 10 or more) for the JET project. Charles cannot change the classificationbecause his write authority for the JET project is only 9.

Example 2:

File name: ENGINECurrent classification: PROProject ID: CARGOStatus code: IW (associated with authority number of 10)Change classification to PRO for JET project

Beryl can change the classification because she has a write authority of 90 (it mustbe 10 or more) for the CARGO project. Amelia cannot change the classificationbecause she has no write authority for the CARGO project.

Can the classification for ENGINE be changed to public? If the public authorityscheme includes the IW status code, then the classification can be changed to PUB.



Changing Revision codes

To change revision codes of previously stored files, use the CHGFREV command.You can do this only if the file does not have a released status and if the file is notassociated with a revision code sequence.

You can specify a revision code of a file to be changed. Otherwise, the currentrevision is changed.

Selection Scope


If you select a binder to change, the classification of the binder and all of itsaggregated objects (which by definition are the same) are changed. If anaggregated object is itself a binder, then the modification cascades down. Bydefinition, all aggregated objects have the same classification as their parentbinder. There is no effect on associated objects in the binder.

Audit Information

When you designate a file as the audit destination, Vault sends the information to afile named CHGFCL.EDMAUDIT. Use a local editor to view this file.

Restrictions

You can not change the classification of a file or part that is in use.

To change the classification of a private file, you must be the owner of the file, andthe current status code of the file must exist in the public authority scheme. Youcannot change a file to be another user’s private file.

If you select a group of files to be changed, only those files with the password youspecify and those that are not password protected are changed. In other words, youcannot use this command to change the properties of a group of files with varyingpasswords at one time.

If you select all project files (of a specified project) to be changed, you must beassigned to the project and have the CHGFCL command in your command list forthat project. All available files within the project are changed.



If you select a file set to be changed, and if any of the files that make up the file setcannot be changed (because they are signed out or locked, for example), none ofthe file set members are changed.

Examples

Example 1:

CICHGFCLEDM> SELNAME=WINGDESC CLASS=PUB

In this example, the WINGDESC file at the current revision level is reclassified as apublic file.

Example 2:

CICHGFCLEDM> SELSCOPE=F SELNAME=WINGDESC,EDM> REVISION=RE, FILEPW=WG CLASS=PUB

In this example, the WINGDESC file at the RE revision level is reclassified as apublic file.


Example 3:

CICHGFCLEDM> SELSCOPE=F SELNAME=WINGDESC,EDM> REVISION=RE CLASS=PRI

In this example, the WINGDESC file at the RE revision level is reclassified as aprivate file.



Example 4:

CICHGFCLEDM> SELSCOPE=F SELNAME=WINGDESC,EDM> REVISION=RE CLASS=PRO PROJID=CARGO

In this example, the WINGDESC file at the RE revision level is reclassified as aCARGO project file.

Please note: If you are changing the classification to PRI, you do not need toenter your Vault user ID in the PROJID parameter field. You cannot change a file’sclassification so it becomes another’s private file; therefore the file can default tobeing your private file.

Vault Commandschgfpw


chgfpw

The cichgfpw command adds, changes, or deletes a file or part password. Youmust know the current password of the file (if one exists) unless you haveadministrative privileges.

Syntax

cichgfpw selscope=selectionScope selname=selectionNamerevision=revisionCode filepw=currentFilePassword nfilepw=newFilePasswordoutput=auditDestination append=replaceOrAppendAuditFile?



All are required.

selscope=selectionScope Indicates the entity you are changing. Enter F(file), P (part), S (file set), or A (all of aproject). The default is F.


revision=revisionCode Revision code. Enter a string up to 20alphanumeric characters or leave blank forthe default current revision.

filepw=currentFilePassword File password. If file has password, enter astring up to 8 alphanumeric char.

nfilepw=newFilePassword New file password. Enter a string up to 8alphanumeric characters or enter a poundsign (#) to remove password.

output=auditDestination Indicates where audit information is to besent. At the prompt enter F (file), B (both), orM (message only). For the keyword, enter For M. The default is F (Command-line format).

append=replaceOrAppendAuditFile? Indicates whether to replace or append theaudit file (CHGFA. EDMAUDIT). If auditdestination is F or B, enter R (replace) or A(append). Ignored if audit destination is S orM. The default is R.




You can use this command to change the password of a file, part, project, or fileset.

This command can be used for files stored on any Vault server.

If your Vault user ID has been assigned administrative privileges, you can changethe password of other users’ files or parts.

Changing Revision Code

You can specify a revision code for a particular version of a file to be changed.Otherwise, the current revision is changed.

When you designate a file as the audit destination, Vault sends the information to afile named CHGFPW.EDMAUDIT. Use a local editor to view this file.

Restrictions

If you select a group of files to be changed, only those files with the password youspecify and those that are not password protected are changed. In other words, youcannot use this command to change the password of a group of files with varyingpasswords at one time.

Please note: When you use the command-line format and enter a filepassword, it is shown as you type it and remains on the screen until you press theprocessing key.

You must have write access to the file(s) you are changing. To change thepassword of a private file, you must be the owner of the file. You can not changethe password of a file that is in use.

If you select a CADDS part to be changed, if any of the files that make up theCADDS part cannot be changed (because they are signed out or locked, forexample), none of the part files are changed.

If you select all project files (of a specified project) to be changed, you must beassigned to the project and have the CHGFPW command in your command list forthat project. All available files within the project are changed.



If you select a file set to be changed, if any of the files that make up the file setcannot be changed (because they are signed out or locked, for example), none ofthe file set members are changed.

Example

CICHFPWEDM> SELSCOPE=F SELNAME=WINGDESC REVISION=RE,EDM> NFILEPW=NWG FILEPW=WG

In this example, the password for the WINGDESC file at the RE revision level ischanged from WG to NWG.

Please note: The file passwords are displayed.

Vault Commandschgfrev


chgfrev

The cichgfrev command allows a user to assign or change a revision of an itemany time that item is in an in-work state and is not associated with a revisionsequence.

Syntax

cichgfrev selscope=selectionScope selname=selectionNamefilepw=filePassword revision=currentrevisionCode newrev=newrevisionCodevaultid=vaultName



All are required.


To change the revision code with the CHGFREV command, the file or other item

• Must be in an in-work state

• Must not be associated with a revision code sequence

• Must not be a member of a part

To change the revision of a file that is a member of a part, you must change therevision of the whole part.

selscope=selectionScope Indicates the entity you are changing. Enter F (file),P (part), or B (binder). The default is F.


filepw=filePassword File password. If file has password, enter a string upto 8 alphanumeric char.

revision=currentrevisionCode Revision code. Enter a string up to 20 alphanumericcharacters or leave blank for the default currentrevision.

newrev=newrevisionCode New revision code. Enter a string up to 20alphanumeric characters or leave blank for norevision.

vaultid=vaultName Enter a unique vault name up to 32 case-sensitivealphanumeric characters.

Vault Commandschgfrev


When you specify a binder to change, only the given binder is affected; there is noeffect on aggregated or associated objects that are contained in the binder.

Revision Codes

The revision of an Vault file distinguishes the design cycle of a file. When youstore a file in the database for the first time you can specify a revision code. If youdo not specify a revision code, Vault automatically assigns the initial revision code.The file keeps this revision code for its entire design cycle. When a file is approvedfor release, the in-work status code changes to a released status code.

Blank Revision Codes

You can assign blank revision codes when you store files. To set this up for publicfiles, execute the ADDP command with a blank project ID and none specified forthe revision sequence name. To set this up for files belonging to a particularproject, execute the ADDP command with the appropriate project ID and nonespecified for the revision sequence name. You cannot change an assigned revisioncode to blank.

Example

CICHGFREVEDM> SELNAME=MY.FILE REVISION=DEC101992,EDM> NEWREV=JAN181993

In this example, the MY.FILE file is given the JAN181993 revision level.

Vault Commandschgfsc


chgfsc

The cichgfsc command changes a file status code.

Syntax

cichgfsc selscope=selectionScope selname=selectionNamerevision=revisionCode filepw=file(s)Password currstat=currentStatusCodenewstat=newStatusCode [comment=comments] output=auditDestinationappend=replaceOrAppendAuditFile? vaultid=vaultName


selscope=selectionScope Indicates the entity you are changing. Enter F(file), P (part), S (file set), B (binder), or A (all ofa project). The default is F.


revision=revisionCode Revision code. Enter a string up to 20alphanumeric characters or leave blank for thedefault current revision.

filepw=file(s)Password If file has password, enter a string up to 8alphanumeric characters.

currstat=currentStatusCode Current status code.Enter a string up to 8 alphanumeric characters ifselection scope is A, or S.

newstat=newStatusCode New status code. Enter a string up to 8alphanumeric characters.

output=auditDestination Indicates where audit information is to be sent.At the prompt enter F (file), B (both), or M(message only). For the keyword, enter F or M.The default is F (Command-line format)

append=replaceOrAppendAuditFile? Indicates whether to replace or append theaudit file (CHGFA. EDMAUDIT). If auditdestination is F or B, enter R (replace) or A(append). Ignored if audit destination is S or M.The default is R.






The status code represents the phase of work within the authority scheme the file isstored under. You can use this command to change the status code of a file, part,project, binder, or file set. You can change a status code if

• The new status code is defined in the authority scheme under which the file isstored.

• You have write access to the file. You can change the status code to onesequence above or one or more sequence below the current status, even if youdo not have write access under the new status.

Please note: This rule does not apply if you have administrative privileges.

To change the status code of a private file, you must be the owner of the file. Youcan not change the status code of a file that is in use or that is a member of a part.You can only change the status of a part as a whole.

Example of File Status Code Changes

File name: FANCurrent status code: IDChange to status code: DRProject ID: JET

The DR status code must exist in the JET authority scheme for this change to beallowed.

Who can make this change? Snoopy has administrative privileges so he can makethe change. Orville cannot make the change. He does not have administrativeprivileges and the sequence number associated with the DR status code is twolevels higher than the ID status code and Orville does not have write authority forfiles with the ID status code.

When changing the status code of a binder, the binder itself and all aggregatedmembers of the binder are changed. There is no effect on associated objects.

comment=comments Status change description. Enter a descriptionup to 240 alphanumeric characters (includingblanks).



By definition all aggregated objects have a status that is equal to or higher than theimmediate parent binder status. Hence for an upward status change, the status ofall those owned objects (files, parts, or binders) that have a lower status than thedestination status, can be changed.

Blank Revision Code

If a file is not associated with a file sequence and has a blank revision code, youmust assign a revision code with the CHGFREV command before you can changethe file status code to released.

When you designate a file as the audit destination, Vault sends the information to afile named CHGFSC.EDMAUDIT. Use a local editor to view this file.

Restrictions

You cannot change other Vault users files. You also cannot change the status codeof a file that is in use or that is a member of a part.


When you select all project files (of a specified project) to be changed, you mustbe assigned to the project and have the CHGFSC command in your command listfor that project. All available files within the project are changed.

When you select a file set to be changed, if any of the files that make up the file setcannot be changed (because they are signed out or locked, for example), none ofthe file set members are changed.

When you select a group of files to be changed, only those files with the passwordyou specify and those that are not password protected are changed. In other words,you cannot use this command to change the status code of a group of files withvarying passwords at one time.

Please note: When you use the command-line format and enter a filepassword, it is shown as you type it and remains on the screen until you press theprocessing key.



Example

CICHGFSCEDM> SELSCOPE=F SELNAME=WINGDESC,EDM> REVISION=RE, FILEPW=WG,EDM> CURRSTAT=FI NEWSTAT=RE,EDM> COMMENT=‘Final phase moved to released’

In this example, the status code for the WINGDESC file at the RE revision level ischanged from FI to RE.


Vault Commandschgfsp


chgfsp

The cichgfsp command changes the storage pool of a file.You must have theability to modify a file to move it from one storage pool to another. You can moveonly a single file with each execution of the command.

Syntax

cichgfsp selname=selectionName revision=revisionCodepoolname=newstoragepoolname



All are required.


You must have the ability to modify a file to move it from one storage pool toanother. You can move only a single file with each execution of the command.

The CHGFSP command can cause the destination storage pool to remainwrite-locked (status = 1), if the source storage pool is offline. To fix the situation,run the “chgsps” on page 3-104 (change storage pool status) to change the statusto available (0).

Example

CICHGFSPEDM> SELNAME=WINGDESC REVISION=RE,EDM> POOLNAME=POOLX

In this example, the WINGDESC file is moved to a storage pool called POOLX.

selname=selectionName Enter a selection name up to 80 alphanumericcharacters.

revision=revisionCode Enter a revision code up to 20 alphanumericcharacters. The default is the current revision.

poolname=newstoragepoolname Enter the name of an existing Vault storage pool upto 8 alphanumeric characters.

Vault Commandschgmas


chgmas

The cichgmas command changes a member of an attribute set. You can changethe required/optional status and the default value.

Syntax

cichgmas setname=setName amemname=attributeOrSetNameamemtype=MemberType reqopt=RequiredOrOptional defaval=Default



All are required.


If you need to change the name of the attribute, you must delete the attribute,define a new one, and then add it to the attribute set.

setname=setName Name of the attribute set that includes the memberbeing changed. Enter as many as 24 charactersincluding only A-Z, 0-9, hyphen, and underscore.

amemname=attributeOrSetName Name of the attribute or attribute set you want tochange. Enter as many as 24 characters includingonly A-Z, 0-9, hyphen, and underscore.

amemtype=MemberType Type of set member being changed. Enter A for anAttribute or S for a Set. The default is A.

reqopt=RequiredOrOptional Indicates whether applying the member is requiredor optional. Specify only for attributes beingchanged. Vault discards this value if the memberbeing changed is a set. Enter R (Required) or O(Optional). The default is R.

defaval=Default Indicates the default value for the attribute beingchanged. The default value must pass the ruledefined for the attribute’s data type. Vault usesexactly the data you enter, respecting upper andlowercase. Enter as many as 240 characters.Specify this value only when the member beingadded is an attribute. Vault discards this value if themember being added is a set. Specify NO-DEFAULTif you do not want a default value.

Vault Commandschgp


chgp

The cichgp command changes the attributes of a project.

Syntax

cichgp projid=projectId [revname=revisionSequenceName][projname=projectName] [contract=contractNumber] [units=unitOfMeasure][projdesc=description]



projid=projectId Existing project identifier. Enter a project identifierup to 8 alphanumeric characters.

revname=revisionSequenceName Previously defined name of a revision codesequence. Enter a string up to 8 alphanumericcharacters.

projname=projectName Project name. Enter a name up to 15alphanumeric characters.

contract=contractNumber Contract number. Enter a string up to 25alphanumeric characters.

units=unitOfMeasure Unit of measure code. Enter a string up to 5alphanumeric characters, for example, FEET(feet), METER (meters), CM (centimeters).

projdesc=description Project description. Enter a description up to 30alphanumeric characters (including blanks).

Vault Commandschgp



To display the current data for the project before you make any changes, executethe CHGP command with the project ID.

You cannot change the project ID with the CHGP command. To change the projectID, delete the project and add it again with the new name (with the ADDPcommand).

Enter a pound sign as the first character to remove the current data from theoptional fields.

To change the revision code sequence used for public files, leave the project IDblank and enter a revision code sequence name.


Vault Commandschgs


chgs

The cichgs command changes a public or project status level by changing any ofits associated attributes:

• Sequence number

• Authority number

• Status partition code

• Status description

Syntax

cichgs statcd=statusCode projid=projectId seqnum=sequenceNumberauthnum=authorityNumber statpc=statusPartitionCode [statdesc=statusDescription]



statcd=statusCode Existing code that represents a phase of work in a Vaultauthority scheme. Enter a string up to 8 alphanumericcharacters.

projid=projectId Existing project identifier. Enter a project identifier up to 8alphanumeric characters or leave blank for the defaultpublic authority scheme.

seqnum=sequenceNumber Number code that establishes order in this authorityscheme. Enter a number between 0 and 9999.

authnum=authorityNumber Number code that associates a user’s authority with astatus code. Enter a number between 0 and 99.

statpc=statusPartitionCode Code to distinguish two special status levels within eachauthority scheme. These codes partition the scheme intodormant, in-work, and released status levels. Enter I (forthe initial in-work status) or R (for the initial releasedstatus). Leave blank for all other status levels. Within anauthority scheme, assign I to one status level and R toanother. The status level associated with the R musthave a higher sequence number than the one associatedwith the I.

statdesc=statusDescription A 30-character (including blank spaces) field to describethe phase of work of this status level (or any otherinformation).

Vault Commandschgs



You cannot change the status code of a status level, instead it must be deleted andreentered with the new status code.

To change the status level of a public authority scheme, do not specify a project ID.To change the status level of a project authority scheme, enter the name of anexisting project ID. The status level must exist in the authority scheme for theproject ID entered.

To display the current data for a status code, execute CHGS specifying the statuscode (for the public status code) or both a status code and a project ID (for theproject status code).

To change the sequence of the status levels within an authority scheme, change thesequence numbers of the status levels within that scheme. The sequence numbersmust be unique within the authority scheme; a sequence number cannot bechanged to another sequence number that already exists.

To assign a status partition code to a different status level, first change the statuslevel that is currently associated with the status partition code. Enter a pound sign(#) for the Status partition code parameter to delete the status partition code fromthe status level. Then immediately add or change another status level so that bothan I (in-work) and R (released) level exist in the scheme. Files can not be stored orcannot be accessed unless both an I and R level exist.

Please note: A warning message is issued whenever you remove a statuspartition code with the CHGS command, because the code should be replacedimmediately.

The I (for initial in-work) and R (for initial released) status partition codes must beunique within the scheme to which they are being added. A status partition codecannot be changed to I or R if it already exists in the scheme.

The sequence number associated with the I status partition code must be less thanthe sequence number associated with the R status partition code.


Vault Commandschgsps


chgsps

The cichgsps command changes the status of a storage pool. The server neednot have a local tape device.

Syntax

cichgsps poolname=storagePoolName poolstat=storagePoolStatus



All are required.

poolname=storagePoolName Enter a unique name of an existing storage area in theVault up to 8 alphanumeric characters.

poolstat=storagePoolStatus Enter a one-character status value. The followingvalues are allowed:

0 Available and online

1 Locked in write-mode by Vault

2 Read-only

3 Offline

4 Unavailable as detected by Vault

5 Unavailable due to media failure

6 Lagged for roll forward by the RECSP command

7 Recovered by RECSP

8-9 Reserved for future use

A-Z Unavailable with user-defined reason

Values 0-9 are defined by Vault and stored in atwo-column database table. These columns are for theactual status value and a description.

Values A-Z are user-defined values that are loaded intothe database with a file. Treatment of values A-Z isfunctionally equivalent to the status value of 3 (offline).

Vault Commandschgspt


chgspt

The cichgspt command changes the type of a storage pool.

Syntax

cichgspt poolname=storagepoolName pooltype=storagepoolTypechgtype=Action



All are required.

See Vault System Administrator Guide for more information about this command.

poolname=storagepoolName Enter a unique name of an existing vault storagepool up to 8 alphanumeric characters.

pooltype=storagepoolType Enter a string up to 32 characters without embeddedblanks. This contains the categorization value.

chgtype=Action Enter a 1-character string that indicates the action tobe performed, A for Add or R for Remove.

Vault Commandschgu


chgu

The cichgu command changes a user’s attributes and/or authority.

Syntax

cichgu userid=VaultUserId [userpw=optegraUserPassword][fullname=userFullName] [lastname=userLastName] [userdesc=userDescription][cmdlist=commandListName] [usergrp=userGroup][protgrp=protectionGroupName] reada=readAuthorityNumber[readag=readAuthorityGroupName] [writea=writeAuthorityNumber][writeag=writeAuthorityGroupName] [admin=doesUserHaveAdministrativePrivileges?][areada=attributeReadAuthorityNumber] [awritea=attributeWriteAuthorityNumber][areadag=attributeReadAuthorityGroupName][awriteag=attributeWriteAuthorityGroupName] [langpref=language][uompref=preferedUOMSystem]


userid=VaultUserId Existing Vault User identifier. Enter a useridentifier up to 12 alphanumeric characters.

Vault Commandschgu



userpw=optegraUserPassword User password. Enter a password up to 8alphanumeric characters.

cmdlist=commandListName Existing command list name. Enter a commandlist name up to 8 alphanumeric characters.

reada=readAuthorityNumber Read authority number that sets a user’s readauthority limit. Enter a number between 0 and99 unless you enter a read authority groupname. The default is 00.

readag=readAuthorityGroupName Existing authority group name. Enter a authoritygroup name up to 8 or fewer letters and ornumbers unless you enter a read authoritynumber. Default: None.

writea=writeAuthorityNumber Write authority number that sets a user’s writeauthority limit. Enter a number between 0 and99 unless you enter a write authority groupname. The default is 00.

writeag=writeAuthorityGroupName Existing authority group name. Enter authoritygroup name up to 8 or fewer letters and ornumbers unless you enter a write authoritynumber. Default: None.

admin=doesUserHaveAdministrative

Privileges?

Indicates whether the user is given specialadministrative privileges. Enter Y (yes) or N(no).

fullname=userFullName User full name. Enter a full name up to 25alphanumeric characters, including blanks.

lastname=userLastName User last name. Enter a last name up to 15alphanumeric characters.

userdesc=userDescription User description field. Enter a description up to30 alphanumeric characters, including blanks.

usergrp=userGroup User group code. Enter 1 or 2 alphanumericcharacters.

protgrp=protectionGroup

Name

CGOS protection group code. Enter ahexadecimal number between 0 and FFFF.

areada=associateReadAuthority

Number

Read authority number that sets the user’sattribute read authority. Enter a numberbetween 0 and 99. You can also specify a rangefrom 0-number. The default is 0.

areadag=associateReadAuthority

GroupName

Existing authority group name. Enter a authoritygroup name up to 8 alphanumeric charactersunless you enter a read authority number.

awritea=associateWriteAuthority

Number

Write authority number that sets a user’sattribute write authority limit. Enter a numberbetween 0 and 99. You can also specify a rangefrom 0-number. The default is 0.

Vault Commandschgu



To view the current data for a user before making changes, enter the Vault user IDand press the processing key. Type over the information you want to change (oradd new information) and press the processing key a second time. To remove thecurrent information and not replace it with new information, enter a pound sign (#)as the first character in the field. Command list and authority group names enteredmust have been previously defined.


awriteag=associateWriteAuthority

GroupName

Existing authority group name. Enter authoritygroup name up to 8 alphanumeric charactersunless you enter a write authority number. Ifboth are entered the authority number isignored.

langpref=language Enter your language preference.

uompref=preferedUOMSystem Enter your prefered unit of measure system, e.g.MKS/FPS.

Vault Commandschguattr


chguattr

The cichguattr command changes the attribute data on a file or part withouttransferring the object.

If an attribute has already been associated, then use the cichguattr command tochange the value of an instance.

For example, if an attribute has an instance value attrvalue2. You want tochange the instance value from attrvalue2 to attrvalue4. Use thecichguattr command to change this existing instance value of attribute attr1.This is illustrated below:

Syntax

chguattr [object-class=classIdentifier] [object-type=objectType]object-name=objectName [object-revision=objectRevision][attribute/data=refertothedescription] [attrfile=attributeFile][input-attrs=attributeFile]





object-name=objectName Name of object. The length of this field dependson the object type.


description

Decription of the attributes and the data that isto be associated to the object. Optional orrequired depending upon whether your systemadministrator has defined the attributes asrequired set members.

Enter description up to 24 alphanumericcharacters in the form attribute=data.


color= purple

material=steel


color(1)=purple

color(2)=mauve

material(1)=steel

material(2)=jello


object-type=objectType Minor group of the object within the class. Thewell known examples are FILE and PART. Theobject-class and the object-type parameterstogether identify specific kinds of objects. Forexample, a CADDS FILE or a CADDS PART.The default is FILE.

object-revision=objectRevision Identifies the character revision of the object.The object-class, object-type, object-name, andobject-revision parameters together identify aspecific instance of an object. The length of thisfield depends on the object type. The default isthe current revision.

attrfile=attributeFile Name of an output attribute file in whichcommand results are displayed. (Note: Youmust specify this parameter to see commandresults.) The length of this field varies based onyour platform.

input-attrs=attributeFile Name of an attrfile that contains theuser-defined attributes and their associateddata that you want to affect with this command.The length of this field varies based on yourplatform.




The Vault administrator can inform you when there are attributes associated with afile. Attributes are important pieces of information associated with a selection.

Attribute File Name

If attributes are associated with a file, enter the name of a local file that contains thelist of attributes and assigned values. When attributes are assigned to a selection,you can use IQF to obtain information about the attributes.


The file containing the attributes should have one assignment on each line with thefollowing format:

ATTRIBUTE NAME=attribute value

The attribute name is always converted to uppercase; value can be mixed case. Thevalue is immediately after the equal sign. Trailing blanks are ignored.

For example,



• Only those attributes are allowed for which you have write authority.




Selection Scopes that Include Multiple Files

When the selection scope covers multiple Vault objects, the file identifies eachobject before listing attribute values. The identifiers OBJECT-NAME andOBJECT-TYPE identify the objects. Instance numbers in parentheses indicatemultiple values for an attribute.

The content of the attribute file might look like this:

OBJECT-NAME=jet.partOBJECT-TYPE=partWEIGHT(1)=3.2WEIGHT(2)=4.4CLEARANCE=SecretOBJECT-NAME=jet.drawingOBJECT-TYPE=fileSIZE=“14 x 22”

Example

CICHGUATTR OBJECT-NAME=AA-FILENAME1 - OBJECT-TYPE=FILE AA-ATTRIBUTE2=STEAK

Vault Commandschgup


chgup

The cichgup command changes a user’s project authority.

Syntax

cichgup userid=VaultUserId projid=projectId [cmdlist=commandListName][reada=readAuthorityNumber] [readag=readAuthorityGroupName][writea=writeAuthorityNumber] [writeag=writeAuthorityGroupName][admin=doesUserHaveAdministrativePrivileges?][areada=attributeReadAuthorityNumber] [awritea=attributeWriteAuthorityNumber][areadag=attributeReadAuthorityGroupName][awriteag=attributeWriteAuthorityGroupName]



userid=VaultUserId Existing Vault user identifier. Enter a useridentifier up to 12 alphanumeric characters.

projid=projectId Existing project identifier. Enter a projectidentifier up to 8 alphanumeric characters.

cmdlist=commandListName Existing command list name. Enter acommand list name up to 8 alphanumericcharacters.

reada=readAuthorityNumber Read authority number that sets a user’s readauthority limit. Enter a number between 0 and99 unless you enter a read authority groupname. The default is 00.

readag=readAuthorityGroupName Existing authority group name. Enter aauthority group name up to 8 or fewer lettersand or numbers unless you enter a readauthority number. Default: None

writea=writeAuthorityNumber Write authority number that sets a user’s writeauthority limit. Enter a number between 0 and99 unless you enter a write authority groupname. The default is 00.

writeag=writeAuthorityGroupName Existing authority group name. Enter authoritygroup name up to 8 or fewer letters and ornumbers unless you enter a write authoritynumber. Default: None


Indicates whether or not the user is givenspecial administrative privileges for thisproject’s files. Enter Y (yes) or N (no).

Vault Commandschgup



Number

Read authority number that sets the user’sattribute read authority. enter a numberbetween 0 and 99. A number entered heremeans a range from 0-number. The default is0.


GroupName

Existing authority group name. Enter aauthority group name up to 8 alphanumericcharacters unless you enter a read authoritynumber.


Number

Write authority number that sets a user’sattribute write authority limit. Enter a numberbetween 0 and 99.A number entered heremeans a range from 0-number. The default is0.


GroupName

Existing authority group name. Enter authoritygroup name up to 8 alphanumeric charactersunless you enter a write attribute authoritynumber. If both are entered the authoritynumber is ignored.

Vault Commandschgup



With the CHGUP command, you can change

• The command list name assigned to the user

• The read and write authorities of the user on the project

• The administrative privileges for the user on the project

• The read and write attribute authorities of the user on the project

To display the current information for the user before you make any changes,execute the CHGUP command with the project ID and Vault user ID.

You cannot change the Vault user ID for a user with this command. To change theVault user ID for a user, remove the user from the project (with REMUP), and deletethe user from Vault (with DELU). Then add the user to Vault (with ADDU) andassign the new Vault user ID to the project (with ADDUP). If both authoritynumbers and authority groups are assigned to a user, Vault uses the authoritygroups and ignores the authority numbers.


Vault Commandschgupw


chgupw

The cichgupw command changes your own user password.

Syntax

cichgupw userpw=currentVaultUserPassword nuserpw=newVaultUserPassword



All are required.


This command cannot change the sign-on password of other users. Only the CHGUcommand can do that.

The new sign-on password can be in affect the next time you initiate a Vaultsession.

The password is encrypted in the Vault database and you cannot translate thisinformation to the valid password. If you forget your password or misspell it whenentering it, a user with authority to execute the CHGU command must change thepassword for you. The new sign-on password cannot be blank.

The current password field is protected on the screen and is not displayed whentyped.

The new password field is displayed on the screen until you press the processingkey. You can catch spelling mistakes before entering the data, but you are notprotected from other users looking over your shoulder.


userpw=currentVaultUserPassword Vault user password. Enter the currentpassword up to 8 alphanumeric characters.

nuserpw=newVaultUserPassword New Vault user password. Enter the newpassword up to 8 alphanumeric characters.

Vault Commandsclassify


classify

The ciclassify command evaluates the classification rules defined in thedatabase and produces a list of user-defined attributes you can associate to theobject.

Syntax

ciclassify [object-class=classIdentifier] object-type=objectTypeobject-name=objectName [object-revision=objectRevision]attrfile=attributeFile input-attrs=attributeFileattribute/data=refertothedescription





object-type=objectType Minor group of the object within the class, suchas FILE and PART. The object-class and theobject-type parameters together identify specifickinds of objects. For example, a CADDS FILE ora CADDS PART. The default is FILE.

object-name=objectName Name of the object. The length of this fielddepends on the object type.


input-attrs=attributeFile Name of an attrfile that contains theuser-defined attributes and their associateddata that you want to affect with this command.The length of this field varies based on yourplatform.


description

Description of the attributes and the data that isto be associated to the object. Optional orrequired depending upon whether your systemadministrator has defined the attributes asrequired set members.

Enter description up to 24 alphanumericcharacters in the form attribute=data.


color= purple

material=steel


color(1)=purple

color(2)=mauve

material(1)=steel

material(2)=jello






Only those objects are allowed for which you have read/write authority.

The objects for which user has read permission, but no write permission aremarked by ## as a first non-blank character, followed ATTRIBUTENAME(n)=attribute_value.

Audit Information

When you designate a file as the audit destination, Vault sends the information to afile named CLASSIFY.EDMAUDIT. Use a local editor to view this file.

Example

CICLASSIFY OBJECT-NAME=AA-FILENAME1 -OBJECT-TYPE=FILE ATTRFILE=AA-TESTFILE3

Vault Commandsclst


clst

The ciclst command ends your access to and cancels your privileges for a tablecontrolled by Vault.

Syntax

ciclst qtblname=tableOrViewName



All are required.


CLST is not available on a remote Vault Client node. See Vault Manager Guide formore information about this command.

qtblname=tableOrViewName Name of an SQL table previously added to Vault withthe ADDT command. Prefix the name with thecreator’s SQL ID in the form creator.table_name.Enter a tablename up to 61 characters.

Vault Commandscopy


copy

The cicopy command creates a Vault copy within the database. This commandcopies a Vault file to a new file name, or the same file name but with a differentrevision level. You can copy a file, a part, all files in a individual files belonging toa part (part information is not copied).

Syntax

cicopy selscope=selectionScope selname=selectionName revision=revisionCodefilepw=filePassword copyname=copyName copyrev=revisionCodecopycla=classification



All are required.

selscope=selectionScope Indicates the entity you are reading. Enter F (file), P (part), or L(list). The default is F.

selname=selectionName Selection name. Enter a name up to 80 alphanumericcharacters.

When SELSCOPE=L, the selection name is the name of a localfile containing the names of the files and parts to be read.

revision=revisionCode Revision code. Enter a string up to 20 alphanumeric charactersor leave blank for the default current revision.

filepw=filePassword File password. If file(s) has password, enter up to 8alphanumeric characters.

copyname=copyName Name of the file copy. Enter a filename up to 80 alphanumericcharacters.

copyrev=revisionCode Revision code of copy. Enter the revision code up to 20alphanumeric characters or leave blank for the default sourcefile revision code.

copycla=classification File classification of copy. Enter PUB (public), PRO (project), orPRI (private), or leave blank for the default source fileclassification.

Vault Commandscopy



The cicopy command allows you to do the following:

• Create a Vault file or part copy with the same properties as the original file orpart.

• Create a Vault file or part copy under another name with different propertiesfrom the original.

File Copy Attributes

Each file copy retains the same optional attributes (Vault file attributes in additionto any user-defined attributes) and contents as the original file. Optional fileattributes are

• System type

• User type

• Group technology code

• File description

• Part number

You can choose whether to retain the other file properties of the original file withinthe copied version or change them at this time. That is, you can specify a different

• Revision code

• Classification (public, project, or private)

• Status code (you must choose one within the authority scheme for the file)

• Project ID (as long as you have the needed authority on the project)

• File password

When you copy files or parts that are members of a binder, none of therelationships are copied that exist between the original file and the binder.

Vault Commandscopy


Revision Codes

The figure below summarizes the rules you need to follow for the COPY command.

Vault Commandscopy


If you specify a new classification, you must also specify a new revision code andvice-versa.

The file name and revision level of the copy must be unique in Vault. You can haveonly one in-work version of a file at a particular revision level. If a file at aparticular revision exists in the archive table, you cannot copy the file and give thecopy the same name and revision.

Associated User-defined Attributes

You can execute the COPY command for a file with associated user-definedattributes. Vault copies these attributes along with the file and its other properties.When you execute a GET or READ command for the copy, you can view theattributes in an attribute file just as you can for the original.

COPY Command Messages

When the selection is copied, the file copy name for every selected file is writtento the audit file. If one or more files cannot be copied, a message alerts you to howmany files were copied.

How the Name of the Copy is Determined

The name of the copy depends on the data you select to copy (a single file, or apart).

If you copy any of the following:

Examples of Names of Copies

The format of the copy file name depends on your selection scope value (that is,whether you are copying a single file, or part).

Selection Scope Name of the Copy

F (file) The copy has the name you specify in the COPY command.

P (part) Each individual file within the CADDS part is copied to the copy name.

For example, if you copy the FIRST.ONE part to the NEW.ONE part,the copy of the FIRST.ONE.A file has the name NEW.ONE.A.

Vault Commandscopy


The tables below shows the names given to copies of Vault files based on theselection scope value and the new copy name.

Audit Information

When you designate a file as the audit destination, Vault sends the information to afile named COPY.EDMAUDIT. Use a local editor to view this file.

Restrictions

You must have read access to the file you are copying (the source). You must havewrite access to the new file (the target). In other words, you must give the new filea status code so that you have the authority to modify that file.

• You must have the STORE command as well as the COPY command in yourcommand list.

• When you want to copy a file, the original file (stored in Vault) must not becurrently in use.

• If the file to be copied is a project (PRO) file, you must be assigned to theproject.

• If the file to be copied is a private (PRI) file, you must be its owner.

• The file to be copied must not be currently in use.

• You can copy a file to be your own private file. You cannot copy a file to beanother user’s private file.

• Together, the file name and revision level of the copy must be unique in Vault.

• You can have only one in-work version of a file at a particular revision level.

• If a file at a particular revision exists in the archive table, you cannot copy thefile and give the copy the same name and revision.

The example following the next page provides information about copying fileswith and without revision codes.

Name of Original File Name of Copy of File

WINGPARTA.1 WINGPARTB.1

WINGPARTA.FILE.T3.1 WINGPARTB.FILE.T3.1

WINGPARTA.PART.&PD WINGPARTB.PART.&PD

Vault Commandscopy


Example

CICOPYEDM> SELSCOPE=F SELNAME=WINGDESC REVISION=RE,EDM> FILEPW=WG,EDM> COPYNAME=NEWWINGDESC OUTPUT=F APPEND=A

In this example, the WINGDESC file at the RE revision level is copied to a new filename, NEWWINGDESC. The audit information is sent to the audit file where the newinformation is appended to the current file contents.


Vault Commandscopyattr


copyattr

The cicopyattr command copies the associated data attributes from one file orpart to another file or part.

Syntax

cicopyattr [object-class=classIdentifier] object-type=objectTypeobject-name=objectName [object-revision=objectRevision][dest-class=destinationClass] dest-type=destinationTypedest-name=destinationName [dest-revision=destinationRevision][attrfile=attributeFile]

Vault Commandscopyattr




Example

CICOPYATTR OBJECT-NAME=AA-FILENAME1 OBJECT-TYPE=FILE -DEST-NAME=AA-FILENAME2 DEST-TYPE=FILE

object-type=objectType Minor group of the object within the class, such asFILE and PART. The object-class and the object-typeparameters together identify specific kinds of objects.For example, a CADDS FILE or a CADDS PART. Thedefault is FILE.

object-name=objectName Name of the source object name. The length of thisfield depends on the object type.

dest-type=destinationType Minor group of the destination object within the class,such as FILE and PART. The object-class and theobject-type parameters together identify specific kindsof objects. For example, a CADDS FILE or a CADDSPART. The default is FILE.

Note: The DEST-TYPE parameter must be the sameas the OBJECT-TYPE or the command can fail.

dest-name=destinationName Name of the destination object. The length of this fielddepends on the object type.

object-class=classIdentifier Major group to which the source objectbelongs. For example, CADDS identifies aclass of objects.

object-revision=objectRevision Identifies the character revision of the object.The object-class, object-type, object-name,and object-revision parameters togetheridentify a specific instance of an object. Thelength of this field depends on the object type.The default is current revision.

dest-class=destinationClass Major group to which the destination objectbelongs. For example, CADDS identifies aclass of objects.

dest-revision=destinationRevision Identifies the character revision of thedestination object. The dest-class, dest-type,dest-name, and dest-revision parameterstogether identify a specific instance of anobject. The default is the current revision.

attrfile=attributeFile The file that can contain all of the attributesthat were copied from the source object to thedestination object. (Note: You must specifythis parameter to see command results.) Thelength of this field varies based on yourplatform.

Vault Commandsdefagrp (Binder)


defagrp (Binder)

The cidefagrp command defines an attribute group to associate with a base classand object type. The defined attribute group becomes a new database table with thename ATR_ATRBGRP.

Syntax

cidefagrp baseclass=baseClass otype=objectType atrbgrp=attributeGroupatrbgrptype=attributeGroupType mandatory=mandatoryAttributeType[desc=description] keyfile=keyFile desc=description



baseclass=baseClass Name of the base class (binder, relationship,file, or part) to uniquely qualify the object type.The default is BINDER.

otype=objectType Name of an existing object type to which theattribute group can be associated.

atrbgrp=attributeGroup Unique attribute group name. Enter attributegroup name up to 26 alphanumeric characters(including blanks).

atrbgrptype=attributeGroupType Indicates whether the attribute group applies toa CLASS (binder) or an INSTANCE(relationship). The default is CLASS.

mandatory=mandatoryAttributeType Indicates whether the attribute group valuesmust be supplied when an object or instance iscreated for the object type. Enter Y (yes) or N(no).

keyfile=keyFile Name of the keyword file for input. Enter thefilename up to 80 alphanumeric characters.

desc=description Attribute group description. Enter a descriptionup to 240 alphanumeric characters (includingblanks).

Vault Commandsdefagrp (Binder)



The attribute group name must not already exist.

When you create an attribute group (using the DEFAGRP command) and addattributes to it (using the DEFATRB command), a new table is added to the databaseand named for the attribute group. The complete name isATR_attribute_group_name. Each attribute that you add to the table becomes acolumn in the table.

Normally, attribute groups for relations are defined on object types with abaseclass of RELATION. Attribute groups for relationships can be defined onobject types with baseclass of binder by using the ATRBGPTYPE=INSTANCEparameter. The reverse is not true, that is an attribute group for a binder must bedefined on an object type with baseclass of binder.

Example

CIDEFAGRP BASECLASS=BINDER OTYPE=FOLDER -ATRBGRP=BOX

Vault Commandsdefatrb (Binder)


defatrb (Binder)

The cidefagrp command defines the rules for and adds an attribute to an existingattribute group. The attribute becomes a column in the database tablecorresponding to the attribute name.

Syntax

cidefagrp baseclass=baseClass otype=objectType atrbgrp=attributeGroupatrb=attribute mandatory=mandatoryAttributes datatype=dataTypedefault=defaultAttributeValue enum=enumerationListName minval=minimumValuemaxval=maximumValue maxlen=maximumLength earliestdate=earliestDatelatestdate=latestDate [desc=description] keyfile=keyFile




baseclass=baseClass Name of the base class of the object type. Thedefault is BINDER.

otype=objectType Name of the object type of the attribute group.

atrbgrp=attributeGroup Name of an existing attribute group to which to addthe attribute.

atrb=attribute Unique attribute name. Enter a name up to 30alphanumeric characters. No blanks allowed. Theattribute name cannot be an Oracle reserved word.

mandatory=mandatoryAttributes Indicates whether the attribute is required. Enter Y(yes) or N (no). Data for a mandatory attribute mustbe specified whenever attribute data is provided forits group. The default is

datatype=dataType Specify INTEGER, REAL, DATE, STRING, or ENUM(enumeration). The default is STRING.

default=defaultAttributeValue Default attribute value. The default is 0 if numericblank if string.

enum=enumerationListName Name of existing enumeration list. Used only whendatatype is ENUM.

minval=minimumValue Minimum value for the data types INTEGER andREAL.

maxval=maximumValue Maximum value for the data for the data typesINTEGER and REAL.

maxlen=maximumLength Maximum length of input. Required for stringdatatypes and allowed for integers. Allowed valuesare:

STRING: 0< MAXLEN < 2001

INTEGER: 0 < MAXLEN < 39

Not valid with REAL, DATE, or ENUM datatypes.

earliestdate=earliestDate Used only when DATATYPE=DATE. Four formats aresupported:

MM/DD/YY

MM/DD/YYYY

DD.MM.YY

DD.MM.YYYY

Earliest date is the ’minval’ for the DATE datatype.

latestdate=latestDate Latest date for the DATE data type. (See above forformat.)

Latestdate is the ’maxval’ for the DATE datatype.

keyfile=keyFile Name of the file containing command parameters inthe format of keyword=value.





Please note: Attribute names are unique within the database for Revision 1.0.Later, attribute names can be unique within the base class.

When you create an attribute group (using the DEFAGRP command) and addattributes to it (using the DEFATRB command), a new table is added to the databaseand named for the attribute group. The complete name isATR_attribute_group_name. Each attribute that you add to the table becomes acolumn in the table.

Examples

CIDEFATRB OTYPE=FOLDER ATRBGRP=BOX DATATYPE=ENUM -ATRB=SURFACE ENUM=SIDE DEFAULT=FRONTCIDEFATRB OTYPE=FOLDER ATRB=BOX DATATYPE=INTEGER -ATRB=EACHSIDE MINVAL=1 MAXVAL=200 MAXLEN=5CIDEFATRB OTYPE=FOLDER ATRB=BOX DATATYPE=REAL -ATRB=VOLUMN MAXLEN=5CIDEFATRB OTYPE=FOLDER ATRB=BOX DATATYPE=DATE -ATRB=M_DATE EARLIESTDATE=‘12/31/95’ - LATESTDATE=31.12.2001’ -DESC=“‘SHOWS DIFFERENT DATE FORMATS’”

desc=description Attribute name description. Enter a description up to 240alphanumeric characters (including blanks).

Vault Commandsdefenum (Binder)


defenum (Binder)

The cidefenum command defines a set of enumerated values for use withattributes.

Syntax

cidefenum enum=enumerationListName values=attributeValues [desc=description]keyfile=keyFile




DEFENUM creates the name for a set of values to use when defining attributes. Thevalues can be added with the DEFENUM command or added and changed later withADDEVALS and CHGEVALS.

Example

CIDEFENUM ENUM=COLORS “VALUES=’RED,GREEN,BLUE’”

enum=enumerationList

Name

Name of the enumeration list. Enter a name up to 35alphanumeric characters (including blanks).

values=attributeValues Values for the attribute: val1, val2, ..., valn.

Note: Case sensitivity is preserved.

keyfile=keyFile Name of the file containing command parameters in theformat of keyword=value.

desc=description Enumeration list description. Enter a description up to 240alphanumeric characters (including blanks).

Vault Commandsdefotype (Binder)


defotype (Binder)

The cidefotype command defines an object type based upon one of thepredefined base classes: FILE, PART, BINDER, or RELATION.

Syntax

cidefotype baseclass=baseClass otype=objectType [desc=description]keyfile=keyFile




In object-oriented concepts, defining an object type corresponds to creating asubclass. Vault has more than forty classes of objects. For Revision 1.0, the classeson which subclasses can be defined are files, parts, binders, and relations. Binders,relations, and attribute groups are created upon typedefs that you must predefine.

Example

CIDEFOTYPE BASECLASS=BINDER OTYPE=FOLDER -DESC=”’A TYPE OF BINDER’”

baseclass=baseClass Name of a predefined base class of objects from whichthe object type (binder, relationship, file, or part) isderived. The default is BINDER.

otype=objectType Unique name of an object type. Enter a name up to 35alphanumeric characters (including blanks).

keyfile=keyFile Name of the file containing command parameters in theformat of keyword=value. Enter a filename up to 80alphanumeric characters.

desc=description Object type description. Enter a description up to 240alphanumeric characters (including blanks).

Vault Commandsdeladef (Binder)


deladef (Binder)

The cideladef command deletes an attribute from an existing attribute group.

Syntax

cideladef baseclass=baseClass otype=objectType atrbgrp=attributeGroupatrb=attribute keyfile=keyFile



All are required.


You must delete all uses of an attribute’s data before you can delete its definitionfrom the attribute group. An attribute is in use when data has been assigned to itusing an ADDOBJ, RELOBJ, or ADDATRBS command.

When attributes are added to an attribute group, they become columns in adatabase table named for the attribute group. When you delete an attribute from itsgroup, the column remains in the database table but you cannot use it.

baseclass=baseClass Name of a predefined base class of objects, such as abinder, from which the object type is derived. The defaultis BINDER.

otype=objectType Name of an existing object type.

atrbgrp=attributeGroup Existing name of an attribute group name.

atrb=attribute Existing name of an attribute within the attribute to delete.


Vault Commandsdelag


delag

The cidelag command deletes an authority group.

Syntax

cidelag authgrp=authorityGroupName


Restrictions

You cannot delete an authority group currently assigned to any public or projectusers.

Reference


authgrp=authorityGroupName Enter a name of an existing authority group nameup to 8 alphanumeric characters.

Vault Commandsdelagrp (Binder)


delagrp (Binder)

The cidelagrp command deletes an attribute group definition and thecorresponding database table.

Syntax

cidelagrp baseclass=baseClass otype=ObjectType atrbgrp=attributeGroupkeyfile=keyFile



All are required.


The named attribute group must exist but not be in use. An attribute group is in usewhen attributes have been added to the attribute group using the DEFATRBcommand.

You must delete all attributes belonging to the group (using the DELATRBcommand) before deleting the group.

When you delete an attribute group, the database table named for the group isdeleted from the database.

baseclass=baseClass Enter a name of the base class to uniquely qualifythe object type. The default is Binder.

otype=ObjectType Enter a name of the object type to which thisattribute group belongs.

atrbgrp=attributeGroup Enter a name of the existing attribute group todelete.

keyfile=keyFile Enter a name of the file containing commandparameters in the format of keyword=value.

Vault Commandsdelaset


delaset

The cidelaset command deletes an attribute set.

Syntax

cidelaset setname=setName



All are required.


If the set is a member of another set, it is removed from that set also. Any attributesor sets contained in the set that is deleted continue to exist but they are no longerassociated to the set. Any rules that use the deleted set are also deleted.

setname=setName Enter a name of the attribute set up to 24 alphanumericand special (hyphen and underscore) characters.

Vault Commandsdelatrbs (Binder)


delatrbs (Binder)

The cidelatrbs command deletes attribute data from an object or relationshipinstance.

Syntax

For Binders Only

cidelatrbs baseclass=baseClass oname=objectName revision=revisionCode


cidelatrbs frombaseclass=baseClass fromoname=fromObjectNamefromrevision=fromRevision tobaseclass=toBaseClass tooname=toObjectNametorevision=toRevision toinstid=toInstanceId


cidelatrbs atrbdata=attributeData keyfile=keyFile




For Binders Only




All are required.

baseclass=baseClass Enter the name of the base class of the objectinstance. The default is Binder.

oname=objectName Enter an existing name for an object instance.

revision=revisionCode Enter the revision code for an existing objectinstance, up to 20 alphanumeric characters. Leaveblank for the default current revision.

frombaseclass=baseClass Enter the name of the base class of the parentobject: binder, part, or file. The default is Binder.

fromoname=fromObjectName Enter the name of the parent object.

fromrevision=fromRevision Enter the revision code of the parent object. Thedefault is the latest revision.

tobaseclass=toBaseClass Enter the name of the base class of the child object:binder, part, or file. The default is BINDER.

tooname=toObjectName Enter the name of the child object.

torevision=toRevision Enter the revision code of the child object. Thedefault is the latest revision.

toinstid=toInstanceId Enter the instance number of the relationship todelete. Required if more than one relationship exists.The default is 1.

atrbdata=attributeData Enter the name of the attribute group.




The sequence number (1-n) is optionally used tospecify an order for assigning the attributes.

keyfile=keyFile Enter the name of the file up to 80 alphanumericcharacters.




Attributes are kept in a database table named for the attribute group. An object orrelationship instance can have one or more rows of data for a given attributegroup. When you use the DELATRBS command, all rows of the specific attributegroups you mention are deleted unless you restrict the change to those rows with acertain attribute value.

Examples

CIDELATRBS ONAME=SAMPLEBOX ATRBDATA=SPECX

This example deletes all occurrences of attribute group SPECX on the bindernamed SAMPLEBOX.

CIDELATRBS ONAME=SAMPLEBOX ATRBDATA=SPECX(A=1)

This example deletes only those occurrences of attribute group SPECX on thebinder named SAMPLEBOX where attribute a has a value of 1.

Vault Commandsdelattr


delattr

Use the cidelattr command with caution to delete an attribute definition for usewith parts and files from all attribute sets.

Syntax

cidelattr attrname=attributeName



All are required.


When you execute the DELATTR command, Vault deletes the attribute, removes itfrom every set it belongs to, and deletes every occurrence including associateddata. Exercise caution when you use this command. It is recommended that younot delete attributes that have been used. If you must delete attributes already used,be aware of the implications.

attrname=attributeName Enter the name of the attribute up to 24 alphanumeric andspecial (hyphen and underscore) characters.

Vault Commandsdelcl


delcl

The cidelcl command deletes a command list.

Syntax

cidelcl cmdlist=commandListName



All are required.

Restrictions

You cannot delete a command list currently assigned to any public or projectusers.

Reference


cmdlist=commandListName Enter an existing command list nameup to 8alphanumeric characters.

Vault Commandsdelenum (Binder)


delenum (Binder)

The cidelenum command deletes an enumerated value set.

Syntax

cidelenum enum=enumerationListName keyfile=keyFile



All are required.


You must delete the values from the enumerated value set (using the DELEVALScommand) before deleting the enumerated set name.

Example

CIDELENUM ENUM=BOND_RATINGS

enum=enumerationListName Enter a name of the enumeration set to delete.

keyfile=keyFile Enter the name of the file containing commandparameters in the format of keyword=value.

Vault Commandsdelete


delete

The cidelete command logically deletes files marked for deletion.

Syntax

cidelete output=auditDestination append=replaceOrAppendAuditFile



All are required.


Only files that are marked for deletion at the time this command is processed canbe deleted.

The deleted files can then be physically erased from the Vault storage pool thenext time the IBKUP (incremental backup) command, followed by the DELOV(delete old file versions) command, is executed.

Files that are marked to be deleted but are still members of a file set cannot bedeleted. A message will inform you of these file names. To delete files that aremembers of a file set, remove the members from the file set, before running theDELETE command..

After you delete a file, you cannot access or recover that file with the UNMARKcommand. To recover files (one at a time), use the RECSF (recover a single file)command.

output=auditDestination Indicates where to send audit information. At theprompt enter F (file), B (both), or M (message only).When using the command-line format, you can onlyenter F or M. The default is F (Command-lineformat).

append=replaceOrAppendAuditFile Indicates whether to replace or append the audit file.If audit destination is F or B, enter R (replace) or A(append). Ignored if audit destination is S or M. Thedefault is (R)eplace.

Vault Commandsdelete


Executing the MARKD command on a file followed by a DELETE command, isequivalent to executing the PURGE command on that file except that a file markedfor delete can be unmarked (with the UNMARK command) to recover the file, but apurged file can only be recovered using the RECSF command.

When you designate a file as the audit destination, Vault sends the information to afile named DELETE.EDMAUDIT. Use a local editor to view this file.

Restriction

This command is not available on a remote Vault Client node.

Reference


Vault Commandsdelevals (Binder)


delevals (Binder)

The cidelevals command deletes values from an enumeration list.

Syntax

cidelevals enum=enumerationName values=attributeValues keyfile=keyfile



All are required.


You must delete values from the enumeration list before deleting the enumerationset.

Restriction

The values from the enumeration list to be deleted cannot be in use by anyattribute definition.

Example

CIDELEVALS ENUM=SIDE “VALUES=’LEFT,RIGHT’”

enum=enumerationName Enter the name of an existing enumeration list.

values=attributeValues Enter the values for the attribute: val1, val2, ..., valn.

keyfile=keyfile Enter the name of the file containing commandparameters in the format of keyword=value.

Vault Commandsdellog


dellog

The cidellog command deletes entries from the Vault process log.

Syntax

cidellog fromdate=fromDate fromtime=fromTime todate=toDatetotime=toTime


fromdate=fromDate USA or European standard date format. For USA format:month/day/year, for example, 05/01/95 for May 1, 1995. ForEuropean format: day.month.year, as in 01.05.95 for 1 May,1995. Determines the starting date. Use the default value forthe earliest log date entry. The default is the earliest date.

fromtime=fromTime USA standard time format using a 24-hour clock. Enter thehour, followed by a colon (:), followed by the minute, followedby a colon (:), followed by the second (HH:MM:SS). Forexample, 09:05:22. Determines the starting time. Use thedefault value for the earliest log time entry. The range ofallowable values is from 00:00:00 through 23:59:59. Thedefault is the earliest time.

todate=toDate USA or European standard date format. For USA format:month/day/year, for example, 05/01/89 for May 1, 1989. ForEuropean format: day.month.year, as in 01.05.89 for 1 May,1989. Determines the ending date. Use the default value forthe current log date entry. The default is the current date.

totime=toTime USA standard time format using a 24-hour clock. Enter thehour, followed by a colon (:), followed by the minute, followedby a colon (:), followed by the second (HH:MM:SS). Forexample, 09:05:22. Determines the ending time. Use thedefault value for the current log time entry. The range ofallowable values is from 00:00:00 through 23:59:59. Thedefault is the current time.

Vault Commandsdellog



The following log entries are deleted from the log table:

• with a date on or after the fromdate and fromtime

• with a date before or on the todate and totime

The default values for the fromdate and fromtime parameters are the earliest dateand time of the records in the log. The default values for the todate and totime

parameters are the current date and time.

Thus, the default date and time range deletes all of the entries in the log table.Periodically use this command to delete old log entries and recover storage space.

Reference


Vault Commandsdelobj (Binder)


delobj (Binder)

The cidelobj command removes an object instance and all attributes associatedwith it. Associated relationships can also be deleted (see the section belowRequirements and Special Considerations).

Syntax

cidelobj oname=objectName [revision=revisionCode]cascade=cascadeDeletions keyfile=keyFile




When a binder is deleted, all relationships that specify this binder as the parentobject are also deleted. Depending upon the system-wide flag in theDM_CONFIGURATION table, relationships that specify this binder as its child objectcan also be deleted.

If cascade delete is N, only the relationships directly connected to the named objectare deleted. If cascade delete is Y, the child binders are also deleted. Child parts andfiles are not deleted on a cascade delete.

oname=objectName Enter the name of the existing binder to delete.

cascade=cascadeDeletions Enter Y(es) to specify the deletion of child binders.The default is N(o).


revision=revisionCode Enter the revision code for the object instance, up to20 alphanumeric characters. Leave blank for thedefault current revision.

Vault Commandsdelotype (Binder)


delotype (Binder)

The cidelotype command deletes an object type definition by base class andobject type.

Syntax

cidelotype baseclass=baseClass otype=objectType keyfile=keyFile



All are required.


The named object type must exist but not be in use. A type definition is in usewhen objects have been created that refer to the definition of the object type.

baseclass=baseClass Enter the name of the base class of this object type. Thedefault is Binder.

otype=objectType Enter the name of the object type to delete.

keyfile=keyFile Enter the name of the file containing command parametersin the format of keyword=value.

Vault Commandsdelov


delov

The cidelov command deletes old versions of files (also called shadow files), andreclaims storage pool space.

Syntax

cidelov


There are no input parameters for this command.


DELOV deletes only those files that have previously been backed up to tape with theIBKUP command.

If you use the command-line format to execute the IBKUP command, you mustexecute the DELOV command separately.

Please note: Because this command is deleting physical data, it can have adetrimental effect on performance.

Reference

See Vault System Administrator Guide for more information about this command.

Vault Commandsdelp


delp

The cidelp command deletes a project name and removes project users from theproject.

Syntax

cidelp projid=projectId



All are required.

Restrictions

You cannot delete a project if there are any active (not archived) files, status levels,or user-defined tables associated with the project.

You cannot delete a project if a binder is owned by a project.

Reference


projid=projectId Enter an existing project identifier up to 8 alphanumericcharacters.

Vault Commandsdelrel (Binder)


delrel (Binder)

The cidelrel command deletes a relationship instance.

Syntax

cidelrel fromoname=fromObjectName fromrevision=fromRevisiontobaseclass=toBaseClass tooname=toObjectName torevision=toRevisiontoinstid=toInstanceId keyfile=keyFile



All are required.


You need to specify the first six input parameters so that the particular relationshipto delete can be identified.

fromoname=fromObjectName Enter the parent object instance name. The baseclassof the parent is BINDER.

fromrevision=fromRevision Enter the revision code for the parent object name. Thedefault is the latest revision.

tobaseclass=toBaseClass Enter the name of the base class of the child object:binder, part, or file. The default is Binder.

tooname=toObjectName Enter the child object instance name.

torevision=toRevision Enter the revision code for the child object. The defaultis the latest revision.

toinstid=toInstanceId Enter the instance number of the relationship betweenthis particular parent and child. The default is 1.


Vault Commandsdelrs


delrs

The cidelrs command deletes a revision code sequence from Vault.

Syntax

cidelrs revname=revisionSequenceName



All are required.

Restrictions

You cannot delete a revision sequence that is associated with a project, used forpublic files, or which has the name DEFAULT.

Reference


revname=revisionSequenceName Enter an existing revision code sequence up to 8alphanumeric characters.

Vault Commandsdelrule


delrule

The cidelrule command deletes rules that are used to determine when to applyattribute sets.

Syntax

cidelrule rulename=ruleName



All are required.

rulename=ruleName Enter a rulename up to 24 alphanumeric and special (hyphen orunderscore) characters.

Vault Commandsdels


dels

The cidels command deletes a status level from an authority scheme.

Syntax

cidels statcd=statusCode projid=projectId



All are required.


To delete a status level of a public authority scheme, do not enter a project ID. Todelete a status level of a project authority scheme, enter the name of an existingproject ID.

If you delete a status level with the I (in-work) or R (released) status partitioncode, be sure to immediately add or change a status level so that both statuspartition codes are still defined. Files can not be stored or accessed unless both theI and R status partition codes exist.

Restrictions

You cannot delete a status level if:

• There are any active (not archived) Vault files or user-defined tables currentlystored under that authority scheme with that status code

• The status code is associated with a user list

• The status level is in use by a binder


statcd=statusCode Enter an existing code up to 8 alphanumeric characters. Thisrepresents a phase of work in an Vault authority scheme.

projid=projectId Enter an existing project identifier up to 8 alphanumericcharacters. Leave blank for the default public authority scheme.

Vault Commandsdelsub (DV)


delsub (DV)

The cidelsub command deletes an existing subscription.

Syntax

cidelsub subname=subscriptionName



All are required.


The DELSUB command must be in your public command list.

subname=subscriptionName Enter an existing subscription name of up to 24characters.

Vault Commandsdelu


delu

The cidelu command deletes users from Vault.

Syntax

cidelu userid=VaultUserId



All are required.

Restrictions

After this command is executed, no one can sign on to Vault using this user ID.

A Vault user cannot be deleted if this user

• Has any file signed out

• Owns any private files

• Is on any user list

• Has any review messages

• Is a reviewer in any current revision

• Has any user-defined tables opened


userid=VaultUserId Enter an existing Vault user identifier up to 12 alphanumericcharacters.

Vault Commandsdelul


delul

The cidelul command removes all members from a user list and deletes the userlist name. To be deleted, the user list must not be associated with a status code as areview or notification list.

Syntax

cidelul userlist=userListName



All are required.

Restrictions

A user list cannot be deleted if it is currently associated with a status code as areview, notification, or post-approval list. If this is the case, execute the REMUSAcommand (remove a status code/user list association) before executing the DELULcommand.


userlist=userListName Enter an existing user list name up to 24 alphanumericcharacters.

Vault Commandsexport (DV)


export (DV)

The ciexport command copies registered objects from their source Vault to theexport directory. An exported object is held in this directory until all of the vaultsidentified in the Vault list (VAULTLST) import it. When exporting an objectspecify a tag to define the object’s access privileges (read, write, move, or transferownership) and a Vault list to identify the vault destinations.

Syntax

ciexport selname=selectionName selscope=selectionScope[revision=revisionCode] vaultlst=vaultListName tag=tagName


Please note: The EXPORT command does not support files with a password.Exporting a file with a password displays an error message.

selname=selectionName Enter the name of the file, part, user definition, or projectdefinition.

selscope=selectionScope Enter the code for the object type. Enter F (file) or P (part).

vaultlst=vaultListName Enter the name for a list of unique vault names up to 24alphanumeric characters.

tag=tagName Enter a name for a preconfigured action:

copy. Copy a file/part to a remote vaultlist. The indicatedvaultlst can contain multiple vaults.

move. Move a file/part to a remote vaultst. The indicatedvaultlst can contain only one vault.

replicate_read. Create a read-only replica of a file/part.The indicated vaultlst can contain multiple vaults.

replicate_write. Create a writable version of the file/part.The indicated vaultlst can contain only one vault. Thesource file/part is locked until write replica is returned. Thetarget (replicated) file/part is available for update.

update. Refresh the source file/part for a write replica. Thisapplies to write_replica[ted] files/parts only.

replace. Return the write replica to the source vault. Forread replicate, this option can delete the read replica.

Vault Commandsexport (DV)




To use the EXPORT command on an object, you must have EXPORT in your publiccommand list.

Objects must be registered to export them. You can have Vault automaticallyexport an object with an object-event subscription that includes one of thepredefined export-action templates.

See Distributed Vault System Administrator Guide for more information about thiscommand.

Example

CIEXPORT SELNAME=PARTNAME SELSCOPE=P REVISION=1 -TAG=COPY VAULTLST=LISTNAME

revision=revisionCode Enter the revision code up to 20 alphanumeric characters,if member type is F or P. If you specify a revision, themember always has this particular revision. The default isthe current revision.

Vault Commandsget


get

The ciget command signs out and copies files to your local storage area forchanges. With the GET command, you can sign out a

• File

• Part

• File set

• List of files and parts

The file is signed out to you. No one else can modify it. Others are prevented fromsigning out or locking the file until you have released it.

Please note: Others can still read the file after it is signed out to you. Theyreceive a warning message, however, that it is signed out (the message includesyour Vault user name).

Syntax

ciget [selscope=selectionScope] selname=selectionNamefilepw=file(s)Password filetype=fileType lfname=localFileNameldirname=localDirectoryName [output=auditDestination][append=replace/AppendAuditFile] overlay=overwriteExistingFilesattrfile=attributeFileName vaultid=vaultName

Vault Commandsget



1Valid input and defaults for this parameter are platform dependant.



The requirements and special considerations for the GET command are as follows.

selname=SelectionName Enter a selection name up to 80 alphanumericcharacters. When selscope=L, the selectionname is the name of a local file containing thenames of the files and parts to be signed out.

filepw=file(s)Password If file(s) has password, enter the file password, up to8 alphanumeric characters..

filetype=fileType File type code.

lfname1=localFileName Enter the name of the selection in your local storagearea when selection scope is F. Enter a name up to80 alphanumeric characters. See footnote.

ldirname1=localDirectoryName Local directory to which the files(s) can betransferred. Enter local directory name up to 80alphanumeric characters. Ignored if path is given inlocal file name. See footnote.

attrfile=attributeFileName Enter the name of a local file that can receive the listof attributes and assigned values. Enter a name upto 80 alphanumeric characters.

vaultid=vaultName Enter a unique vault name up to 32 alphanumericcase-sensitive characters.

selscope=selectionScope Indicates the entity you are signing out. Enter F (file),P (part), S (file set), B (binder), L (list). The default isF.

output=auditDestination Indicates where audit information is to be sent. Atthe prompt enter S (screen), F (file), B (both), or M(message only). For the keyword, enter F or M. Thede4fault is F (command-line format).

append=replace/AppendAuditFile Indicates whether to replace or append the audit file.If audit destination is F or B, enter R (replace) or A(append). Ignored if the audit destination is S or M.Default is R.

overlay=overwriteExistingFiles Indicates whether to overwrite an existing local filewith the Vault file. Enter Y (yes) or N (no). Default isN.

Vault Commandsget


Revision Code

You do not specify a revision level with the GET command because the current,in-work version of the file is automatically obtained for you.

This means:

• The current in-work revision is transferred.

• If the current revision is released, Vault creates a new revision at the initialin-work status level and transfers this revision.

A file name placeholder for the next revision level of the file or part is createdin the Vault database at the time of transfer. There is no new file or part in thedatabase, however, until you transfer a modified version back to Vault with theUPDATE or REPLACE command.

When you add a member to a file set and specify a revision code for the member,you can never sign out the member for modification. This is true even when yousign out the file set with the GET or SIGNOUT commands. A member of a file setwith an explicit revision code is available for only read access.

When you have finished your work with the file, you can:

• Transfer your modified file back to Vault with the REPLACE command. Whenyou do this, the file is no longer signed out to you, the version in your localstorage area is deleted, and a new version of the file now exists under the namereserved for it.

• Transfer your modified file back to Vault with the UPDATE command. Whenyou do this, the file continues to be signed out to you, the version in your localstorage area is not deleted, and a new version of the file now exists under thename reserved for it.

• Use the RESET command to sign in the file without making any changes to it.The file copy remains in your local storage area.

Name of Selection in Your Local Storage Area

The location where Vault places your local copy of the file depends on the localfile name and local directory name you specify. Input for the LDIRNAME parameteris platform-dependent. Default locations for the copy of the file in the databasedepend on your type of system.

Audit Information

When you designate a file as the audit destination, Vault sends the auditinformation to a file named GET.EDMAUDIT. Use a local editor to view this file.

Vault Commandsget


Local File Name

For a single file or part transfer, the value of the LFNAME keyword is the local filename for the file to be transferred from Vault.

When you transfer a single Vault file or part to your local storage area, you canalways use the LFNAME keyword to rename the object.

For multiple file transfer (file set, list), the value of the LFNAME keyword isignored. The Vault names of the member files are used. In other words, you cannotrename files included in a file set.

User Defined Attributes

Attributes are important pieces of information associated with a selection. TheVault administrator informs you when there are attributes associated with a file.

Attribute File Name

When attributes are associated with a file, you can obtain them by specifying anattribute file name when you execute the GET command. Enter the name of a localfile that receives the list of attributes and assigned values.


The file listing the attributes has one assignment on each line with the formatATTRIBUTE NAME=attributeValue.

The attribute value you see in the attribute file output can be as stored or, ifassociated with a unit of measure, converted and formatted for output with its unitof measure.

Only those attributes for which you have at least read permission are presented.Attributes for which you have read but not write permission are preceeded with“##” in the attribute file listing. These attributes are ignored when youreplace/update the underlying object. Only those attributes are allowed for whichyou have read/write authority, depending on the action you want to perform.


When the selection scope covers multiple Vault objects, the file identifies eachobject before listing attribute values. The identifiers OBJECT-NAME andOBJECT-TYPE identify the objects. Instance numbers in parentheses indicate

Vault Commandsget


multiple values for an attribute. The content of the attribute file would look likethis:


Please note: As this command can include more than eight parameters,special considerations can apply.

Issuing get on a List

To operate on a list, specify L for the selection scope and specify the name of alocal list file for the selection name. The specified local list file contains the Vaultpart names and file names to transfer.

Please note: You can not include directories, file sets, or other lists in the listfile.

If, for some reason, Vault cannot transfer even one member of the list, then noneof the members from the list are transferred. Consequently, we recommend thatyou use lists only to operate on parts and files as a group.

You can sign out a list of parts and stand-alone files and then replace the parts andfiles individually. You can also signout parts and files individually and thenreplace a list of them.

Specify the fully qualified local file name of the list file, or ensure that it is in yourcurrent working directory.

Contents of the List File

The file that contains the list of parts and files to be operated on uses akeyword=value format. For GET, you can include the following for each part orfile in the list.

PART=Vaultpartname or FILE=Vaultfilename

REVISION=Vaultrevision (optional value)

READ=Y (optional value)

Vault Commandsget


Please note: When you specify READ or REVISION, the associated part or fileis obtained for read-only use.

Syntax Rules for List Files

The syntax rules for the list are as follows:

• Use no blanks between the keyword, the equal sign, and the value.

• The keyword-value pairs for one part or file can be separated by commas orspaces.

• A keyword and its value must be on one line.

• If all keyword-value pairs for one part or file do not fit on one line, identify thecontinuation with a comma after the last entry in one line.

• Data for each part or file in the list must start on a new line.


Restrictions

Listed below are the restrictions of the GET command:

Executing the GET Command Twice on the Same File

After you sign out a file with the GET command, you cannot execute another GETcommand for the same file unless you first use the RESET command.

Files That Cannot be Transferred

You cannot perform the GET command on a file that is:

• Already signed out by you or another user

• Locked with the MARKD (mark for delete) or MARKA (mark for archive)commands

• Locked for review

When files are Not Available

If all files cannot be obtained, different results occur, depending on the selectionscope.

Vault Commandsget


If you select a part or file set to be signed out, and if any of the files that make upthis part or file set cannot be signed out (because they are already signed out orlocked, for example), none of the part or file set files are signed out to you.

When you checkout a binder, you can neither sign out nor modify the associatedmembers of a binder as they have read-only permissions.

Recommendations

Do not issue the GET or REPLACE command for file sets that include parts, unlessyou are not adding any files to the parts or deleting any files from the parts whilethe file set is signed out.

Example

CIGETEDM> SELSCOPE=F SELNAME=TEST1 LFNAME=localtest1,EDM> FILEPW=TEST1,EDM> OUTPUT=F APPEND=A

In this example, file TEST1 is signed out.

The current audit file contents are appended with the new information.


Vault Commandshelp


help

The cihelp command displays online help. Use it for all Vault commands,including IQF commands.

Syntax

cihelp

Command-Line Format and Example

When using the command-line format, you can access online documentation forthe commands in three ways:

• Enter the name of the command you want help for followed by a question markin quotes.

• Enter the name of the command you want help for followed by the word help.

• Enter the CIHELP command followed by the name of the command you wanthelp for.

For example, executing any of the following commands displays onlinedocumentation for the GET command:

• CIGET “?” (If your operating system is UNIX, enter CIGET followed by areturn)

• CIGET HELP

• CIHELP GET

CIGET “?” and CIGET HELP generate a description of what the command doesand an explanation of each keyword. CIHELP GET generates only a description ofwhat the command does. Help text appears in line mode with no scrolling or wordsearch capabilities.

Vault Commandsibkup


ibkup

The ciibkup command creates a backup tape containing copies of all files addedor modified since the last incremental backup. To use the ciibkup command, itmust be in your public command list. You can only run this command locally fromthe system on which the Vault and tape drive are installed.

Syntax

ciibkup tapeunit=tapeUnit(s) tapenum=tapeSerialNumbertappend=appendToTape?



All are required.


To create an Vault file backup tape, use the IBKUP command. You can execute thiscommand only when locally logged in to the Vault server; you cannot execute thiscommand at a remote VaultClient node. The server need not have a local tapedevice.

This command selectively copies on tape only those files that have been added orchanged since the previous IBKUP command was executed. The initial executionof the IBKUP command backs up all Vault files.

You can make two copies on two separate tapes at the same time. Vault can appenddata to tapes that already contain incremental backups.

tapeunit=tapeUnit(s) Name to represent the tape device(s). Enter TAPE1,TAPE2, TAPE3, or TAPE4. Or enter two devicesseparated by a comma, for example, TAPE1,TAPE3,to create two backup tapes at the same time.Spaces are not allowed. The default is TAPE1.

tapenum=tapeSerialNumber Tape identifier name. Enter a tape identifier name ofup to 6 alphanumeric characters. The default isVOL1.

tappend=appendToTape? Indicates whether to append to the tape. Enter Y(yes) or N (no). The default is N.

Vault Commandsibkup


The UBKUP (universal backup) command copies to tape the entire Vault database.

Never use more than one kind of tape media (1/2-inch, Exabyte) between universalbackups. In other words, when performing an incremental backup, always use thesame type of tape media as used by any other incremental backup since the lastuniversal backup. This is important when you want to recover a storage pool. TheRECSP command might need to read data from several tapes during its operation.You cannot change media during execution of the RECSP command.

We strongly recommends that you do not use the tapenlabel command toinitialize 1/2-inch tapes. Use the tapelabel command instead.

Exabyte tape drives have a performance problem when writing physical tapemarks. ANSI-standard labeled tapes, which Vault uses, require tape marks.Consequently, the tapenlabel command was developed for use with Exabytetapes. The tapenlabel command reduces the number of physical tape marksrequired for each file. This improves the performance of Exabyte tape drives.

To execute the IBKUP command, it must be in your public command list.

During the initial Vault software installation, each tape device that can be used tocreate incremental backup tapes or perform any tape command must be logicallyidentified to Vault. If you have only one tape device it must be identified with thetape unit name TAPE1. If you have a second tape device it must have the nameTAPE2. Third and fourth tape devices must be assigned the names TAPE3 andTAPE4, respectively.

You need to know which name belongs to which tape device. When you executethe IBKUP command, enter the tape unit name(s) to identify the tape device(s) onwhich you are creating the tape(s).

If your tape is unlabeled, label it before executing the IBKUP command. Eachincremental backup tape needs its own unique tape serial number (up to sixalphanumeric characters) and Vault uses the label as the tape serial number. Whenyou execute the IBKUP command, you can use the default value for the tape serialnumber. The default is SCRTCH. This instructs Vault to use the serial number (orlabel) already on the tape.

You can use serial numbers for identification purposes. For example, if you createone incremental backup tape each day, you can use the month, day, and year toidentify your tapes (010289 for the tape created on January 2, 1989).

Vault Commandsibkup


Vault does not control the tape density setting. Use your operating systemcommands to change the current tape device setting.

When the tape becomes full, Vault displays a message telling you to mount anadditional tape. You can take one of two actions:

• Attach another tape to the tape device, enter its tape serial name, and press theprocessing key to continue the backup.

• Exit the IBKUP command by pressing the F3 or F4 function key.

You can append to both new and used tapes. When you append to new tapes, Vaultsimply starts at the beginning of the tape. When you specify the append option fora two-copy backup, both tapes must be new or must be the two copies from anexisting two-copy backup set.

You can enter two tape units and two serial numbers to produce two copies of theincremental backup at the same time. You can enter one tape unit and one serialnumber to produce one copy.

If you instruct Vault to append to a tape that is half of a two-copy set with thesecond copy not included in the current backup operation, Vault returns an errormessage and does not perform the backup. You can reexecute the command afterincluding the second copy in the two-copy set.

Vault performs the same checks on the second tape unit and serial number that itperforms on the first unit and number. Vault also verifies that two different unitsare specified.

When creating a two-copy backup or appending to a two-copy backup, anend-of-tape condition on one tape stops the backup process. Similarly, the speedof the backup process is determined by the speed of the slower tape unit.

Vault uses magnetic tape to back up and archive its controlled storage areas.ORACLE also uses magnetic tape to back up Vault control tables. To reduce therisk of data loss due to a media or tape drive failure, you can use the Vaultdual-copy facility to make two backup tapes at the same time. Alternatively, youcan make a copy of the backup tape with your OS utilities.

When issuing the CIIBKUP command with dual tapes, you must provide twotapenum(s) in addition to two tapeunits. For example,

ciibkup tapeunit=tape1,tape2 tapenum=scrtch,scrtch tappend=y

Vault Commandsibkup


The ciibkup command ejects tape after the process is complete. To prevent itfrom doing so set an environment variable EUNATTENDED to yes. This behavioris UNIX specific.

IBKUP and DELOV

After the IBKUP command is executed, use the DELOV command to delete old fileversions from the database and reclaim storage space.

The incremental backup command always starts at the beginning of the backupsequence, backing up all new or modified files not previously backed up.

For example, when you execute the IBKUP and DELOV commands in either of thefollowing sequences, the incremental backup and old file deletion results are thesame.

1. IBKUP

2. DELOV

3. IBKUP

4. DELOV

or

1. IBKUP

2. IBKUP

3. DELOV

The backup tapes produced by the IBKUP command are required for the RECSF(recover a single file) and the RECSP (recover a storage pool) commands.

Vault Commandsimport (DV)


import (DV)

The ciimport command transfers exported objects from the export directory of aremote vault to the importing vault. Administrators can issue the ciimportcommand to explicitly import objects, however, each vault automatically importsobjects from known vaults (see ADDVAULT). The ciimport command must be inyour public command list.

Syntax

ciimport selname=selectionName selscope=selectionScoperevision=revisionCode tag=tagName exporter=exportingVaultName



All are required.

selname=selectionName Existing name of the file or part.

selscope=selectionScope Code for the object type. Enter: F (file) or P (part).

revision=revisionCode Revision code. Leave blank for the default latestrevision.

tag=tagName Name for a preconfigured action:

copy. Copy a file/part to a remote vault list. Theindicated vault list can contain multiple vaults.

move. Move a file/part to a remote vault list. Theindicated vault list can contain only one vault.

replicate_read. Create a read-only replica of afile/part. The indicated vault list can contain multiplevaults.

replicate_write. Create a writable version of thefile/part. The indicated vault list can contain only onevault. The source file/part is locked until write replicais returned. The target (replicated) file/part isavailable for update.update. Refresh the sourcefile/part for a write replica. This applies towrite_replica(ted) files/parts only.

replace. Return the write replica to the source vault.For read replicate, this option can delete the readreplica.

The vault list parameter is not required.

exporter=exportingVaultName Name of the exporting vault.

Vault Commandsimport (DV)



Each vault in the distributed environment periodically polls the export directory ofeach known vault for objects to import. A tag defines an object’s accesscapabilities on the importing vault (copy, move [ownership transfer], read, write,and synchronize).

This command is usually not necessary because the Import Manager automatesthis operation. It can, however, be required in order to explicitly import files/partsthat can not be imported due to errors.

You can elect to import in either mode:

• Specific File

In this mode, you must specify the three parameters selname, selscope, andrevision, along with the required tag and exporter parameters.

This mode can select the indicated file/part, even though there can be otherfiles/parts queued for import.

This mode can select a file/part for import if that file/part is not yet successfullyimported.

Please note: If a prior import of this file/part were done, and was notsuccessful, then this mode is the only way in which that file/part can be[re]selected for import.

• Any File

In this mode, you must specify only tag and exporter, omitting selname,selscope, and revision.

This mode can not select files/parts that can have been previouslyunsuccessfully imported. This is the mode that is used by the Import Manager.

Tag names are documented in EXPORT comments.

The Import Manager automates the import operation. It can periodically performimport operations against all known vaults, for the tag names specified here. TheImport Manager produces a daily log, and stores this log in the /tmp directory,identified by a file name of IMGR.AUDIT.yymmdd. This is a useful source ofinformation which can show all import operations performed and their disposition.

Vault Commandsiqf


iqf

The ciiqf command begins an Interactive Query Facility session.

Syntax

ciiqf


This command does not have any input parameters.


The Interactive Query Facility (IQF) allows you to generate reports or viewinformation about your implementation of Vault. You can access informationabout

• Users

• Projects

• Current and archived files

• Authority schemes

You can access any tabular information that Vault uses to manage data. Thesetables are called control tables. IQF provides an interface to the RDBMS tablesthat contain information about your implementation of Vault. You use IQF toselect the exact information you want to view, then you can

• View the information on the screen.

• Store the information in a file.

• Print one or more copies of the information.

• Store the selection (query) in a local file so you can request the sameinformation again.

You can use the command-line format from any location. IQF does not have itsown programmatic interface. Execute the EXIT command to leave IQF. Consultthe documentation for your particular RDBMS for information about theprogrammatic interface it supports.

See Vault Interactive Query Facility Guide for more information.

Vault Commandslistdict (Binder)


listdict (Binder)

The cilistdict command queries the Vault database for selected informationpertinent to one class of database objects and produces a results file in auser-specified order. Use this command to display selected information aboutobjects.

Syntax

cilistdict baseclass=baseClass select=selectList cond=conditionorder=sequence ocount=outputCount outfile=reportFile keyfile=keyFile



All are required.

baseclass=baseClass Name of the predefined base class of Vault objects toquery, for example, Binder, Part, File, User. See thecomplete list of base classes in the Requirements andSpecial Considerations section. The default is BINDER.

select=selectList A list of data items (fields) to obtain for each databaseobject that satisfies the query. Each base class hasdifferent data items relevant to it. See the complete list ofavailable items by base class in the Requirements andSpecial Considerations section. Syntax is SELECT=(Item1,Item2, ...) Required field.

cond=condition A constraint on the query to limit the results to a subset ofall objects in the database for the selected base class. Seethe complete list of available conditions in theRequirements and Special Considerations section.

order=sequence A list of data items to control the order of presentation of theoutput. The first item in the list can be presented inascending sequence. Where there are duplicates, thesecond item in the list determines the order.

Syntax is SELECT=(Item1, Item2, ...) The default isRandom order.

ocount=outputCount Maximum number of objects to list. Enter: 0 < Number <99999. The default is No limit.

outfile=reportFile Name of the output file. Enter an output Fleming up to 80alphanumeric characters. The default isLISTDICT.OUTPUT.

keyfile=keyFile Name of a file containing command parameters of formatkeyword=value.




The LISTDICT command produces an ASCII text file containing the requestedinformation. The first line of the file consists of the names of the selected items,that is, the column headings for the report. The items in the results file are commadelimited, convenient for importing into a spreadsheet.

LISTDICT uses the Data Dictionary High Level Query (HLQ) facility. The itemnames (fields) used for the Select List and Order List are any valid “aliases” in theHLQ facility. The valid Conditions are any conditions known to the HLQ facility.Vault comes with a set of predefined aliases and conditions as shown below. Thesenames can be customized for your site. Attributes you define are additional itemsof information available for you to query.

Examples

CILISTDICT ’SELECT=(BINDER NAME,REVISION,OWNER)’ - OCOUNT=3 ’ORDER=(BINDER NAME)’ OUTFILE=BINDER.TXT

This example produces a list of the first four binders in the database, showingname, revision, and owner and sequencing the results by binder name. Output file,Binder.txt,can look like:

Binder Name,Revision,Owner,Binder1,A,ProjX,Binder1b,B, ,Binder2,A,JONES

CILISTDICT ’SELECT=(FILE NAME,REVISION,OWNER)’ - BASECLASS=FILES COND=FILESOUTTOME

This example produces report of all files signed out to me. No order is imposedand the report is called LISTDICT.OUTPUT.

Predefined Select Items by Base Class

Baseclass Item Name Database Table Field in Table

AGROUP Authority DM_AUTH_GROUP DM_AG_AUTH

Group Name DM_AUTH_GROUP DM_AG_NAME

ASSEMBLY Backup Version DM_FILE_DIRECTORY DM_FILE_VERSION

Class DM_FILE_DIRECTORY DM_FILE_CLASS

Description DM_FILE_DIRECTORY DM_FILE_DESC

File Name DM_FILE_DIRECTORY DM_FILE_NAME



Group TechCode

DM_FILE_DIRECTORY DM_FILE_CLASS_CD

Name DM_FILE_DIRECTORY DM_FILE_NAME

Owner DM_FILE_DIRECTORY DM_FILE_OWNER_ID

Part Number DM_FILE_DIRECTORY DM_FILE_PART_NO

Revision DM_FILE_DIRECTORY DM_FILE_CHAR_REV

RevisionSequence

DM_FILE_DIRECTORY DM_FILE_REV

SignedOut To DM_FILE_DIRECTORY DM_FILE_USER_ID

Status Code DM_FILE_DIRECTORY DM_FILE_STATUS_CD

Storage Pool DM_FILE_DIRECTORY DM_FILE_POOL_NAME

System Code DM_FILE_DIRECTORY DM_FILE_SYSTEM_CD

System Type DM_FILE_DIRECTORY DM_FILE_SYS_TYPE

Type DM_FILE_DIRECTORY DM_FILE_TYPE

User Type DM_FILE_DIRECTORY DM_FILE_USER_TYPE

BINDER Base Class DCT_DESCRIPTION DCT_NAME

Base ClassDescription

DCT_DESCRIPTION DCT_DESC

Base ClassObject Name

DCT_OBJECT DCT_OBJ_NAME

Binder Name EDM_REFERENCE EDM_NAME

Class EDM_RELATIONS PM_CLASS

CharacterRevision

EDM_REFERENCE EDM_CHAR_REV

Object Definition DCT_DESCRIPTION DCT_NAME

Object DefinitionDesc


ObjectTypeObject Name

DCT_OBJECT DCT_OBJ_NAME

Owner EDM_REFERENCE EDM_OWNER_ID

Revision EDM_REFERENCE EDM_CHAR_REV

Signed Out To EDM_REFERENCE EDM_USER_ID

Status Code EDM_REFERENCE EDM_STATUS_CD

CLIST Command List DM_COMMAND_LIST DM_COMMAND_LIST




Command Name DM_COMMAND_LIST DM_COMMAND_NAME

ENUMSET Data Type Value EDM_ENUM_VAL_PAIRS PM_ENUM_VAL

Description DCT_DESCRIPTION DCT_DESC

Enumsetname DCT_OBJECT DCT_OBJ_NAME

Enumeration DCT_DESCRIPTION DCT_NAME

FILE Backup Version DM_FILE_DIRECTORY DM_FILE_VERSION

Comments DM_REVIEWERS DM_REVW_COMMENTS




Group TechCode


Local File DM_FILE_XREF DM_FILE_LOCAL_NAME




Reviewer DM_IN_REVIEW DM_REVW_USER_ID

Revwr_comments

DM_IN_REVIEW DM_REVW_COMMENTS

Revwr_seqno DM_IN_REVIEW DM_REVW_SEQNO

Revw_date DM_IN_REVIEW DM_REVW_DATE

Revw_name DM_IN_REVIEW DM_REVW_NAME

Revw_rev DM_IN_REVIEW DM_REVW_REV

Revw_time DM_IN_REVIEW DM_REVW_TIME

Revw_type DM_IN_REVIEW DM_REVW_TYPE

Revw_vote_date DM_REVIEWERS DM_REVW_VOTE_DATE

Revw_vote_time DM_REVIEWERS DM_REVW_VOTE_TIME


RevisionSequence


Seqno DM_REVIEWERS DM_REVW_SEQNO










User_seqno DM_REVIEWERS DM_REVW_USER_SEQNO


UserID DM_REVIEWERS DM_REVW_USER_ID

Vote DM_REVIEWERS DM_REVW_VOTE

FILESET Description DM_FILE_SET DM_SET_DESC

FSet Level DM_FILE_SET DM_SET_LLC

File Set DM_FILE_SET DM_SET_NAME

MemberDescription

DM_SET_MEMBER DM_SET_MDESC

Member Level DM_SET_MEMBER DM_SET_MLLC

Member Name DM_SET_MEMBER DM_SET_MEMBER

Member Rev DM_SET_MEMBER DM_SET_CHAR_MREV

Member Type DM_SET_MEMBER DM_SET_MTYPE

Number Rev DM_SET_MEMBER DM_SET_MREV

JOBTYPE JOBID GUI_JOBTYPE JOB_JOBID

JOBNAME GUI_JOBTYPE JOB_JOBNAME

JOBTYPE DESC GUI_JOBTYPE JOB_DESCRIPTION

LOGENTRY Code DM_AUDIT_LOG DM_LOG_CODE

Command DM_AUDIT_LOG DM_LOG_COMMAND

Data DM_AUDIT_LOG DM_LOG_DATA

Date DM_AUDIT_LOG DM_LOG_DATE

File Name DM_AUDIT_LOG DM_LOG_FILE_NAME

Node Name DM_AUDIT_LOG DM_LOG_NODE_NAME

Owner DM_AUDIT_LOG DM_LOG_FILE_REV

Task ID DM_AUDIT_LOG DM_LOG_TASK_ID

Time DM_AUDIT_LOG DM_LOG_TIME




User ID DM_AUDIT_LOG DM_LOG_USER_ID

PART Archive Code DM_PART_DIRECTORY DM_PART_ARCHIVE_CD

Backup Version DM_PART_DIRECTORY DM_PART_VERSION

Class DM_PART_DIRECTORY DM_PART_CLASS

Description DM_PART_DIRECTORY DM_PART_DESC

Group TechCode

DM_PART_DIRECTORY DM_PART_CLASS_CD

Owner DM_PART_DIRECTORY DM_PART_OWNER_ID

Part Name DM_PART_DIRECTORY DM_PART_NAME

Part Number DM_PART_DIRECTORY DM_PART_PART_NO

Revision DM_PART_DIRECTORY DM_PART_CHAR_REV

RevisionSequence

DM_PART_DIRECTORY DM_PART_REV

Status Code DM_PART_DIRECTORY DM_PART_STATUS_CD

System Code DM_PART_DIRECTORY DM_PART_SYSTEM_CD

System Type DM_PART_DIRECTORY DM_PART_SYS_TYPE

Type DM_PART_DIRECTORY DM_PART_TYPE

User ID DM_PART_DIRECTORY DM_PART_USER_ID

User Type DM_PART_DIRECTORY DM_PART_USER_TYPE

PROJECT Date DM_PROJECT DM_PROJ_DATE

Last Name DM_USER DM_USER_LAST_NAME

Project Contract DM_PROJECT DM_PROJ_CONTRACT

ProjectDescription

DM_PROJECT DM_PROJ_DESC

Project ID DM_PROJECT DM_PROJ_ID

Project Name DM_PROJECT DM_PROJ_NAME

Protection Group DM_USER DM_USER_PROT_GRP

RevisionSequence

DM_PROJECT DM_PROJ_REV_NAME

Time DM_PROJECT DM_PROJ_TIME

Units DM_PROJECT DM_PROJ_UM

Update Date DM_USER DM_USER_DATE




Update Time DM_USER DM_USER_TIME

Update User DM_USER DM_USER_TIME

Updater DM_PROJECT DM_PROJ_UPDATER

User Description DM_USER DM_USER_DESC

User Group DM_USER DM_USER_GROUP

User ID Key DM_USER DM_USER_ID

User Name DM_USER DM_USER_NAME

QUERY ClassDescription


Object Name DCT_DESCRIPTION DCT_NAME

Object Type ID DCT_OBJECT DCT_OBJ_NAME

Qry_Name DCT_OBJECT DCT_OBJ_NAME

QueryDescription


Query Name DCT_DESCRIPTION DCT_NAME

Query Owner DCT_OBJECT PM_OWNER

REVSEQ Revision Code DM_REVISION_CODE DM_REV_CODE

Revision Name DM_REVISION_CODE DM_REV_NAME

RevisionSequence

DM_REVISION_CODE DM_REV_SEQNO

STORPOOL Number of Files DM_STORAGE_POOL DM_POOL_NO_FILES

Percent Free DM_STORAGE_POOL DM_POOL_PCT_FREE

Percent Used DM_STORAGE_POOL DM_POOL_PCT_USED

Pool Name DM_STORAGE_POOL DM_POOL_NAME

Pool Size DM_STORAGE_POOL DM_POOL_SIZE

Size Free DM_STORAGE_POOL DM_POOL_SIZE_FREE

Size Used DM_STORAGE_POOL DM_POOL_SIZE_USED

Status DM_POOL_STATUS DM_POOL_STAT_DESC

Update Date DM_STORAGE_POOL DM_POOL_DATE

Update Time DM_STORAGE_POOL DM_POOL_TIME

Updater DM_STORAGE_POOL DM_POOL_UPDATER

User DM_STORAGE_POOL DM_POOL_USER_ID

Write Date DM_STORAGE_POOL DM_POOL_DATE_WR




Write Time DM_STORAGE_POOL DM_POOL_TIME_WR

TRIGGER AE Name DM_COMMAND_TRIGGER DM_CT_AE_NAME

Begin DM_COMMAND_TRIGGER DM_CT_BEGIN

Begin Timeout DM_COMMAND_TRIGGER DM_CT_WB_TIMEOUT

Command Name DM_COMMAND_TRIGGER DM_COMMAND_NAME

End DM_COMMAND_TRIGGER DM_CT_END

End Timeout DM_COMMAND_TRIGGER DM_CT_WE_TIMEOUT

Status DM_COMMAND_TRIGGER DM_CT_STATUS

TYPEDEF Base Class DCT_DESCRIPTION DCT_NAME

Base Class Desc DCT_DESCRIPTION DCT_DESC

Type DefinitionDesc


Type DefinitionName

DCT_DESCRIPTION DCT_NAME

USER Last Name DM_USER DM_USER_LAST_NAME

Protection Group DM_USER DM_USER_PROT_GRP

Update Date DM_USER DM_USER_DATE

Update Time DM_USER DM_USER_TIME

Update User DM_USER DM_USER_TIME

User Description DM_USER DM_USER_DESC

User Group DM_USER DM_USER_GROUP

User ID DM_USER DM_USER_ID

User Name DM_USER DM_USER_NAME

USERLIST Date DM_USER_LIST_DATA DM_LIST_DATE

Description DM_USER_LIST_DATA DM_LIST_DESC

Member DM_USER_LIST DM_LIST_MEM_NAME

Sequence DM_USER_LIST DM_LIST_SEQNO

Time DM_USER_LIST_DATA DM_LIST_TIME

Type DM_USER_LIST DM_LIST_MEM_TYPE

Updater DM_USER_LIST_DATA DM_LIST_UPDATER

User List DM_USER_LIST_DATA DM_LIST_NAME

USERTABLE Classification DM_UDT_DIRECTORY DM_UDT_CLASS

Date DM_UDT_DIRECTORY DM_UDT_DATE

Owner DM_UDT_DIRECTORY DM_UDT_OWNER_ID




Status DM_UDT_DIRECTORY DM_UDT_STATUS_CD

Table Name DM_UDT_DIRECTORY DM_UDT_TABLE_NAME

Time DM_UDT_DIRECTORY DM_UDT_TIME

User DM_UDT_DIRECTORY DM_UDT_UPDATER

VAULTLISTS List DM_VAULT_LISTID DM_LIST_ID

Vault ID DM_VAULT_LIST DM_VAULT_ID

VAULTPS Backup Version DM_FILE_DIRECTORY DM_FILE_VERSION




Group TechCode






RevisionSequence









FILE FilesOutToMe Files I have signed out

PSFiles Product Structure Files

VAULTPS DB+PS_Files DB and Product Structure Files

PS_Files Product Structure Files


Vault Commandslistdir


listdir

The cilistdir command you can, from a local or remote node, list a file, part,file set, all the files in a project, all your private files, or the Vault database.

Syntax

cilistdir selscope=selectionScope selname=selectionNamerevision=revisionCode dirform=listFormat output=listDestinationappend=replaceOrAppendAuditFile? dirname=listFileName



All are required.

selscope=selectionScope Indicates the entity you are signing out. Enter F(file), P (part), S (file set), A (all of a project), U(user’s private files), or E (entire database).

selname=selectionName Selection name. If selection scope is not E, enterup to 80 alphanumeric characters.

revision=revisionCode Revision code. Enter a string up to 20alphanumeric characters or leave blank for thedefault all revisions.

dirform=listFormat List format. Enter S (short format) or L (longformat). The default is S.

output=listDestination Indicates where audit information is to be sent. Atthe prompt enter F (file), B (both), or M (messageonly). For the keyword, enter F or M. The default is(command-line format).

append=replaceOrAppendAuditFile? Indicates whether to replace or append the auditfile. If audit destination is F or B, enter R (replace)or A (append). Ignored if audit destination is S orM. The default is R.

dirname=listFileName List file name. Enter a filename up to 80alphanumeric characters. The default isLISTDIR.LISTING.




With the LISTDIR command, you can, from a local or remote node,

• List all your privately owned files

• List all the files in a particular part, project, or file set

• List all the files in your Vault database

• Obtain any of the above listings on either the local or a remote Vault node

• Verify Vault file names

To list the file directory entries on an Vault node (local or remote), use LISTDIR.You can use this alphabetical listing to

• Determine the owner of a file

• Verify the correct name of a file

• Determine when the file was last updated

Your listing is placed in your current working directory. You do not need read orwrite access to the files you want to list. The default listing file name isLISTDIR.LISTING or you can specify a different name. You can list informationon a local or remote node. You can list a file, CADDS catalog, part, file set, all thefiles in a project, all your private files, or the Vault database.

Please note: For more complex listings (such as all the files you currentlyhave signed out) on your local node, use the Interactive Query Facility (IQF).



List Format

You can see the listing on your screen, write the information into a file, or both.You can specify a short or long list format, depending on how much informationyou require.

Audit Information

When you designate a file as the audit destination, Vault sends the information to afile named LISTDIR.EDMAUDIT. Use a local editor to view this file.

Short Format Information Long Format Information

EDM file name EDM file name

File revision code File revision code

File type code File size

File description

File classification

Owner ID

User type code

Status code

Last update date

Last update time

Updater user ID

System code

User ID (if file is signed out)

EDM node name (if file is signed out)

File type code

System type code

Part number

Vault Commandsliststru (Binder)


liststru (Binder)

The ciliststru command lists a tree hierarchy for the named object. Use thiscommand to display the tree hierarchy of a binder.

Syntax

ciliststru baseclass=baseClass oname=objectName [revision=revisionCode]outfile=outputFile keyfile=keyFile




The output includes information for each binder, part, and file in the tree hierarchy:

• Level within the tree (named object is level 0)

• Object Name

• Object Revision

• Base Class of object

• Typedef of the object

• Status Code of the object

• Classification (public, project, private)

• Owner (blank if public, project id, user id)

baseclass=baseClass Name of the predefined base class of objects that uniquelyqualifies the object name. he default is BINDER

oname=objectName Name of the object.

outfile=outputFile Name of the output file. Enter an output filename up to 80alphanumeric characters. The default isLISTSTRU.OUTPUT


revision=revisionCode Revision code for the object.

The default is the current revision

Vault Commandsload


load

The ciload command loads a file, part, or all files from tape to Vault. It is usedprimarily to create the Vault database.

Please note: When you execute this command the tape device need not belocal.

Syntax

ciload tapeunit=tapeUnit loadtype=loadType selscope=selectionScopeselname=selectionName pfname=newVaultName revision=revisionCode

filepw=file(s)Password class=classification projid=projectId statcd=statusCodedatecrit=dateScope date=date output=auditDestinationappend=replaceOrAppendAuditFile?

Vault Commandsload




All are required.

tapeunit=tapeUnit Name to represent the tape device. EnterTAPE1, TAPE2, TAPE3, or TAPE4. The defaultis TAPE1.

loadtype=loadType Indicates the type of loading operation toinitiate. Enter R (replace), S (store), or N(replace if newer). The default is R.

selscope=selectionScope Indicates the entity you are transferring. Enter E(entire tape), F (file), P (part). The default is F.

selname=selectionName Selection name. Enter a name up to 80alphanumeric characters. Leave blank ifselection scope is E.

pfname=newVaultName Name the selection is to have in Vault. Enter aname up to 80 alphanumeric characters. Leaveblank for the default selection name.

revision=revisionCode Revision code. Enter a string up to 20alphanumeric characters or leave blank for thedefault current revision. Optional if load type isS. Ignored otherwise.

filepw=file(s)Password File password. If file(s) has password, enter upto 8 alphanumeric characters. Optional if loadtype is S. Ignored otherwise.

class=classification File classification code. Enter PUB (public),PRO (project), or PRI (private). Optional if loadtype is S. Ignored otherwise. The default isPUB.

projid=projectId Existing project identifier. If classification isPRO, enter up to 8 alphanumeric characters.Optional if load type is S. Ignored otherwise.

statcd=statusCode Status code. Enter a string up to 8 alphanumericcharacters or leave blank for the default initialin-work code. Optional if load type is S. Ignoredotherwise.

output=auditDestination Indicates where to send audit information. Atthe prompt enter F (file), B (both), or M(message only). When using the command-lineformat, you can only enter F or M. The default isF (Command-line format).

append=replaceOrAppendAuditFile? Indicates whether to replace or append theaudit file. If audit destination is F or B, enter R(replace) or A (append). Ignored if auditdestination is S or M. The default is R.

Vault Commandsload



The requirements and special considerations for the LOAD command are asfollows.

Tape Format

The files you are loading must be on a CGOS FUTIL or CGOS SAVFIL formattape.

File Names

The name of the file on the tape is the selection name; the name in Vault is theVault file name. The default, however, is for both names to be the same.

In addition, the following rules apply:

• To add a file with LOAD, the file name must not exist in the archive table.

• If a file with a released status exists in Vault (but not in the archive table) withthe same name as the file you want to load from tape

• You can add the new file with an in-work status if the new file’s revision isgreater than that of the existing file

• You can add the new file with a released status if the new file’s revisionlevel is greater than or less than the existing file.

• If a file with an in-work status exists with the same name as the file you want toload from tape, you can add a new file with a released status if the revision levelis less than that of the existing file.

Replacing Files

To replace a file (the replace option), it must already be signed out to you. Toreplace a file only if it is a more recent version (the replace if newer option), itdoes not need to be signed out to you.

For both CGOS FUTIL and SAVFIL tapes, if you select N (replace if newer),Vault compares either the tape creation date or the latest modification date for eachfile selected on the tape version. The replace operation occurs only if the tapecreation date for each file is more recent than the Vault source update date for thatfile.

When replacing a file, you cannot specify a revision code, password,classification, project ID, or status code. These are automatically specified for you.You cannot change this data at this time.

Vault Commandsload


File Properties

You can specify the following file properties when load type is Store:

• Revision code (otherwise the current revision is assigned)

• Password

• Classification (public, project, or private)

• Project ID (if the classification is project)

• Status code (otherwise the initial in-word code is assigned)

Other File Information

You can optionally add the following file attribute information for the file by usingthe CHGFA command (change file attributes):

• System type

• User-defined type

• Description

• Part number

• Group technology code

• File type code

Loading Tape Contents

The LOAD command with a selection scope of Entire tape does not store parts.Files belonging to parts are stored but there is no recognition of any parts.

Audit Information

When you designate a file as the audit destination, Vault sends the auditinformation to a file named LOAD.EDMAUDIT. Use a local editor to view this file.You must be locally logged on to the Vault server to execute this command. Theserver need not have a local tape drive.

Example

CILOADEDM> TAPEUNIT=TAPE2 LOADTYPE=S SELSCOPE=F,EDM> SELNAME=WINGDESC PFNAME=WINGDESC

In this example, the WINGDESC file on the tape mounted on TAPE2 is stored inVault.

Vault Commandslocate (DV)


locate (DV)

The cilocate command allows you to search for objects within the distributedvault environment without having to know in which vault they are stored.

Syntax

cilocate selscope=selectionScope selname=selectionNamerevision=revisionCode listform=listFormLength output=outputFormappend=replaceOrAppendAuditFile? listname=listName



All are required.


The LOCATE command must be in your public command list.

Use the LOCATE command to find an object’s location within the distributed vaultenvironment. You have transparent access to distributed vault objects, so you donot need to know where objects are stored. The LOCATE command places theresulting information into a file it creates in your current working directory.

selscope=selectionScope Enter F (File) or (P) Part. The default is F.

selname=selectionName Name of the file or part as it is stored in Vault.

revision=revisionCode Revision code. Leave blank for the defaultcurrent revision.

listform=listFormLength Specify (S) SHORT or (L) LONG list. A short listcontains an object’s name, revision, type, andvault ID. A long list contains the registrationinformation as well. The default is S.

output=outputForm Specify SCREEN (S), FILE (F), or BOTH (B) foroutput. The default is F.

append=replaceOrAppendAuditFile? Indicates whether to replace or append theaudit file. If audit destination is F or B, enter (R)replace or (A) append. The default is R.

listname=listName File name of up to 80 characters containing thequery results. The default is LOCATE.LIST.

Vault Commandslocate (DV)


Example

CILOCATE SELSCOPE=F SELNAME=INTERNAL.REPORT - REVISION=3 LISTFORM=L APPEND=A - LISTNAME=MYLIST.OUTPUT

The resulting report file can look like:

Object 1

TYPE = FNAME = INTERNAL.REPORTREVISION= 1VAULTID= VALHALLA

Vault Commandsmarka


marka

The cimarka command marks files to be archived the next time the ARCHIVEcommand is executed.

Syntax

cimarka selscope=selectionScope selname=selectionNamerevision=revisionCode filepw=file(s)Password output=auditDestinationappend=replaceOrAppendAuditFile?



All are required.


The requirements and special consideratiosn for the MARKA command are asfollows.

selscope=selectionScope Indicates the entity you are marking. Enter F(file), P (part), S (file set), or A (all of a project).The default is F.



filepw=file(s)Password If file(s) has a password, enter up to 8alphanumeric characters.

output=auditDestination Indicates where audit information is to be sent.At the prompt enter F (file), B (both), or M(message only). For the keyword, enter F or M.The default is F (command-line format).


Vault Commandsmarka


Why Files Are Marked

The marking commands increase the security of your database and allow Vaultusers to perform parts of the deletion, archive, and restoration operations atdifferent times.

For example, the MARKD command specifies a file (or a group of files) to bedeleted. The actual physical deletion step (which can take considerable time,depending on the file size and workload on your system) can be done later and byanother person.

In this way, each marking operation can be performed at the most convenient timeand by a designated person.

Because the commands to delete, archive, and restore files are executed in separatesteps (marking and archiving, for example), your database is better protected fromaccidental actions.

Which Files Can be Marked

You can use this command to mark a file, part, project or file set. You must besigned on to the proper Vault node with the SIGNON command to perform MARKA.

Please note: You cannot mark for archive or mark for restore a file that is amember of a part. You can only mark the whole part.

After a file is marked for archive, the next ARCHIVE command can physically copythe file to tape and logically delete it from Vault. The file can be physically deletedfrom Vault after the IBKUP and DELOV commands are executed.

The following determines whether you can mark a particular file:

• You must have write access to the file(s) you are marking.

• To mark a project file, you must be assigned to the project and MARKA must bein your command list for that project.

• To mark a private file, you must be the owner of the file.

• You cannot mark a file that is in use or that is a member of a part.

You can only mark files stored on a local or remote Vault node (you must be signedon to the node). For files stored on another Vault node, sign on to that node andexecute the marking command there.

Vault Commandsmarka


Marking Files

After a file is marked for archiving with the MARKA command, you can obtain onlyread access to it. The next ARCHIVE command copies the file to tape and deletes itfrom Vault. To modify the file, execute the UNMARK command, then access the filewith the GET command.

Marking Parts

If you select a CADDS part to be marked, if any of the files that make up theCADDS part cannot be marked (because they are signed out or locked), none ofthe part files are marked.

Marking Projects

If you select all project files (of a specified project) to be marked, you must beassigned to the project and have the MARKA command in your command list forthat project. All available files within the project are marked.

Marking File Set

If you select a file set to be marked, if any of the files that make up the file setcannot be marked (because they are signed out or locked, for example), none ofthe file set members are marked.

Revision Code of Marked Files

When you do not specify a revision code, the default is the current revision.

Marking Password-Protected Files

If you have administrative privileges, you can mark all files in a part, project, orfile set even if the files have varying passwords. If you do not have administrativeprivileges, the result depends on the group of files you are marking:

• If you attempt to mark a project that contains files with varying passwords,Vault marks only those files with the password you specify and those that arenot password protected.

• If you attempt to mark a part or file set that contains files with varyingpasswords, Vault marks none of the files in the part or file set.

When you use the command-line format and enter a file password, it is shown asyou type it and remains on the screen until the processing key is pressed.

Vault Commandsmarka


Audit Information

When you designate a file as the audit destination, Vault sends the information to afile named MARKA.EDMAUDIT. Use a local editor to view this file. See Vault EndUser Guide for more information about this command.

Restrictions

You cannot mark for archive or mark for restore a file that is a member of a part.You can only mark the whole part.

Examples

CIMARKAEDM> SELNAME=WINGDESC

In this example, the WINGDESC file at the current revision level is marked to bearchived.

CIMARKAEDM> SELSCOPE=S SELNAME=WINGFS REVISION=RE,EDM> FILEPW=WG

In this example, the WINGFS file set at the RE revision level is marked to bearchived.


Vault Commandsmarkd


markd

The cimarkd command marks files to be deleted the next time a DELETEcommand is issued.

Syntax

cimarkd selscope=selectionScope selname=selectionNamerevision=revisionCode filepw=file(s)Password output=auditDestinationappend=replaceOrAppendAuditFile?



All are required.


You can use this command to mark a file, part, project or file set.

After you mark a file for deletion with the MARKD command, execute the DELETEcommand to complete the process of logically removing the file from Vault.(Execution of the IBKUP and DELOV commands physically deletes the file.)







Vault Commandsmarkd


After a file is marked for deletion with the MARKD command, you can no longeraccess it (unless you cancel the mark for deletion with the UNMARK command). Thefile still physically exists, however, until it is deleted with the DELETE command,or until you perform an incremental backup (IBKUP) and the DELOV command.

The following determines whether you can mark a particular file:

• You must have write access to the file(s) you are marking.

• To mark a project file, you must be assigned to the project and you must havethe MARKD command in your command list for that project.

• To mark a private file, you must be the owner of the file.

• You cannot mark a file that is in use. But you can mark a file that is a member ofa part.

You can only mark files stored on a local or remote Vault node (you must be signedon to the node). For files stored on another Vault node, sign on to that node andexecute the marking command there.

Objects relate to a binder cannot be deleted. You must first delete either therelationships or the binder. The High Level Query Facility can list all relatedbinders and/or relationships.

Marking Parts

If you select a CADDS part to be marked, if any of the files in the part cannot bemarked (because they are signed out or locked), none of the part files are marked.

Marking Projects

If you select all project files (of a specified project) to be marked, you must beassigned to the project and have the MARKD command in your command list forthat project. All available files within the project are marked. When you select afile set to be marked, and any of the files that make up the file set cannot be marked(because they are signed out or locked), none of the file set members are marked.


You can specify a revision code for a particular version of a file to be marked.Otherwise, the current revision is marked.

Vault Commandsmarkd







Audit Information

When you designate a file as the audit destination, Vault sends the information to afile named MARKD.EDMAUDIT. Use a local editor to view this file.

Restrictions

You cannot mark for deletion a file that has been locked by the system (by a GETcommand executed on it) or marked for archive.

Example

CIMARKDEDM> SELNAME=WINGDESC

In this example, the WINGDESC file at the current revision level is marked to bedeleted.

CIMARKDEDM> SELSCOPE=P SELNAME=WINGPART FILEPW=WINGPW

In this example, all of the WINGPART part files at the current revision level aremarked to be deleted.


Vault Commandsmarkr


markr

The cimarkr command marks files to be restored the next time the RESTOREcommand is issued.

Syntax

cimarkr selscope=selectionScope selname=selectionNamerevision=revisionCode filepw=file(s)Password output=auditDestinationappend=replaceOrAppendAuditFile?



All are required.


You can use this command to mark a file, part, project, or file set.

Previously archived files can be marked with the MARKR command. Then, the nexttime the RESTORE command is executed, the files can be copied to Vault fromtape. To prevent a file from being restored, execute the UNMARK command.



revision=revisionCode Revision code. Enter a revision code up to 20alphanumeric characters or leave blank for thedefault current revision.




Vault Commandsmarkr


Marking Projects

When you select all project files (of a specified project) to be marked, you must beassigned to the project and have the MARKR command in your command list forthat project. All available files within the project are marked.

Marking File Set

When you select a file set to be marked, if any of the files that make up the file setcannot be marked (because they are signed out or locked), none of the file setmembers are marked.


You can specify a revision code for a particular version of a file to be marked.Otherwise, the current revision is marked.






Audit Information

When you designate a file as the audit destination, Vault sends the information to afile named MARKR.EDMAUDIT. Use a local editor to view this file. See Vault EndUser Guide for more information about this command.

Vault Commandsmarkr


Restrictions

You must have write access to the file(s) you are marking. To mark a project file,you must be assigned to the project and you must have the MARKR command inyour command list for that project. To mark a private file, you must be the owner ofthe file. You can not mark a file that is in use or that is a member of a part. You canonly mark for restore a part as a whole.

Examples

CIMARKREDM> SELNAME=WINGDESC

In this example, the WINGDESC file at the current revision level is marked to berestored.

CIMARKREDM> SELSCOPE=F SELNAME=WINGDESC REVISION=RE,EDM> FILEPW=WG

In this example, the WINGDESC file at the RE revision level is marked to berestored.


Vault Commandsopnt


opnt

The ciopnt command opens a table previously added to the control of Vault.

Syntax

ciopnt qtblname=tableOrViewName acctype=accessType



All are required.


You can open a table with select or modify access. Vault checks to see if you havethe proper authority to open the table for the kind of access you specify. Selectaccess allows you to query the table. This is equivalent to the SQL command

GRANT SELECT ON

You must have the proper read authority to open a table for select access at thecurrent status of the table.

Modify access allows you to modify as well as query the table. This is equivalentto having the authority to use the SQL commands

INSERT DELETE SELECT INDEX UPDATE

You must have the proper write authority to open the table for modify access at thecurrent status of the table. OPNT is unavailable on a remote Vault Client node. SeeVault Manager Guide for more information.

qtblname=tableOrViewName Name of a SQL table previously added to Vault with theADDT command. Prefix the name with the creator’sSQL ID in the form creator.table_name. Enter upto 61 characters.

acctype=accessType Flag that indicates whether to open the table in Selector Modify access mode. Enter S (select) or M (modify).The default is S.

Vault Commandspurge


purge

The cipurge command logically deletes files not previously marked for deletion.

Syntax

cipurge selscope=selectionScope selname=selectionNamerevision=revisionCode filepw=file(s)Password output=auditDestinationappend=replaceOrAppendAuditFile?



All are required.


PURGE is basically a one-step deletion procedure, in contrast to the two-stepprocedure of executing the MARKD (mark for deletion) command, followed by theDELETE command.

Vault physically deletes a purged file the next time the IBKUP and DELOVcommands are executed.

selscope=selectionScope Indicates the entity you want purged. Enter F (file), A(all of a project), P (part), or U (user’s private files).The default is F.

selname=selectionName Selection name. Enter a selection name up to 80alphanumeric characters.

revision=revisionCode Revision code. Enter a revision code up to 20alphanumeric characters or leave blank for thedefault current revision.

filepw=file(s)Password File password. If file(s) has password, enter up to 8alphanumeric characters.

output=auditDestination Indicates where to send audit information. At theprompt enter F (file), B (both), or M (message only).When using the command-line format, you can onlyenter F or M. The default is F (Command-Lineformat).

append=replaceOrAppend

AuditFile?

Indicates whether to replace or append the audit file.If audit destination is F or B, enter R (replace) or A(append). Ignored if audit destination is S or M. Thedefault is R.

Vault Commandspurge


Executing the PURGE command for a file is equivalent to executing the MARKDcommand on that file and then the DELETE command.

Please note: You can only recover and access files deleted with the PURGEcommand, one at a time, with the RECSF (recover a single file) command.

To purge a file it

• Must be listed in the file directory.

• Cannot be a member of a file set or binder

• Cannot be signed out

• Cannot be marked for archive (with the MARKA) command

• Can be marked for delete (with the MARKD) command

• Cannot be in a review cycle (locked for review)

To purge files or parts in a fileset or binder, first remove them from the fileset orbinder. The High Level Query Facility can list all relationships that need to bedeleted in order for the purge to work.

Please note: Under normal circumstances, use the MARKD command tologically delete a file, followed by the DELETE command, instead of using thePURGE command. This allows the exact file to be recovered using the UNMARKcommand up until the DELETE command is executed.

When you designate a file as the audit destination, Vault sends the information to afile named PURGE.EDMAUDIT. Use a local editor to view this file.


Vault Commandsread


read

The ciread command copies a Vault file selection to your local storage area. Anynumber of Vault users can use the READ command on the same file concurrently.

Please note: You must have read access for the file to be copied.

The READ command does not sign the file out to you. You cannot modify the datain the original file stored in Vault (with the UPDATE or REPLACE command).

Syntax

ciread selscope=selectionScope selname=selectionName lfname1=localFileName

ldirname1=localDirectoryName revision=revisionCode filepw=filePasswordfiletype=fileType output=auditDestination append=replaceOrAppendAuditFile?overlay=overwriteExistingFiles? cont=continue?attrfile=attributeFileNamevaultid=vaultName

Vault Commandsread



1 Valid input and defaults for this parameter are platform dependent.


All are required.

selscope=selectionScope Indicates the entity you are reading. Enter F(file), P (part), S (file set), B (binder), L (list).The default is F.

selname=selectionName Selection name. Enter a selection name up to80 alphanumeric characters.

When SELSCOPE=L, the selection name is thename of a local file containing the names of thefiles and parts to be read.

lfname1=localFileName Name of the selection in your local storage areawhen selection scope is F. Enter a name up to80 alphanumeric characters.

ldirname1=localDirectoryName Local directory to which the files(s) can becopied. Enter a local directory up to 80alphanumeric characters. Ignored if path isgiven in local file name. See footnote.

revision=revisionCode Revision code. Enter a revision code string upto 20 alphanumeric characters or leave blankfor the default current revision.

filepw=filePassword File password. If file(s) has password, enter upto 8 alphanumeric characters.




overlay=overwriteExistingFiles? Indicates whether to overwrite an existing localfile with the Vault file. Enter Y (yes) or N (no).The default is N.

cont=continue? Indicates whether or not to transfer anadditional copy of a file already signed out tothe user. Enter Y (yes) or N (no). The default isN.

attrfile=attributeFileName Enter the name of a local file that can receivethe list of attributes and assigned values. Entera name up to 80 alphanumeric characters.

vaultid=vaultName Enter a unique vault name, up to 32case-sensitive alphanumeric characters.

Vault Commandsread



You can use the READ command to obtain a copy of a file, part, or file set, or a listof files and parts. The READ command allows you to do the following:

• Copy Vault files or parts to your local storage area without signing them out.

• Copy Vault files or parts to your local storage area while another user has thefile signed out.

Saving Your Modifications

Use the GET command to obtain a file copy on your local storage area if you wantto have your modifications stored back into Vault. See “get” on page 3-164. Youcan also save the modifications under a new name or the same name (with certainrestrictions) in Vault with the STORE command. See “store” on page 3-278.

Copying Signed Out Files

If a file is currently signed out to someone else, you can still obtain it locally. Youare cautioned that the file you are obtaining has been signed out, so you can nothave the most current version. The message also tells you who signed the file out.If you issue this command with the command-line format, the audit file indicateswho signed the file out.

File Names in Vault and Your Local Storage Area

The name of the file in your local storage area depends on the local file name andlocal directory name you specify. Specify the file name in Vault with the selectionname parameter; specify the file name in your local storage area with the local filename parameter. You can also specify a local directory name.

Input for the local directory name (LDIRNAME) parameter is platform-dependent.Default locations for the copy of the file in the database depends on your type ofsystem.

Local File Name

For a single file or part transfer, the value of the LFNAME keyword is the local filename for the file to be transferred from Vault. When you transfer a single Vault fileor part to your local storage area, you can always use the LFNAME keyword torename the object.

Vault Commandsread


For multiple file transfer (file set, list), the value of the LFNAME keyword isignored. The Vault names of the member files are used. In other words, you cannotrename files included in file set.

User-Defined Attributes

Attributes are important pieces of information associated with a selection. TheVault administrator informs you when there are attributes associated with a file.

Attribute File Name

When attributes are associated with a file, you can obtain them by specifying anattribute file name when you execute the READ command. Enter the name of alocal file that can receive the list of attributes and assigned values. Depending onhow CADDSPATH is defined, the attribute file might end up in a directory otherthan the directory that includes the files you just read.


The file listing the attributes has one assignment on each line with the formatATTRIBUTE NAME=attribute value.

The attribute name is uppercase; the value can be mixed case. The value can be anexact copy of whatever data was associated to the attribute. The value starts afterthe equal sign. Trailing blanks are ignored.

The attribute value you see in the attribute file output can be stored or, ifassociated with a unit of measure, converted and formatted for output with its unitof measure.

Only those attributes for which you have at least read permission are presented.Attributes for which you have read but not write permission are preceeded with'##' in the attribute file listing. These attributes are ignored when youreplace/update the underlying object. Only those attributes are allowed for whichyou have read/write authority, depending on the action you want to perform.


When the selection scope covers multiple Vault objects, the file identifies eachobject before listing attribute values. The identifiers OBJECT-NAME andOBJECT-TYPE identify the objects. Instance numbers in parentheses indicatemultiple values for an attribute. The content of the attribute file might look likethis:

OBJECT-NAME=jet.part

Vault Commandsread


OBJECT-TYPE=partWEIGHT(1)=3.2WEIGHT(2)=4.4CLEARANCE=SecretOBJECT-NAME=jet.drawingOBJECT-TYPE=fileSIZE=“14 x 22”

Files Marked for Deletion

You cannot obtain a file marked for deletion (with the MARKD command).

Deleting a Local File

To delete a file copy in your local storage area, use your operating system deletionprocedure.

Issuing READ on a List

To operate on a list, specify L for the selection scope and specify the name of alocal list file for the selection name. The specified local list file contains the Vaultpart names and file names to transfer. You cannot include directories, file sets, orother lists in the list file.

If for some reason Vault cannot transfer even one member of the list, then nomembers of the list are transferred. Consequently, we recommend that you use listsonly to operate on parts and files as a group.



The file that contains the list of parts and files to be operated on uses akeyword=value format. For READ, you can include

PART=Vaultpartname or FILE=VaultfilenameREVISION=Vaultrevision (optional value)

for each part or file in the list.

Vault Commandsread



The syntax rules for the list are as follows.

• There must not be any blanks between the keyword, the equal sign, and thevalue.





Example

CIREADEDM> SELSCOPE=F SELNAME=TEST1,EDM> REVISION=RE,EDM> FILEPW=TEST1,EDM> OUTPUT=B APPEND=R

In this example, the TEST1 is copied to the local storage area.


Vault Commandsreadattr


readattr

The cireadattr command reads the attributes associated to a file or part.

Syntax

cireadattr [object-class=classIdentifier] object-type=objectTypeobject-name=objectName [object-revision=objectRevision][attrfile=attributeFile]



object-type=objectType Minor group of the object within the class. EnterFILE or PART. The object-class and theobject-type parameters together identify specifickinds of objects. For example, a CADDS FILE ora CADDS PART. The default is FILE.

object-name=objectName Name of the object. The length of this fielddepends on the object type.



attrfile=attributeFile Name of an output attribute file in whichcommand results are displayed. (Note: You mustspecify this parameter to see command results.)The length of this field varies based on yourplatform.

Vault Commandsreadattr



The requirements and considerations for the READATTR command are as follows.

Attribute File Output

When you designate a file as the audit destination, Vault sends the information to afile named READATTR.EDMAUDIT. Use a local editor to view this file.

Example

CIREADATTR OBJECT-NAME=AA-FILENAME1 -OBJECT-TYPE=FILE ATTRFILE=AA-TESTFILE3

Vault Commandsreadmsg


readmsg

The cireadmsg command allows you to read messages generated and maintainedby Vault. You can read only messages sent to you; you cannot read messages sentto others.

Syntax

cireadmsg msgopt=readMessageAction msgnum=messageNumberappend=replaceOrAppendAuditFile?



All are required.


When you issue the READMSG command using command-line format, the messagetext is displayed in the center of the screen. Vault informs you when you do nothave any messages to read.

The following information about the message is displayed at the top of the screen:

• The message number Vault assigned to the message

• The message type—N for notification messages, R for review messages

• The Vault user ID of the person who sent the message

• The time and date the message was sent

If your message is an R (review) message type, you have received a messagethrough the release/revision control facility. See the rsvp command on page 267for information about responding to this message type.

msgopt=readMessage

Action

Indicates what action to take with the message.Enter E (erase), or A (copy to audit file).

msgnum=messageNumber Message number. If MSGOPT is E, enter up to10 characters.

append=replaceOrAppendAuditFile? Indicates whether to replace or append theaudit file. If read message action is A, enter R(replace) or A (append).

Vault Commandsreadmsg


You cannot delete a review message. You can also use IQF to read messages. SeeVault Interactive Query Facility Guide for further information or instructions.

Responding to a Message with the Command-LineFormat

To read a message for the first time, enter the CIREADMSG command and specifyMSGOPT as A (to send the message to the audit file).

Please note: You cannot use the next and previous message options with thecommand-line format.

Enter R (to replace existing audit file information) or A (to append the message tothe file) in the append parameter. Your message can be displayed on the screen,along with the other message information, including the message number.Remember or jot down this number.

To erase the message, enter the CIREADMSG command and specify MSGOPT as E(to erase the message). Enter the message number in the MSGNUM field.

Types of Messages

You can receive review messages and notification messages. The Message typefield in your message displays an R (for review) and an N (for notification) toindicate which message you have received.

Review messages require you to respond to the message in certain ways. See thersvp command on page 267 for information. Notification messages can be sent toyou from another user. As an Vault user, you can only send notification messages.Notification messages do not require responses.

Your messages are sent to your message bin. The next time you enter Vault (byusing the SIGNON command), the following message is displayed:

SIGNON TO EDM SERVER COMPLETED SUCCESSFULLYYOU HAVE n EDM MESSAGE(S)

You can see this message (n is the number of messages) any time there is amessage in your message bin until the message is erased. To find out if you havereceived a message during your work session, use the READMSG command. Vaultalso informs you if you do not have any messages. See Vault End User Guide formore information.

Vault Commandsrecsf


recsf

The cirecsf command recovers a single file with a previous version from anVault backup tape. You can execute this command only when you are locallylogged in to the Vault server.

Syntax

cirecsf tapeunit=tapeUnit pfname=VaultFileName revision=revisionCodedate=lastUpdateDate time=lastUpdateTime



All are required.


You can execute this command only when locally logged in to the server. Thiscommand is not available on VaultClient on a remote node. The server need nothave a local tape drive.

tapeunit=tapeUnit Name to represent the tape device. Enter TAPE1,TAPE2, TAPE3, or TAPE4. The default is TAPE 1.

pfname=VaultFileName Vault file name. Enter a filename up to 80 alphanumericcharacters.

revision=revisionCode Revision code. Enter a revision code up to 20alphanumeric characters.

date=lastUpdateDate USA or European standard date format. For USA format:month, followed by a slash (/), day, slash, year. Forexample, 05/01/89 for May 1, 1989. For European format:day, followed by a period (.), month, period, year, as in01.05.89 for 1 May, 1989. Used to determine which fileversion can be recovered.

time=lastUpdateTime USA standard time format consisting of the hour, followedby a colon (:), followed by the minute, followed by a colon(:), followed by the second (HH:MM:SS). For example,09:05:22. Used to determine which file version can berecovered.

Vault Commandsrecsf


Execute the RECSF (recover single file) command under the following conditions:

• If you have accidentally deleted a file or corrupted the latest version of a fileand want to recover an earlier version of it.

The command recovers an old version of a file either to replace the current(corrupted version) or to reactivate a deleted file. The file’s old version isrecovered from an incremental backup tape or from the storage pool where itawaits incremental backup.

• If you have deleted or corrupted an entire part and want to recover it, recovereach file in the part individually.

When you recover part files, they might or might not be automaticallyreattached to their original part. If you recover a file before you perform anincremental backup and before you delete old file versions, then the files arereattached to their part. If the entire part was deleted, it becomes active againduring the recovery process.

If the part is not recovered intact, you can reassemble it by following these steps:

1. Issue the READ command for the orphaned files after they are recovered. Thiscreates a local copy of each orphaned file.

2. Issue the STORE command for each orphaned file and specify the part to whichyou want the file added.

3. Issue the PURGE command to delete the orphaned files from the file directory.

If an entire part is disassembled,

1. Issue the READ command for each part file after it is recovered. This creates alocal copy of each file.

2. Issue the PURGE command to delete the files from the file directory.

3. Issue the STORE command for the part.

Specify which old version is to be recovered by entering the date and time of thelast Vault update version. Use the Interactive Query Facility (IQF) to view theBackup Table (UPDATE_DATE and UPDATE_TIME columns) for thisinformation. You can be prompted to mount a specified incremental backup tape(you can use either copy of a two-copy set) where the requested version is stored,or the file can be recovered from a storage pool.

If any attributes are associated with the file being recovered, the attribute servershould be running during the execution of the RECSF command. This ensures thatVault recovers any associated attributes along with the file itself.

Vault Commandsrecsf


Recovery is successful when the revision codes of the lost file (file directory) andthe backed-up file (backup directory) are the same. With different revision codes,recovery is successful when the backup has a released status.

The user ID under which you execute the RECSF command must own the storagepool(s) that contain the file to be recovered. When you execute the RECSFcommand and you do not own the storage pool, Vault changes the status of thepool so that it is unavailable; recovery is unsuccessful. You must execute theCHGSPS command to return the storage pool to an available status.

See Vault System Administrator Guide for system privileges you cancanexecutethis command. See Vault Manager Guide for more information about thiscommand.

Vault Commandsrecsp


recsp

The cirecsp command recovers a destroyed or corrupted storage pool area.Before you issue this command, restore the storage pool with the most recentuniversal backup tape. See Vault System Administrator Guide for additionalinformation about recovering storage pools.

Syntax

cirecsp tapeunit=tapeUnit poolname=storagePoolNameappend=replaceOrAppendAuditFile?



All are required.


This command can only be used to recover one storage pool at a time. In the caseof a disk error, it is likely that you need to recover more than one storage pool.When recovering multiple storage pools, leave the Replace/append audit file?parameter set to A (append). This allows you to recover one storage pool after theother and save information about each recovery. When the Replace/append auditfile? parameter is set to R, Vault erases the information about the previous recoverywhen you recover another storage pool. RECSP.EDMAUDIT is the name of theaudit file.

During the recovery process, the system prompts you to mount a specified tape, ifthat is where the most current version of a file is stored.

To recover a storage pool, first reload it with the latest universal backup tape. Thisstep returns the pool to its state at the time of the universal backup.

tapeunit=tapeUnit Name to represent the tape device. EnterTAPE1, TAPE2, TAPE3, or TAPE4. The defaultis TAPE 1

poolname=storagePoolName Existing storage area name in Vault. Enter aname up to 8 alphanumeric characters.

append=replaceOrAppendAuditFile? Indicates whether to replace or append to (orcreate) the audit file. Enter A (append) or R(replace). The default is A.

Vault Commandsrecsp


Next, run the RECSP command to roll forward the storage pool. Detailed directionsfor these steps are in Vault System Administrator Guide.

If any attributes are associated with the storage pool being recovered, the attributeserver should be running during the execution of the RECSP command. Thisensures that Vault recovers any associated attributes along with the storage pool.

You must be locally logged in to the Vault server to execute the RECSP command.The server need not have a local tape device. See Vault System AdministratorGuide for other privileges you cancanexecute this command and for moreinformation about this command.

Never use more than one kind of tape media (1/2-inch, Exabyte) between universalbackups. In other words, when performing an incremental backup, always use thesame type of tape media as used by any other incremental backup since the lastuniversal backup. This is important when you want to recover a storage pool. TheRECSP command might need to read data from several tapes during its operation.You cannot change media during execution of the RECSP command.

To execute the RECSP command, it must be in your public command list.

Conditions of Files After Executing RECSP

After you run the RECSP command, all files residing in the storage pool prior to itsdemise fall into one of the following categories.

• Recovered to the latest version (an exact copy of what was lost) from the latestuniversal backup tape. The date and time stamp for these files precedes thelatest universal backup.

• Recovered to latest version from an incremental backup tape. The date and timestamp for these files precedes one of the incremental backups taken since thelast universal backup.

• Recovered to an old version from either an incremental backup tape or anotherstorage pool. The date and time stamp for the latest version of these files is laterthan the latest incremental backup, but a previous version is available. Vault’sdefault storage pool selection logic assigns a new version of a file to a differentstorage pool than the one most recently used, so that a recent version of a file isoften available when a storage pool is lost.

• Lost permanently. Files stored for the first time since the latest universal orincremental backup cannot be recovered.

Files recovered to their latest version retain the Vault state they had before thestorage pool was lost: Files signed out or marked for archive or delete, remain

Vault Commandsrecsp


signed out or marked. Files previously in review remain in review as long as theselection in review to which they belong has not been partially destroyed. Forexample, if a file belonged to a part and another file belonging to that part was lost,the entire part is taken out of review. Recovered files that belonged to a partcontinue to belong to that part.

Files that were recovered to an old version usually drop any special Vault statethey can have had: Files marked for archive or delete are no longer marked. Filespreviously in review are no longer in review. However, files that were signed outremain signed out. Files recovered from old versions assume the attributes of theold version: such attributes include class, owner, and status code. Files recoveredfrom old versions no longer belong to any part.

Files that were lost altogether also lose any special Vault status they can have had,such as marked for archive, marked for delete, or in review, but they remain in theVault file directory as placeholders. If the file they replace was signed out, theplaceholder representing them is signed out. The placeholder for a lost file nolonger belongs to any part.

Using Local Copies to Recreate Latest Versions

If you have local copies of the files that were lost or recovered to old versions, youcan recreate the latest version in Vault using the Vault REPLACE or STOREcommands.

• Lost file now shown as a placeholder in Vault.

• Standalone file: Store the file again.

• Part member file: Store the file again and specify add file to part.

• File recovered to an old version, file is signed out.

• Standalone file: Replace or update the file.

• Part member file: Replace or update the part.

• File recovered to an old version, file not signed out.

• Standalone file: Get and replace file—convenient for in-work files, but becareful not to overlay the local, good copy with the GET command. Or, youcan read, purge, and then store the file. This is best when the file is released.

• Part member file: Get and replace part or read, purge, and then store fileusing the add file to part option.

If you no longer want the old versions or placeholders, you can remove them withthe PURGE or DELETE commands or, for placeholders, the RESET command.

Vault Commandsrecsp


Examples of the RECSP Audit File

The RECSP command produces an audit file describing the outcome of rollingforward the storage pool. (Files restored from the universal backup tape are notlisted in the RECSP audit file.)

Here are some examples of RECSP audit files with explanations of how to interpretthem.

Example 1:

An exact copy of the following file was recovered by the RECSP command from anincremental backup tape. You can see this by examining the SRC DATE, SRCTIME, UPT DATE, and UPT TIME fields. The file remains a member of its partand remains signed out.

16-Oct-93 14:26:24 STORAGE POOL RECOVERY POOL : POOL7 AUDIT REPORT PAGE NO : 0001FILENAME : ENGINE.BLOCK.DRAW1PARTNAME : ENGINE.BLOCKREVISION : 1TYPE : 21CLASS : PUBOWNER :STATUS : IWSYS CODE : SNODE : freudUSER : SMITHSRC DATE : 921012SRC TIME : 150223UPT DATE : 921013UPT TIME : 131108 IS REPLACED BY THE FOLLOWING -----FILENAME :ENGINE.BLOCK.DRAW1PARTNAME : ENGINE.BLOCKREVISION : 1TYPE : 21CLASS : PUBOWNER :STATUS : IWSYS CODE : SNODE : freudUSER : SMITHSRC DATE : 921012SRC TIME : 150223UPT DATE : 921013UPT TIME : 131108CDMRSP497I The storage pool recovery has completed successfully.Please print the file RECSP.EDMAUDIT for information about therecovered file(s).

Vault Commandsrecsp


Example 2:

An old version of the following file was recovered by the RECSP command fromeither an incremental backup tape or another storage pool, as seen by examiningthe dates and times shown. The file had belonged to a part but no longer does, asshown by the part name difference. The part and file are no longer in review.

16-Oct-93 14:26:24 STORAGE POOL RECOVERY POOL : POOL7 AUDIT REPORT PAGE NO : 0001FILENAME : AIRFOIL.PART1.&PDPARTNAME : AIRFOIL.PART1REVISION : 1TYPE : 20CLASS : PROOWNER : JET12STATUS : IWSYS CODE : RNODE :USER :SRC DATE : 921015SRC TIME : 140709UPT DATE : 921016UPT TIME : 160735 IS REPLACED BY THE FOLLOWING BUT DETACHED FROM PART -----FILENAME : AIRFOIL.PART1.&PDPARTNAME :REVISION : 1TYPE : 20CLASS : PROOWNER : JET12STATUS : IWSYS CODE :NODE :USER :SRC DATE : 921010SRC TIME : 105200UPT DATE : 921012UPT TIME : 135520

CDMRSP048I The review of part AIRFOIL.PART1 has been terminated.

CDMRSP497I The storage pool recovery has completed successfully.Please print the file RECSP.EDMAUDIT for information about therecovered file(s).

Vault Commandsrecsp


Example 3:

An old version of the following file was recovered by RECSP. The file previouslywas released, but now is in-work again, indicating that a review or status changehad taken place on the file.

16-Oct-93 14:26:24 STORAGE POOL RECOVERY POOL : POOL7 AUDIT REPORT PAGE NO : 0001FILENAME : WHEEL.SPECSPARTNAME :REVISION : 2TYPE :CLASS : PROOWNER : JET12STATUS : RLSYS CODE :NODE :USER :SRC DATE : 921015SRC TIME : 140709UPT DATE : 921016UPT TIME : 160735

IS REPLACED BY THE FOLLOWING -----

FILENAME : WHEEL.SPECSPARTNAME :REVISION : 2TYPE :CLASS : PROOWNER : JET12STATUS : IWSYS CODE :NODE :USER :SRC DATE : 921010SRC TIME : 105200UPT DATE : 921012UPT TIME : 135520CDMRSP497I The storage pool recovery has completed successfully.Please print the file RECSP.EDMAUDIT for information about therecovered file(s).

Vault Commandsrecsp


Example 4:

The next example shows two files that were lost because no versions were foundon either an incremental or universal backup tape. RECSP created placeholders forthem.

The first file was marked for delete. The placeholder created for it has a systemcode of P. You can delete it using the RESET command or recreate it using theSTORE command. The second file belonged to a part. The placeholder created forit has a system code of P. It retains the user ID and node from the former file but isno longer connected to the part. To remove the file, issue the RESET commandtwice. To recreate it, issue the REPLACE or UPDATE commands for the part.

13-Oct-93 14:29:15 STORAGE POOL RECOVERY POOL : POOL6 AUDIT REPORT PAGE NO : 0001THE FOLLOWING FILE IS LOST FILENAME : LOST.FILE.MARKD PARTNAME : REVISION : 1 TYPE : CLASS : PUB OWNER : STATUS : IW SYS CODE : D NODE : USER : SRC DATE : 921013 SRC TIME : 134207 UPT DATE : 921013 UPT TIME : 134249

THE FOLLOWING FILE IS LOST AND DETACHED FROM PART

FILENAME : LOST.PART.&PD PARTNAME : LOST.PART REVISION : 1 TYPE : 20 CLASS : PUB OWNER : STATUS : IW SYS CODE : NODE : starship USER : SPOCK SRC DATE : 921013 SRC TIME : 134349 UPT DATE : 921013 UPT TIME : 134417

CDMRSP497I The storage pool recovery has completed successfully.Please print the file RECSP.EDMAUDIT for information about therecovered file(s).

Vault Commandsregister (DV)


register (DV)

The ciregister command allows you to make objects accessible to users onselected remote vaults. You can register your objects and give query, read, or writeaccess to users on remote vaults. You can also transfer ownership of an object orrestrict an object’s accessibility by registering it for local-vault access only. Theciregister command must be in your public command list.

Syntax

ciregister selscope=selectionScope selname=selectionNamerevision=revisionCode objectpw=objectPassword reglevel=registrationLevel



All are required.

selscope=selectionScope A letter specifying either of the following objecttypes: F File or P Part.

selname=selectionName Name of the file or part, as stored in the database.

revision=revisionCode Revision code of up to 20 characters. Blankindicates the latest revision.

objectpw=objectPassword Password of up to 8 characters. Required if the fileor part is password-protected.

reglevel=registrationLevel Access rights for objects:

Q Queryable only. The level allows file/partmetadata to be sent to the DOD, and is availablefor query, but no Vault operations are valid.

R Read-only. This level restricts remote access tothe file/part to the Vault READ command.

W Writable. This level allows remote access to thefile/part for Vault file access commands whichhonor the VAULTID parameter.

O Ownership. Beyond W, this level also allowsexporting (EXPORT) of this file/part for a move[tag=move] operation.

L Local. This level effectively withdraws priorregistration, and the file/part is no longer known tothe DOD. This is the default.




You must register objects before you can export them to other vaults. Theregistration level (REGLEVEL) defines the object’s access capability on thereceiving vault. For example, if you want to transfer the object with writecapability, you must use a REGLEVEL value of Write.

Registering objects also allows them to be available for transparent access fromother vaults in the Distributed Vault environment. The level of registrationdetermines the accessibility.

Please note: Objects with NONE revision sequence cannot be registered. Youcannot change the registration level of a previously registered object that is signedout.

Prerequisites

To register an object, you must have

• A valid user ID and password on the object’s resident vault

• Ownership access to the object

• The REGISTER command in your command list

Considerations

When registering objects, you determine

• Specific revision or latest revision

• The access capability of this object on other vaults (query, read write,ownership transfer)

Registering Parts

A part is a set of files recognized as a unit by an application such as CADDS. Apart member cannot be registered independently.

You must give the command to register the entire part and specify the selectionscope as P.

For more details on part registration, refer to the Vault End User Guide.



Unregistering Vault Objects

Use the utility, revregobj, to unregister Vault objects that were registered withno revision. This is applicable to the Vault objects that were registered usingOptegra Vault 3 or earlier versions.

This utility is available in the following path:

• On UNIX

$EPD_HOME/install/revregobj

• On Windows NT

%EPD_HOME%\install\revregobj.exe

Run revregobj from the specified paths.

For example, if you have a Vault object PART1 registered with revision=' ', youcan run this utility to unregister the Vault object PART1.

Please note: You cannot unregister a single object using this utility.

Example

CIREGISTER SELSCOPE=F SELNAME=TEST1 REVISION=3 REGLEVEL=R

In this example, Revision 3 of the file TEST1 is registered with external readaccess privileges. If another revision exists, such as Revision 4, it is not registered.

Please note: If you check a file with external read/write privilege out of theVault, you cannot change the scope or access level of that object until you sign it inor reset it.

Vault Commandsremadod (DV)


remadod (DV)

The ciremadod command removes knowledge of an existing distributed objectdirectory (DOD) from the distributed environment.

Syntax

ciremadod vaultid=vaultName type=vaultType node=vaultSystemName



All are required.


You must be logged on as the Vault installation account to use this command, andthe REMADOD command must be in your public command list. This command isnot available programmatically.

To change the preferred DOD for a Vault, use the ciremadod command followedby the ciaddadod command.

The ciremadod command automatically updates the network configuration filesnsm.config and pm.config, and also updates the relational databasemanagement system. These updates occur when you shut down and restart Vault.

Example

CIREMADOD VAULTID=VAULTB TYPE=DOD NODE=VALHALLA


type=vaultType Enter SELF if the DOD resides on your system. EnterDOD if it resides elsewhere.

node=vaultSystemName Name of the system where the DOD resides. Enter a vaultname up to 32 case-sensitive alphanumeric characters.

Vault Commandsremalias (DV)


remalias (DV)

The ciremalias command removes the alias (remote vault for Vault messages)for a user ID. After the REMALIAS command is executed, you receive Vaultmessages in your local vault.

Syntax

ciremalias userid=userID



All are required.


VAULTID is not needed for this command. To change the alias for a user, useREMALIAS and ADDALIAS with the new alias.

The REMALIAS command must be in your public command list.

Example

CIREMALIAS USERID=CARL

userid=userID Unique user identifier. Enter a user identifier up to 12alphanumeric characters.

Vault Commandsremfs


remfs

The ciremfs command removes a file set association from Vault and deletes thefile set name. The members of the set are not deleted but continue to exist in thedatabase.

Syntax

ciremfs fsname=fileSetName



All are required.


After the command is executed, each of the members are removed from the file setand the file set name no longer exists in the file directory. However, the membersstill exist in Vault by themselves.

Please note: You cannot remove a file set that is a member of another file set.You must first remove the association.


fsname=fileSetName Existing file set name. Enter a filename of up to 80alphanumeric characters.

Vault Commandsremmas


remmas

The ciremmas command removes a member attribute or set from an attribute set.

Syntax

ciremmas amemname=memberName amemtype=memberType setname=setName



All are required.


A member can be an attribute or a set name. When you remove a member, Vault nolonger associates that member with the attribute set. The removed membercontinues to exist as an attribute or set on its own.

amemname=memberName Name of the attribute or attribute set you want to remove.Enter as many as 24 characters including only A-Z, 0-9,hyphen, and underscore.

amemtype=memberType Type of set member being removed. Enter A for anAttribute or S for a Set. The default is A.

setname=setName Name of the attribute set that includes the member beingremoved. Enter as many as 24 characters including onlyA-Z, 0-9, hyphen, and underscore.

Vault Commandsremmfs


remmfs

The ciremmfs command removes (disassociates) a member from a file set. Themember still exists on its own within the database.

Syntax

ciremmfs fsname=fileSetName memtype=memberType memname=memberNamerevision=revisionCode



All are required.


This command removes the member from the file set, but does not delete themember. The member still exists as a file or part on its own within Vault.

To remove all the members of a file set at one time and remove the file set namefrom Vault, use the REMFS command. Do not remove a member from a file set thatis signed out. If you do, when you replace the file set, the removed member canstill be replaced because it was signed out with the file set.

If a specific revision code was specified when a member was added to a file set,then you must specify this same revision code to remove the member from the set.This is true even when the explicitly assigned revision code is the current revision.


fsname=fileSetName Existing file set name. Enter a filename of up to 80alphanumeric characters.

memtype=memberType Code for the member type. Enter F (file), P (part), S (fileset), or U (user-defined). The default is F.

memname=memberName Name of the file, part, or file set to be removed. Enter a aname of up to 80 alphanumeric characters.

revision=revisionCode Revision code. If member type is F or P, enter up to 20alphanumeric characters or leave blank for the defaultcurrent revision.

Vault Commandsremmul


remmul

The ciremmul command removes one member from a user list.

Syntax

ciremmul userlist=userListName ulmname=memberNameseqnum=sequenceNumber ulmtype=memberType



All are required.


Removing all the members of a user list does not delete the user list name fromVault. The user list name remains in Vault and you can add members to it in thefuture until you execute the DELUL (delete a user list name) command for thatname.

You can only remove one Vault user ID at a given sequence number or one user listname each time you execute the REMMUL command.

For example, if a user is on a user list with four different sequence numbers, youmust execute the REMMUL command four times to completely remove this userfrom the list. To remove all members from a user list and delete the user list name,execute the DELUL command.

If the user list is currently in-use as a review list, removing a person during areview cycle has no effect on that cycle.

userlist=userListName Existing user list name. Enter a user list name of up to 24alphanumeric characters.

ulmname=memberName Existing user list member name. Enter up to 24alphanumeric characters.

seqnum=sequenceNumber Enter the number, 0 through 9999, that corresponds tothis list member’s existing sequence number.

ulmtype=memberType Code that indicates the type of list member. Enter U foruser ID, A for a user list in which all members mustrespond to a review, or O for a user list in which onemember only can respond to a review. The default is U.

Vault Commandsremt


remt

The ciremt command removes a user-defined table from the control of Vault.

Syntax

ciremt qtblname=tableOrViewName sqlid=tableCreator’sSQLIDsqlpw=tableCreator’sSQLPassword



All are required.


You can remove a table that is currently open with either access type. The REMTcommand closes the table and then removes it from Vault control. This commandis not available on a remote VaultClient node.


qtblname=tableOrViewName Name of a table previously added to the controlof Vault with the ADDT command. Enter a nameof up to 30 characters.

sqlid=tableCreator’sSQLID SQL user ID of the creator of the table. Enter auser ID of up to 30 characters. (For SQL/DSenter a user ID of up to 8 characters.)

sqlpw=tableCreator’sSQLPassword SQL password of the creator of the table. Entera password of up to 30 characters. (For SQL/DSenter a password of up to 8 characters.)

Vault Commandsremuattr


remuattr

The ciremuattr command removes an associated attribute from an object.

Syntax

ciremuattr [object-class=classIdentifier] object-type=objectTypeobject-name=objectName [object-revision=objectRevision][input-attrs=attributeFile] [attrfile=attributeFile][attribute=attribute/attributeName]


object-type=objectType Minor group of the object within the class. Enter FILEor PART. The object-class and the object-typeparameters together identify specific kinds ofobjects. For example, a CADDS FILE or a CADDSPART. The default is FILE.

object-name=objectName Name of the object. The length of this field dependson the object type.






Attribute File Name

If attributes are associated with a file, enter the name of a local file that containsthe list of attributes and assigned values. When attributes are assigned to aselection, you can use IQF to obtain information about the attributes.


object-revision=objectRevision Identifies the character revision of the object.The object-class, object-type, object-name, andobject-revision parameters together identify aspecific instance of an object. The length of thisfield depends on the object type. The default isCurrent revision.

input-attrs=attributeFile Name of an attrfile that contains theuser-defined attributes that you want to removewith this command. The length of this fieldvaries based on your platform.


attribute=attribute

OR

attribute=attributeName

Attributes that are to be removed.

If you remove multiple attributes from the object,use the instance specifier to differentiate theattributes, that is,

ATTRIBUTE(1)=color ATTRIBUTE(2)=material

where color and material are the names ofassociated attributes. Only a single instance ofthe attribute can be removed.

To remove multiple instances of an attribute, usethe instance specifier to differentiate theinstances of the attribute, that is,

ATTRIBUTE(1)=color(4)ATTRIBUTE(2)=color(5)

where the numbers 4 and 5 identify specificinstances of the attribute color.





ATTRIBUTE=attribute name

The attribute name is always converted to uppercase. The lines starting with ## aretreated as comments and are ignored while processing.

For example,

ATTRIBUTE(1)=OPERATORATTRIBUTE(2)=HOURSATTRIBUTE(3)=MATERIAL





When the selection scope covers multiple Vault objects, the file identifies eachobject before listing attribute values. The identifiers OBJECT-NAME andOBJECT-TYPE identify the objects. Instance numbers in parentheses for attributesindicate multiple attribute instances to be removed. The content of the attribute filemight look like this:

OBJECT-NAME=jet.partOBJECT-TYPE=partATTRIBUTE(1)=WEIGHT(1)ATTRIBUTE(2=WEIGHT(2)ATTRIBUTE(3)=CLEARANCEOBJECT-NAME=jet.drawingOBJECT-TYPE=fileATTRIBUTE=SIZE

Example

CIREMUATTR OBJECT-NAME=AA-FILENAME1 - OBJECT-TYPE=FILEATTRIBUTE=AA-ATTRIBUTE2

Vault Commandsremup


remup

The ciremup command removes a user from one project or all projects to whichthe user is assigned.

Syntax

ciremup userid=VaultUserID allproj=RemoveUserFromAllProjects?projid=projectID



All are required.


You can use this command to remove an Vault user ID from a specific project orfrom all projects with which the user is associated.

To remove a user from a single project, fill in the Project ID field with the projectID. To remove a user from all projects, leave the Project ID field blank and enter aY in the Remove user from all projects? field.

You cannot remove a user from a specified project if the user has any project filesigned out, or has open a user-defined table associated with the project.

You cannot remove a user from all projects after if the user has any file or anyuser-defined table on any project signed out. See Vault Manager Guide for moreinformation about this command.

userid=VaultUserID Existing Vault user identifier. Enter a useridentifier of up to 12 alphanumericcharacters.

allproj=RemoveUserFromAllProjects? Indicates whether you are removing theuser from all projects. Enter Y (yes) or N(no).

projid=projectID Existing project identifier. Enter a projectidentifier of up to 8 alphanumericcharacters. (This parameter is ignored ifyou enter Y in the Remove user fromall projects ? field.)

Vault Commandsremusa


remusa

The ciremusa command removes the association between a user list and a statuscode.

Syntax

ciremusa userlist=userListName listtype=listType statcd=statusCodeprojid=projectID



All are required.


The next time a request for review occurs for a file at the specified status level, thelist of users is no longer notified or sent review messages.

If a review list association is removed while the review list is being used, thereview is allowed to finish in the usual way. If a notification list association isremoved, notification messages can not be sent.

If a review list association is removed, files are automatically bumped to the nextstatus level when a request for review is performed.


userlist=userListName Existing user list name. Enter a user list name of up to 24alphanumeric characters.

listtype=listType Code that specifies how the user list functions. Enter R(review), N (notification), or P (post-approval).

statcd=statusCode Existing code that represents a phase of work in an Vaultauthority scheme. Enter a code of up to 8 alphanumericcharacters.

projid=projectID Existing project identifier. Enter a project identifier of up to 8alphanumeric characters or leave blank to dissociate theuser list from a public status code.

Vault Commandsremvault (DV)


remvault (DV)

The ciremvault command removes knowledge of an existing vault from thedistributed vault environment.

Syntax

ciremvault vaultid=vaultName type=typeOfVault



All are required.


You must be logged on as the Vault installation account to use this command. Youmust also have the REMADOD command in your public command list. Thecommand is available only from the command line interface, notprogrammatically.

REMADOD automatically updates the network configuration files (nsm.configand pm.config) and the RDBMS. The changes take affect when you shut downand restart the Vault.

Example

CIREMVAULT VAULTID=VAULTB TYPE=DOD


type=typeOfVault Either SELF (on this node) or VAULT (someplace else).

Vault Commandsremvlist (DV)


remvlist (DV)

The ciremvlist command removes a vault list for use in the distribution ofobjects.

Syntax

ciremvlist vaultlst=vaultListName



All are required.


The REMVLIST command must be in your public command list.

Example

CIREMVLIST VAULTLST=MYVLIST

vaultlst=vaultListName Enter a name of an existing vault list.

Vault Commandsremvlmem (DV)


remvlmem (DV)

The ciremvlmem command removes a vault ID (member) from an existing vaultlist.

Syntax

ciremvlmem vaultlst=vaultListName vaultid=vaultName



All are required.


The REMVLMEM command must be in your public command list.

Example

CIREMVLMEM VAULTLST=MYVLIST VAULTID=EIGER

vaultlst=vaultListName Enter the name of an existing vault list.

vaultid=vaultName Enter a unique vault name of a Vault in the Vault list,up to 32 case-sensitive alphanumeric characters.

Vault Commandsreplace


replace

The cireplace command transfers your updated version of a file from your localstorage area to Vault, releases the file, and deletes your local copy. However, thepart’s directory structure (that is; the part’s directory name and /bcd) is notremoved.

These files were previously signed out by you with the GET command. Use theREPLACE command when you have completed your modifications and want othersto be able to sign out the file.

Please note: To transfer your updated version back to Vault without signing itback in, use the UPDATE command. To sign the file back into Vault withoutupdating it with changes made to your local version, use the RESET command.

Syntax

cireplace selscope=selectionScope selname=selectionNameoutput=auditDestination append=replaceOrAppendAuditFile?attrfile=attributeFileName vaultid=vaultName



All are required.

selscope=selectionScope Indicates the entity you are replacing. Enter F(file), P (part), S (file set), B (binder), L (list).The default is F.

selname=selectionName Selection name. Enter a selection name of up to80 alphanumeric characters.



attrfile=attributeFileName Name of a local file that contains user-definedattributes. Enter a filename of up to 80alphanumeric characters.





REPLACE saves your locally modified version of files into the Vault database. Usethe REPLACE command when you are finished with your modifications and wantothers to be able to sign out the file. You can use the REPLACE command only onfiles or parts signed out to you.

The REPLACE command deletes your local versions of files after it completes.Under some circumstances the local versions can not be deleted, but the transferaction still succeeds.

Please note: To transfer your updated version back to Vault without signing itback in, and without deleting the local versions, use the UPDATE command. Tosign the file back into Vault without updating it with changes made to your localversion, use the RESET command.

A user with administrative privileges can REPLACE or UPDATE others’ files afteran Vault SIGNON to the domain from which the files were obtained. Depending onthe system’s protection of the file, the local copies can or can not be deleted afterbeing replaced by a user with administrative privileges. If files are Project, the usermust have administrative privileges for that project.


The Vault administrator can inform you when there are attributes associated with afile. Attributes are important pieces of information associated with a selection.The administrator defines the attribute types, and you assign the values whenexecuting the STORE, UPDATE, or REPLACE command. You can also obtain theattribute values when you execute the GET and READ commands.

Attribute File

If attributes are associated with a file, enter the name of a local file that containsthe list of attributes and assigned values. When attributes are assigned to aselection, you can use IQF to obtain information about files based on theirattributes.

The attributes for the replaced/updated version are created using this attribute file.By default, the prior attribute data of the Vault tables is copied for attributes notspecified in the attribute file. If an attribute were defined to be required, and it isnot present in the attributes file, then the transaction would fail.




The file containing the attributes has one assignment on each line with the formatATTRIBUTE NAME=attribute value

The attribute name is uppercase; the value can be mixed case. The value starts afterthe equal sign. Trailing blanks are ignored.



Only those attributes for which you have at least read permission are presented.Attributes for which you have read but not write permission are preceeded with '##'in the attribute file listing. These attributes are ignored when you replace/updatethe underlying object. If the attribute has unit of measure associated with it, youcan express the attribute values in any presentation format as defined for theuom-set.

Setting the $$COPYATTRS parameter

The $$COPYATTRS parameter can be specified in the attribute file for the STORE,REPLACE, or UPDATE commands.

By default, the prior attribute data of the Vault tables is copied for attributes notspecified in the attribute file. If you do not want to copy this data, set$$COPYATTRS to NO, in attributes file.

The $$COPYATTRS parameter should appear within an object definition in theattribute file. This is shown in the example given below.

OBJECT-NAME=jet.partOBJECT-TYPE=part$$COPYATTR=NOWEIGHT(1)=3.2WEIGHT(2)=4.4CLEARANCE=SecretOBJECT-NAME=jet.drawingOBJECT-TYPE=fileSIZE=“14 x 22”




When the selection scope covers multiple Vault objects and different values are tobe associated, the file must identify each object before assigning attribute values.Use the identifiers OBJECT-NAME and OBJECT-TYPE to identify the objects.The allowable values for OBJECT-TYPE are part, PART, file, and FILE. To inputmultiple values for an attribute, specify each instance starting with (1). You mustorder instances consecutively.


Audit Information

When you designate a file as the audit destination, Vault sends the auditinformation to a file named REPLACE.EDMAUDIT. Use a local editor to view thisfile. See Vault End User Guide for more information about this command.

Replacing a Part

You must sign out the part in order to replace the part. You cannot signout theindividual files belonging to the part and then replace the part as a whole.

When you replace a part, the entire part must transfer successfully or none of itcan. In addition,

• All new local files following the part naming convention can be placed intoVault and connected to the part.

• All files following the part naming convention that have been deleted locallycan be removed from Vault and disconnected from the part.

Replacing a File Set

When you issue the REPLACE command for a file set, Vault only replaces files thatexist in the database and are signed out to you for the file set you specified in theREPLACE command.

If any standalone file in the file set cannot be processed or has been deleted locally,the file set can not be replaced.



To delete a file that belongs to a file set, replace the file set (REPLACE), remove thefile from the file set (REMMFS), and mark the file for deletion (MARKD).

We recommend that you do not issue the REPLACE command for file sets thatinclude parts, unless you are not adding or deleting any files from the parts whilethe file set is signed out.

You must use the STORE command to transfer all new local files into Vault. After anew file is stored in Vault, use the ADDMFS (add a member to a file set) commandto add the file to the file set.

Replacing a List



You can signout a list of parts and stand-alone files and then replace the parts andfiles individually. You can also signout parts and files individually and then replacea list of them.



The file that contains the list of parts and files to be operated on uses akeyword=value format. For the UPDATE and REPLACE commands, you caninclude


for each part or file in the list.



Syntax Rules for List File




• Entries (keyword=value) can be separated by commas or blanks.

• If the entries for a single file or part cannot fit on one line, identify thecontinuation with a comma after the last entry in the line.


Restrictions

You can use REPLACE only on a file or part signed out to you, unless you haveadministrative privileges. If you have administrative privileges, you can REPLACEanother user’s files. You must first sign on to the domain from which the files wereobtained. Depending on the system’s protection of the file, the local copies can orcan not be deleted after being replaced by a user with administrative privileges.

If the files belong to a project, you must have administrative privileges for thatproject.

The REPLACE command can only replace the aggregated members of a binder.Binder members that are associated are not replaced, and locally the files remainas read-only.

Example

CIREPLACEEDM> SELSCOPE=F SELNAME=TEST1

In this example, the file TEST1 is replaced with modifications made to it.

Vault Commandsreqrvw


reqrvw

The cireqrvw command requests a file review and initiates the review cycle toadvance the file to the next status level.

Syntax

cireqrvw selscope=selectionScope selname=selectionNamerevision=revisionCode filepw=file(s)Password [comment=comments]output=auditDestination append=replaceOrAppendAuditFile? vaultid=vaultName



selscope=selectionScope Indicates the entity you are requesting a reviewfor. Enter F (file), P (part), B (binder), or S (fileset). The default is F.


revision=revisionCode Revision code. Enter a revision code of up to 20alphanumeric characters or leave blank for thedefault current revision. Ignored if selectionscope is S.

filepw=file(s)Password If file(s) has password, enter up to 8alphanumeric characters.

output=auditDestination Indicates where audit information is to be sent.At the prompt enter F (file), B (both), or M(message only). For the keyword, enter F or M.The default is F (command-line format)



comment=comments Review request description. Enter adescription of up to 240 alphanumericcharacters (including blanks).

Vault Commandsreqrvw



If a status does not have a review list associated with it, the status of the file isautomatically bumped to the next status. Users on notification lists andpost-approval lists, if any, are notified of an automatic status change.

When a review list does exist, the command locks the appropriate files, parts, orbinders for the duration of the review so users cannot modify them until the reviewis complete.

Vault sends a review message to all users at the lowest sequence number on thereview list associated with the current status code of the file, part, binder, or fileset. During a review cycle, the responses and comments of each reviewer are keptin a table for reference.

Your Vault manager might have set up Vault so that when you execute the REQRVWcommand, system email as well as Vault messages are sent at the appropriate time.

When you review a binder, the binder and all aggregated objects that it contains atthe same status code are locked for review. Only the objects at the same statuscode as the root binder advance when the review succeeds.

The file, part, or file set must exist in Vault. The files to be reviewed cannot belocked. For a part, all the files must be at the same status. A review can occur onmore than one revision of a file at the same time. For a file set, all files that can bemodified must be at the same status level.

When you designate a file as the audit destination, Vault sends the information to afile named REQRVW.EDMAUDIT. Use a local editor to view this file.


Vault Commandsreserve


reserve

The cireserve command reserves a unique file name in the Vault database to usein the future, and can also sign out the entry to your Vault user ID.

Syntax

cireserve pfname=VaultFileName revision=revisionCode class=classificationprojid=projectID statcd=statusCode filepw=file(s)Password [filetype=fileType]signout=signOutFile? [systype=systemType] [usertype=userDefinedType][filedesc=fileDescription] [partnum=partNumber] [gtcode=groupTechnologyCode]


pfname=VaultFileName Unique name the selection is to have in Vault.Enter a name of up to 80 alphanumericcharacters.

revision=revisionCode Revision code. Enter a revision code of up to 20alphanumeric characters or leave blank for thedefault first revision.

class=classification File classification code. Enter PUB (public), PRO(project), or PRI (private). The default is PUB.

projid=projectID Existing project identifier. If classification is PRO,enter up to 8 alphanumeric characters.

statcd=statusCode Status code. Enter a status code of up to 8alphanumeric characters or leave blank for thedefault initial in-work code.

filepw=file(s)Password File password. If file has password, enter up to 8alphanumeric characters.

signout=signOutFile? Indicates whether or not you want to keep the filesigned out to you after you reserve it. Specify Y(yes) or N (no). The default is Y.





The RESERVE command places a file entry in the Vault file directory and can orcan not sign this entry out to you. No file is transferred or stored in Vault with thiscommand. Use RESERVE to reserve a file name for a file you are planning to storein Vault at some time in the future. A file must not already be stored or reservedwith the same Vault file name.

Using STORE on a Reserved File Name

A reserved Vault file name can be used with any file access command. A STOREcommand stores a physical file in Vault with the reserved file name. When thisoccurs, the Vault file name is no longer considered reserved, since it then has aphysical file associated with it. A reserved file cannot be accessed since nophysical file exists.

When you execute the RESERVE command, you can specify attributes (such asclassification, project ID, status code, or file password) to be associated with thefile name. When you execute the STORE command with the reserved file name,you cannot change those attributes. Use the CHGFA (Change File Attributes)command to change attributes you specified with RESERVE command.

After you have reserved the file name you can use the STORE command toassociate a local file with the reserved file name. (The file name is no longerconsidered reserved, because it is has a physical file associated with it.) Or, youcan use the RESET command to delete the reserved name from Vault.

filetype=fileType CGOS file type code. Enter 2 hexadecimalcharacters.

systype=systemType System type code. Enter a type code of up to 8alphanumeric characters.

usertype=userDefinedType User-defined type code. Enter a user-defined typecode of up to 8 alphanumeric characters.

filedesc=fileDescription File contents description. Enter a description of upto 25 alphanumeric characters (including blanks).

partnum=partNumber Part description. Enter a description of up to 32alphanumeric characters (including blanks).

gtcode=groupTechnologyCode Further file contents description or grouptechnology code. Enter a description or code of upto 32 alphanumeric characters (including blanks).



You can add the reserved name to a file set. It does not matter whether or not thereserved name is signed out.

Reserving a File Name with SIGNOUT

When you reserve a file name with SIGNOUT=Y, or when you issue the SIGNOUTcommand for a reserved file name, you must then execute the STORE command toplace the file in Vault.

Signing Out the File Name

Whether or not a local file exists with the same name as the reserved file name, youcan sign out that file as though it had already been stored in Vault. Issue the GETcommand to sign out the reserved file name. No physical data is transferred(because the file does not exist in the Vault), but the file is signed out to you.

Later, issue the REPLACE command to transfer the local file to the database. Sinceyou already signed out the reserved name, you do not have to execute the STOREcommand for the reserved name.

Issuing the RESERVE command with SIGNOUT = Y is the same as issuing theRESERVE command with SIGNOUT = N and then issuing the SIGNOUT command.You must issue the GET command to execute the REPLACE command when youwant to save changes.

Changing Reserved File Name Attributes

When you execute the RESERVE command, you can specify attributes (such asclassification, project ID, status code, or file password) to be associated with thefile name. When you execute the STORE command with the reserved file name,you cannot change those attributes. Use the CHGFA (Change File Attributes)command to change attributes you specified with RESERVE command.

Deleting a Reserved File Name

To delete a reserved file name, issue the RESET command. To delete a reserved filename that is signed out, issue the RESET command twice.



Example

CIRESERVEEDM> PFNAME=TAIL CLASS=PRO PROJID=CARGO,EDM> STATCD=ID FILETYPE=0 SYSTYPE=I USERTYPE=AA

In this example, a file name is reserved in Vault. Its name is TAIL and it isassigned to the CARGO project with a status code ID, file type 0, system type I,and user-defined type AA. When the file is stored in Vault, it can be assigned thefirst revision code.

Vault Commandsreset


reset

The cireset command signs a file back into Vault so it is no longer signed out toyou. cireset does not update the Vault version, and does not delete your localfile version.

Syntax

cireset selscope=selectionScope selname=selectionNameoutput=auditDestination append=replaceOrAppendAuditFile? vaultid=vaultName



All are required.


Use RESET when you no longer want a file signed out to yourself but do not wantto change the Vault version with changes made to your local file version.

selscope=selectionScope Indicates the entity you are resetting. Enter F (file), A(all of a project), P (part), B (binder), or S (file set).The default is F.


output=auditDestination Indicates where audit information is to be sent. Atthe prompt enter F (file), B (both), or M (messageonly). For the keyword, enter F or M. The default is F(command-line format)

append=replaceOrAppend

AuditFile?

Indicates whether to replace or append the audit file.If audit destination is F or B, enter R (replace) or A(append). Ignored if audit destination is S or M. Thedefault is R.


Vault Commandsreset


RESET and SIGNOUT Commands

When you execute the SIGNOUT command for a released file and then execute theRESET command for that file, Vault removes the file directory entry for the newrevision that was created when you executed the SIGNOUT command.

You can also use RESET to remove a reserved file name entry from Vault. Whenyou execute the SIGNOUT command for a reserved file name and then execute theRESET command for that file, Vault cancels the signout, and the reserved file nameremains in the file directory. Execute the RESET command again to remove the filename from Vault.

REPLACE and UPDATE Commands

To sign the file back into Vault, update the file with your changes, and delete yourlocal file version, use the REPLACE command. Other users can then sign out thefile.

To transfer your updated version back to Vault without signing it in, use theUPDATE command. To delete the file version in your local storage area, use thedeletion process for your operating system.

Unlocking a Binder

Reset of a binder unlocks the binder and its aggregated objects such that they canbe modified again. If an aggregated object is itself a binder, then unlockingcascades downward. Associated objects are unaffected.

Audit Information

When you designate a file as the audit destination, Vault sends the information to afile named RESET.EDMAUDIT. Use a local editor to view this file. See Vault EndUser Guide for more information about this command.

Restrictions

You can use the RESET command only on files signed out to you, unless you haveadministrative privileges. To use RESET for project files, you must haveadministrative privileges for that project.

You can reset individual files belonging to a part, but the part remains signed outto you until you reset the part. You cannot reset another user’s private files.

Vault Commandsreset


Example

CIRESETEDM> SELSCOPE=F SELNAME=TEST1

In this example, the file TEST1 is reset.

Vault Commandsrestore


restore

The cirestore command restores previously archived files to Vault from anVault archive tape. You can execute this command only when locally logged in tothe Vault server.

Syntax

cirestore tapeunit=tapeUnit(s) restopt=restoreAllMarkedFiles?pfname=VaultFileName revision=revisionCode filepw=filePasswordoutput=auditDestination append=replaceOrAppendAuditFile?



All are required.

tapeunit=tapeUnit(s) Name to represent the tape device. EnterTAPE1, TAPE2, TAPE3, or TAPE4. The defaultis TAPE1.

restopt=restoreAllMarkedFiles? Indicates whether to restore all marked files.Enter Y (yes) or N (no).

pfname=VaultFileName Vault file name. Enter a filename of up to 80alphanumeric characters if you are restoring asingle file.

revision=revisionCode Revision code. Enter a revision code of up to 20alphanumeric characters if you are restoring asingle file.

filepw=filePassword File password. If single file has password, enterup to 8 alphanumeric characters.

output=auditDestination Indicates where to send audit information. Atthe prompt enter F (file), B (both), or M(message only). When using the command-lineformat, you can only enter F or M. The default isF (command-line format).





You can restore all files previously marked for restore (with the MARKR command)or restore a specific file that has not been previously marked.

To restore a single file, you must enter its revision code. There is no default for theRESTORE command. To restore all marked files, do not enter a revision code.

The restored file can have the same file information as the archived file, except forthe file revision. The file revision assigned to the restored file depends on

• Whether any other versions of the file already exist in Vault

• The status code of the file to be restored and the files already existing in Vault

If the current database does not contain a version of the file, Vault assigns therestored file a revision code one higher than the archived file.

If there are other versions of the archived file already existing in Vault, the revisioncode of the archived file after it is restored depends on:

For archived files whose status code is in-work:

• If Vault already contains an in-work version of the file, the archived file cannotbe restored. (Vault allows only one in-work version of a file to exist in the filedirectory.)

• If Vault does not contain an in-work version of the file to be restored, and ifthere is a released version of the file in Vault, the archived file is restored with arevision code one level higher than that of any file in Vault (including entries inthe archive table, if any).

For archived files whose status code is released:

• If Vault already contains a released version of the file, one of the following canoccur:

• If the revision code of the archived file is the same as the revision code ofthe file in Vault, the archived file cannot be restored.

• If the revision code of the archived file is different from the revision code ofthe existing file in Vault, the archived file is restored with the same revisioncode it had when it was archived.

• If Vault does not contain a released version, the archived file is restored with thesame revision code it had when it was archived.



The existence of an in-work version has no effect when you restore an archivedfile with a released status code.

The project and the status code under which the file was archived must still exist.

Mount the correct tape on the tape unit specified before you execute the RESTOREcommand. If you do not, Vault identifies the tape serial number and location of thenext file and prompts you to mount that tape.

Please note: A Vault archive tape can only be restored on the node where itwas created.

If you do not restore all member files for a part marked for restore, you mightleave this part in a partially restored state. Use the UNMARK command on anypartially restored parts to make them accessible again. (A partially restored parthas an X as its in-use code in the DM_PART_DIRECTORY table. Such parts cannotbe accessed by any Vault command except UNMARK for restore and RESTORE.)

When you designate a file as the audit destination, Vault sends the information to afile named RESTORE.EDMAUDIT. Use a local editor to view this file.

You must be locally logged in to the Vault server to execute the RESTOREcommand. The server need not have a local tape device. See Vault SystemAdministrator Guide for other privileges you can need to execute this command.See Vault Manager Guide for more information about this command.

You cannot change media during execution of the RESTORE command. This canbe a problem when you are restoring all marked files and they are not on the samemedia. The workaround is to mark the files on one kind of tape media, restorethem, then mark the files on another type of tape media, restore them, and so on.

Vault does not prompt for specific tapes during execution of the RESTOREcommand. You must know the exact tape to mount when restoring files.

Vault Commandsrsvp


rsvp

The cirsvp command allows you to respond to a file review request. You canreject or approve the file, and provide comments.

Syntax

cirsvp selscope=selectionScope selname=selectionName revision=revisionCoderesponse=response comment=comments vaultid=vaultName



All are required.

selscope=selectionScope Indicates the entity you are reviewing. Enter F (file), P(part), B (binder), or S (file set). The default is F.

selname=selectionName Selection name. Enter a selection name of up to 80alphanumeric characters.

revision=revisionCode Revision code. Enter a revision code of up to 20alphanumeric characters or leave blank for currentrevision. Ignored if selection scope is S.

response=response Indicates whether you approve or reject the work. Enter A(approve) or R (reject),

comment=comments Review response description. Enter a description of up to240 alphanumeric characters (including blanks). Optionalwhen response is A. Required when it is R.


Vault Commandsrsvp



You must have received a review message in order to respond to a review with theRSVP command. If you reject the work, you must enter a comment. If you approvethe work, a comment is optional.

You receive a message to review a file when all reviewers at the previous sequencenumber have responded to the review request.

The review cycle ends when the termination count is reached or when the lastreviewer responds to the review request.

If all responses to a review are for approval, the status code of the file is changedto the next status code in the appropriate authority scheme. If there is apost-approval list associated with the old status code, Vault sends messages tousers on that list informing them of the status change approval. The file is nolonger locked in review. It can be signed out and modified again.

When a review ends before all reviewers have had a chance to respond, allreviewers that already responded to the review and all others who received reviewmessages to do the review, now receive notification messages about the reviewtermination.

When a review is successfully completed, the initiator, all users who voted on thereview, and all members of the notification list and post approval list receive amessage describing the results of the review.

The sender ID for these messages is RSVP, since neither the initiator of the reviewnor any one reviewer sends these messages.

After all the users at a sequence level respond to the review, the users on the userlist at the next highest sequence level receive a review message.

You can request to review a file at more than one sequence level on the samereview list. You can receive a review request message for each sequence level inthe review list that you are a member of, and in the order of the sequence numbers.

Your Vault manager might have set up Vault so that when you execute the RSVPcommand, system email as well as Vault messages are sent at the appropriate time.


Vault Commandsscantape


scantape

The ciscantape command scans and lists the contents of a tape.

Syntax

ciscantape tapeunit=tapeUnit selscope=selectionScopeselname=selectionName output=auditDestination append=replaceOrAppendAuditFile



All are required.


You must be locally logged in to the Vault server to execute the SCANTAPEcommand. The server need not have a local tape device.

See Vault System Administrator Guide for system privileges you can execute thiscommand.

tapeunit=tapeUnit Name to represent the tape device. EnterTAPE1, TAPE2, TAPE3, or TAPE4. The defaultis TAPE1.

selscope=selectionScope Indicates the entity you are listing. Enter E(entire tape), F (file), L (tape label), or P (part).The default is E.

selname=selectionName Selection name. If selection scope is F or P,enter up to 80 alphanumeric characters.

output=auditDestination Indicates where to send audit information. Atthe prompt enter F (file), B (both), or M(message only). When using the command-lineformat, you can only enter F or M. The default isF (Command-line format).

append=replaceOrAppendAuditFile Indicates whether to replace or append theaudit file. If audit destination is F or B, enter R(replace) or A (append). Ignored if auditdestination is S or M. The default is (R)eplace.

Vault Commandsscantape


You can obtain the following types of information with the SCANTAPE command:

• The tape label (to verify the correct label if the label sticker is missing)

• A list of all the files, or parts on the tape

• Whether a specific file name exists on the tape

• The total of files in the generated list

Please note: You can only obtain information about the file names; not abouttheir actual contents.

Tape Types

The SCANTAPE command helps you identify the contents of a tape with anincorrect or missing label. You can scan all three tape types accepted by Vault:

• Vault-created tape

• CGOS SAVFIL

• CGOS FUTIL

Output File (SCANTAPE.EDMAUDIT)

When processing is complete:

• The listing created is written in the audit file destination you specified.

Please note: The audit file contains the numeric equivalent of the revisioncode rather than the character revision.

• Total files listed is displayed.

• If requested, the tape label name is displayed in the message area.

• If the information requested cannot be located, you are notified.

When you designate a file as the audit destination, Vault sends the information to afile named SCANTAPE.EDMAUDIT. Use a local editor to view this file.

Vault Commandssendmsg


sendmsg

The cisendmsg command sends notification messages to an Vault user and/ormembers of a user list.

Syntax

cisendmsg userid=VaultUserID userlist=userListName msgtext=messagevaultid=vaultName



All are required.


To send a message to another Vault user, you must know that person’s Vault userID. To send a message to a user list, you must know the user list name. Informationabout setting up user lists is in Vault Manager Guide.

You can obtain Vault user ID and user list name information using the InteractiveQuery Facility (IQF) described in Vault Interactive Query Facility Guide.

For UNIX and IBM platforms, your system administrator might have set up Vaultso that messages are also sent to your UNIX mailbox.


Please note: You cannot send the Review Messages. Only Vault can do it.

userid=VaultUserID Existing user identifier. Enter a user identifier of up to12 alphanumeric characters.

userlist=userListName Existing user list name. Enter a user list name up to24 alphanumeric characters.

msgtext=message Message text. Enter text of up to 240 alphanumericcharacters (including blanks).

vaultid=vaultName Enter a unique vault name upto 32 alphanumericcase-sensitive characters.

Vault Commandssignoff


signoff

The cisignoff command ends an Vault session.

Syntax

cisignoff


This command does not have any input parameters.

Reference


Vault Commandssignon


signon

The cisignon command identifies a valid Vault user. It also identifies the nodethat Vault can use to access files.

Syntax

cisignon userid=optegraUserId userpw=optegraUserPassworddmserver=domainName



All are required.


After you execute the SIGNON command, Vault uses the authorities associated withyour Vault user ID to determine your ability to execute Vault commands and toaccess and modify files. These authorities remain in effect until you sign off fromVault or execute the SIGNON command with another Vault user ID and password.

Vault informs you if you have any messages when you sign on. See Vault End UserGuide for more information about this command.

If you issue the SIGNON command for a new user ID when you are already signedon, Vault signs you off from the first account you were signed on to.

userid=optegraUserId Unique user identifier. Enter a user identifier ofup to 12 alphanumeric characters.

userpw=optegraUserPassword User password. Enter a password of up to 8alphanumeric characters.

dmserver=domainName Name of the domain to which you are signingon. Enter a name of up to 32 alphanumericcharacters or leave blank for the default Vaultserver.

Vault Commandssignout


signout

The cisignout command signs out files, parts, or binders without transferring acopy of the files. This command signs out the file to your Vault user ID andprevents others from signing out or locking the file until you have released it.

The file is signed out to you. No one else can modify it. Others are prevented fromsigning out or locking the file until you have released it.

Please note: Others can still read the file after it is signed out to you. Theyreceive a warning message, however, that it is signed out (the message includesyour Vault user name).

Syntax

cisignout selscope=selectionScope selname=selectionNamefilepw=file(s)Password filetype=fileType catlevel=CADDScatelogLeveloutput=auditDestination append=replaceOrAppendAuditFile vaultid=vaultName



All are required.

selscope=selectionScope Indicates the entity you are signing out. Enter F(file), P (part), B (binder), or S (file set). Thedefault is F.


filepw=file(s)Password File password. If file(s) has password, enter up to8 alphanumeric characters.


output=auditDestination Indicates where to send audit information. At theprompt enter F (file), B (both), or M (messageonly). When using the command-line format, youcan only enter F or M. The default is F(Command-line format).

append=replaceOrAppendAuditFile Indicates whether to replace or append the auditfile. If audit destination is F or B, enter R (replace)or A (append). Ignored if audit destination is S orM. The default is (R)eplace.





This command signs the file, part, or binder out to you and prevents others fromsigning it out. However, they can obtain a copy of the file for revision purposeswith the GET command.

Revision Code

You do not need to specify a revision level with the SIGNOUT command becausethe current revision of the file is automatically signed out to you. This means that:

• The current work-in revision is signed-out.

• If the current revision is released, Vault creates an entry in the file directory fora new revision at the initial in-work status level and signs out this revision.

A file name entry for the next revision level of the file is created in the filedirectory. Executing the RESET command removes the file name entry for thenext revision level. There is no new file in the database until you obtain thesigned-out file with the GET command, then transfer a modified version back toVault with the UPDATE or REPLACE command.

When you add a member to a file set and specify a revision code for the member,you can never sign out the member for modification. This is true even when yousign out the file set with the GET or SIGNOUT commands. A member of a file setwith an explicit revision code is available for only read access.

Executing SIGNOUT

For a Released File:

When you execute the SIGNOUT command for a released file, and then execute theRESET command for that file, Vault removes the file directory entry for the newrevision that was created when you executed the SIGNOUT command.

For a Reserved File Name:

When you execute the SIGNOUT command for a reserved file name, and thenexecute the RESET command for that file, Vault cancels the signout and thereserved file name remains in the file directory. Execute the RESET commandagain to remove the file name from Vault.



Audit Information

When you designate a file as the audit destination, Vault sends the auditinformation to a file named SIGNOUT.EDMAUDIT. Use a local editor to view thisfile. See Vault End User Guide for more information about this command.

Modifying Files

To modify a file that you have signed out with the SIGNOUT command

1. Execute the GET command for the file.

2. Make your changes.

3. Use the UPDATE or REPLACE commands to transfer those changes to thedatabase.

Modification Access By Other Users

The SIGNOUT command prevents modification access to a file by other users orother Vault commands until you release the file with the RESET command.

Signout of a Binder

Signout of a binder locks the binder and its aggregated objects (files, parts, orbinders) so that no one can modify the binder or its aggregated objects. Modifyingan object means any operation that requires write access to the object. Forexample, modification/deletion of the object or its attributes andcreation/modification/deletion of relationships, requires write authority on theobject.

If an aggregated object is itself a binder, locking cascades downward. Cascading islimited to an unbroken chain of aggregation relationships. Associated objects arenot signed out.

If a binder is at a released status, then SIGNOUT puts it in-work at a new revision.Also, all aggregated objects, which by definition must also be released, are putin-work at a new revision. All relationships present in the released binder arepropagated to the new in-work binder: Aggregated relationships are created fromthe new binder to the new aggregated objects. Associated relationships are createdfrom the new binder to the old associated objects.

Signing out a released binder is the method for initiating work on a new revisionof the binder. After the new revision is created using SIGNOUT, it cannot beremoved using RESET. Instead, remove the binder using DELOBJ.



Restrictions

You cannot use the SIGNOUT command for a file that is:

• Signed out to another user

• Marked for archive (with the MARKA command)

• Marked for delete (with the MARKD command)

• Locked by the Release/Revision Control facility

If any part member or file set member cannot be signed out (because they arealready signed out or locked, for example), none of the part or file set members aresigned out.

If any part member or file set member cannot be signed out (because they arealready signed out or locked, for example), none of the part or file set members aresigned out.

You cannot sign out a file if it is already signed out by another user, or if it has beenmarked for archive or deletion or if it has been locked by the Release/RevisionControl facility.

Example

CISIGNOUTEDM> SELSCOPE=f SELNAME=TEST1,EDM> FILEPW=TEST1,EDM> OUTPUT=F APPEND=A

In this example, the file TEST1 is signed out.

The current audit file contents are appended with the new information.


Vault Commandsstore


store

The cistore command adds a file, directory, part, or list of parts and files fromyour local storage area to the Vault database.

Syntax

cistore selscope=selectionScope selname=selectionName env=environmentlfname=LocalFileName revision=revisionCode class=classificationpfname=partFileName signout=signOutFile projid=projectId statcd=statusCodefilepw=file(s)Password filetype=fileType attrfile=attributeFileNameoutput=auditDestination append=replaceOrAppendAuditFile [systype=systemType][usertype=userDefinedType] [filedesc=fileDescription] [partnum=partNumber][gtcode=groupTechnologyCode]

Vault Commandsstore



selscope=selectionScope Indicates the entity you are updating. Enter F (file),P (part), D (Directory), or L (list). The default is F.


env=environment Code for application environment. Enter CADDS,LOCAL, or other custom environment name. Thedefault is Local.

lfname=LocalFileName Name of the file or directory in your local area.Enter a filename of up to 80 characters.

revision=revisionCode Revision code. Enter a revision code of up to 20alphanumeric characters or leave blank for thedefault first revision.

class=classification File classification code. Enter PUB (public), PRO(project), or PRI (private). The default is PUB.

pfname=partFileName Name of an existing part that you want to add asingle file to. Selection scope must be F; Signoutfile? must be N.

signout=signOutFile Indicates whether or not you want to keep the filesigned out to you after you store it. Specify Y (yes)or N (no). The default is

projid=projectId Existing project identifier. If classification is PRO,enter up to 8 alphanumeric characters.

statcd=statusCode Status code. Enter a status code of up to 8alphanumeric characters or leave blank for defaultinitial in-work code.

filepw=file(s)Password File password. If file has password, enter up to 8alphanumeric characters.

filetype=fileType CADDS file type code. Enter 2 hexadecimalcharacters. If you are storing a CADDS file, theexisting file type is used. If you enter a file type,the object becomes a CADDS file.

attrfile=attributeFileName Name of a local file that contains user -definedattribute assignments. Enter a filename of up to 80alphanumeric characters.

output=auditDestination Indicates where audit information is to be sent. Atthe prompt enter F (file), B (both), or M (messageonly). For the keyword, enter F or M. The default isF (Command-line format).

append=replaceOrAppendAuditFile Indicates whether to replace or append to existingaudit file (STORE. EDMAUDIT). If auditdestination is F or B, enter R (replace) or A(append). Ignored if audit destination is S or M.The default is R.

Vault Commandsstore




When the file is successfully stored in Vault, it is deleted from your local storagearea (unless you specify SIGNOUT=Y). It is not signed out to you (or any otheruser), nor is it locked for any process. Files are stored on the Vault node specifiedwhen you signed on to Vault.

If you do not specify a status code, the status defaults to the initial in-work statusin the authority scheme under which the file is being stored.

Signing Out a File When You Store It

When you issue the STORE command, you can choose whether or not to sign outthe entity at the same time. Use the SIGNOUT parameter to indicate your choice.

When you specify SIGNOUT=N, Vault stores the entity and automatically deletes itfrom your local storage area. It is not signed out to you (or to any other user), noris it locked for any process.

When you specify SIGNOUT=Y, Vault stores the entity and signs it out to you. Thecopy of the entity in your local storage area is now under Vault control.

systype=systemType System type code. Enter a code type of up to 8alphanumeric characters.

partnum=partNumber Part description. Enter a description of up to 32alphanumeric characters (including blanks).

usertype=userDefinedType User-defined type code. Enter a user-definedtype code of up to 8 alphanumeric characters.

filedesc=fileDescription File contents description. Enter a description ofup to 25 alphanumeric characters (includingblanks).

gtcode=groupTechnologyCode Further file contents description or grouptechnology code. Enter a description of up to 32alphanumeric characters (including blanks).

Vault Commandsstore


Rules for Using the STORE Command

When you use the STORE command to add a file to the Vault database, thefollowing rules apply:

• To add a file with STORE, the file name must not exist in the archive table at thesame or higher revision.

• If a file with a released status exists in Vault (but not in the archive table) withthe same name as the file you want to STORE.

• You can add the new file with an in-work status if the new file’s revision isgreater than that of the existing file.

• You can add the new file with a released status if the new file’s revision levelis greater than or less than the existing file.

• If a file with an in-work status exists with the same name as the file you want tostore, you can add a new file with a released status if the revision level is lessthan that of the existing file.

• If the file name is reserved in Vault at the same revision, you cannot changes itsattributes when you store it. Attributes include classification, status, project,password, file type, system type, user type, description, part number, and grouptechnology code.

Local File Name

When you execute the STORE command and the environment is LOCAL, the valueyou enter for the Local file name parameter (LFNAME keyword) must exactly matchthe local file. This includes case.

The Vault file name (SELNAME keyword) defaults to the local file name as youentered it except for case. The setting of EDMCASE determines whether Vault usesthe local file name literally as the Vault file name or converts the local file name touppercase and uses that form for the Vault file name. The value of EDMCASEalways takes precedence over any case rules in the associated rulebase.

If you store files or parts when EDMCASE is set to mixed, then for a successful GET,READ, UPDATE, or REPLACE operation, EDMCASE must be continue to be set toMIXED respectively.

Please note: In the CADDS application environment, the Local File Name(LFNAME) and Vault File Name (SELNAME) should be in CADDS format (CGOSformat).

For more details, refer to “Storing CADDS Files and Parts” on page A-7 ofAppendix A “Moving Vault Files to and from UNIX.”

Vault Commandsstore


Application Environment

This parameter identifies to Vault the environment in which the object ismaintained. Vault uses this keyword to identify an executable that enforces therules for the environment.

The value for environment could be LOCAL. Enter LOCAL for standalone filesand directories.

Check with your Vault system administrator to determine if other values for theenvironment parameter have been defined for your site.

Specifying Selection Scope

When the selection scope is P (part), all member files in the local part directory aretransferred and an Vault part is created. If for some reason a file cannot betransferred, none are transferred.

When the selection scope is D (directory), all files in one local directory that canbe transferred, are transferred. Those that cannot be transferred, are not. No recordof the grouping remains after the STORE command is completed.

When selection scope is L for a list of parts and files, the selection name is thename of a local file that contains a list of parts and files. Specify the entire localfile name or ensure that the file is in your current working directory. See Chapter 1in Vault End User Guide for more information about storing lists.

Vault Commandsstore


For each possible selection scope, the table below shows what you can specify forlocal file name, Vault file name, and environment. If another environment has beendefined at your site, and you specify that environment, then the selection scopemust be P. If the selection scope is F, then the environment must be LOCAL.

Storing CADDS Parts

The CISTORE command has a maximum limit of 80 characters for the SELNAMEparameter. However, when a CADDS part is stored, it is expanded by the CADDSrulebase to include the files that comprise the CADDS part. For example, MYPARTcan be expanded to MYPART.&PD or MYPART.&BCD.THENAME. In some cases, thisexpansion can create file names that exceed 80 characters, which causes thefollowing message to display:

CDMSTR612E Processing not done -- the file(s) referenced by theselection scope entered are currently being processed by anotheruser. Please try again later.

To avoid this, part names should be kept to a more reasonable length.

If you are storing a CADDS file or part, the existing file type is used; if you enter afile type, it is ignored. If you are storing a standalone file or a directory, you canassign a file type to the file(s) you are storing.

Storing Directories

Storing a directory is useful for loading large numbers of existing standalone filesinto Vault. The directory selection scope is not intended to retain any relationships

Selection Scope(SELSCOPE)

Local File Name

(LFNAME)

Vault File Name

(SELNAME)Environment(ENV)

F (File) Local file name in localoperating system format

Actual Vault file name LOCAL

Local file name in CADDSformat

Actual Vault file name CADDS

P (Part) Local part directory Part name CADDS oruser-definedrulebase name

D (Directory) Local directory namewhere files are found

Can be blank or anVault prefix for all filesstored

LOCAL

L (List) Leave blank Name of local filelisting parts and files tobe stored

LOCAL orCADDS oruser-definedrulebase name

Vault Commandsstore


among the files stored after they are in Vault directory structures, which aredifferent on the various operating systems that are Vault platforms.

Vault transfers those files that it can and does not transfer those that it cannot.

When storing a directory, Vault stores files in the directory specified by the localfile name. When selection scope is D,

• Environment must be LOCAL.

• Local file name must be the directory name. If the directory containssubdirectories or parts, Vault ignores them.

• Signout can be yes or no.

• Vault name (SELNAME) can be specified or blank. If it is specified, it becomesthe prefix of the file name for all files stored. If it is blank, the Vault file name isthe name of the file in the directory.

Authority Information

You must have write authority for the status at which the file is to be stored. Theauthority scheme under which the file is to be stored must already exist.

For example, you are storing a directory containing the files wing, tail, andfan. If you specify jet as the Vault name (SELNAME), the names of the filesin Vault are jetwing, jettail, and jetfan. There is no punctuationbetween what you specify as the Vault file name and the local file name. IfVault name (SELNAME) is blank, the names of the files in Vault are wing,tail, and fan.

• The Part file name parameter should be blank. If specified, Vault ignores it.

• Vault assigns the same revision code, classification, project ID, status code, andpassword to each file in the directory.

• You should not specify a file type because it makes the file appear to be aCADDS file without following CADDS file-naming conventions.

• When you specify an attribute file, be sure each object in the directory isidentified before its attributes are defined.

• There are no restrictions for audit destination, replace or append, system type,user-defined type, file description, part number, or group technology code.

The setting of the keyword EDMCASE in the EDM.DEFAULTS file does not affectcase translation for files stored in Vault with SELSCOPE=D. The names of suchfiles are stored exactly as they appear (mixed-case or uppercase) on the localsystem. The setting of EDMCASE does affect the directory name, that is, theselection name.

Vault Commandsstore


Storing a List



You can store a list of parts and stand-alone files and then perform othercommands on the parts and files individually.



The file that contains the list of parts and files to be operated on uses akeyword=value format. For the STORE command, you can include the followingfor each part or file in the list:

PART=Vaultpartname or FILE=VaultfilenameREVISION=Vaultrevision (optional)ENV=CADDS or LOCAL or site-defined type (optional)LFNAME=local_file_name



• There must not be any blanks between the keyword, the equal sign, and thevalue.





Vault Commandsstore


File Password

To store your file selection with password protection, enter a password. Thepassword is shown when you use the command-line format.

Optional Information

All other information for the STORE command is optional. This includes systemtype or user-defined type, file description, group technology code, part number,and file type.

Please note: Use the STORE command only for parts and files not previouslystored in Vault. To store a new version of a file that has already been stored inVault and has been signed out for modification, use the UPDATE or REPLACEcommand.

When you designate a file as the audit destination, Vault sends the information to afile named STORE.EDMAUDIT. Use a local editor to view this file. See Vault EndUser Guide for more information about this command.

Attribute File Name

The Vault administrator can inform you when you need to specify attributes whenstoring a file. Attributes are important pieces of information associated with aselection. The administrator defines the attributes and the attribute types, and youassign the values when executing the STORE command. (You can also specifyattributes when executing the UPDATE and REPLACE commands.)

If attributes are required, enter the name of a local file that includes a list ofattributes and assigned values. Vault does not process the command if you do notspecify attributes when they are required.




The attribute name is always converted to uppercase; value can be mixed case. Thevalue is immediately after the equal sign. Trailing blanks are ignored. The linesstarting with “##” are treated as comments and are ignored while processing.

Vault Commandsstore


For example,






When the selection scope covers multiple Vault objects, you must identify eachobject if you want to assign different values. Use the identifiers object-name andobject-type. The allowable values for object-type are part, PART, file, and FILE. Toinput multiple values for an attribute, specify each instance starting with (1). Youmust order instances consecutively. For example,


After attributes are assigned to a selection, you can use IQF to obtain informationabout files and parts and use attributes to select the particular files and parts youwant information about. For example, you can examine all parts whereCLEARANCE=Secret.

What is a Part?

A part is a set of files sharing the same name prefix and connected explicitly in theVault tables. A part has a unique name. Each part also has a classification, revision,status, and owner (public, project ID, or user ID). These part attributes are sharedby each file belonging to the part.

Vault stores part information in the part directory. It is separate from fileinformation.

A part can include zero or more files. You can transfer a part only when it includesat least one file.

Vault Commandsstore


When you want to add a new file to an existing part, (and you do not want to signout the part in order to replace it with the new file) you specify the name of thepart when you store the file. Using the STORE command, you can add a new file toan existing part. You cannot add a file that is already stored in the Vault databaseto an existing part.

Please note: Earlier versions of Vault defined parts as groups of files basedupon naming conventions and dependent upon a main part file with an &PD suffix.A part directory and a part/file directory explicitly define the files belonging to apart.

Storing New Parts

When you store a new part, you specify a value for the Environment parameter.This value determines the rulebase that Vault uses to determine which files belongto your part.

When you specify CADDS, Vault recognizes all files as belonging to the part ifthey share the part name as a prefix.

The CADDS parts must include an &PD file and can include other files dependingon the list of file types specified as belonging to a CADDS part at your site.

When you specify LOCAL, you cannot store a part.

If another rulebase has been defined at your site, your Vault manager can informyou how that rulebase determines part membership.

Rules for Adding a New File to an Existing Part

When you store a new file in the Vault database and want to add that file to anexisting part, you must specify the name of the part as well as the name of the filewhen you execute the STORE command. When using the command-line format,you use the PFNAME keyword to specify the name of the part.

Selection Scope and Signout Parameters

You can specify a part file name with the STORE command only when you alsospecify F for selection scope and N for signout. This means that you must bestoring a file and you do not want to signout the file as part of STORE commandexecution.

Vault Commandsstore


Vault File Name

The prefix of the Vault file name (Vault file name/SELNAME parameter) must matchthe entire part name (Vault part name/PFNAME parameter), and the file name mustbe longer than the part name.

For example, an existing part named CDPART includes the CDPART.&PD file.Using the command-line format, the command to store a file in Vault and add it tothe CDPART part would look like this:

cistore env=cadds lfname=myparts.dir.1 selscope=fselname=cdpart.1,pfname=cdpart

If env=cadds, the lfname and selname should be in CGOS format (CADDSFormat). lfname=myparts.dir.1 means you have a file 1 in the myparts/dirdirectory in your local area.

If you have abc.txt file in myparts/dir in your local area, the lfname ismyparts.dir.abc@txt.

The command used for adding this file into the part cdpart is:

cistore env=cadds lfname=myparts.dir.abc@txt selscope=fselname=cdpart.abc@txtpfname=cdpart

Please note: Mixed case file names are not supported in the CADDSapplication environment.

Revision Codes

When you do not specify a revision, Vault adds the file to the highest revision ofthe part. The revision of the part that you add the file to (highest or explicit) mustexist, and must not be signed out, archived, marked for archive or for delete, inreview, or locked in any other way.

Vault Commandsstore


Part Attributes

When adding a new file to an existing part, you cannot change the existing partattributes of class (PUB, PRO, PRI), project ID, status code, or file password.Leave these parameters blank; Vault uses the existing values. You can specifyvalues for only these attributes—filetype and user-defined attributes (systype,usertype, filedesc, partnum, and gtcode) as long as the file was not previouslyreserved.

File Types

When adding a new file to an existing CADDS part, the file must have a non-blankfile type. Each of the actions described below creates a non-blank file type.

• Specify CADDS as the Environment when issuing the STORE command.

• Specify a value for file type when issuing the STORE command, and specifyENV=LOCAL.

• Store a file for a previously reserved file name that has a file type.

If you specify CADDS as the environment and you specify a file type, Vaultignores the explicitly specified file type. If you specify CADDS as theenvironment, Vault uses client-level naming conventions for finding the file andretrieves client-level CGOS attributes for the file.

Example

CISTOREEDM> LFNAME=CHARLESWINGDESC SELNAME=WINGDESC,EDM> REVISION=RE CLASS=PRO PROJID=CARGO,EDM> STATCD=AA FILEPW=WINGPW FILETYPE=01,EDM> SYSTYPE=IBM USERTYPE=AA PARTNUM=PRT00012,EDM> GTCODE=DEVELOPMENT007

In this example, the CHARLESWINGDESC file is stored from your localenvironment. Its name in Vault is WINGDESC. It is stored under the CARGO projectat the AA status code with RE for a revision code. Its file type code is 0, systemtype code is IBM, user-defined type code is AA, part number is PRT00012, and itsgroup technology code is DEVELOPMENT007.

Vault Commandsubkup


ubkup

The ciubkup command creates a backup tape containing copies of all the files inthe entire database.

Syntax

ciibkup tapeunit=tapeUnit(s) restart=Backupfromsavepoint?clear=clearBackupTables? cycles=Numberofcyclestokeepinput=ListedorfromFile? pools=PoolsList append=ReplaceOrAppendAuditFile?compact=CompressPoolData? partial=PartialBackup?pause=PauseDuringBackup?

Vault Commandsubkup



tapeunit=tapeUnit(s) Name assigned to the local physical tapedevice of the local system. Enter TAPE1,TAPE2, TAPE3, or TAPE4. The default isTAPE1.

restart=Backupfromsavepoint? Indicates whether or not the backup shouldstart at the point at which it was stopped thelast time it was executed. Enter Y for Yes or Nfor No. The default is N.

clear=clearBackupTables? Indicates whether or not the Backup Tableshould be cleared. Enter Y for Yes or N for No.The default is N.

cycles=Numberofcyclestokeep Number that specifies how many universalbackup cycles to keep. Enter a number from01 to 99. Required if CLEAR=Y. The default is01.

input=ListedorfromFile? A 1-character value that indicates if storagepools to be backed up are listed in thecommand or in a file. Enter L for Listed in thecommand or F for listed in a File. The defaultis L.

pools=PoolsList Used in conjunction with the INPUT keyword.Indicates the name of the storage pools toprocess. Enter * (asterisk) when INPUT=L toindicate all storage pools. Or, enter a list ofpool names enclosed in parentheses, notincluding blanks, and separated by commasto specify those storage pools whenINPUT=L. Enter a local file name whenINPUT=F to indicate that the file contains thenames of the storage pools to be backed up.The file must be a text file and each storagepool name must be on a separate line in thefile. The file must be in your current workingdirectory or you must specify the full pathname. The default is *.

append=ReplaceOrAppendAuditFile? Append new audit information to audit file?Enter Y for Yes or N for No. N means thatVault erases the content of the existing auditfile. The default is Yes.

compact=CompressPoolData? Compress the data as the pools are backedup? Enter Y for Yes or N for No. The default isNo.

partial=PartialBackup? Continue the backup even if some of thepools are currently unavailable? Enter Y forYes or N for No. The default is No.

pause=PauseDuringBackup? Query the operator during backup? Enter Yfor Yes or N for No. For example, if a pool isbusy and PAUSE=Yes, you can instruct Vaultto try again. When PAUSE=No, the backupaborts. The default is Yes.

Vault Commandsubkup



All are required.

Prerequisites

You must have the UBKUP command in your public command list to execute thiscommand. If your site uses user-defined attributes, the attribute server must berunning when you execute the UBKUP command.

You cannot use a UNIX system to retrieve data backed up to tape from the VaultNT Version 2.0.1. Use an NT system to retrieve this information.

When you issue the UBKUP command, you must have a universal backupconfiguration file in the current directory.

• The file is ubkup.config on UNIX and Windows NT.

• This configuration file does not exist on VMS.

The ubkup.config file can include any or all of the keyword=valuespecifications that you can include in the command line. There should be onekeyword=value per line. Blank lines are allowed. Specifications on the commandline take precedent over specifications in the ubkup.config file. Anything after ablank in the line is a comment.

The ubkup.config file can be empty. In this case the UBKUP command uses thedefault values for parameters not specified on the command line.

To access help for this command, you must type: cihelp ubkup. Entering anyother help command for ciubkup can hang your system.


The backup created is a snapshot of the database at the time the command isexecuted. This universal backup command provides database protection in case thestorage medium fails.

The contents of a storage pool are backed up to a tape using an operating systemutility. Where possible, multiple storage pools are placed on a physical tape.However, this depends on your operating system. See the Vault SystemAdministrator Guide. Different storage pools that are copied to tape are, wherepossible, grouped by physical disk volume. This minimizes tape mountingoperations during the recovery process.

Vault Commandsubkup


One storage pool is backed up at a time. While a storage pool is being backed upno new files are written to that storage pool.

If a previous universal backup was aborted during processing, you can restart theprocess at the point it was aborted.

Cleaning the BackUp Table

After all the storage pools have been copied to tape, the universal backup utilitygives you the opportunity to clean up the Backup Table by deleting entries thatyou no longer need. If you want to clean up the Backup Table you must indicatethe number of cycles you want to save. A cycle is the time between two universalbackups.

Designating the number of cycles as one(1) means the entire Backup Table can becleaned out. Only the current universal backup can remain. Designating thenumber of cycles at two (2) means the Backup Table is cleaned out up to theprevious universal backup. This leaves only the current and previous universalbackups. Designating the number of cycles as three (3) means the Backup Table iscleaned out up to the backup before the previous universal backup, and so on.

The Audit Trial File (ubkup.edmaudit)

Vault generates an audit trail to indicate the storage pool name, date and time ofbackup, and other platform specific information. Vault places a copy of the audittrail in your local storage area under the name UBKUP.EDMAUDIT. You use theaudit trail to perform the storage pool recovery command (RESCP). Vault appendsthe new audit trail to the current file. When RESTART is set to Y, the backup is notconsidered to be a new backup because it is being restarted.

See Vault System Administrator Guide for system privileges you can execute thiscommand and performing universal backups.

Recommendations

Depending on the local operating system, the backup should be performed whilethe Vault system is active.

Vault Commandsubkup


Restrictions

You cannot use the Vault remote tape facility for universal backups.

If you attempt to execute the ciubkup command while logged in under a username other than the name of the account where Vault software is loaded (accountthat owns the software storage pools), the system responds with the error message

CDMRSP899F Processing not done - fatal return code frompool_access. RC = 30,204 EC = 0. Please notify your EDMadministrator.

Log on under the correct name and reenter the command.

Vault Commandsunload


unload

The ciunload command copies files from the Vault database to a tape.

After you press the processing key for the above screen, the Audit File Destinationscreen appears.

Syntax

ciunload tapeunit=tapeUnit tapenum=tapeSerialNumber unldtype=unloadTypeselscope=selectionScope selname=selectionName unldname=tapeFileNamerevision=revisionCode filepw=file(s)Password filetype=fileTypecatlevel=CADDScatelogLevel output=auditDestinationappend=replaceOrAppendAuditFile restart=n/a




1Used only with the command-line format


All are required.

tapeunit=tapeUnit Name to represent the tape device. Enter TAPE1,TAPE2, TAPE3, or TAPE4. The default is TAPE1.

tapenum=tapeSerialNumber Tape identifier name. Enter a tape identifier nameof up to 6 alphanumeric characters. The default isVOL1.

unldtype=unloadType Indicates how the selections are to be unloaded.Enter R (for read purposes) or G (for getpurposes). The default is R.

selscope=selectionScope Indicates the entity you want unloaded. Enter F(file), A (all of a project), P (part), or S (file set).The default is F.

selname=selectionName Selection name. Enter a selection name up to 80alphanumeric characters.

unldname=tapeFileName Name of the selection on the tape. Enter a nameof up to 80 alphanumeric characters. Leave blankfor default selection name.

revision=revisionCode Revision code. Enter a revision code of up to 20alphanumeric characters or leave blank for thedefault current revision.

filepw=file(s)Password File password. If file(s) has password, enter up to8 alphanumeric characters.

filetype=fileType File Type code.



restart1=n/a Indicates whether to restart a process where it leftoff or begin again. Enter Y to restart or N to beginagain.




You can load CGOS SAVFIL or CGOS FUTIL format tapes. However, you canonly create (unload from the database to tape) a CVFUTIL format tape.

The UNLOAD command can only be used for files stored on your local node. Forfiles on remote nodes, you must log on to the remote node and execute thecommand there.

Transferring Files

There are two ways you can transfer a file:

• For read purposes

When you specify R (read) as the unload type, a duplicate version of theselection specified is copied on the tape.

With this option, you can specify a particular revision of the selection (with therevision code parameter) to be copied. Alternately, you can leave thisparameter blank to select the current revision.

Please note: To use this option, the READ command must be in yourcommand list and you must have read access to the file.

• For get purposes

When you specify G (get) as the unload type, the selection specified is copiedon the tape. The version on the tape is signed out to you.

With this option, the current in-work copy of the selection (if one exists) isobtained. If the only version is released, a new revision is created anddesignated as the in-work version.

To use this option, the GET command must be in your command list and youmust have write access to the selection.

For both options, a copy of the file remains in Vault.

Labeling Tapes

You can transfer your files to a new tape or a tape with files already on it.

If your tape is new (and unlabeled), the UNLOAD command can label the tapeeither with the tape serial name you specify or the default label, which is VOL1.(To locate the tape in the future, you should also attach a tape label with this nameto the outside of the tape.)



If your tape has already been labeled, the tape serial name you specify must matchthe one previously written on the tape.

File Naming Conventions

The files you are transferring can have the same or a different name on the tape asthey have in Vault. If you do not specify a new name, the current Vault name isautomatically supplied.

If you transfer your files to a tape that already contains files, the tape isreinitialized and any files that were previously on the tape are lost.

When you designate a file as the audit destination, Vault sends the information to afile named UNLOAD.EDMAUDIT. Use a local editor to view this file.

Restrictions

You must be locally logged on to the Vault server to execute the UNLOADcommand. The server need not have a local tape device.

Recommendations

Do not use Exabyte tape drives when unloading data with the UNLOAD command tocreate FUTIL-format tapes.

Reference

See Vault System Administrator Guide for system privileges you can execute thiscommand. See Vault Manager Guide for more information about this command.

Vault Commandsunmark


unmark

The ciunmark command unmarks files that were previously marked with theMARKA, MARKD, or MARKR commands. The UNMARK command only works whenyou execute it before the ARCHIVE, DELETE, or RESTORE commands.

Syntax

ciunmark selscope=selectionScope selname=selectionNamerevision=revisionCode filepw=file(s)Password marktype=currentMarkTypeoutput=auditDestination append=replaceOrAppendAuditFile



All are required.


You can also unmark for restore a partially restored selection. A selection can bepartially restored if you fail to attach the next tape in a restore sequence and werein the middle of a selection when the previous tape ran out.

selscope=selectionScope Indicates the entity you are marking. Enter F (file),P (part), S (file set), A (all of a project), or E (everymarked file).

selname=selectionName Selection name. If selection scope is not E, enterup to 80 alphanumeric characters.

revision=revisionCode Revision code. Enter 20 alphanumeric charactersor leave blank for the default current revision.


marktype=currentMarkType Indicates how selection was previously marked.Enter A (archive), D (delete), or R (restore).





Unmarking Partially Restored Parts

You can also use the UNMARK command for a partially restored part. A part can bepartially restored if you fail to attach the next tape in a restore sequence and werein the middle of a part when the previous tape ran out. Partially restored parts areunavailable for use.

If you are unable to access a part that you thought you had restored, it can only bepartially restored. Issue the UNMARK command, and then try the MARKR andRESTORE commands again.

File Sets

When you unmark for archive a file set and you don’t specify a current revision, allrevisions of the files associated with the file set are unmarked for archive.Consequently, if any files are erroneously unmarked, you must reexecute theMARKA command for those files.

Audit Information

When you designate a file as the audit destination, Vault sends the information to afile named UNMARK.EDMAUDIT. Use a local editor to view this file.


Restrictions

Unmarking Parts

You cannot execute the UNMARK for archive or UNMARK for restore command on afile that is a member of a part. You must unmark the whole part.



Examples

CIUNMARKEDM> SELNAME=JET MARKTYPE=D

In this example, the JET file at the current revision level previously marked fordeletion is unmarked.

ciunmarkEDM> SELSCOPE=A SELNAME=JET REVISION=RE,EDM> FILEPW=JT MARKTYPE=D

In this example, all the files in the JET project at the RE revision level that haveeither no password or the password JT, and were previously marked for deletion,are unmarked.


Vault Commandsupdate


update

The ciupdate command transfers a copy of your local updated file version toVault, replacing the current version in Vault. The file(s) remains signed out to youand a copy of it is still in your storage area.

Use the UPDATE command when you want others to be able to read a more currentfile version, but you want to continue modifying the file. You can only use theUPDATE command on a file signed out to you, unless you have administrativeprivileges.

Please note: To sign the file back into Vault, updating the file with yourchanges, use the REPLACE command. To sign the file back into Vault withoutupdating it, use the RESET command.

Syntax

ciupdate selscope=selectionScope selname=selectionNameattrfile=attributeFile output=auditDestination append=replaceOrAppendAuditFilevaultid=vaultName





All are required.


This command replaces the database version of the file with your updated version,but the file remains signed out to you and a copy of it is still in your local storagearea.

Use the UPDATE command when you want others to be able to read a more currentfile version, and/or you want your change backed up for later recovery, but youwant to be able to continue modifying the file and keep it signed out to yourself.

When you no longer need the file signed out to you, execute the REPLACEcommand. REPLACE updates the file in the Vault database and deletes your localcopy. To sign the file back into Vault without updating it, use the RESETcommand.



selscope=selectionScope Indicates the entity you are signing out. Enter F(file), P (part), S (file set), B (binder), L (list). Thedefault is F.

selname=selectionName Enter the selection name of up to 80 alphanumericcharacters.

attrfile=attributeFile Enter the name of a local file that containsuser-defined attributes, up to 80 alphanumericcharacters.






The administrator defines the attribute types, and you assign the values whenexecuting the STORE, UPDATE, or REPLACE command. You can also obtain theattribute values when you execute the GET and READ commands.

Attribute File Name



The file containing the attributes has one assignment on each line with the formatATTRIBUTE NAME=attribute value. The attribute name is uppercase; thevalue can be mixed case. The value starts after the equal sign. Trailing blanks areignored. For example,



Only those attributes for which you have at least read permission are presented.Attributes for which you have read but not write permission are preceeded with“##” in the attribute file listing. These attributes are ignored when youreplace/update the underlying object. If the attribute has unit of measure associatedwith it, you can express the attribute values in any presentation format as definedfor the uom-set.


When the selection scope covers multiple Vault objects, the file must identify eachobject before assigning attribute values. Use the identifiers OBJECT-NAME andOBJECT-TYPE to identify the objects. The allowable values for OBJECT-TYPE arepart, PART, file, and FILE. To input multiple values for an attribute, specify eachinstance starting with (1). You must order instances consecutively.

For example,

OBJECT-NAME=jet.partOBJECT-TYPE=partWEIGHT(1)=3.2WEIGHT(2)=4.4



CLEARANCE=SecretOBJECT-NAME=jet.drawingOBJECT-TYPE=fileSIZE=“14 x 22”

Audit Information

When you designate a file as the audit destination, Vault sends the auditinformation to a file named UPDATE.EDMAUDIT. Use a local editor to view thisfile.

Issuing UPDATE on a List

To operate on a list, specify L for the selection scope and specify the name of alocal list file for the selection name. The specified local list file contains the Vaultpart names and file names to transfer.

Please note: You cannot include directories, file sets, or other lists in the listfile.

If, for some reason Vault cannot transfer even one member of the list, then nomembers of the list are transferred. Consequently, we recommend that you uselists only to operate on parts and files as a group.

You can signout a list of parts and stand-alone files and then update the parts andfiles individually. You can also signout parts and files individually and then updatea list of them.



The file that contains the list of parts and files to be operated on uses akeyword=value format. For the UPDATE and REPLACE commands, you caninclude the following for each part or file in the list.





The syntax rules for the list are as follows:







Recommendations

Do not issue the REPLACE or GET command for file sets that include parts, unlessyou are not adding any files to the parts or deleting any files from the parts whilethe file set is signed out.

Restrictions

Following are the restrictions of the UPDATE command.

Updating Private Files

You can only use the UPDATE command on a file signed out to you. You cannotupdate another user’s private files.

Updating Project Files

If you have administrative privileges, you can update another user’s files. You mustfirst sign on to the domain from which the files were obtained.

Please note: This does not apply to private files.

If files you want to update belong to a project, you must have administrativeprivileges for that project.



Example

CIUPDATEEDM> SELSCOPE=F SELNAME=TEST1

In this example, the file TEST1 is updated with modifications.

Vault Commandsvalatrbs (Binder)


valatrbs (Binder)

The civalatrbs command validates attributes on an object or a relationshipwithout storing them.

Syntax

For Binders Only

civalatrbs baseclass=baseClass oname=objectName [revision=revisionCode]


ciaddatrbs atrbdata=attributeData keyfile=keyFile

atrbdata=Attribute Group Name (1-n):atrb_name1=atrb_val1,,atrb_name2=atrb_val2,,...,,atrb_namen=atrb_valn),,


ciaddatrbs frombaseclass=FromObjectBaseClass fromoname=FromObjectNamefromrevision=FromRevision tobaseclass=ToObjectBaseClasstooname=ToObjectName torevision=ToRevision toinstid=ToInstanceId

Vault Commandsvalatrbs (Binder)



For Binders Only




For Binders Only

Use the VALATRBS command to verify correct attribute values before storingthem.

baseclass=baseClass Enter the name of the base class of this object type.The default is Binder.

oname=objectName Existing name for an object instance.

atrbdata=attributeData Enter the name of the attribute group.




keyfile=keyFile Enter the name of the keyword file for input, up to 80alphanumeric characters.

frombaseclass=FromObject

BaseClass

Enter the name of the base class of the parentobject: binder, part, or file. Default is BINDER.

fromoname=FromObjectName Enter the name of the parent object in therelationship.

fromrevision=FromRevision Enter the revision code for the parent object name.The default is the latest revision.

tobaseclass=ToObject

BaseClass

Enter the name of the base class of the child object:binder, part, or file.

tooname=ToObjectName Enter the name of the child object in the relationship.

torevision=ToRevision Enter the revision code for the child object name.The default is the latest revision.

toinstid=ToInstanceId Enter the instance number of the particular parent tochild relation to validate. The default is 1.

revision=revisionCode Enter the revision code for the object, up to 20alphanumeric characters or leave blank for thedefault current revision.

Vault Commandsveruattr


veruattr

The civeruattr command verifies the attribute data by executing the data typerule for the attribute.

Syntax

civeruattr attribute/data=Refertodescription [attrfile=attributeFile[inputattrs=attributeFile]




The Vault administrator can inform you when there are attributes associated with afile. Attributes are important pieces of information associated with a selection. Theadministrator defines the attribute types, and you assign the values when executingthe STORE, UPDATE, or REPLACE command. You can also obtain the attributevalues when you execute the GET and READ commands.

Attribute File Name


attribute/data=Referto

description

Name of the attribute and the data that is to beverified. Enter a name, up to 24 alphanumericcharacters.


inputattrs=attributeFile Name of an attrfile that contains theuser-defined attributes and their associateddata that you want to affect with this command.The length of this field varies based on yourplatform.

Vault Commandsveruattr





The attribute name is always converted to uppercase; value can be mixed case. Thevalue is immediately after the equal sign. Trailing blanks are ignored. The linesstarting with “##” are treated as comments and are ignored while processing.

Only those attributes are allowed for which user has write authority.

If an attribute has a unit of measure associated with it, the attribute values areverified to conform with at least one syntax defined for uom-set associated withthe user attribute.

If the attribute has a unit of measure associated with it and the attribute value isnumeric only, it is expressed in its storage unit of measure.

Audit Information

When you designate a file as the audit destination, Vault sends the auditinformation to a file named VERUATTR.EDMAUDIT. Use a local editor to view thisfile.

Example

CIVERUATTR VACATIONSPOT=SPAIN


Chapter 4 IQF Commands

This chapter provides reference information for IQF commands. These commandsare arranged in alphabetical order.

• Overview

• BACKWARD

• BOTTOM

• BREAK

• COLUMN

• EDIT

• END

• EXIT or QUIT

• FILE

• FORMAT

• FORWARD

• HELP

• LEFT

• LIST

• PRINT

• QUIT or EXIT

• RECALL

• RETRIEVE

• RIGHT

• RUN

• SAVE

IQF Commands


• SELECT

• SET

• SHOW

• START

• TOP

• TYPE

IQF CommandsOverview


Overview

This chapter provides reference information for IQF commands. The commandsare arranged in alphabetical order. Information for each command includes

• Syntax

• Requirements and Special Considerations

• Example

For more information about the IQF commands see Vault Interactive QueryFacility Guide.

Queries can include &STRING as placeholders. This can cause a problem whenrunning an old query because queries written before Vault 2.0 can include only &1through &9 as placeholders. For example, SELECT FILE_NAME FROMFILE_DIRECTORY WHERE FILE_NAME LIKE ‘%.&PD’. IQF reads PD as thename of the placeholder and not as a value qualifying part selection.

IQF CommandsBACKWARD


BACKWARD

This IQF command scrolls a query result backward.

Syntax

BACKward [n]

where,


Enter the BACKWARD command without specifying a number to move backwardthe default number of rows. The default is one half of the top blank section of thescreen (nine rows, for a 24 x 80 screen).

Enter the BACKWARD command with a number to move backward a specificnumber of rows. You can specify a positive integer with as many as six digits.

You cannot scroll backward past the beginning of the query result. If you specify anumber that is greater than the total number of rows left in the display, IQF scrollsbackward only the number of rows left. It is as if you scrolled to the beginning ofthe query result with the TOP command.

Example

BACK 10

n A number that specifies the number of rows to move backward. Specify apositive integer with as many as six digits.

IQF CommandsBOTTOM


BOTTOM

This IQF command scrolls the display so that the end of the query result appears atthe bottom of the screen. IQF displays as many rows as fit on the screen at onetime.

Syntax

BOTTOM


If you execute the BOTTOM command when the display already shows the bottomof the query result, IQF tells you that you are already at the bottom.

IQF CommandsBREAK


BREAK

This IQF command organizes the rows of a report into groups. You can specifywhere to place a break in the output and what to do when a break occurs. You canbreak several columns at a time.

Syntax

BREak { ON { column, ROW, PAGe, REPORT }[ SKIp { n, PAGE } ][ { NODUPlicates, DUPlicates } ]OFF }

where,


Except for the BREAK ON column command, the break settings remain in effectuntil you turn them off either by using the BREAK OFF command or by exiting the

ON Specifies that breaks in the data should occur.

column The name of a column in the current query. When the value of thiscolumn changes, IQF inserts a break in the output. If subtotals or totalswere requested for this column, they appear each time the value ofcolumn changes.

ROW Causes a break after every row of data is displayed. If subtotals ortotals were requested, they appear in the appropriate columns aftereach row.

PAGe Causes a break at the end of each page. If subtotals or totals wererequested, they appear in the appropriate columns at the bottom ofeach page of data.

REPORT Causes a break at the end of a report or query. If subtotals or totalswere requested, they appear at the end of the report.

SKIp n Specifies the number of lines IQF should skip when there is a break. nis a two-digit positive integer. IQF skips the specified number of linesand then prints any applicable totals or subtotals. The default is 1.Allowed only when column is specified.

SKIP PAGE break. IQF prints any applicable totals or subtotals at the top of the newpage. Allowed only when column is specified.

NODUPlicates Specifies that the value in the column that causes the break should bedisplayed/printed only when that value changes. In other words, IQFdisplays/prints the value only in the first row out of all the rows wherethe value occurs. This is the default. Allowed only when column isspecified.

DUPlicates Specifies that all values in the column that caused the break should bedisplayed/printed. Allowed only when column is specified.

OFF Turns off all breaks.

IQF CommandsBREAK


Interactive Query Facility. IQF turns off the breaks specified for a column whenyou execute a new query.

IQF does not automatically redisplay the query result with the breaks in effect. Youmust issue the RUN command to view the effects of the BREAK command on thecurrent query.

To clear breaks previously set, issue the BREAK OFF command.

The simplest form of the BREAK command organizes the rows of a report into agroup when the value of a column changes. This can be useful when you use it inconjunction with the FORMAT TOTAL and FORMAT SUBTOTAL commands.

Example

BREAK ON CMDLISTBREAK SKIP 2BREAK NODUPLICATES

IQF CommandsCOLUMN


COLUMN

This IQF command specifies which column should be the left-most column in thedisplay.

Syntax

COLumn [n]

where,


IQF numbers columns as they appear in the SELECT command. For example, lookat this SELECT command:

SELECT USER_ID, PROJ_ID, RD_AUTH, WR_AUTH FROM DM_USER_AUTH;

Column number 1 is USER_ID, column number 2 is PROJ_ID, column number 3is RD_AUTH, and so on. This does not change until you execute another SELECTcommand. Format commands do not affect these numbers.

If you execute the FORMAT EXCLUDE command so that PROJ_ID, column number2, no longer appears in the display, PROJ_ID is still column number 2 andRD_AUTH is still column number 3. You must count excluded columns when youexecute the COLUMN command.

Execute the COLUMN command without specifying a number to display columnnumber 1 at the left edge of the screen.

When you know the number of the column that you want to appear at the left edgeof the display, execute the COLUMN command and specify the number of thecolumn.

If you specify the number of an excluded column, IQF begins the display with thenext displayable column to the right. If you specify the number of a column thatdoes not exist, IQF displays the last displayable column.

Example

COLUMN 3

n Specifies the number of the column that you want to appear at the leftedge of the display. Include as many as three digits.

IQF CommandsEDIT


EDIT

This IQF command allows you to enter a group of IQF commands. You can thenexecute the commands at one time and/or save the commands in a local file.

Syntax

EDIT


When you want to exit the EDIT command, in the bottom portion of the screenenter the END command:

END

The top portion becomes blank. Be sure to save your work before you enter theEND command. If you do not, it is lost.

You cannot store the END, EXIT, QUIT, START, or SAVE commands in a file usingthe EDIT command.

Command-Line Format

When you enter commands at the prompt they are not processed until you entereither the RUN, START or SAVE command. You can enter a maximum of 54 IQFcommands.

If you enter the EDIT command through the command line format, you can viewall the commands you entered if you save them in a file. Otherwise, you can onlyview the line that you are typing. If you make a typing mistake, you can back spaceand retype before you press the processing key. If you notice a mistake after youpress the processing key, you must redo the line.

With the command-line format you cannot store the END, EXIT, QUIT, START orSAVE commands in a file using the EDIT command. This is because SAVE andSTART commands begin processing the previous commands, while the END, EXIT,and QUIT commands end the EDIT session.

IQF CommandsEND


END

When using the EDIT command, the END command ends the EDIT session.

Syntax

END

IQF CommandsEXIT or QUIT


EXIT or QUIT

This IQF command ends an IQF session.

If you are using the command line format, the EXIT/QUIT command returns youto the operating system prompt.

Syntax

END or QUIT

IQF CommandsFILE


FILE

This IQF command copies the current query result to a local file.

Syntax

FILE filename [ DATAonly ] [ { REPlace, APPend } ]

where,


IQF copies the query result to the file according to the formatting modificationsrequested or the default values. The only exception to this is when you specifyDATAONLY in the FILE command.

The DATAONLY option copies the data from the query to a file without consideringany format settings previously set by the FORMAT, SET and BREAK commands.IQF copies the data in the format in which it is received from the query. Columnheadings and blank lines, however, are not copied to the file. The DATAONLYoption is useful for extracting data from the tables into a file and then loading thedata from the file into another application.

When the local file already exists, you must specify REPLACE or APPEND. If youdo not, IQF sends you an error message and prompts you to indicate REPLACE orAPPEND. If you indicate APPEND for a file that does not exist, IQF creates a newfile. If you try to copy a query result that is wider than the specified line size, IQFsends you a warning message to inform you that the results can be truncated to fiton the page.

Example

FILE USER.REPORT REPLACE

filename The complete name of a local file that can contain the query result. Includeas many as 80 alphanumeric characters. The name must follow the localfile naming conventions.

DATAonly Specifies that just the data from the query is copied to the file. Noformatting of the data is performed and no blank lines are inserted betweenthe lines of data. Also, no column names are written to the file.

REPlace Specifies that the contents of the local file should be replaced with thecurrent query results.

APPend Specifies that the current query results should be appended to the contentsof the local file.

IQF CommandsFORMAT


FORMAT

This IQF command formats the current query result.

Syntax

The FORMAT command has many options. You can specify only one option eachtime you execute the FORMAT command.

FORMat [ {TTITle { ‘text of title’, ON, OFF },BTITle { ‘text of title’, ON, OFF },COLumn column { HEADing ’text’

DPLACes nWIDth nNULL ’text’{ ON, OFF } },

EXCLude [ALL BUT] (column-list),INCLude [ [ONLY] (column-list) ],{ ON, OFF, ERASE },TOTal { [EXCEPT] (column-list), ON, OFF }SUBTotal { [EXCEPT] (column-list), ON, OFF } } ]

where,

TTITLe Specifies a title to be printed at the top of each page of a report. Without anyoptions, this keyword displays the current top title.

BTITLe Specifies a title to be printed at the bottom of each page of a report. Withoutany options, this keyword displays the current bottom title.

‘text of title’ Defines the actual top or bottom title. You can use as many as 80 characters.IQF truncates the title if you use more than 80 characters. Enclose the title insingle quotation marks if the title includes a blank. The top and bottom titlescan each span one or two lines. Separate one line of the title from anotherwith a vertical bar (|). Do not insert a space before or after the vertical bar. Ifthe title is on two lines, the total number of characters in both lines must be nomore than 80 characters.

ON Causes the specified top or bottom title to appear in the query result. This isthe default.

OFF Omits the specified top or bottom title from the query result.

The top and/or bottom title settings are active during the duration of the IQFsession (unless specifically reset).

COLumn Specifies formatting for a column or a column heading.

column_name The name of the column you want to define the format for. You cannot specifya column that is defined by a placeholder in the SELECT command.

IQF CommandsFORMAT


HEADingtext

Defines the heading that you want to appear at the top of the specifiedcolumn. The maximum size of a column heading is the maximum number ofcharacters allowed for the column. If you exceed that number, IQF truncatesthe heading and sends you a warning message. The column heading canspan more than one line. Separate one line from another with a vertical bar(|). If the title is on two lines, the total number of characters in each line mustbe no more than the maximum width of the column. If the text contains ablank, enclose it in single quotation marks. For quotes in names, use an extrasingle quote. For example, Fred’s Garage, would be ‘Fred’s Garage’.

DPLACes n Specifies the number of decimal places to be displayed/printed for a numericfield. Rounding is not performed. n must be a positive integer from 1 - 10(inclusive) that is less than the column width. The default is all the decimalplaces for the value being displayed/written.

WIDth n Specifies the total display width of the column. For character columns, theleft-most n characters are displayed. For numeric columns, the left-most nsignificant digits counting the sign and decimal point, if any, are displayed. Forcharacter data, if the actual data to be displayed in the column is longer thanthe specified width, IQF truncates the data to fit in the column. If a column isnumeric, however, and the specified width is less than the number of digitsneeded to display the number, IQF replaces the entire field with asterisks(*********). n must be a positive integer from 1 - 254, inclusive. The default isthe larger of the column name and the full width of the column.

NULL text Specifies the text to be displayed for a null value. The default is a string ofblanks.

{ON, OFF} ON turns back on the previously defined heading, null text strings, andsettings for decimal places and width. The default is ON. OFF turns off thepreviously defined heading and null text strings. It also returns the settings fordecimal places and width to their original values.

EXCLude Specifies certain columns to be excluded from the query result display.

ALL BUT Indicates that you are listing the columns that you want to appear in thedisplay. The display excludes all columns that do not appear in the column list.

column_list A list of column names as they appear in the SELECT command. Exceptwhen used with the ALL BUT option, these are the columns that you do notwant to appear in the display. When specifying more than one column,separate the names with a blank and enclose the list in parentheses. Enclosecolumn names that contain blanks in single quotation marks.

INCLude Specifies certain columns that were previously excluded to be included againin the query result display. When you specify the INCLUDE option without itsown options, any columns that were previously excluded are now included inthe display.

ONLY Indicates that you are listing the columns that you want to appear in thedisplay. The display includes only the columns that appear in the list. Thiscommand is equivalent to the EXCLUDE ALL BUT command.

column_list A list of column names as they appear in the SELECT command. Exceptwhen used with the ONLY option, these are the columns that you want toappear in the display again.

When specifying more than one column, separate the names with a blank andenclose the list in parentheses. Enclose column names that contain blanks insingle quotation marks.


IQF CommandsFORMAT



When you want to format a query result, you must execute the query first. FORMATcommands apply only to the current query.

When you execute the FORMAT command through the command line format, youcannot see the formatted output before it is filed or printed. The formattingchanges are, however, reflected in the file or on the printed report.

When you are finished formatting a query result you can

• Save the formatted query result in a file with the FILE command

• Print the formatted query result with the PRINT command

The options defined by the FORMAT command remain in effect until you

• Individually turn an option off

• Erase all formatting

• Execute another FORMAT command to change the options

ON Turns back on the display of all previously defined FORMAT options.

OFF Turns off the display of previously defined FORMAT options. When youexecute the FORMAT OFF command, any option that you set with theFORMAT command is reset to its original value. FORMAT OFF does not,however, affect any parameters changed with the SET command or anyactions performed as a result of the BREAK command.

ERASE Cancels all previously defined FORMAT options and reverts the FORMATsettings back to their original values.

TOTal Calculates the total for a specified numeric column. Use in conjunction withthe BREAK ON column command to display totals when the value of columnchanges.

SUBTotal Calculates the subtotal for a specified numeric column. Use in conjunctionwith the BREAK ON column command to display totals when the value ofcolumn changes.

EXCEPT Indicates that you are listing the columns you do not want to calculate totals orsubtotals for. IQF calculates totals or subtotals for the decimal columns thatare not listed.

column_list A list of column names as they appear in the SELECT command. Exceptwhen used with the EXCEPT option, these are the columns that you want todo calculations for.

When specifying more than one column, separate the names with a blank andenclose the list in parentheses. Enclose column names that contain blanks insingle quotation marks.

ON/OFF Turns on/off the calculation of a total or subtotal.


IQF CommandsFORMAT


• Execute another SELECT command with at least one different column

• Exit IQF

Use the TOTAL and SUBTOTAL options in conjunction with the BREAK command.The BREAK command causes a break in the output so totals or subtotals canappear.

You must perform the RUN command to see the result of the FORMAT command.Also, you must execute RUN after issuing a FORMAT command to be able to use thescroll display commands.

Example

FORMAT TTITLE ‘USER REPORT’FORMAT COLUMN FULLNAME WIDTH 10FORMAT EXCLUDE ALL BUT (USERID PROJID CMDLIST)FORMAT INCLUDE ONLY USERID

IQF CommandsFORWARD


FORWARD

This IQF command scrolls a query result forward.

Syntax

FORWard [n]

where,


Enter the FORWARD command without specifying a number to move forward thedefault number of rows. The default is one half of the top blank section of thescreen (9 rows, for a 24 x 80 screen).

Enter the FORWARD command with a number to move forward a specific number ofrows. You can specify a positive integer with as many as six digits.

You cannot scroll forward past the end of the query result. If you specify a numberthat is greater than the total number of rows left in the display, IQF scrolls forwardonly the number of rows left. It is as if you scrolled to the end of the query resultwith the BOTTOM command.

Example

FORWARD 15

n A number that specifies the number of rows to move forward. Specify a positiveinteger with as many as six digits.

IQF CommandsHELP


HELP

You can view online documentation for each IQF command.

When using the command line format, enter HELP at the IQF> prompt. When youexecute the HELP command alone, IQF displays a list of IQF commands. To viewinformation about a particular command enter HELP followed by the name of thecommand.

Syntax

HELP commandname


When using the command line format, IQF displays online documentation oneline at a time, starting on the line following the prompt line. IQF displays theIQF> prompt after it completes the help text. You cannot use the END commandto terminate the display of online documentation when using the command lineformat. IQF displays all the information.

To view general help information about IQF you can execute any of the followingcommands:

CIHELP IQFCIIQF ?CIIQF HELP

IQF online documentation does not include help for the SELECT command. Referto your relational database management system documentation.

Example

HELP FORMAT

IQF CommandsLEFT


LEFT

This IQF command scrolls the display one or more columns to the left.

Syntax

LEFT [n]

where,


Execute the LEFT command without specifying a number to scroll the display onecolumn to the left. The new display starts one column to the left of the previousdisplay.

Execute the LEFT command and specify a number to scroll more than one columnto the left. The new display starts at the nth column to the left of the left-mostcolumn in the previous display.

When you specify a number that is greater than the number of columns remainingto the left, IQF displays the first displayable column and as many other columns asfit on the screen. If you execute the LEFT command when you are already at thefirst column, IQF tells you that you are already at the first column.

Example

LEFT 16

n A positive number that specifies how many columns to scroll to the left from thecurrent left-most column. Include as many as three digits.

IQF CommandsLIST


LIST

This IQF command displays the current query.

Syntax

LIST [PLACEHOLDER]

where,


IQF displays a message if there is no current query.

If the current query has placeholders, and if you executed a START command thatreplaced the placeholders with values, then IQF lists the current query with thosevalues. If you use the PLACEHOLDER option, IQF displays the current query withthe placeholders instead of the values you supplied.

Example

SELECT &1, &2 FROM USERS;START (USER_ID PROTECTION_GROUP)

USER_ID PROTECTION_GROUP-------- ----------------SNOOPY F23BAMELIA E23BORVILLE DB12CHARLES A3C2WILBUR A3C2BERYL E23BERICA B95ALISTSELECT USER_ID, PROTECTION_GROUP FROM USERS;LIST PLACEHOLDERSELECT &1, &2 FROM USERS;

PLACEHOLDER Displays the location of any placeholders within the current query.

IQF CommandsPRINT


PRINT

This IQF command sends the current query result to the printer. You can print theresult of only the current query.

Syntax

PRInt [filename] [ COPies n ]

where,

Execute the PRINT command without the COPIES option to print one copy.


The query result is printed according to the formatting modifications requested orthe default values. The number of characters printed per row and the number ofrows printed per page depends on the values you previously set or the defaultvalues. When you try to print a query result that is wider than the specified linesize, IQF truncates the results to fit the page and prints a warning message.

Example

PRINT USERS.REPORT COPIES 10

COPies Indicates that you want more than one copy.

n A two-digit positive integer that specifies the number of copies youwant.

IQF CommandsQUIT or EXIT


QUIT or EXIT

This IQF command ends an IQF session.

If you are using the command line format, the QUIT/EXIT command returns youto the operating system prompt.

Syntax

QUIT or EXIT

IQF CommandsRECALL


RECALL

This IQF command displays the current query (the last successful SELECTcommand you entered) in the command area.

Syntax

RECALL


When the current query includes placeholders, IQF does nothing. You cannot usethe RECALL command when you use the command line format to enter IQFcommands.

The RECALL command is useful because it saves you from retyping the lastsuccessful SELECT command. If you want to execute a query similar to the lastone, you can recall the las SELECT command, type over it, and then press theprocessing key.

Example

SELECT USER_ID, PROTECTION_GROUP FROM USERS;START

USER_ID PROTECTION_GROUP-------- ----------------SNOOPY F23BAMELIA E23BORVILLE DB12CHARLES A3C2WILBUR A3C2BERYL E23BERICA B95A

RECALLSELECT USER_ID, PROTECTION_GROUP FROM USERS;

IQF CommandsRETRIEVE


RETRIEVE

This IQF command displays the last IQF command you entered—valid orinvalid—in the command area.

Syntax

RETRIEVE


IQF retrieves only the first 158 characters of the command. The only twocommands that the RETRIEVE command does not display are the RECALL andRETRIEVE commands.

If the last IQF command you entered was a SELECT command, you can useRETRIEVE to redisplay it in the command area, even if the query containsplaceholders.

If the last command you entered was entered with a function key, the RETRIEVEcommand does not recognize it as the last command and, instead, retrieves the lastcommand you typed in. You cannot use the RETRIEVE command when you usethe command line format.

The RETRIEVE command is useful because it saves you from typing repetitivecommands, such as a series of FORMAT commands. If you want to execute a querysimilar to the last one, you can retrieve the last command, type over it, and thenpress the processing key.

Example

SELECT &1, &2 FROM USERS;START (USER_ID PROTECTION_GROUP)

USER_ID PROTECTION_GROUP-------- ----------------SNOOPY F23BAMELIA E23BORVILLE DB12CHARLES A3C2WILBUR A3C2BERYL E23BERICA B95A

RETRIEVESTART (USER_ID PROTECTION_GROUP)

IQF CommandsRIGHT


RIGHT

This IQF command scrolls the display one or more columns to the right.

Syntax

RIGHT [n]

where,


To scroll the display one column to the right, execute the RIGHT command withoutspecifying a number. The new display starts one column to the right of theprevious display.

To scroll more than one column to the right, execute the RIGHT command andspecify a number. The new display starts at the nth column to the right of theleft-most column in the previous display.

When you specify a number that is greater than the number of columns remainingto the right, IQF displays the last displayable column and as many other columnsas fit on the screen. If you execute the RIGHT command when the display alreadyshows the last column, IQF tells you that you are already at the last column.

Example

RIGHT 3

n A positive number that specifies how many columns to scroll to the rightfrom the current left-most column. Include as many as three digits.

IQF CommandsRUN


RUN

This IQF command executes the current query when it does not have placeholders.You must have already executed this query with the START command.

Syntax

RUN


The RUN command does not have any modifiers or parameters. When you executethe current query with the RUN command, the query reflects any format changesyou have made since you last executed it.

The RUN command is useful because it executes a SELECT command that you didnot explicitly save.

If the SELECT and START commands have not been previously executed, the RUNcommand does nothing.

IQF CommandsSAVE


SAVE

This IQF command saves the current query in a local file.

Syntax

SAVe filename [ { REPlace, APPend } ]

where,


After you save a query in a local file, you can specify that file in a STARTcommand when you want to execute the current query at a later time. When thelocal file already exists, you must specify REPLACE or APPEND. If you do not, IQFprompts you to indicate REPLACE or APPEND. If you indicate APPEND for a filethat does not exist, IQF creates a new file.

Example

SAVE USER.REPORT APPEND

filename The complete name of a local file that can contain the current query. Includeas many as 80 alphanumeric characters. The name must follow the localfile naming conventions.

REPlace Replace the contents of the local file with the current query.

APPend Append the current query to the contents of the local file.

IQF CommandsSELECT


SELECT

This IQF command defines the exact information you want to view.

Syntax

SELECT columnname,... -FROM tablename -WHERE condition;

where,


The list below shows you the kind of information you can specify in a SELECTcommand. It is by no means a complete list.

• Table name(s)

• Column name(s)

• Which columns not to include

• Order of columns and/or rows

• Conditions for displaying or not displaying information

The clauses of a SELECT command can appear on one line or continue over manylines. Place a blank followed by a hyphen at the end of every line that continues tothe next line.

This is by no means the complete format for the SELECT command. There aremany more keywords that can be included. The order of the clauses is alsoimportant. Consult the documentation for your RDBMS for comprehensiveinformation about the SELECT command.

Example

SELECT USERID USERNAME -FROM USERS -WHERE CMDLIST=JETCL

columnname The name of one or more columns to display. Enter anasterisk (*) for all columns. Separate multiple column nameswith commas.

viewname The name of one or more views that contain the columnsspecified in the SELECT clause.

condition A condition for determining whether or not to print certainrows in the specified columns.

IQF CommandsSET


SET

This IQF command defines values for format parameters.

Syntax

SET { DECimal /t/d/ECHO {ON,OFF}LINesize nNEWPage nNOROWS nPAGESize nNULL ‘text’SEParator {n BLANKS, ‘text’} }

where,

DECimal Defines punctuation in decimal columns.

t The thousands separator. You can enter a period, a comma, or a blank. Thedefault is that no thousands separator is used.

d The decimal separator. You can enter a period or a comma. The defaultdecimal separator is a period.

ECHO Specifies whether or not to display stored queries as IQF executes them. Thiscommand is applicable only to IQF commands executed from a local file.

ON Indicates that stored queries are displayed before they are executed. This isthe default.

OFF Indicates that stored queries are not displayed before they are executed.

LINesize n Specifies the number of characters that can be displayed or printed per line. nis a three-digit positive integer greater than zero. The default is 132characters.

NEWPage n Specifies the number of blank lines to be displayed/printed at the top of everypage. n is a two-digit positive integer. A value of 0 sends a form feed betweenpages and does not print any blank lines at the top of the page. The default is1.

NOROWS n Specifies the number of lines of data to be displayed/printed per page. n is atwo-digit positive integer. The default value is 54. Data lines do not include topand bottom titles or column headings.

PAGESize n Specifies the total number of lines per page. n is a two-digit positive integer.The default is 66.

NULL ‘text’ Specifies text that replaces any null values in the query result. ‘text’ is acharacter string of as many as 254 characters. The default is a string ofblanks. Enclose the text in single quotation marks.

SEParator Specifies how to separate columns.

n BLANKS Specifies the number of blanks that appear between any two columns. n is athree-digit positive integer greater than zero. The default is two blanks.

‘text’ A character string of as many as 254 characters. This text appears betweenany two columns. Enclose the text in single quotation marks.

IQF CommandsSET



Each format parameter has a default setting. Execute the SHOW command todisplay the default settings for your system. When you define a new setting, it is ineffect until you exit IQF or redefine the parameter. You can define one parametereach time you execute the SET command.

Please note: When setting format parameters through the command lineformat, you cannot see the results of the changed parameters. They are, however,reflected in the file or in the printed report.

Example

SET DECIMAL /,/./SET ECHO ONSET NOROWS 40SET NULL ‘*****’

IQF CommandsSHOW


SHOW

This IQF command lists the value of one or all format parameters.

Syntax

SHOw {ALL, BTITle, DECimal, ECHO, LINesize, NEWPage, NOROWS, NULL,PAGESize, SEParator, TTITle}

where,


You can specify which parameter you want to list the value for. Or you can executethe SHOW ALL command to list the values for all format parameters.

When you are using the command line format, IQF sends the output to the screenone line at a time, beginning on the line beneath the prompt line. IQF prompts youagain when all lines have been displayed.

Example

SHOW TTITLE

ALL Shows the current settings for all the parameters listed below.

BTITLe Shows the current bottom title for reports.

DECimal Shows the type of punctuation used when displaying a decimal column.

ECHO Shows whether commands are displayed when executed from a commandfile.

LINesize Shows the maximum number of characters that can be displayed on a line.

NEWPage Shows the number of blank lines displayed/printed at the top of every page.

NOROWS Shows the maximum number of lines of data displayed/printed per page.

NULL Shows the text that is substituted for a NULL value.

PAGESize Shows the total number of lines displayed/printed per page.

SEParator Shows the separation characters used between columns.

TTITle Shows the current top title for reports.

IQF CommandsSTART


START

This IQF command executes the current query or a query stored in a local file.

Syntax

STArt [filename] [ (parameter list) ]

where,


If the current query does not include placeholders, execute the START commandwithout a parameter list. You cannot mix letters and numbers in a placeholder.

Queries can include &STRING as placeholders. This can cause a problem whenrunning an old query because queries written before Vault 2.0 can include only &1through &9 as placeholders. For example, SELECT FILE_NAME FROMFILE_DIRECTORY WHERE FILE_NAME LIKE ‘%.&PD’. IQF reads PD as thename of the placeholder and not as a value qualifying part selection.

If the current query has placeholders, you must include the parameter list. IQFreplaces the placeholders with the parameters and then displays the results of thequery on the screen. IQF displays an error message if there is no current query.When you execute the current query again with the START command, the queryreflects any format changes you have made since you last executed it.

To execute a stored query, enter the START command and specify the completename of a file that contains IQF commands. When you specify an incorrect filename, IQF displays an error message.

An IQF command file can contain any IQF command. Some can or can not work,it depends on the current query when the file is executed. A command file caninclude more than one SELECT command or no SELECT commands at all.

filename The name of a file that contains IQF commands. The name caninclude as many as 80 alphanumeric characters. It must follow thelocal file naming conventions.

parameter list A list of parameters, separated by blanks, that are substituted for anyplaceholders in the SELECT command. Enclose the list inparentheses. Enclose a parameter that includes a blank in singlequotation marks. The first parameter is substituted for everyoccurrence of &1, the second replaces every occurrence of &2, andso on.

IQF CommandsSTART


If a command file does not contain a SELECT command, the query that was thecurrent query when you executed the command file remains the current query.

If the file does not contain a FILE or PRINT command, the output lost when youexecute the file by means of the command line format.

To see the command that is being run from the file, include the SET ECHO ONcommand in the file. When IQF completes execution of the START command, thelast SELECT command, if there was one, is now the current query.

Example

START USER.COMMAND.FILE (COMDLIST, PROTGRP)

IQF CommandsTOP


TOP

This IQF command scrolls the display so that the beginning of the query resultappears at the top of the screen. IQF displays as many rows as fit on the screen atone time.

Syntax

TOP


If you execute the TOP command when the display already shows the top of thequery result, IQF tells you that you are already at the top.

IQF CommandsTYPE


TYPE

This IQF command displays the contents of a file containing IQF commands.

Syntax

TYPE filename

where,


You can use the TYPE command to display the contents of any file, not just thosecontaining IQF commands, but the results are unpredictable for other kinds offiles.

Example

TYPE USER.REPORTSELECT USER_ID, USER_GROUP, PROTECTION_GROUP, -UPDATE_DATE FROM USERS;SELECT USER_GROUP, PROTECTION_GROUP FROM USERS;

filename The complete name of a file that contains IQF commands. The name caninclude as many as 80 alphanumeric characters. The name of the file mustfollow the local file naming conventions.

Vault Command Reference A-1

Appendix A Moving Vault Files to and fromUNIX

This chapter provides information about moving data between UNIX operatingsystems and Vault.

• Using Vault File Transfer Commands

• Storing UNIX Files and Parts

• Storing All Files in a UNIX Directory

• Storing CADDS Files and Parts

• Default CADDS Attributes for UNIX Files

• Copying Vault Files to UNIX

Moving Vault Files to and from UNIXUsing Vault File Transfer Commands

A-2 Vault Command Reference

Using Vault File Transfer Commands

You can use five Vault commands to move your files around in the system.

• The STORE command moves files from your workstation to the Vault database.This introduces new files and parts to Vault.

• The GET and READ commands copy files stored in Vault to your workstation.

• The UPDATE and REPLACE commands return updated copies of files obtainedwith the GET command to Vault.

To use the STORE, GET, and READ commands, you must supply values for one orboth of these keywords:

• LFNAME (Local File Name—the name of the file on your workstation)

• SELNAME (Selection Name—the name of the file in Vault)

For the GET and READ commands, you can supply a value to the optionalLDIRNAME (Local Directory Name) keyword.

The use of the SELNAME, LFNAME, and LDIRNAME keywords with the STORE, GET,and READ commands is discussed in detail in this section.

Please note: You can also store, retrieve, and update CADDS files fromwithin CADDS. For information about the CADDS commands used with Vault,see Appendix C, “Using CADDS Commands to Access the Vault Database”.

Audit Files

Vault file transfer commands produce an audit file in your current workingdirectory. The audit file contains the Vault name and revision of each filetransferred and a message indicating whether the transfer was successful. Theaudit files for the GET and READ commands also contain the UNIX name given toeach Vault file transferred to your workstation.

The audit files are named command.EDMAUDIT; for example, STORE.EDMAUDITand READ.EDMAUDIT. If you execute multiple commands of the same type, theaudit file is overwritten unless you use the optional keyword APPEND=A with thefile transfer command.

Moving Vault Files to and from UNIXStoring UNIX Files and Parts


Storing UNIX Files and Parts

You can store your UNIX files and parts in Vault.

Storing a Single UNIX File

To store a single UNIX file, enter the STORE command with the keyword valueSELSCOPE=F. Do not specify a value for the ENV keyword (accepting the defaultof LOCAL).

Storing Custom Parts

Using the Custom Part Facility, the Vault administrator can define a part for use atyour site and can determine which files can belong to that part. If custom parts areimplemented, the Vault administrator must inform End Users of this.

To store a custom part, enter the STORE command with the keyword valueSELSCOPE=P. Your Vault administrator must inform you what value to enter forthe Environment keyword. Do not enter LOCAL or CADDS.

You can also add a file to a custom part that has already been stored. Specify theselection scope as F, specify the name of the part that the file is being added to, andspecify the value provided by the Vault administrator for the Environmentkeyword.

Deleting Local Files in the Process of Storing

When you store a UNIX file or part, if signout is not requested, the local files aredeleted. If signout is requested, the files remain locally and are signed out fromVault.

LFNAME Keyword

When you store a single UNIX file, you supply the name of the file to betransferred with the LFNAME keyword. You must enter this keyword with theSTORE command; there is no default.

Vault limits the total number of characters for the LFNAME value to 80 characters(including periods and slashes). Because UNIX is case-sensitive, UNIX file namesmust be entered in uppercase or lowercase just as they appear in the file system.

Moving Vault Files to and from UNIXStoring UNIX Files and Parts


Here is an example of a STORE command for a single UNIX file.

% cistore selscope=f lfname=myfile

Vault looks for the specified file in your current working directory.

To store a file that exists in a directory other than your current working directory,enter a full path name as illustrated in the following example.

% cistore selscope=f lfname=/users/owright/newfile

In Vault, this file is called /users/owright/newfile. This name is mapped touppercase unless the EDMCASE environment variable is set to MIXED. See theprevious chapter for details.

SELNAME Keyword

You can give the file you are storing an Vault name different from the local filename with the optional SELNAME (selection name) keyword.

If you do not use the SELNAME keyword, the Vault file name defaults to the localfile name exactly as entered, except for case. (See the index for locations ofinformation about case translation of Vault file names.)

With the SELNAME keyword, you can give a file any Vault name. For example, ifyou specify a full path name with the LFNAME keyword, you can use the SELNAMEkeyword to give the file an Vault file name that does not contain the directoryspecification.

Here is an example of a STORE command for a file in the /users/ejongdirectory.

% cistore selscope=f lfname=/users/ejong/minutes selname=minutes

In Vault, this file can be called minutes.

Moving Vault Files to and from UNIXStoring All Files in a UNIX Directory


Storing All Files in a UNIX Directory

To store in Vault one level of a directory of UNIX files, enter the STORE commandwith the keyword value SELSCOPE=D. Do not specify the ENV keyword (acceptingthe default of LOCAL). Using SELSCOPE=D allows you to store more than one fileat a time. However, subdirectories within a directory specified for STORE are notthemselves stored.

Please note: The files transferred to Vault with the STORE command aredeleted from your system.

LFNAME Keyword

When you store in Vault one level of a directory of files, you supply the directoryname as the value of the LFNAME keyword.

Example of a STORE command to store in Vault all the files in the/users/bmarkham/obj directory:

% cistore selscope=d lfname=/users/bmarkham/obj

SELNAME Keyword

If you do not use the SELNAME keyword, the Vault file names in the directory youspecify default to the local file names, exactly as they appear in UNIX.

If you use the SELNAME keyword when you store all the files in a directory, the filenames in Vault are prefixed by the value of the SELNAME keyword(SELNAMEfilename). Here is an example of a STORE command for a directoryusing the SELNAME keyword:

% cistore selscope=d lfname=/users/bmarkham/obj selname=spec

Moving Vault Files to and from UNIXStoring All Files in a UNIX Directory


If two files in this directory are named test1.c and input.data and EDMCASE isset to MIXED, the files in Vault would be named:

• spectest1.c

• specinput.data

If EDMCASE is set to UPPER or not set at all, spec would be converted touppercase and the files as stored in Vault would have these names:

• SPECTEST1.C

• SPECINPUT.DATA

Moving Vault Files to and from UNIXStoring CADDS Files and Parts


Storing CADDS Files and Parts

The STORE command with ENV=CADDS copies a CADDS file or part (parts cancontain many files) to Vault. If signout is not requested, the local files are deleted.If signout is requested, the files remain locally and are signed out in Vault.

Please note: You can store more than one item at a time in Vault withSELSCOPE=L(ist). See Chapter 1 for information about the List value. This chapterprovides details about how to enter the file names in the List file.

To store a CADDS file or part enter the STORE command with the keyword valuesENV=CADDS and SELSCOPE=F or P. F indicates a CADDS file. P indicates aCADDS part.

LFNAME Keyword

When you store a CADDS file or part in Vault, you supply the name of theCADDS entity to be transferred with the LFNAME keyword. You must enter thiskeyword with the STORE command; there is no default.

The local file name resembles the UNIX name, but uses CADDS file-namingconventions. The local file name must be in a CADDS format. Enter the name inlowercase letters. Vault limits the total number of characters for the LFNAMEvalue to 80 characters.

Here is an example of a STORE command for a CADDS part.

% cistore env=cadds selscope=p lfname=jet.body

You can specify a full path name by preceding the LFNAME with an equals sign.For example, LFNAME==user.wwright.newbody. Unless you specify a fullpath name, the CADDS rulebase looks in your CADDS create directory for theCADDS file(s) that you specify.

SELNAME Keyword

If you do not specify a SELNAME, the Vault name depends on the LFNAME. Forexample, no SELNAME was specified in the previous example and the Vault namebecomes =USER.WWRIGHT.NEWBODY.

You can give the CADDS file or part you are storing an Vault name different fromthe CADDS file name with the SELNAME (selection name) keyword.



Here is an example of a STORE command for a CADDS file where the SELNAMEkeyword is used (the Vault name is DRAFT.SPEC).

% cistore env=cadds selscope=f lfname=test.spec.&bcdselname=draft.spec

Selection names are mapped to uppercase for all CADDS files. EDMCASE, if set,does not apply.

If you enter the SELNAME keyword when you store a CADDS part, the SELNAMEvalue is used as the directory to each file. Here is an example of a STOREcommand for a CADDS part where the SELNAME keyword is used (the part nameis PROTOTYPE.BODY).

% cistore env=cadds selscope=p lfname=test.bodyselname=prototype.body

If two of the files in this part are named test.body._pd andtest.body._nfig.one, the files in Vault would be named as follows:

• PROTOTYPE.BODY.&PD

• PROTOTYPE.BODY.&NFIG.ONE

If you do not specify a SELNAME keyword, the Vault file name defaults to theUNIX file name with CADDS character conversions. For parts, even whenSELNAME is used, these conversions apply to the individual files within theselection. These are shown in the table below.

Table A-1 Character Conversions for CADDS File Names Copied to Vault

UNIX Name Vault Name Comments

A-Z A-Z No change.

a-z A-Z CADDS file names are converted to uppercase by therulebase.

0-9 0-9 No change.

= = No change.

/ .

@ @ No change.

_ (underline) &



CADDS Attributes for CADDS Files

When CADDS files or parts are stored in Vault, each file is assigned CADDSattributes based upon information in the UNIX directory and in the associated.attr file for each CADDS file stored.

If the .attr file is missing, the file is assigned a file type of 00. For selectionscopes of part, files with the file type of 00 are only stored if that file type isincluded in the CADDS flexible part definition.

Moving Vault Files to and from UNIXDefault CADDS Attributes for UNIX Files


Default CADDS Attributes for UNIX Files

When UNIX files are stored in Vault, the CADDS attributes (associated with allVault files) are set to the following defaults:

• Update date and time = date and time of the input file

• Protection group = 0

• File type = 1 blank

• Checksum = 0

• User attributes = nulls

Moving Vault Files to and from UNIXCopying Vault Files to UNIX


Copying Vault Files to UNIX

Use the GET and READ commands to copy an Vault file, file set, part from Vault toyour workstation, leaving the Vault version intact.

Please note: You can store more than one item at a time in Vault withSELSCOPE=L(ist). See Chapter 1, “Description of Commands” for informationabout the List value. This chapter provides details about how to enter the filenames in the List file.

SELNAME Keyword

When you use the GET or READ command, supply the Vault file name, file set, part,with the SELNAME keyword. You must enter this keyword with the GET and READcommands; there is no default.

If you do not know the exact name of the Vault file, file set, part you want to copyto your local directory, use the LISTDIR command in Chapter 3, VaultCommands, section “listdir” on page 3-188 or IQF (described in Vault InteractiveQuery Facility Guide).

Vault File Name Conversions with GET and READ

When you use the GET and READ commands to transfer Vault files to UNIXwithout specifying a value for the LFNAME keyword, Vault attempts to create newUNIX files with names that comply with UNIX.

The way Vault file names are converted also depends on whether the file is aCADDS or UNIX file.

File Names for CADDS and Non-CADDS Files

Vault converts CADDS file names but not non-CADDS file names when files arecopied from Vault to UNIX.

Copying CADDS Files

When you use the GET and READ commands to transfer a CADDS file from Vaultto UNIX, its name is converted to a directory plus a file name.



To allow CADDS-format conversion of Vault names, Vault creates new UNIXsubdirectories within the directory specified by the CVPATH logical (if there isone) or your current working directory.

When Vault copies CADDS files to UNIX, the CADDS runtime code performs thecharacter conversions shown in the table below.

Copying UNIX Files

Vault does not perform format conversions for UNIX files. An Vault file is copiedto your current working directory with the same name it has in Vault. If an Vaultfile name cannot be translated to a UNIX file name, you must supply a differentUNIX file name with the LFNAME keyword, as described below.

LFNAME Keyword

When you use the GET or READ command, the LFNAME keyword is optional. If youdo not enter a local file name, Vault attempts to use the file’s Vault name as thelocal file name. If the Vault file name is invalid on UNIX, the file is not transferredand a message instructs you to enter a local file name.

For the GET and READ commands, Vault uses the LFNAME keyword differently,depending on whether you are transferring a single file or a group of files (part, fileset).

For single file transfer, the value of the LFNAME keyword is the local UNIX filename for the file to be transferred from Vault. When you transfer a single Vault fileto your local storage area, you can always use the LFNAME keyword to rename thefile.

Table A-2 Character Conversions for CADDS File Names Copied to UNIX

Vault Name UNIX Name Comments

a-z a-z No change

0-9 0-9 No change

A-Z a-z Uppercase to lowercase

= / First character only

. /

@ .

& _ (underscore)



UNIX Names of Copied Files

For multiple file transfer, the resulting UNIX file name depends on the parametersyou enter for the READ or GET command. See the table on the next page.

In the table, filename indicates the last level in the actual file name of a filebelonging to a part. For example, the part /jet/engine includes three files.

/jet/engine/fan/jet/engine/plug/jet/engine/bolt

The filenames are fan, plug, and bolt.

Also in the table, EDMNAME indicates the name of the object when stored in Vault.

Artificial Names for Multiple File Transfer

The GET and READ commands have an optional keyword called LDIRNAME (localdirectory name). You can use it to designate the local directory to which the Vaultfile is transferred. You can specify a relative or absolute directory name with theLDIRNAME keyword.

If LDIRNAME is not entered, the file is transferred to your current workingdirectory.

Please note: If a file was renamed by Vault, you must use the name suppliedby Vault to replace or update it. You can find the file name(s) supplied by Vault inthe audit file (GET.EDMAUDIT).

Table A-3 Specified Parameters for GET and READ Determine UNIX File Name

SelectionScope

SELNAMESpecified

LFNAMESpecified

LDIRNAMESpecified Resulting UNIX Name(s)

File 3 SELNAME

3 3 LFNAME

3 3 LDIRNAME/SELNAME

3 3 3 LDIRNAME/LFNAME

Part 3 SELNAME/filename

3 3 LFNAME/filename

3 3 LDIRNAME/SELNAME/filename

3 3 3 LDIRNAME/LFNAME/filename

File set (File) 3 EDMNAME

3 3 LDIRNAME/EDMNAME



Examples of File Name Conversion for GET and READ

The tables on this page and the next two pages show the UNIX file names given toVault files, depending on whether you specify a local file name (with the LFNAMEkeyword) and/or a local directory name (with the LDIRNAME keyword).

These examples show the input to LDIRNAME to be a relative directory; therefore,the local directory name is prefixed by the current working directory. Vault inserts$PWD only when LDIRNAME is not a fully qualified path name, that is, only whenLDIRNAME does not start at root (/).

.

Table A-4 File Name Conversions for UNIX Files Stored in Vault Copied to UNIX

SELNAME LFNAME LDIRNAME Local File Name

OUTPUT.TXT my.file edmdir $PWD/edmdir/my.file

my.file none $PWD/my.file

none edmdir $PWD/edmdir/OUTPUT.TXT

none none $PWD/OUTPUT.TXT

MSL.OUTPUT.TXT my.file edmdir $PWD/edmdir/my.file

my.file none $PWD/my.file

none edmdir $PWD/edmdir/MSL.OUTPUT.TXT

none none $PWD/MSL.OUTPUT.TXT

Table A-5 File Name Conversions for UNIX Files Stored in Vault Copied to UNIX


CAR.DASH.AIR

contains the files:

edmpart edmdir

CAR.DASH.AIR.&PD $CVPATH/edmdir/edmpart/_pd

CAR.DASH.AIR.&NFIG $CVPATH/edmdir/edmpart/_nfig

CAR.DASH.AIR.DRAW $CVPATH/edmdir/edmpart/draw



Table A-6 File Name Conversions for File Sets Copied to UNIX


FILESET2 none edmdir

contains the files:

PROJ.PLAN (non-CADDS) $PWD/edmdir/PROJ.PLAN

PROJ.PLAN.SCHED(non-CADDS) $PWD/edmdir/PROJ.PLAN.SCHED

LABOR.HOURS.JULY(non-CADDS) $PWD/edmdir/LABOR.HOURS.JUL

Y

NC.ANALYSIS.&BCD.K$PWD/edmdir/nc/analysis/_bcd/k

Vault Command Reference B-1

Appendix B Command Abbreviations

This appendix lists Vault and IQF (Interactive Query Facility) commandabbreviations. These abbreviations are primarily used as identifiers in messages.

• Vault Command Abbreviations

• IQF Command Abbreviations

Command AbbreviationsVault Command Abbreviations

B-2 Vault Command Reference

Vault Command Abbreviations

The following table lists the Vault command abbreviations.

Table B-1 Vault Command Abbreviations with their descriptions

Abbreviation Command Description

AAG ADDAG Add an authority group to Vault

AAS ADDASET Add an attribute set to Vault

AAT ADDATTR Add an attribute to Vault

ACL ADDCL Add a command list to Vault

ADM ADMCOPY Administrative copy

ADP ADDP Add a project to Vault

ADS ADDS Add a status level to an authority scheme

ADT ADDT Add a user-defined table to the control of Vault

ADU ADDU Add a user to Vault

AFS ADDFS Add a file set

ALS ADDUSA Add a user list/status code association

AMA ADDMAS Add a member to an attribute set

AML ADDMUL Add members to a user list

AMS ADDMFS Add a member to a file set

ARC ARCHIVE Move files marked for archiving from Vault to tape

ARL ADDRULE Add a classification rule to Vault

ARS ADDRS Add a revision code sequence

ASP ADDSP Add a storage pool to Vault

AUL ADDUL Add a user list name

AUP ADDUP Add a user to a project

CAG CHGAG Change entries in an authority group

CCL CHGCL Change entries in a command list

CFA CHGFA Change file(s) attributes

CFC CHGFCL Change file(s) classification

CFP CHGFPW Change file(s) password

CFR CHGFREV Change file(s) revision code

CFS CHGFSC Change file(s) status code

CLT CLST Close a user-defined table

CMA CHGMAS Change a member of an attribute set

CPA CHGP Change the attributes of a project



CPS CHGSPS Change storage pool status

CPT CHGSPT Change storage pool type

CPW CHGUPW Change your Vault user password

CPY COPY Copy file(s) to new Vault file(s)

CSA CHGS Change the attributes of a status level

CTL CHGCTL Change command trigger list

CUA CHGU Change an Vault user’s attributes and/or authority

CUP CHGUP Change a user’s project authority

DAG DELAG Delete an authority group from Vault

DAS DELASET Delete an attribute set from Vault

DAT DELATTR Delete an attribute from Vault

DCL DELCL Delete a command list from Vault

DEL DELETE Delete files marked for deletion

DIR LISTDIR List file(s) on local or remote Vault node

DLG DELLOG Delete Vault audit log entries

DLP DELP Delete a project from Vault

DLS DELS Delete a status level from an authority scheme

DLU DELU Delete a user from Vault

DLV DELOV Delete old versions of files

DRL DELRULE Delete a classification rule from Vault

DRS DELRS Delete a revision code sequence

DUL DELUL Delete a user list

EDM EDM General Vault messages not related to anycommand

FSP CHGFSP Change a file’s storage pool

GET GET Sign out and copy file(s); modifications allowed

HLP HELP Vault help command

IBU IBKUP Back up new and modified files

IQF IQF Interactive Query Facility

LOA LOAD Load file(s) from tape to Vault

MKA MARKA Mark file(s) to be archived




B-4 Vault Command Reference

MKD MARKD Mark file(s) to be deleted

MKR MARKR Mark file(s) to be restored

OPT OPNT Open a user-defined table

PUR PURGE Delete file(s) not previously marked for deletion

REA READ Copy file(s); modifications not allowed

REP REPLACE Save modified file(s); ability to modify ends

RES RESTORE Restore files from tape to Vault

RFS REMFS Remove a file set

RLS REMUSA Remove a user list/status code association

RMA REMMAS Remove a member from an attribute set

RMG READMSG Read messages

RML REMMUL Remove a member from a user list

RMS REMMFS Remove a member from a file set

RMT REMT Remove a user-defined table from Vault control

RSF RECSF Recover a single file

RSP RECSP Recover a storage pool

RST RESET Cancel signing out of file(s); changes are lost

RSV RESERVE Define and sign out an Vault file name for future use

RUP REMUP Remove a user from a project

RVP RSVP Respond to a review request

RVW REQRVW Request review of file(s)

SCN SCANTAPE List the contents of an Vault tape

SMG SENDMSG Send a message

SOF SIGNOFF Sign off and exit Vault session

SON SIGNON Sign on to Vault or another Vault user ID

SOT SIGNOUT Sign out file(s) to modify; file(s) not copied

STR STORE Add a new file

UBU UBKUP Back up entire Vault database

UMK UNMARK Unmark previously marked files

UNL UNLOAD Unload files to tape

UPT UPDATE Save modified file(s); continue modifications



Command AbbreviationsIQF Command Abbreviations


IQF Command Abbreviations

The following table lists the IQF command abbreviations.

Table B-2 IQF Command Abbreviations with their descriptions


BAK BACKWARD Scrolls a display towards the beginning

BOT BOTTOM Scrolls a display so the end is visible

BRK BREAK Inserts one or more empty lines into the display

CIF COMMANDINTERFACE

Calls the command interface

COL COLUMN Scrolls a display left to the specified column

EDT EDIT Accepts multiple IQF commands and then executes all

END END Ends display of a query result or help text

EXT EXIT Terminates IQF

FIL FILE Copies query result to a local file

FMT FORMAT Formats a display

FWD FORWARD Scrolls a display towards the end

HLP HELP Displays online IQF help

LFT LEFT Scrolls the display to the left

LST LIST Displays the current query

PRT PRINT Sends the query result to a printer

REC RECALL Retrieves the last successful SELECT command

RET RETRIEVE Retrieves the previous IQF command

RUN RUN Executes the current query

RYT RIGHT Scrolls the display to the right

SAV SAVE Copies the current query to a local file

SEL SELECT Specifies information to view

SET SET Assigns values to format parameters

SHO SHOW Displays the current format parameter settings

STA START Executes a current or stored query

TIF TERMINALINTERFACE

Calls the terminal interface

TOP TOP Scrolls a display towards the beginning

TYP TYPE Displays an IQF command file

Vault Command Reference C-1

Appendix C Using CADDS Commands toAccess the Vault Database

This appendix describes the CADDS commands GET PART, PUT PART, UPDATEPART, GET FILE, PUT FILE, GET FILESET, and PUT FILESET. Thesecommands are executed from within CADDS to access data in the Vault database.

• Introduction to CADDS and Vault

• GET PART

• PUT PART

• UPDATE PART

• GET FILE

• PUT FILE

• GET FILESET

• PUT FILESET

• Quick Reference for Vault Commands in CADDS

Using CADDS Commands to Access the Vault DatabaseIntroduction to CADDS and Vault

C-2 Vault Command Reference

Introduction to CADDS and Vault

To use Vault from within CADDS, you must sign on to Vault.

Starting the DBMS Process

Before you start CADDS and before you sign on to Vault, you must start a DBMSprocess which allows you to access Vault from within CADDS. The DBMSprocess must be running under the same user who is running CADDS. To start theDBMS process, enter the following command:

dbms &

There is no need to terminate the DBMS process after you leave CADDS. Beforeentering CADDS, verify that the DBMS process is running using the ps commandat the UNIX prompt. If you reboot your machine for any reason, you must start theDBMS process again before starting CADDS.

Signing On to Vault from Within CADDS

To sign on to Vault from within CADDS, you enter the DMPASSWORD parameterfollowed by your assigned Vault password when you use the GET command (eitherGET FILE, GET FILESET, or GET PART). This signs you onto the node fromwhich you are getting the file(s). If you do not specify a node with the NODEparameter, you are signed on to the default node set up by your systemadministrator.

You must enter the DMPASSWORD parameter with the first Vault command youissue during a CADDS session. You do not need to enter the DMPASSWORDparameter again during that session.

Alternatively, instead of entering your Vault password with the first Vaultcommand during a CADDS session, you can include the following line in your.caddsrc file:

setenv DMPASSWORD password

password has an eight character maximum. If this line is in your .caddsrc file,you do not need to enter your Vault password when you execute the first Vaultcommand in a CADDS session.



Re-enter the password if you change nodes on a subsequent GET or PUT and thepassword on the new node differs from that of the previous node.

Please note: To successfully log in to Vault, your Vault user ID and yourUNIX log in ID must be the same. See the Vault administrator if you have anydifficulties.

CADDS Command Description Format

The following format conventions are used to describe each CADDS command.

Description

The brief command description explains the general purpose, benefit, and use ofthe command.

Valid Modes

This entry specifies the CADDS level and the mode(s) in which you can use thecommand. For example, entries can take place within an active part or not in anactive part, in Model mode and/or Draw mode.

Syntax

This entry shows you the format to use when you type a CADDS command in itsgeneral form. A command consists of the verb/noun combination, modifiers (ifany), and getdata (if specified). Modifiers provide optional ways of using the basiccommand. Getdata allows you to enter information about locations and to identifyentities. Brackets surround optional parts of the command.

Modifiers

This chapter lists and describes the modifiers that you can use within the commandsyntax. You enter modifiers after the verb/noun combination. Optional modifiersare shown in brackets.

Examples

Examples clarify the command and its variations using modifiers. Brief writtendescriptions can accompany examples.



Vault Commands in UNIX and CADDS

The following four tables show comparisons between Vault commands entered atUNIX level and corresponding CADDS commands used to access and manipulatefiles in the Vault database.

Table C-1 GET noun (CADDS) and GET (UNIX) Compared

GET noun (CADDS) GET (UNIX)

GET GET

PART PART

FILE CADDS CATALOG

FILE SINGLE FILE

FILESET FILESET

NODE DMSERVER (SIGNON)

FILENAME SELNAME

FILENAME LFNAME

FILE PASSWORD FILEPW

Not available FILETYPE

OVERWRITE OVERLAY

Not specified (always FILE) OUTPUT

Not specified (always REPLACE) APPEND

N/A CATLEVEL

N/A DATECRIT

N/A DATE

N/A LDIRNAME

NEW RESERVE

GET READ

PART PART

FILE CADDS CATALOG

FILE SINGLE FILE

FILESET FILESET

READ Not used


FILENAME SELNAME

FILENAME LFNAME




Not available FILETYPE

PREFIX LDIRNAME

REVISION REVISION

N/A CATLEVEL

N/A DATECRIT

N/A DATE

OVERWRITE OVERLAY

N/A CONT



Table C-2 PUT noun (CADDS) and REPLACE (UNIX) Compared

PUT noun (CADDS) REPLACE (UNIX)

PUT REPLACE

PART PART

FILE CADDS CATALOG

FILE SINGLE FILE

FILESET FILESET

FILENAME SELNAME




PUT STORE

PART PART

FILE CADDS CATALOG

FILE SINGLE FILE

Table C-1 GET noun (CADDS) and GET (UNIX) Compared

GET noun (CADDS) GET (UNIX)



NEW STORE

FILENAME SELNAME

FILENAME (always CADDS format) LFNAME


Not specified (always CADDS) ENVIRONMENT

CLASS CLASS

PROJID PROJID


Not Available FILETYPE

Not specified STATCD

Not specified REVISION

Not specified SYSTYPE

Not specified USERTYPE

Not specified FILEDESC

Not specified PARTNUM

Not specified GTCODE



Table C-2 PUT noun (CADDS) and REPLACE (UNIX) Compared

PUT noun (CADDS) REPLACE (UNIX)

Using CADDS Commands to Access the Vault DatabaseGET PART


GET PART

Use the GET PART command to access a part in the database. No other user canactivate, modify, and/or file a part while it is signed out to you for modification.

When you execute the GET PART command, the following occurs:

1. The part and associated files are copied to the local CADDS database volume.

2. The part file is flagged in Vault, preventing other users from modifying the file.

3. The database notes that the part is accessed by your user name with modifyaccess.

The named part and any drawing files, figures, subassemblies, animation or otherTYPE 0 (undefined) files with the same name as the part are copied to your localsystem when the GET PART command is executed. If no part exists under thespecified name, and if you specify the NEW modifier, Vault reserves a place in thedatabase for the new part. You receive access to the part and an appropriatemessage is issued informing you that you reserved a new part. (You can use theNEW modifier only when accessing the Vault database.)

Please note: GET PART, not GET FILE, is recommended for part transfers. AGET PART request marks all associated files in the Vault database as a group, aGET FILE request does not.

Valid Modes

In CADDS, in or out of a Part or Drawing, in Model or Draw mode.

Syntax

GET PART partname [modifiers]

GET PART [PARTNAME] partname [NODE nodename] [DMPASSWORD password]FILEPASSWORD password [READ local directory name] [REVISION x] [NEW][PUBLIC] [PRIVATE] [PROJECT projectID]



Modifiers

[PARTNAME] partname

Names the requested part. You can enter the modifier PARTNAME but it is notrequired. Or, you can enter only the actual part name.

[DMPASSWORD password]

Signs you on to the Vault node you are getting the file(s) from. You must enterthe DMPASSWORD parameter with the first Vault command you issue during aCADDS session. You do not need to enter the DMPASSWORD parameter againduring that session. Alternatively, you can include the following line in your.caddsrc file:


password has an eight character maximum. You must reenter the password ifyou change nodes on a subsequent GET or PUT and the password on the newnode differs from that of the previous node.

[NODE nodename]

Names the requested node; the node that you specify is where the GETcommand goes to get the data. Supply both the modifier (NODE) and the actualnode name. Not required if you are using the default node. Node names can beas many as 18 alphanumeric characters.

FILEPASSWORD password

Is the password associated with one or more files in the part. Must be specifiedif passwords exist.

[READ local directory name]

Indicates you want read-only access to the named part. The system attaches thelocal directory name, followed by a period (.), to the specified part name,creating a new part name. A copy of the current part is copied to the local diskunder the new name. The part is not signed out of Vault. If you do not provide aprefix indicating the local directory name, the location of the copy is systemspecific. UNIX uses your CVpath or your current working directory (in thatorder) to create a new part name.

Please note: You can optionally include the PREFIX modifier immediatelyfollowing the READ modifier and immediately before the value local directoryname. PREFIX is a reserved word that indicates a local directory name follows it.

[REVISION x]

Specifies the revision level of the part and is available only with READ. A realnumber, denoting the revision, is required. The default is the highest revision, ifreleased, of the part. CADDS GET/PUT commands support only numericrevision codes.



[NEW]

Reserves a part name in the Vault database for a part that does not yet exist. Thismodifier is optional and can be included before or after the part name. Thedependent modifiers PUBLIC, PRIVATE, and PROJECT require the use of theNEW modifier.

[PUBLIC]

A classification group. This modifier allows any user with the proper authorityto access the part. This is the default.

[PRIVATE]

A classification group. This modifier indicates that you want only your username and the system administrator to have access to the part. A classificationgroup.

[PROJECT projectID]

This modifier indicates that you want only users assigned to that projectidentifier with the proper authority to have access to the part. Both the modifiername PROJECT and the project identifier name must be entered if this modifieris used. The project identifier must exist in Vault.



Examples

GET PART WING

CDMSON016I Sign on to EDM server NODENAME completedsuccessfully. You have 0 EDM message(s).CDMGET606I All of the file(s) requested have been processed.CDMSOF017I Sign off from EDM completed successfully.

In the first example, you gain access to the part. The system response confirms thatthe part was copied from Vault to your local disk. Notice that when you do notspecify the NODE modifier, the default node is assumed.

GET PART WING READ A

CDMSON016I Sign on to EDM server NODENAME completedsuccessfully. You have 0 EDM message(s).CDMREA606I All of the file(s) requested have been processed.CDMSOF017I Sign off from EDM completed successfully.

In this example you request read-only access to the part. Notice that the systemadds your prefix to the requested part when you gained access to it, and places thefiles in a subdirectory called A. This protection prevents you from overwriting theprimary version of the original part, having asked for read-only access.

Additionally, you have not locked out other users from this part. Anyone with therequired authority can receive a read-only copy of the part, even if the part has notbeen signed out for modify access.

Using CADDS Commands to Access the Vault DatabasePUT PART


PUT PART

The PUT PART command allows you to transfer a part back to Vault. Each PUTPART command, except PUT PART NEW, requires that a GET PART commandprecede it.

With GET PART, you gain access to the part you want to modify, modify the part,and then return it to Vault. When you return the part with PUT PART, three thingshappen:

1. The newly modified version is copied back to Vault.

2. The local copy is deleted from the local CADDS workpack.

3. The reference to the access of the part is deleted.

Parts created by the commands COPY PART and CONSTRUCT PART can also beput in Vault even though they have not been signed out with GET PART. If a part ofthe same name already exists, an overwritten version is not permitted by using thePUT PART command.

If you have access to a part in Vault, either of the following scenarios occur:

1. You enter the PUT PART command when you have modify access for the part.Your version of the part is copied back to Vault, overwriting the original part.The local copy is deleted, and your access reference is deleted.

If the part already existed, any drawing files that you deleted on your localversion can be flagged for deletion by the system manager and deleted at a laterdate.

2. You enter the GET PART READ command, naming a part for which you haveread-only access. A read-only copy is passed to the local disk with a new name,and the part is not signed out. This copy does not need to be returned to theControl Data Store. If you want to return this part, use the PUT PART NEWcommand. The NEW modifier is required because the part was given a new namewhen it was copied to the local disk with the GET PART READ command.

Please note: You cannot execute PUT PART for an active part. Execute EXITPART F or Q first.

Valid Modes

Within CADDS, in or out of a part or drawing, model or draw mode.



Syntax

PUT PART partname [modifiers]

PUT PART [PARTNAME] partname [NODE nodename] [DMPASSWORD password]FILEPASSWORD password [NEW] [PUBLIC] [PRIVATE] [PROJECT projectID]

Modifiers

[PARTNAME] partname

Names the part to be added or returned to the database. If your part name is thesame as a modifier name, enter the word PARTNAME before the part name. Thisno-name modifier allows you to name a part with the same name as a modifier.This naming choice is not encouraged.


Signs you on to the Vault node you are getting the file(s) from. You need onlyenter this DMPASSWORD during a CADDS session. Alternatively, you caninclude the following line in your .caddsrc file:



[NODE nodename]

Names the requested node; the node that you specify is where the PUTcommand goes to put the data. Supply both the modifier (NODE) and the actualnode name. Node names can be as many as 18 alphanumeric characters. Notrequired if you are using the default node.


Is the password associated with one or more files in the part. Must be specifiedif passwords exist. A password is not required when adding a new part to theVault database. If combined with NEW, this modifier associates the passwordwith the part name. A file password can be eight or fewer alphanumericcharacters.

[NEW]

Allows you to put a new part in the database. Do not use this modifier if youentered GET PART NEW for this part. The dependent modifiers PUBLIC,PRIVATE, and PROJECT require the use of the NEW modifier.

[PUBLIC]

A classification group, allowing any user with the proper authority to accessthis part. This is the default if you do not specify a classification group.



[PRIVATE]

A classification group, allowing only your user name and the systemadministrator to have access to this part.

[PROJECT projectID]

A classification group, allowing only users assigned to that project identifier(ID) with the proper authority to have access to this part. The project identifiermust already exist in Vault.

Example

PUT PART TEST.PART [CR]

CDMSON016I Sign on to EDM server NODENAME completed successfully.You have 0 EDM message(s).CDMREP882I The part has been replaced.CDMSOF017I Sign off from EDM completed successfully.

TEST.PART PUT into the database.

The messages in this example indicate that the part has been successfully stored inVault and is no longer signed out to you.

If you attempt to return the part to the Vault database but the system cannot serviceyour request, wait a minute, then the system can execute your request.

Using CADDS Commands to Access the Vault DatabaseUPDATE PART


UPDATE PART

Use the command UPDATE PART when you want to replace a part in Vault withyour modified version but still keep the part available for further modification. Ifyou have modify access to the part, you can use this command. Otherwise, asystem message reminds you that you do not have modify-access to the namedpart. Use the command PUT PART when adding new drawings to a part.

Valid Modes

Inside CADDS, in or out of a Part or Drawing, Model or Draw mode.

Syntax

UPDATE PART partname [modifiers]

UPDATE PART [PARTNAME] partname [NODE nodename] FILEPASSWORD password

Modifiers





[PARTNAME] partname

Names the part exactly as you accessed it using the GET PART command.

[NODE nodename]

Names the requested node; the node that you specify is where the part exists inVault. Supply both the modifier (NODE) and the actual node name. Node namescan be as many as 18 alphanumeric characters.

Not required if you are using the default node.


Is the password associated with one or more files in the part. Must be specifiedif passwords exist.

Using CADDS Commands to Access the Vault DatabaseUPDATE PART


Example

UPDATE PART TEST.PART

CDMSON016I Sign on to EDM server NODENAME completed successfully.You have 0 EDM message(s).CDMUPT887I The part has been updated.CDMSOF017I Sign off from EDM completed successfully.

TEST.PART UPDATED in the database.

In this example, changes made to the part are updated and stored in the Vaultdatabase. The part is still signed out to you and you can continue to modify it.

Using CADDS Commands to Access the Vault DatabaseGET FILE


GET FILE

The GET FILE command allows you to sign out a single file or a CADDS catalogof files from Vault. Possible outcomes from this command are as follows:

• Have all named file(s) available with modify access.

• Specify READ as a modifier in the command line for read-only access to the file.

• A system message reports no file found under that name or CADDS catalog.

You must include a file name or CADDS catalog name with the GET FILEcommand. The password after using with a file is required for any GET/PUToperation on that file.

GET FILE is not recommended for any part file transfers. Use GET PART toensure that all part related files are transferred.

Please note: Press ESCAPE and Q to interrupt multiple file transfers.

Valid Modes

Within CADDS, in or out of a Part or Drawing, and in Model or Draw mode.

Syntax

GET FILE filename [modifiers]

GET FILE [FILENAME] filename [NODE nodename] [SINGLE] [DMPASSWORDpassword] FILEPASSWORD password [READ prefix] [REVISION n]

Modifiers

[FILENAME] filename

Names the file or CADDS catalog of files to be accessed. The modifierFILENAME is optional. The actual file name is required. If not used withSINGLE, the system assumes the request is for a CADDS catalog.







[NODE nodename]

Names the requested node; the node that you specify is where the GETcommand goes to retrieve the data. Supply both the modifier (NODE) and theactual node name. Node names can be as many as 18 alphanumeric characters.Not required if you are using the default node.


Is the password associated with the file or with one or more files in the CADDScatalog. Must be specified if passwords exist. A file password can be eight orfewer alphanumeric characters. If you request a CADDS catalog, all files withthe entered password or no password are transferred.

[SINGLE]

Instructs the system to get only a single file, not an entire CADDS catalog offiles.

[READ prefix]

Indicates you want read-only access to the named file(s). The system attachesthe prefix, followed by a period (.), to the specified file name, creating a new filename. Files are not signed out of the Vault database when READ is used. Instead,a copy of the current Vault file is renamed and sent to the local disk.

[REVISION n]

Use this modifier with the modifier READ, to tell Vault which revision of the fileyou want. All associated files with that revision level can be transferred. If youdo not enter a revision level, files with the highest revision level, if released, arereturned. CADDS GET/PUT commands support only numeric revision codes.



Example

GET FILE AA.HELP

GET FILE AA.HELPCDMSON016I Sign on to EDM server NODENAME completedsuccessfully. You have 0 EDM message(s).CDMGET606I All of the file(s) requested have been processed.CDMSOF017I Sign off from EDM completed successfully.

AA.HELP transferred from the database.

In this example, the file is signed out to you and you can modify it.

Using CADDS Commands to Access the Vault DatabasePUT FILE


PUT FILE

The PUT FILE command gives you the ability to move a file or files, accessedwith a GET FILE command, from your local disk to Vault. The NEW modifierallows you to move a new file to the database. The PUT FILE command is notrecommended for part file transfers. Use PUT PART to ensure that all part relatedfiles are transferred.

Please note: Press ESCAPE and Q to interrupt multiple file transfers.

Valid Modes

Within CADDS, in or out of a Part or Drawing, and in Model or Draw mode.

Syntax

PUT FILE filename [modifiers]

PUT FILE [FILENAME] filename [NODE nodename] [DMPASSWORD password]FILEPASSWORD password [SINGLE] [NEW] [PUBLIC] [PRIVATE] [PROJECTprojectID]

Modifiers

[FILENAME] filename

Names the file or CADDS catalog of files to be returned to Vault. If you do notuse SINGLE, the system assumes you want to move an entire CADDS catalog.








[NODE nodename]

Names the requested node; the node that you specify is where the PUTcommand goes to put the data. Supply both the modifier (NODE) and the actualnode name. Node names can be as many as 18 alphanumeric characters.



Is the password associated with the file or one or more files in the CADDScatalog. Must be specified if passwords exist. A password is not required whenadding a new file or CADDS catalog to the Vault database. If combined withNEW, this modifier associates the password with the file or CADDS catalogname. A file password can be eight or fewer alphanumeric characters.

[SINGLE]

This modifier notes that the file is a single file, not an entire CADDS catalog offiles.

[NEW]

Indicates that you want to store a new file in the database. If you do not specifyNEW and a CADDS catalog is being returned to the database, only files alreadyaccessed are returned.

If you perform a GET FILE on a CADDS catalog, then add new files to theCADDS catalog while it is in your local storage area, run the PUT FILEcommand on the CADDS catalog twice, first without the NEW modifier toreplace the files that were originally in the CADDS catalog. Then run the PUTFILE command again, this time with the NEW modifier, to store the newlyadded files to the CADDS catalog in the Vault database.

The dependent modifiers PUBLIC, PRIVATE, and PROJECT require the use ofthe NEW modifier.

[PUBLIC]

A classification group, allowing any user with the proper authority to access thepart. This is the default if you do not specify a classification group.

[PRIVATE]

A classification group, allowing only your user name access to the part.

[PROJECT projectID]

A classification group, allowing only users assigned to that project identifierwith the proper authority to access the part.



Examples

PUT FILE HELP NEW PUBLIC SINGLE

CDMSON016I Sign on to EDM server NODENAME completed successfully.You have 0 EDM message(s).CDMSTR177I The file has been stored.CDMSOF017I Sign off from EDM completed successfully.

HELP PUT into the database.

This example shows how to store a new file in Vault. Vault deletes your local copy.The SINGLE modifier indicates a single file only, not a CADDS catalog of files.

PUT FILE AA.HELP NEW PUBLIC

CDMSON016I Sign on to EDM server NODENAME completed successfully.You have 0 EDM message(s).CDMSTR177I The catalog has been stored.CDMSOF017I Sign off from EDM completed successfully.

AA.HELP PUT into the database.

This example demonstrates how to return a CADDS catalog of files to thedatabase. Notice the SINGLE modifier is not used in this example.

Using CADDS Commands to Access the Vault DatabaseGET FILESET


GET FILESET

This command allows you to transfer sets of related files, or filesets, from an Vaultnode to your own CADDStation. The file sets are placed at CADDS level in yourlocal CADDS create directory. You receive a confirmation message upon thesuccessful transfer of each file in the file set. If the transfer cannot be completed,you receive a message stating why and the transfer is aborted.

Valid Modes

Only at CADDS level.

Syntax

GET FILESET FILESETNAME filesetname [modifiers]

GET FILESET FILESETNAME filesetname [DMPASSWORD password][NODE nodename] FILEPASSWORD password [READ prefix]

Modifiers

FILESETNAME filesetname

Names the file set to be transferred from Vault to CADDS. Must be specified.





[NODE nodename]

Indicates the node from which the file set is to be transferred. Optional.


Is the password associated with one or more files in the file set. Must bespecified if passwords exist.

Using CADDS Commands to Access the Vault DatabaseGET FILESET


[READ prefix]

Specifies that you do not want to have Vault sign out the file set. Names theprefix you want prepended to the file set name. Optional.

Examples

GET FILESET TESTFS3 READ AB

CDMSON016I Sign on to EDM server NODENAME completed successfully.You have 0 EDM message(s).CDMREA606I All of the file(s) requested have been processed.CDMSOF017I Sign off from EDM completed successfully.

TESTFS3 transferred from the database.

In this example, the READ modifier gives you a copy of the files in the file setTESTFS3, places the files in a subdirectory called AB, and allows you read-onlyaccess to the files in the database. The files are not signed out to you.

GET FILESET TESTFS3

CDMSON016I Sign on to EDM server NODENAME completed successfully.You have 0 EDM message(s).CDMGET606I All of the file(s) requested have been processed.CDMSOF017I Sign off from EDM completed successfully.

TESTFS3 transferred from the database.

Using CADDS Commands to Access the Vault DatabasePUT FILESET


PUT FILESET

This command allows you to transfer sets of related files, or filesets, from yourCADDStation to an Vault node. file sets are placed in whichever node you specifyin the command line. You must enter PUT FILESET from a CADDStation atCADDS level.

Only those file sets you have signed out with the GET FILESET command can betransferred. All files in the file set must already exist in the target Vault database.

You receive a confirmation message upon the successful transfer of each file in thefile set. After a file set is successfully transferred, all files are deleted from theCADDStation directory, including the cross-reference file.

Valid Modes

Only at CADDS level.

Syntax

PUT FILESET FILESETNAME filesetname [modifiers]

PUT FILESET FILESETNAME filesetname [DMPASSWORD password][NODE nodename]

Modifiers

FILESETNAME filesetname

Names the file set to be transferred from the CADDS user to Vault. Must bespecified.


Signs you on to the Vault node you are putting the file set to. You need onlyenter this DMPASSWORD during a CADDS session. Alternatively, you caninclude the following line in your .caddsrc file:



Using CADDS Commands to Access the Vault DatabasePUT FILESET


[NODE nodename]

Names the node to which the file set is to be transferred. Must be the node thefile set was retrieved from. Optional.

Examples

PUT FILESET TESTFS3

CDMSON016I Sign on to EDM server NODENAME completed successfully.You have 0 EDM message(s).CDMREP882I The file set has been replaced.CDMSOF017I Sign off from EDM completed successfully.

TESTFS3 PUT into the database.

This example stores TESTFS3 in Vault and deletes your local copies. The files areno longer signed out to you.

Using CADDS Commands to Access the Vault DatabaseQuick Reference for Vault Commands in CADDS


Quick Reference for Vault Commands in CADDS

PUT PART

PUT PART[PARTNAME] partnameNODE nodenameDMPASSWORD passwordFILEPASSWORD passwordNEWPUBLICPRIVATEPROJECT projectID

GET PART

GET PART [PARTNAME] partnameNODE nodenameDMPASSWORD passwordFILEPASSWORD passwordREAD local directory nameREVISION xNEWPUBLICPRIVATEPROJECT projectID

UPDATE PART

UPDATE PART [PARTNAME] partnameNODE nodenameFILEPASSWORD password

GET FILE

GET FILE [FILENAME] filenameNODE nodenameSINGLEDMPASSWORD passwordFILEPASSWORD passwordREAD prefixREVISION n

Using CADDS Commands to Access the Vault DatabaseQuick Reference for Vault Commands in CADDS


PUT FILE

PUT FILE [FILENAME] filenameNODE nodenameDMPASSWORD passwordFILEPASSWORD passwordSINGLENEWPUBLICPRIVATEPROJECT projectID

GET FILESET

GET FILESET FILESETNAME filesetnameDMPASSWORD passwordNODE nodenameFILEPASSWORD passwordREAD prefix

PUT FILESET

PUT FILESET FILESETNAME filesetnameDMPASSWORD passwordNODE nodename

Vault Command Reference Glossary-1

Glossary

Access type

Determines how to open an SQL table or view for accessing. Choose S toselect, M to modify.

Action

A one-character string that indicates the action to be performed. Enter Afor Add or R for Remove.

Active

A flag that indicates whether or not Vault should connect to the triggeredprocess. Enter Y for yes or N for no.

APPEND

Append new audit information to audit file for UBKUP Enter Y or N. Nmeans that Vault erases the content of the existing audit file.

Application entity name

Application entity name of the triggered process in the NSM configurationfile. An alias is also allowed. Enter as many as 32 letters and/or numbers.

Approval type

A code that specifies the kind of approval needed for review of a file. EnterU for Unanimous, M for Majority, or N for Number of rejects.

Attribute file

The name of a local file that contains a list of attributes.

Glossary

Glossary-2 Vault Command Reference

Attribute name

The name of an attribute. Enter as many as 24 characters including onlyA-Z, 0-9, hyphen, and underscore.

Attribute set name

The name of an attribute set. Enter as many as 24 characters including onlyA-Z, 0-9, hyphen, and underscore.

Attribute type

The type of an attribute. Enter CHARACTER, NUMBER, or DATA, or asmany as 24 characters, including only A-Z, 0-9, hyphen, and underscore, ifyou have defined your own attribute types.

Audit destination

A code that specifies the destination of output from the command. Enter Sfor screen, F for local file, B for both, or M for message only.

Authority group name

The name of a set of authority numbers and/or ranges of authoritynumbers. Include as many as eight alphanumeric characters.

Authority number(s)

A list of authority numbers (and/or authority ranges). Enter up to 300characters, including numbers, commas, and hyphens. Separate eachindividual number from the next by a comma (for example, 5,10,50).Separate each number within a range by a hyphen (for example,10,30-40,50). The list cannot include blank spaces.

Change type

A code that specifies whether to add or remove commands from anexisting command list. Enter A for add or R for remove.

Classification

A code that indicates the extent of the access to the file. Enter PUB forPublic, PRO for project or PRI for private.

CLEAR

Enter Y or N. Indicates whether or not to delete old entries from theBackup Table.

Glossary


Command description

Text that describes the function of a command. This is the same text thatappears on the menu from which you choose the command.

Command file name

The name of a file that contains the names of Vault commands to be addedor removed from a command list. Enter as many as 80 alphanumericcharacters.

Command keyword

Keyword that the attribute rule operates on. Enter CLASS, PARTNUM,PROJID, STATUS, USER, or USERTYPE.

Command list name

A unique name that identifies a user-defined list of Vault commands.Include as many as eight alphanumeric characters.

Command name

A name that identifies an Vault command (GET, STORE, RESET).

Comments

Text that describes an action.

COMPACT

Compress the data as the pools are backed up by the UBKUP command?Enter Y or N.

Continue

Indicates whether to transfer an additional copy of a file already signed outto the user. Enter Yes or No.

Contract number

A number of a contract associated with an Vault project ID. Include asmany as 25 alphanumeric characters. This is a user-defined parameter;Vault does not use this information.

Copy from

A project ID, command list name, authority group name, or user list nameto be copied from. Include as many as 24 alphanumeric characters.

Glossary


Copy name

The name of a copy of an entity. Include as many as 80 alphanumericcharacters.

Copy to

A project ID, command list name, authority group name, or user list nameto be copied to. Include as many as 24 alphanumeric characters.

Copy type

A code that specifies the Vault entity to copy. Enter SA to copy anauthority scheme, PU to copy project users, UL to copy a user list, AG tocopy an authority group, and CL to copy a command list.

CYCLES

The number that specifies how many universal backup cycles to keep.Enter a number from 01 to 99. Required if CLEAR=Y.

Date

A USA or European standard date format. For USA format: the numberrepresenting the month, followed by a slash (/), followed by day of themonth, followed by a slash, followed by the year. For example, 05/01/89for May 1, 1989. For the date in European format: day, followed by aperiod (.), followed by the number representing the month, followed by aperiod, followed by the year. For example, 01.05.89 for 1 May, 1989.

Date criteria/Date scope

A code that specifies how to use the date when signing out, loading,unloading, or listing files. Enter one of the following:

B—Select files modified before the date entered

S—Select files modified on or since the date entered

N—Select all eligible files (no date scope)

Default value

Indicates the default value for the attribute being added to an attribute set.

Glossary


Description

Text that describes a project, attribute, attribute set, or file set Include asmany as 30 alphanumeric characters. This is a user-defined parameter;Vault does not use this information.

Does user have administrative privileges?

Enter Yes or No. Yes indicates that for commands in the user’s commandlist, the user need not enter passwords to access password-protected files.No indicates that the user must use passwords for password-protected files.

Domain name

The name of the domain to which you are signing on. Enter 32 or fewerletters and/or numbers or leave blank for the default Vault node.

Environment

This tells Vault where to find local files. Enter CADDS or LOCAL.

File description

Text that specifies the contents of a file. Include as many as 25alphanumeric characters. This is a user-defined parameter; Vault does notuse this information.

File password

A password that is associated with an Vault file to password protect thatfile. Include as many as 8 alphanumeric characters.

File set description

A description of a file set. Enter 30 or fewer alphanumeric characters,including blanks.

File set name

The name of a set of files. Include as many as 80 alphanumeric characters.

File type

A CADDS code that specifies the type of CADDS file stored in Vault.Include 2 hexadecimal digits.

Glossary


Group technology code

A code that specifies the group technology field associated with the part orfile. Include as many as 32 alphanumeric characters. This is a user-definedparameter; Vault does not use this information.

Include all commands?

Enter Yes or No. Yes indicates that all valid Vault commands are to beassociated with the command list name. No indicates that you can definethe subset of commands that are to be associated with the command listname.

INPUT

A one-character value that indicates whether the storage pools to bebacked up are listed in the command or in a file. Enter L for Listed in thecommand or F for listed in a File.

Input field

A code that indicates whether you want to add or remove the commandfrom the command list. Enter A to add the command to the command list.Enter R to remove the command from the command list. Leave the fieldblank when you do not want to make a change for a command.

Last update date

The last date the file was updated. Enter as mm/dd/yy for USA format ordd.mm.yy for European format.

Last update time

The last time the file was updated. Enter as hh:mm:ss to indicate time.

List destination

A code that specifies the destination of the list generated by the LISTDIRcommand. Enter S for screen, F for local file, or B for both.

List file name

The name of the file that contains the listing generated by the LISTDIRcommand. Include as many as 80 alphanumeric characters.

Glossary


List format

A code that specifies if the LISTDIR output should be in long or shortform. Enter S for short or L for long.

List type

A code that specifies how the user list functions. Enter one of thefollowing:

R—Review list

N—Notification list

P—Post-approval list

Load type

A code that specifies how to load files. Enter one of the following:

S—Store the files as new files

R—Replace existing files

N—Replace existing files if the copy on the tape is newer

Local directory name

The name of the local directory/mini-disk to which a file can be transferred.Include as many as 80 characters.

Local file name

The name of a local file. Include as many as 80 characters.

Mark type

A code that indicates how the files were marked. Enter one of thefollowing:

A—Files marked for archive

D—Files marked for delete

R—Files marked for restore

Member description

Text that describes a member of a file set. Include as many as 30alphanumeric characters.

Glossary


Member name

The name of a part, file, file set, attribute set, or user-defined item. Includeas many as 80 alphanumeric characters.

Member revision code

See “Revision code” on page -11.

Member type

A code that specifies the type of Vault entity the file set member is. Enterone of the following:

F—Vault file

P—CADDS part

S—Vault file set

U—User-defined item

Also, a code that specifies the type of Vault entity the attribute set memberis. Enter A for an attribute or S for an attribute set.

Message

A message that you want to send to one or more users. Include as many as240 alphanumeric characters.

Message number

A number that Vault assigns to each message sent by the SENDMSGcommand or sent by Vault. Include as many as 10 alphanumericcharacters.

New Vault name

See “Vault file name” on page Glossary-16.

Number of cycles kept

A number that indicates how many universal backup cycles to keep in theBackup Table. Valid numbers 00 through 99.

Operator

Operator that the attribute rule uses to determine whether or not to applythe attribute. Enter an equals sign (=) to indicate an exact match, enter

Glossary


angle brackets (<>) to indicate “not equal to”, or enter the keyword LIKEto indicate some matching characters. LIKE is an SQL wildcard operator.

Overwrite existing local file?

Indicates whether or not to overwrite the existing local file. Enter Y or N.

Part number

Part numberA part number associated with a file. Include as many as 20alphanumeric characters. This is a user-defined parameter; Vault does notuse this information.

PARTIAL

Continue the universal backup even if some of the pools are currentlyunavailable? Enter Y or N.

PAUSE

Query the operator during universal backup? Enter Y or N. For example, ifa pool is busy and PAUSE=Y, you can instruct Vault to try again. WhenPAUSE=N, the backup aborts.

POOLS

Used in conjunction with the INPUT keyword. Indicates the name of thestorage pools to process. Enter * (asterisk) when INPUT=L to indicate allstorage pools. Or, enter a list of pool names enclosed in parentheses, notincluding blanks, and separated by commas to specify those storage poolswhen INPUT=L. Enter a local file name when INPUT=F to indicate thatthe file contains the names of the storage pools to be backed up. The filemust be a text file and each storage pool name must be on a separate line inthe file. The file must be in your current working directory or you mustspecify the full path name.

Project description

Text that describes a project identified by a project ID. Include as many as30 alphanumeric characters. This is a user-defined parameter; Vault doesnot use this information.

Project ID

A name that identifies an Vault project. Include as many as eightalphanumeric characters.

Glossary


Project name

A name associated with an Vault project ID. Include as many as 15alphanumeric characters. This is a user-defined parameter; Vault does notuse this information.

Protection group code

A code that represents a CGOS protection group. Include fourhexadecimal digits between 0000 and FFFF.

Qualified table or view name

Fully qualified name of an SQL table or view which has been added to thecontrol of Vault. Include as many as 61 characters. The default isCREATOR.TABLENAME.

Read authority number

A number that associates a user’s read authority with a status code and viceversa. Numbers in the range 00 to 99 are allowed. Vault uses the readauthority number to control the user’s ability to read Vault files. Users canread files that have status codes whose associated authority numbers areless than or equal to the user’s read authority number.

Read authority group name

The previously defined name of a set of authority numbers and/or rangesof authority numbers. Vault uses the read authority group name to controlthe user’s ability to read Vault files. Include as many as 80 alphanumericcharacters.

Read message action

A code that specifies the READMSG action to perform. Enter one of thefollowing:

N—Scroll to next message

P—Scroll to previous message

E—Erase message

A—Create audit listing of messages

Reject count

A three-digit number that specifies the maximum number of rejections thatallow approval of a status change.

Glossary


Remove user from all projects?

Enter Yes or No. Yes indicates you want to delete the user from all assignedprojects. No indicates you want to delete the user from a specified projectonly.

Replace or append audit file?

A code that specifies whether to replace the existing audit directory with anew directory that reflects the current transaction data, or to append thecurrent transaction data to the existing audit directory. Enter R for replaceor A for append.

Required or optional?

Indicates whether applying the attribute set member is required or optional.

Response

A code that specifies a review response. Enter A for approval or R forrejection.

RESTART

Enter Y or N. Indicates whether to resume a process where it stopped orstart over again.

Restore all marked files?

Enter Yes or No. Yes restores all files marked for restore. No indicates thatyou can specify a single file to restore.

Revision code

A code that distinguishes the revision of an Vault file or part. Include asmany as 20 alphanumeric characters.

Revision sequence name

The previously defined name of a revision code sequence. Enter 8 or fewerletters and/or numbers.

Rule name

Name of the rule you are defining for applying attributes. Enter as many as24 characters—A-Z, 0-9, hyphen or underscore.

Glossary


Selection name

The name of the entity you want the command to act upon. The selectionname must correspond to the selection scope. Enter a file name, part name,file set name, project ID, or user ID. Include as many as 80 characters.

Selection scope

A code that specifies the entity upon which you want the command to act.Valid codes are:

F—Single file

D—Directory

P—Part

L—List of files and/or parts

S—File set

U—All private files of a user

E—All files in the Vault file directory

Sequence number

A number that establishes order in a list or authority scheme. Numbers inthe range 0000 to 9999 are allowed. Vault right justifies numbers with lessthan four digits and pads the left with zeros.

Sign out file?

A code that designates whether a file should be signed out to the userreserving the file name. Enter Y (yes) or N (no).

SQL ID

The SQL user name or ID of the SQL user who created the table or view.Enter as many as 30 characters.

SQL password

The SQL password of the SQL user who created the table or view. Enter asmany as 30 characters.

Status code

A code that represents a phase of work in an Vault authority scheme.Include eight or fewer alphanumeric characters (no blanks).

Glossary


Status description

Text that describes the phase of work that a status code represents. Includesas many as 30 alphanumeric characters. This is a user-defined parameter;Vault does not use this information.

Status partition code

A code that distinguishes a special status level. Enter I or R, or leave blank.I flags the initial in-work status level. R flags the initial released statuslevel. A blank indicates a status level that is neither the initial in-workstatus level nor the initial released status level. The I and the R partition anauthority scheme into dormant status levels, in-work status levels, andreleased status levels.

Storage pool information

Specific operating system information needed to access the physicalstorage area. The format is defined in the EDS for the respective platform.Include as many as 240 alphanumeric characters.

Storage pool name

A logical name associated with a physical area of storage. Include as manyas eight alphanumeric characters.

Storage pool status

A one-character status value. The following values are allowed:

0—Available and online

1—Locked in write-mode by Vault

2—Read-only

3—Offline

4—Unavailable as detected by Vault

5—Unavailable due to media failure

6—Tagged for roll forward by the RECSP command

7—Recovered by RECSP

8-9—Reserved for future use

A-Z—Unavailable with user-defined reason

Glossary


Values 0-9 are defined by Vault and stored in a two-column database table.These columns are for the actual status value and a description. Values A-Zare user-defined values that are loaded into the database by a flat file.Treatment of values A-Z is functionally equivalent to the status value of 3(offline).

Storage pool type

A 32-character string without embedded blanks that contains thecategorization value.

System type

A code that identifies the system the file was created on. This is auser-defined parameter. Vault does not use this information. Include asmany as eight alphanumeric characters.

Table or view name

Name of an SQL table or view to be added or removed form the control ofVault. Include as many as 30 characters.

Tape file name

The name of an Vault file when it is on a tape. Include as many as 80characters. Applies only to VAX servers.

Tape serial number

The name assigned to and written on an Vault tape to distinguish the tape.Include as many as 6 alphanumeric characters.

Tape unit

The name of the local tape device to be used. Valid values are TAPE1,TAPE2, TAPE3, TAPE4, and TAPE5.

Termination count

A number from 000 to 999 that specifies the number of rejections neededto end the review of the specified entity.

Test value

Exact value that the rule uses the operator on. This value must exactlymatch what the keyword expects. For example, you can enter only PRO,PRI, or PUB when the command keyword is CLASS. Enter as many as

Glossary


240 letters, numbers, or special characters. When the operator is LIKE, youcan include a percent sign (%) to represents one or more characters.

Time

Standard time format using a 24-hour clock. Enter the hour, followed by acolon (:), minutes, followed by a colon, seconds. For example, 14:07:25 forseven minutes and twenty-five seconds past 2 p.m.

Timeout

Maximum number of seconds Vault waits for a triggered process to return aresponse before (WBTIME parameter) or after (WETIME parameter) Vaultcommand execution. Enter a number from 0 through 32767.

Trigger at beginning

A flag that indicates whether or not Vault should connect to the triggeredprocess at the beginning of command execution. Enter Y for Yes or N forNo.

Trigger at end

A flag that indicates whether or not Vault should connect to the triggeredprocess at the end of command execution. Enter Y for Yes or N for No.

Unit of measure

A code that identifies the unit of measure that the project uses. Include asmany as five alphanumeric characters, for example., FEET, METER. Thisis a user-defined parameter; Vault does not use this information.

Unload type

A code that specifies how to unload files. Enter one of the following:

G—Get, unload and sign out the file

R—Read, unload for reading purposes

User description

Text that describes a user in relation to Vault. Include as many as 30characters. This is a user-defined parameter; Vault does not use thisinformation.

Glossary


User full name

A full name associated with a user ID. Include as many as 25 characters.This is a user-defined parameter; Vault does not use this information.

User group

A code that Vault uses to place users in a particular group. Include one ortwo characters.

User last name

A last name associated with a user ID. Include as many as 15 characters.This is a user-defined parameter; Vault does not use this information.

User list description

A description of a user list. Include as many as 30 alphanumericcharacters, including blanks.

User list member name

The name of an Vault user or user list which is a member of a user list.Include as many as 24 alphanumeric characters.

User list member type

Designates the type of the user list member. Enter U for user ID, A for allusers on the list to receive a message, or O for only one user on the list tovote.

User list name

A name that identifies an ordered list of Vault users. Include as many as 24alphanumeric characters.

User-defined type

A code that users define to use for any purpose they want. Include as manyas eight alphanumeric characters. Vault does not use this parameter.

Vault file name

The name the file has in the Vault database. Include as many as 80alphanumeric characters.

Glossary


Vault user ID

A name that identifies an Vault user. Include as many as 12 alphanumericcharacters.

Vault user password

A password associated with a user ID. You must correctly enter thepassword before you can use Vault. The password is encoded so it cannotbe read. Include as many as eight alphanumeric characters.

Write authority number

A number that associates a user’s write authority with a status code andvice versa. Numbers in the range 00 to 99 are allowed. Vault uses the writeauthority number to control the user’s ability to modify Vault files. Userscan modify files that have status codes whose associated authority numbersare less than or equal to the user’s write authority number.

Write authority group name

The previously defined name of a set of authority numbers and/or ranges ofauthority numbers. Vault uses the write authority group name to control theuser’s ability to modify Vault files. Enter as many as 8 characters.

Vault Command Reference Index-1

Index

Symbols$$COPYATTR parameter 3-251

Positioning in attribute file 3-251

Setting 3-251

&UNIX systems 2-9

=on UNIX systems A-7

AAccessing

database from CADDS C-7

ACCTYPE keywordOPNT 3-208

ACTIONID keyword, ADDSUB 3-39

ACTIVE keyword, CHGCTL 3-73

ADDALIAS command 3-10

ADDASET command 3-11

ADDATRBS command 3-13

ADDATTR command 3-16

ADDCL command 3-18

ADDFS command 3-21

Addingattribute data

to binders and relationships 3-13

to files and parts 3-61

attribute definitionsfor binders and relationships 3-131

for files and parts 3-22

attribute rulesfor parts and files 3-35

Distributed Object Directory 3-7

enumeration setnames 3-134

values 3-20

filesto existing parts 3-288

membersto binders 3-31

to file sets 3-24

to user lists 3-26

to vault lists 3-55

object types 3-135

remote vaults 3-53

storage pools 3-38

user aliases 3-10

ADDMAS command 3-22

ADDMFS command 3-24

ADDMUL command 3-26

ADDOBJ command 3-28

ADDP command 3-30

ADDREL command 3-31

ADDRS command 3-33

ADDRULE command 3-35

ADDS command 3-36

ADDSP command 3-38

ADDSUB command 3-39

ADDUL command 3-47

ADDUP command 3-48

ADDVLIST command 3-54

ADDVLMEM command 3-55

ADMCOPY command 3-56

ADMIN keywordADDU 3-44, 3-45

ADDUP 3-48, 3-49

CHGU 3-106, 3-107

Index

Index-2 Vault Command Reference

CHGUP 3-113

Administrativecopy 3-56

privilegesassigning

project 3-48

changingproject 3-113

public 3-44, 3-45

transaction logdeleting entries 3-149

AENAME keywordmixed case

UNIX systems 2-13

AENAME keyword, CHGCTL 3-73

ALL keywordwith command lists 3-72

with command triggers 3-75

ALLCMDS keywordADDCL 3-18

ALLPROJ keywordREMUP 3-244

AMEMNAME keywordADDMAS 3-22

CHGMAS 3-99

REMMAS 3-237

AMEMTYPE keywordADDMAS 3-22

CHGMAS 3-99

REMMAS 3-237

AmpersandUNIX systems 2-9

Answering messages 3-271

APPEND keywordARCHIVE 3-58

audit files 2-5

CHGFA 3-79

CHGFCL 3-83, 3-89

CHGFSC 3-94

LISTDIR 3-188

LOAD 3-192, 3-193

LOCATE 3-196

MARKA 3-198

MARKD 3-202

MARKR 3-205

PURGE 3-209

READ 3-211, 3-212

READMSG 3-219

RECSP 3-224

REPLACE 3-249

REQRVW 3-255

RESET 3-261

RESTORE 3-264

STORE 3-278, 3-279

APPTYPE keywordADDUSA 3-51

ARCHIVE command 3-58

Archivingcatalogs

after marking 3-58

file setsafter marking all members 3-58

filesafter marking 3-58

partsafter marking 3-58

projectsafter marking all files 3-58

restoring archived data 3-264

Assigningattribute data

to binders and relationships 3-13

to files and parts 3-61

attribute definitionsfor binders and relationships 3-131

for files and parts 3-22

membersto file sets 3-24

to user lists 3-26

users to projects 3-48

ASSOCIAT command 3-61

Associatingevents and actions 3-39

ATRB keywordCHGADEF 3-64, 3-65

DEFATRB 3-131, 3-132

DELADEF 3-136

ATRBDATA keywordADDOBJ 3-28

ADDREL 3-31

CHGATRBS 3-68

ATRBGRP keywordCHGADEF 3-64, 3-65

CHGDESC 3-76, 3-77

DEFAGRP 3-129

DEFATRB 3-131, 3-132

DELADEF 3-136

ATRBGRPTYPE keyword


Index

DEFAGRP 3-129

ATTRDESC keywordADDATTR 3-16

ATTRFILE keywordASSOCIAT 3-61, 3-62

CHGUATTR 3-109, 3-110, 3-117, 3-118, 3-241, 3-242

COPYATTR 3-127, 3-128

GET 3-165

READ 3-211, 3-212

READATTR 3-217

REPLACE 3-249

STORE 3-278, 3-279

ATTRIBUTE keywordREMUATTR 3-241, 3-242

AttributesCADDS

on UNIX systems A-10

filewhen storing 3-278

project 3-30

changing 3-100

user-definedadding definitions

for binders and relationships 3-131

for parts and files 3-16

to attribute setsfor parts and files 3-22

adding group namesfor binders and relationships 3-129

adding set namesfor parts and files 3-11

associating to parts or files 3-61

attribute fileGET 3-167

REPLACE 3-63, 3-251

STORE 3-286

UPDATE 3-305

changing definitionsfor binders and relationships 3-64


changing valueson binders and relationships 3-67

on parts and files 3-109, 3-117

defining rulesfor binders and relationships 3-131


deletingdefinitions


for parts and files 3-143, 3-237

group namesfor binders and relationships 3-138

rulesfor parts and files 3-157

set namesfor parts and files 3-139

valuesfor binders and relationships 3-140


validatingfor binders and relationships 3-309


viewingfor binders and relationships 3-179


ATTRNAME keywordADDATTR 3-16

ATTRTYPE keywordADDATTR 3-16

Audit filesARCHIVE 3-60

CHGFA 3-81

CHGFCL 3-63, 3-86, 3-119, 3-218

CHGFPW 3-90

CHGFSC 3-96

content 2-5

COPY 3-125

DELETE 3-147

file transfer commandson UNIX systems A-2

GET 3-166

LISTDIR 3-190

LOAD 3-195

MARKA 3-201

MARKD 3-204

MARKR 3-206

PURGE 3-210

READ 3-213

RECSP 3-224

REPLACE 3-252

REQRVW 3-256

RESET 3-262

RESTORE 3-266

Index


SCANTAPE 3-270

SIGNOUT 3-276

STORE 3-286

UNLOAD 3-299

UNMARK 3-301

UPDATE 3-306, 3-312

AUTHGRP keywordCHGAG 3-66

AUTHNUM keywordADDS 3-36

CHGS 3-102

AUTHNUMS keywordCHGAG 3-66

Authority groupscopying 3-56

definition 3-8

deleting 3-137

displaying current numbers 3-66

precedence 3-46, 3-50

Authority numberschanging project user assignment 3-113

precedence 3-46, 3-50

range 3-46

specifying in authority groups 3-9

Authority schemeschanging status levels 3-102

defining status levels 3-36

deletingprojects 3-154

status levels 3-158

project 3-36

public 3-36

sequence numbers 3-36

status codes 3-36

status levels 3-36

status partition codes 3-36

Automatedstatus code changes 3-52

BBacking up

cleaning the Backup Table 3-294

incremental 3-172

universal 3-291

BACKWARD commandIQF 4-4

BASECLASS keyword

CHGADEF 3-64, 3-65

CHGATRBS 3-68

CHGDESC 3-76, 3-77

DEFAGRP 3-129

DEFATRB 3-131, 3-132

DEFOTYPE 3-135

DELADEF 3-136

LISTDICT 3-179

LISTSTRU 3-191

BEGIN keyword, CHGCTL 3-73

Bindersadding members 3-32

assigningattribute data 3-13

changingattribute values 3-67

classifications 3-83

revision codes 3-92

status codes 3-94

creating 3-28

object types 3-135

deletinginstances 3-151

listing 3-179

tree structure 3-191

readingmember files and parts 3-211

replacingmember files and parts 3-249

requesting reviews 3-255

resetting 3-261

review requests 3-255

signing outmember files and parts 3-164, 3-274

Blank revision sequences 3-33

BLANKS optionSET command 4-29

BOTTOM commandIQF 4-5

BREAK commandIQF 4-6

BTITLE optionFORMAT command 4-13

SHOW command 4-31


Index

CCADDS

attributeson UNIX systems A-10

catalogson UNIX systems A-7, A-11, A-12

commandsand Vault commands C-4

GET FILE C-16

GET FILESET C-22

GET PART C-7

PUT FILE C-19

PUT PART C-11

UPDATE PART C-14

create directoryon UNIX systems A-7

file namesand STORE command

on UNIX systems A-7

character conversionon UNIX systems A-11, A-14

partstransferring from Vault

to UNIX systems A-11, A-12

signing on to Vault from CADDS C-1

Cancellingreserved name 3-261

signout 3-261

Case sensitivity 2-8

Case translationVault commands and keywords

UNIX systems 2-12

Vault file nameson UNIX systems 2-13

Catalogsadding to database 3-278

archivingafter marking 3-58

cancelling signout 3-261

changingclassifications 3-83

passwords 3-89

status codes 3-94

copyingfrom tape to Vault 3-192

from Vault to tape 3-296

deletingafter marking 3-146

marking 3-202

purging 3-209

loading from tape to Vault 3-192

markingto delete 3-202

modifying 3-164

purging 3-209

read only 3-211

replacing 3-249

resetting 3-261

restoringafter marking 3-264

signing out 3-164

without copying 3-274

storingon UNIX systems A-7

storing in Vault 3-278

tape listing 3-269

transferring from Vaulton UNIX systems A-11

unloading from Vault to tape 3-296

CATLEVEL keywordUNLOAD 3-274, 3-296

CGOSFUTIL and SAVFIL formats

loading 3-194

unloading 3-298

Changingcommand trigger attributes 3-73

descriptions 3-76

passwordsyours 2-15, 3-116

projectsattributes 3-100

IDs 3-100

names 3-100

revision code sequences 3-100

user authorities 3-113

status levels 3-102

storage poolsmoving a file 3-98

status 3-104

system attributesclassifications 3-83

Index


passwords 3-89

revision codes 3-92

status codes 3-94

user lists 3-26, 3-239

user-defined attributesdefinitions





usersproject authorities 3-113

your password 3-116

Character conversionon UNIX systems A-11, A-14

Checking files into Vault 3-249, 3-278

CHGADEF command 3-64

CHGATRBS command 3-67

CHGCTL command 3-73

CHGDESC command 3-76

CHGFCL command 3-83

CHGFPW command 3-89

CHGFREV command 3-92

CHGFSC command 3-94

CHGFSP command 3-98

CHGMAS command 3-99

CHGP command 3-100

CHGS command 3-102

CHGSPS command 3-104

CHGTYPE keywordCHGCL 3-72

CHGUATTR command 3-109

CHGUP command 3-113

CHGUPW command 3-116

how to use 2-15

CIHELP command 3-171

UNIX systems 2-16

CLASS keywordADDOBJ 3-28

CHGFCL 3-83

LOAD 3-192, 3-193

RESERVE 3-257

STORE 3-278, 3-279

Classificationsassigning 3-278

changing 3-83

CLASSIFY command 3-117

Classifying

attributesfor parts and files 3-117

Closing tables 3-120

CLST command 3-120

CMDFILE keywordADDCL 3-18, 3-72

CMDLIST keywordADDCL 3-18

ADDU 3-44

ADDUP 3-48

CHGCL 3-72

CHGU 3-106, 3-107

CHGUP 3-113

COLUMN commandIQF 4-8

Column numbers 4-8

COLUMN optionFORMAT command 4-13

Command filesdisplaying 4-35

COMMAND keyword, CHGCTL 3-73

Command linecontinuation characters

UNIX systems 2-11

Command listsADMCOPY rules 3-56

assigningfor projects 3-48

changingusersassignedlists

forprojects' 3-113

copying 3-56

creating 3-18

deleting 3-144

Command triggersactivating all 3-75

AENAME keywordUNIX systems 2-13

changing attributes 3-73

definition 3-74

e-mailusing on UNIX systems 2-18

modifying list 3-73

Command-line formatcommas in

UNIX systems 2-10, 2-11

continuing a command lineUNIX systems 2-11

executing commands 2-6


Index

help 2-16

hyphens inUNIX systems 2-11

spaces inUNIX systems 2-10

UNIX systems 2-10

Commandsabbreviations B-1

entering using command-line formatUNIX systems 2-10

running in backgroundUNIX systems 2-9

Commasused to continue a command line

UNIX systems 2-11

used to separate keywordsUNIX systems 2-10

COMMENT keywordCHGFSC 3-94, 3-95

REQRVW 3-255

RSVP 3-267

Comparison of Vault commands in UNIX andCADDS C-4

COND keywordLISTDICT 3-179

CONT keywordREAD 3-211, 3-212

Continuation charactersVault

UNIX systems 2-11

CONTRACT keywordADDP 3-30

CHGP 3-100

Control keysUNIX systems 2-12

COPIES optionPRINT command 4-21

COPY commandon UNIX systems 2-13

COPYATTR command 3-127

COPYCLA keywordCOPY 3-121

Copyingadministrative information 3-56

authority groups 3-56

command lists 3-56

current query result to local file 4-12

current query to local file 4-27

filesfor modification 3-164

for read purposes 3-211

from archive tape to Vault 3-264

from tape to Vault 3-192

from Vaulton UNIX systems A-11

to local storage 3-211

to tape 3-296

project attributes 3-56

set of status levels 3-56

signing out files 3-213

user lists 3-56

user-defined attributesfor parts and files 3-127

Vault objects 3-56

COPYNAME keywordCOPY 3-121

COPYREV keywordCOPY 3-121

Correcting typing errorsUNIX systems 2-12

Creatingbinder

instances 3-28

relationships 3-31

command lists 3-18

file passwords 3-89

file setsmembers 3-24

names 3-21

object types 3-135

projects 3-30

authority schemes 3-36

users 3-48

revision code sequences 3-33

status levels 3-36

storage pools 3-38

subscriptions 3-39

tape listings 3-269

tree hierarchies 3-32

user lists 3-47

members 3-26

user-defined attributesattribute definitions



Index


attribute groupsfor binders and relationships 3-129

attribute setsfor parts and files 3-11

rules for parts and files 3-35

vault lists 3-54

members 3-55

Current querychanging 4-28

copying to local file 4-27

displaying 4-20

executing 4-26, 4-32

listing 4-23

saving 4-27

Current working directoryon UNIX systems A-2, A-4, A-12

CURRSTAT keywordCHGFSC 3-94

CVFUTIL filesloading 3-194

CVFUTIL tapesunloading 3-298

CVPATH logicalon UNIX systems A-11, A-12

CVSAVFIL file 3-194

CVSAVFIL tapesunloading 3-298

DDatabase

backup 3-172, 3-291

recovery 3-224

DATAONLY optionFILE command 4-12

DATATYPE keywordCHGADEF 3-64, 3-65

DEFATRB 3-131, 3-132

DATE keywordLOAD 3-192

RECSF 3-221

DATECRIT keywordLOAD 3-192

DECIMAL optionSET command 4-29

SHOW command 4-31

DEFAGRP command 3-129

DEFATRB command 3-131

DEFAULT keywordCHGADEF 3-64, 3-65

DEFATRB 3-131, 3-132

DefaultsCADDS attributes


case sensitivity 2-8

DEFENUM command 3-134

DEFOTYPE command 3-135

DEFVAL keywordADDMAS 3-22

CHGMAS 3-99

DELADEF command 3-136

DELAG command 3-137

DELAGRP command 3-138

DELASET command 3-139

DELATTR command 3-143

DELCL command 3-144

DELETE command 3-146

audit trail 3-147

Deletingauthority groups 3-137

binderinstances 3-151

bindersmembers 3-155

catalogsafter marking 3-146

marking 3-202

purging 3-209

command lists 3-144

enumeration setnames 3-145

values 3-148

file sets 3-236

marking all members 3-202

members, after marking 3-146

removing a member 3-238


marking 3-202

passwords 3-89

purging 3-209

local files 3-215

log entries 3-149

marked data 3-146

marking data for 3-202

object types 3-152


Index

old versions of files 3-153


marking 3-202

purging 3-209

private files 3-209

process log entries 3-149

projects 3-154

files, after marking 3-146

marking all files 3-202

purging all files 3-209

purging without marking 3-209

relationships 3-155

reserved names 3-261

reviewers 3-239

status levels 3-158

subscriptions 3-159

unmarked files 3-209

user lists 3-161

association with a status code 3-245

members 3-239

user-defined attributesdefinitions



group namesfor binders and relationships 3-138

rulesfor parts and files 3-157

set namesfor parts and files 3-139



users 3-160

DELLOG command 3-149

DELOV command 3-153

DELP command 3-154

DELRULE command 3-157

DELS command 3-158

DELU command 3-160

DELUL command 3-161

DESC keywordADDOBJ 3-28

ADDREL 3-31, 3-32

CHGADEF 3-64, 3-65

CHGDESC 3-76, 3-78

DEFAGRP 3-129

DEFATRB 3-131, 3-133

DEFENUM 3-134

DEFOTYPE 3-135

Descriptive fieldsUNIX systems 2-10, 2-13

DEST-CLASS keywordCOPYATTR 3-127, 3-128

DEST-NAME keywordCOPYATTR 3-127, 3-128

DEST-REVISION keywordCOPYATTR 3-127, 3-128

DEST-TYPE keywordCOPYATTR 3-127, 3-128

Directories$EPD_HOME/data

on UNIX systems 2-13

CADDS create directoryon UNIX systems A-7

created by Vault during file transferon UNIX systems A-11

storing all files inon UNIX systems A-5

storing in Vault 3-278, 3-284

DIRFORM keywordLISTDIR 3-188

DIRNAME keywordLISTDIR 3-188

Diskserror handling 3-224

DMSERVER keywordCISIGNON 2-3

Documentation, printing from PortableDocument Format (PDF) file xlv

DPLACES optionFORMAT command 4-14

EEARLIESTDATE keyword

CHGADEF 3-65

DEFATRB 3-131, 3-132

ECHO optionSET command 4-29

SHOW command 4-31

EDIT commandIQF 4-9

Index


EDM.DEFAULTS file 2-8


EDMCASE keyword 2-8


E-mail triggerattaching a file 2-18

usingon UNIX systems 2-18

Embedded spacesin Vault keyword values

UNIX systems 2-10

Embedded user lists 3-26

END keyword, CHGCTL 3-73

Endingaccess to Vault-controlled tables 3-120

IQF sessions 3-178

Entering commandsusing command-line format

UNIX systems 2-10

ENUM keywordCHGADEF 3-64, 3-65

CHGDESC 3-76, 3-77

DEFATRB 3-131, 3-132

DEFENUM 3-134

Enumeration setadding values 3-20

defining names 3-134

deleting values 3-148

ENV keywordon UNIX systems A-3, A-5

STORE 3-278, 3-279, 3-282

Environmentparameter for STORE 3-282

Equals signon UNIX systems A-7

ERASE optionFORMAT command 4-15

EVENTID keyword, ADDSUB 3-39

EXCEPT optionFORMAT command 4-15

EXCLUDE ALL BUT optionFORMAT command 4-14

EXIT command 3-178

ExitingIQF 4-22

EXPCNT keyword, ADDSUB 3-39, 3-40

EXPDATE keyword, ADDSUB 3-39, 3-40

EXPORTER keyword, IMPORT 3-176

EXPTIME keyword

ADDSUB 3-39, 3-40

FFILE command

IQF 4-12

File setsadding members 3-24



passwords 3-89

status codes 3-94

using GET 3-164

copyingfrom Vault to tape 3-296

creating 3-21

deleting 3-236

marking 3-202

members, after marking 3-146

removing a member from the set 3-238


modifying 3-166

read only 3-211

recursive 3-24

removing a member 3-238

replacing 3-249


resetting 3-261


review requests 3-255, 3-267

signing out 3-164


transferring from Vaulton UNIX systems A-11, A-12

transferring to CADDS C-22


File transfer commandsaudit files

on UNIX systems A-2

FILEDESC keywordRESERVE 3-257, 3-258

STORE 3-278, 3-280

FILEPW keyword


Index

CHGFA 3-79

CHGFCL 3-83

CHGFPW 3-89

CHGFREV 3-92

CHGFSC 3-94

COPY 3-121

GET 3-164, 3-165

LOAD 3-192, 3-193

MARKA 3-198

MARKD 3-202

MARKR 3-205

PURGE 3-209

READ 3-211, 3-212

REQRVW 3-255

RESERVE 3-257

RESTORE 3-264

SIGNOUT 3-274

STORE 3-278, 3-279

UNLOAD 3-296, 3-297

Filesadding

to existing parts 3-288

to file sets 3-24

to Vault database 3-278


audit 2-5

backupsincremental 3-172

universal 3-291




contents 3-164

passwords 3-89

revision codes 3-92

status codes 3-94



query to file 4-27


marking 3-202

old versions 3-153

purging 3-209

listsread only 3-211

replacing 3-249

signing out 3-164


lost 3-221


modifying 3-164

moving from CADDS C-19

purging 3-209

read only 3-211

recovering 3-221

replacing 3-249


reserving a file name 3-257

resetting 3-261


in-work 3-265

released 3-265

revision code when restored 3-265


revision codeswhen restored 3-265

savingending signout 3-249

query in local file 4-27

shadow 3-153

signing out 3-164


storing new 3-278

tape listing 3-269


verifying names 3-189

FILETYPE keywordGET 3-164, 3-165

READ 3-211, 3-212

RESERVE 3-257, 3-258

SIGNOUT 3-274

STORE 3-278, 3-279

UNLOAD 3-296, 3-297

FORMAT commandIQF 4-13

FORWARD commandIQF 4-17

FROM keywordSELECT 4-28

Index


FROMBASECLASS keywordCHGATRBS 3-68

CHGDESC 3-76, 3-78

FROMONAME keywordADDREL 3-31

CGHATRBS 3-68

CHGDESC 3-76, 3-78

FROMREVISION keywordADDREL 3-31

CGHATRBS 3-68

CHGDESC 3-76, 3-78

FSNAME keywordADDMFS 3-24

REMFS 3-236

REMMFS 3-238

Full path nameon UNIX systems A-7

FULLNAME keywordADDU 3-44, 3-45

CHGU 3-106, 3-107

FUTIL tapesloading 3-194

unloading 3-298

GGET command 3-164

on UNIX systems A-2, A-11

LDIRNAME keyword A-13

LFNAME keyword A-12

Vault file name conversions A-11, A-14

GET FILE command C-16

GET FILESET command C-22

GET PART command C-7

GTCODE keywordRESERVE 3-257, 3-258

STORE 3-278, 3-280

HHEADING option

FORMAT command 4-14

Helpfor IQF 4-18

online 2-16

using command-line format 2-16

HELP command 3-171

HP-UXcommand line length 2-10

directoriesstoring all files in A-5

e-mail triggerusing 2-18

filesstoring A-3, A-7

keyboard 2-8

subdirectories A-5, A-11

Hyphensused to continue a command line

UNIX systems 2-11

IIBKUP command 3-172

Importingobjects from remote vaults 3-176

INCLUDE ONLY optionFORMAT command 4-14

Incremental backupusing the IBKUP command 3-172

Initiating a review 3-255

INPUT-ATTRS keywordASSOCIAT 3-61, 3-62

CHGUATTR 3-109, 3-110, 3-117, 3-118

REMUATTR 3-241, 3-242

Interactive promptUNIX systems 2-10, 2-11

Interactive Query Facility 4-1

Interfacescommand-line 2-6

In-workstatus levels

changing 3-94

IQFcolumn format 4-13

column numbers 4-8

command 3-178

command abbreviations B-1

command files 4-35

commandsBACKWARD 4-4

BOTTOM 4-5

BREAK 4-6

COLUMN 4-8

EDIT 4-9


Index

FILE 4-12

FORMAT 4-13

FORWARD 4-17

HELP 4-18

LEFT 4-19

LIST 4-20

PRINT 4-21

RECALL 4-23

RETRIEVE 4-24

RIGHT 4-25

RUN 4-26

SAVE 4-27

SELECT 4-28

SET 4-29

SHOW 4-31

START 4-32

TOP 4-34

TYPE 4-35

COPIES, PRINT 4-21

DATAONLY, FILE 4-12

defining information to view 4-28

displayingcommand file contents 4-35

current query 4-20, 4-23

last command entered 4-24

echoing stored queries 4-29

erasing format settings 4-15

excluding columns 4-14

executingcurrent query 4-26, 4-32

stored queries 4-32

format 4-6, 4-13

titles 4-13

including columns 4-14

left-most columns 4-8

LINESIZE, SET 4-29

listingcurrent query 4-20

last command entered 4-24

multiple command entries 4-9

new page top margin 4-29

NOROWS, SET 4-29

null text 4-14

placeholdersdisplay locations of 4-20

saving

queries 4-27

query results 4-12

scrollingbackward 4-4

forward 4-17

left 4-19

right 4-25

to end 4-5

to top 4-34

SEPARATOR, SET 4-29

SUBTOTAL, FORMAT 4-15

TOTAL, FORMAT 4-15

WHERE, SELECT 4-28

KKeyboards

UNIX 2-8

KEYFILE keywordADDOBJ 3-28

ADDREL 3-31

CHGADEF 3-64, 3-65

CHGATRBS 3-68

CHGDESC 3-76, 3-77

DEFAGRP 3-129

DEFATRB 3-131, 3-132

DEFENUM 3-134

DEFOTYPE 3-135

DELADEF 3-136

LISTDICT 3-179

LISTSTRU 3-191

Keyscontrol

UNIX systems 2-12

RETURNUNIX systems 2-11

keywordADDT 3-42

Keyword valuesstored in mixed case

UNIX systems 2-12

with embedded spaces 2-10

Keywordscase translation

UNIX systems 2-12

for STORE, GET, and READ

Index


on UNIX systems A-2

order ofUNIX systems 2-10

values stored in mixed caseUNIX systems 2-12

LLabels

tape, missing 3-270

LASTNAME keywordADDU 3-44, 3-45

CHGU 3-106, 3-107

LATESTDATE keywordCHGADEF 3-65

DEFATRB 3-131, 3-132

LDIRNAME keywordfile location 3-213

GET 3-165


READ 3-211, 3-212

LEFT command 4-19

LFNAME keywordGET 3-164, 3-165

on UNIX systemsGET and READ commands A-12

STORE command 2-13, A-3, A-5, A-7

READ 3-211, 3-212

STORE 3-278, 3-279

LINESIZE optionSET command 4-29

SHOW command 4-31

LIST command 4-20

LISTFORM keyword, LOCATE 3-196

Listingbinders 3-191

current query 4-20

databaseselected information 3-179

tape contents 3-269

tree hierarchies 3-191

LISTNAME keyword, LOCATE 3-196

Listscommand 1-1

command trigger 3-73

notification 3-52

of filesmodifying 3-164

read only 3-211

replacing 3-249


signing out 3-164

placeholders 4-20

review 3-256

user 3-26, 3-47

LISTTYPE keywordADDUSA 3-51

REMUSA 3-245

LOAD command 3-192


Loadingfiles from tape to Vault 3-192

LOADTYPE keywordLOAD 3-192, 3-193

Localstorage areas

file name in 3-213

Locatingdistributed objects 3-196

Log filedeleting entries 3-149

LogicalsCVPATH


MMANDATORY keyword

CHGADEF 3-64, 3-65

DEFAGRP 3-129

DEFATRB 3-131, 3-132

MARKD command 3-202

Marking datato delete 3-202

MAXLEN keywordCHGADEF 3-64, 3-65

DEFATRB 3-131, 3-132

MAXVAL keywordCHGADEF 3-64, 3-65

DEFATRB 3-131, 3-132

MEMDESC keywordADDMFS 3-24

MEMNAME keywordADDMFS 3-24

REMMFS 3-238


Index

MEMTYPE keywordADDMFS 3-24

REMMFS 3-238

Messagesidentifiers B-1

notification 3-52, 3-220

post-approval 3-52, 3-268

reading 3-219

responding 3-220, 3-271

review 3-52, 3-161, 3-220, 3-245, 3-256, 3-268, 3-271

sending 3-271

MINVAL keywordCHGADEF 3-64, 3-65

DEFATRB 3-131, 3-132

Missing tape label 3-270

Mixed casewith local files 2-8

Modify accessuser-defined tables 3-208

Monitoringchanges to database objects 3-39

MSGNUM keywordREADMSG 3-219

MSGOPT keywordREADMSG 3-219

MSGTEXT keywordmixed case

UNIX systems 2-13

SENDMSG 3-271

Multiple file transactions C-16

NNEWPAGE option

SET command 4-29

SHOW command 4-31

NEWREV keywordCHGFPW 3-89

CHGFREV 3-92

NEWSTAT keywordCHGFSC 3-94

NODUPLICATES optionBREAK command 4-6

NOROWS keywordSET 4-29

NOROWS optionSHOW command 4-31

Notification messages 3-220

NOTIFY keyword, ADDSUB 3-39

NOTIFYID keyword, ADDSUB 3-39

NULL optionFORMAT command 4-14

SET command 4-29

SHOW command 4-31

NUSERPW keywordCHGUPW 2-15, 3-116

OOBJECT-CLASS keyword

ASSOCIAT 3-61, 3-62

CHGUATTR 3-109, 3-110

CLASSIFY 3-117, 3-118

COPYATTR 3-127, 3-128

READATTR 3-217

REMUATTR 3-241, 3-242

OBJECT-NAME keywordASSOCIAT 3-61, 3-62

CHGUATTR 3-109, 3-110

CLASSIFY 3-117, 3-118

COPYATTR 3-127, 3-128

READATTR 3-217

REMUATTR 3-241

OBJECTPW keyword, REGISTER 3-231

OBJECT-REVISION keywordASSOCIAT 3-61, 3-62

CHGUATTR 3-109, 3-110

CLASSIFY 3-117, 3-118

COPYATTR 3-127, 3-128

READATTR 3-217

REMUATTR 3-241, 3-242

OBJECT-TYPE keywordASSOCIAT 3-61, 3-62

CHGUATTR 3-109, 3-110

CLASSIFY 3-117, 3-118

COPYATTR 3-127, 3-128

READATTR 3-217

REMUATTR 3-241

OCOUNT keywordLISTDICT 3-179

OFF optionBREAK command 4-6

FORMAT command 4-15

ON option

Index


BREAK command 4-6

FORMAT command 4-15

ONAME keywordADDOBJ 3-28

CHGATRBS 3-68

CHGDESC 3-76, 3-77

LISTSTRU 3-191

Online helpfor all Vault commands 3-171

IQF 4-18

Opening user-defined table 3-208

OPERATOR keywordADDRULE 3-35

OPNT command 3-208

ORDER keywordLISTDICT 3-179

OTYPE keywordADDOBJ 3-28

ADDREL 3-31

CHGADEF 3-64, 3-65

CHGDESC 3-76, 3-77, 3-78

DEFAGRP 3-129

DEFATRB 3-131, 3-132

DEFOTYPE 3-135

DELADEF 3-136

OUTFILE keywordLISTDICT 3-179

LISTSTRU 3-191

OUTPUT keywordARCHIVE 3-58

audit files 2-5

CHGFA 3-79

CHGFCL 3-83, 3-89

CHGFSC 3-94

GET 3-164, 3-165

LISTDIR 3-188

LOAD 3-192, 3-193

LOCATE 3-196

MARKA 3-198

MARKD 3-202

MARKR 3-205

PURGE 3-209

READ 3-211, 3-212

REPLACE 3-249

REQRVW 3-255

RESET 3-261

RESTORE 3-264

STORE 3-278, 3-279

OVERLAY keywordREAD 3-211, 3-212

Ownerof a file, determining 3-189

PPAGE option

BREAK command 4-6

PAGESIZE optionSET command 4-29

SHOW command 4-31

PARTNUM keywordRESERVE 3-257, 3-258

STORE 3-278, 3-280

Partsadding

to file sets 3-24

to Vault database 3-278




contents 3-164

passwords 3-89

revision codes 3-92

status codes 3-94




marking 3-202

purging 3-209

listingfrom a tape 3-269



modifying 3-164

purging 3-209

read only 3-211

replacing 3-249


resetting 3-261




Index


signing out 3-164

from CADDS C-7


storingon UNIX systems A-7

storing new 3-278

tape listing 3-269

transferring from Vaulton UNIX systems A-11

to UNIX systems A-12


Passwordsassigning to

files 3-89, 3-278

changingfor files 3-89

yours 2-15, 3-116

deletingfor files 3-89

PDMCASE keywordwith selection names and file names 2-8

PFNAME keywordRECSF 3-221

RESERVE 3-257

RESTORE 3-264

STORE 3-278, 3-279

Physical storage areas 3-38

Placeholdersin LIST command 4-20

in START command 4-32

POOLNAME keywordCHGSPS 3-104

RECSP 3-224

POOLSTAT keywordCHGSPS 3-104

Post-approvallists 3-52

messages 3-268

PRINT command 4-21

Printing a query result 4-21

Printing documentation from PortableDocument Format (PDF) file xlv

Private fileschanging to public 3-83

deletingpurging 3-209

Process logdeleting entries 3-149

Programmatic interfacefunctions 3-75

PROJDESC keywordADDP 3-30

CHGP 3-100

Projectsarchiving

after marking files 3-58

assigningusers 3-48

authority schemes 3-36

creating 3-36

deleting status levels 3-158



changingattributes 3-100

classifications 3-83

passwords 3-89

status codes 3-94


copyingcomponents 3-56


users 3-56

creating 3-30

status levels 3-36

defining status levels 3-36

deleting 3-154

files after marking 3-146

marking 3-202

purging all files 3-209

status levels 3-158

IDschanging 3-101

defining 3-30, 3-48


purging 3-209

removing users 3-244

resetting 3-261

restoringafter marking all files 3-264


PROJID keyword

Index


ADDOBJ 3-28

ADDP 3-30

ADDS 3-36

ADDUP 3-48

ADDUSA 3-51

CHGFCL 3-83

CHGP 3-100

CHGS 3-102

CHGUP 3-113

LOAD 3-193

REMUP 3-244

REMUSA 3-245

RESERVE 3-257

STORE 3-278, 3-279

PROJNAME keywordADDP 3-30

CHGP 3-100

PROTGRP keywordADDU 3-44, 3-45

CHGU 3-106, 3-107

Public authority schemechanging 3-102

creating 3-36

deleting 3-158

PURGE command 3-209

Purgingparameters for 3-209

PUT FILE command C-19

PUT FILESET command C-24

PUT PART command C-11

QQTBLNAME keyword

CLST 3-120

OPNT 3-208

Queriesdefining 4-28

executing 4-26, 4-32

listing 4-20, 4-23

saving 4-27

Query resultcopying to local file 4-12

formatting 4-13

inserting blank lines 4-6

printing 4-21

scrollingbackward 4-4

forward 4-17

left 4-19

right 4-25

to bottom 4-5

to top 4-34

specifyingleft column 4-8

QuittingIQF 4-22

Quotation markssingle

UNIX systems 2-10

RRead authority

ADDU 3-45

CHGU 3-107

specifying 3-8

READ command 3-211


LDIRNAME keyword A-13

LFNAME keyword A-12

Vault file name conversions A-11, A-14

READA keywordADDU 3-44, 3-45, 3-48, 3-49, 3-106, 3-107, 3-113, 3-114

ADDUP 3-48, 3-49

CHGU 3-106, 3-107

CHGUP 3-113

READAG keywordADDU 3-44, 3-45

ADDUP 3-48, 3-49

CHGU 3-106, 3-107

CHGUP 3-113

READATTR command 3-217

Readingmessages 3-219

READMSG command 3-219

RECALL command 4-23

Recoveringsingle file 3-221

storage pools 3-224

RECSF command 3-221

RECSP command 3-224

REGISTER command 3-231

Registeringobjects

for distributed access 3-231


Index

REGLEVEL keyword, REGISTER 3-231

REJCNT keywordADDUSA 3-51

Relationshipsassigning

attribute data 3-13

changingattribute values 3-67

creating 3-32

object types 3-135

deleting 3-155

when binder deleted 3-151

listing 3-179

listing structures 3-191

Release/revision controlreviewing data

comments 3-267

initiating reviews 3-255

messages 3-52, 3-220, 3-245

registering approval or rejection 3-267

sequence of reviewers 3-26

terminating reviews 3-268

user listsadding members 3-26

defining name of list 3-47

deleting 3-161

removing association with statuscode 3-245

removing members 3-239

Releasedstatus levels

changing 3-102

creating 3-36

deleting 3-158

RELTYPE keywordADDREL 3-31

REMALIAS command 3-235

REMFS command 3-236

REMMAS command 3-237

REMMFS command 3-238

REMMUL command 3-239

Removingassociations

between events and actions 3-159

binders 3-151

members 3-155

file sets 3-236

members 3-238

relationships 3-155

remote vaults 3-246

tables from Vault control 3-240

user aliases 3-235

user list/status code association 3-245

usersfrom projects 3-244

from user lists 3-239

vault lists 3-247

members 3-248

REMT command 3-240

REMUATTR command 3-241

REMUP command 3-244

REMUSA command 3-245

REMVAULT command 3-246

REMVLIST command 3-247

REMVLMEM command 3-248

REPLACE command 3-249

on UNIX systems A-2

REPLACE optionFILE command 4-12

Replacingbinders 3-249

files 3-249

lists of files and parts 3-249

parts 3-252

from CADDS C-14

Report generator 4-1

REPORT optionBREAK command 4-6

REQOPT keywordADDMAS 3-22

CHGMAS 3-99

REQRVW command 3-255

Requestingreviews 3-255

RESERVE command 3-257


Reservingcancelling a reserved name 3-257

file names 3-257

RESET command 3-261

Resetting files 3-261

Respondingto file review requests 3-267

RESPONSE keywordRSVP 3-267

Index


RESTOPT keywordRESTORE 3-264

RESTORE command 3-264

Restoringarchived data

after marking 3-264

catalogsafter marking 3-264

file setsafter marking 3-264



projectsafter marking all files 3-264

RETURN keyUNIX systems 2-11

REVFILE keywordADDRS 3-33

Review lists 3-52, 3-245, 3-256

Reviewsinitiating 3-255

Revision codeschanging 3-92

restored files 3-265

sequencescreating 3-33

REVISION keywordADDMFS 3-24

ADDOBJ 3-28

ADDSUB 3-39, 3-40

CHGATRBS 3-69

CHGDESC 3-76, 3-77

CHGFA 3-79

CHGFCL 3-83

CHGFPW 3-89

CHGFREV 3-92

CHGFSC 3-94

COPY 3-121

LISTDIR 3-188

LISTSTRU 3-191

LOAD 3-192, 3-193

LOCATE 3-176, 3-196

MARKA 3-198

MARKD 3-202

MARKR 3-205

READ 3-211, 3-212

RECSF 3-221

REGISTER 3-231

REMMFS 3-238

REQRVW 3-255

RESERVE 3-257

RESTORE 3-264

RSVP 3-267

STORE 3-278, 3-279

REVNAME keywordADDP 3-30

ADDRS 3-33

CHGP 3-100

RIGHT command 4-25

ROW optionBREAK command 4-6

RSVP command 3-267

RULEKEY keywordADDRULE 3-35

RULENAME keywordADDRULE 3-35

RUN command 4-26

Running commands in backgroundUNIX systems 2-9

SSAVE command 4-27

SAVFIL tapesloading 3-194

unloading 3-298

Savingcatalogs

maintaining signout 3-303

file setsending signout 3-252


filesending signout 3-249


list of filesending signout 3-215, 3-253

lists of filesending signout 3-168, 3-306


partsending signout 3-252

in CADDS C-11



Index

SCANTAPE command 3-269

Scrollingquery results

backward 4-4

down 4-17

forward 4-17

left 4-19

right 4-25

to beginning 4-34

to the end 4-5

up 4-4

Select accessuser-defined tables 3-208

SELECT command 4-28

SELECT keywordLISTDICT 3-179

Selection namedefault case 2-8

Selection scope 3-283

SELNAME keywordADDSUB 3-39

case translation 3-281

CHGFA 3-79

CHGFCL 3-83

CHGFPW 3-89

CHGFREV 3-92

CHGFSC 3-94

COPY 3-121

EXPORT 3-162

GET 3-164, 3-165

IMPORT 3-176

LISTDIR 3-188

LOAD 3-192, 3-193

LOCATE 3-196

MARKA 3-198

MARKD 3-202

MARKR 3-205

on UNIX systemsGET and READ commands A-11

STORE command 2-13, A-4, A-5, A-7

PURGE 3-209

READ 3-211, 3-212

REGISTER 3-231

REPLACE 3-249

REQRVW 3-255

RESET 3-261

RSVP 3-267

SIGNOUT 3-269, 3-274

STORE 3-278, 3-279

UNLOAD 3-296, 3-297

SELSCOPE keywordADDSUB 3-39

CHGFA 3-79

CHGFCL 3-83

CHGFPW 3-89

CHGFREV 3-92

CHGFSC 3-94

COPY 3-121

EXPORT 3-162

GET 3-164

IMPORT 3-176

LISTDIR 3-188

LOAD 3-192, 3-193

LOCATE 3-196

MARKA 3-198

MARKR 3-205

on UNIX systems A-3, A-5, A-7

PURGE 3-209

READ 3-211, 3-212

REGISTER 3-231

REPLACE 3-249

REQRVW 3-255

RESET 3-261

RSVP 3-267

SIGNOUT 3-269, 3-274

STORE 3-278, 3-279, 3-283

UNLOAD 3-296, 3-297

SENDMSG command 3-271

UNIX systems 2-13

SEPARATOR optionSET command 4-29

SHOW command 4-31

SEQNUM keywordADDMUL 3-26

ADDS 3-36

CHGS 3-102

REMMUL 3-239

Sequence numbersuser lists 3-26

SET command 4-29

SETNAME keywordADDMAS 3-22

ADDRULE 3-35

CHGMAS 3-99

REMMAS 3-237

Shadow files 3-153

SHOW command 4-31

Index


Signing in files 3-249

Signing off from Vaultusing command-line format 2-4

Signing on to Vault 3-273

from CADDS C-2

using command-line format 2-3

Signing outbinders


catalogsreceiving local copy 3-164


file setsreceiving local copy 3-164


filescancelling 3-261

from CADDS C-16

receiving local copy 3-164

reserving name for future use 3-257


lists of files and partsreceiving local copy 3-164

partsfrom CADDS C-7

receiving local copy 3-164


SIGNON command 3-273

SIGNOUT command 3-274

SIGNOUT keywordRESERVE 3-257

STORE 3-278, 3-279

Single quotation marksUNIX systems 2-10

SKIP optionBREAK command 4-6

Solariscommand line length 2-10





Spacesin command lines

UNIX systems 2-10

SQLID keywordADDT 3-42

REMT 3-240

SQLPW keywordADDT 3-42

REMT 3-240

START command 4-32

STATCD keywordADDS 3-36

ADDT 3-42

ADDUSA 3-51

CHGS 3-102

LOAD 3-192

REMUSA 3-245

RESERVE 3-257

STORE 3-278, 3-279

STATDESC keywordADDS 3-36

CHGS 3-102

STATPC keywordADDS 3-36

CHGS 3-102

Status codesautomatic changes 3-256

changing codes assigned to files 3-94

defining 3-36

initiating review for status change 3-255

removing association with user list 3-245

review lists 3-52

Status levelschanging 3-102

copying sets 3-56

creating 3-36

deleting 3-158

initiating review for status level change 3-255

Status partition codeschanging 3-102

creating 3-37

Storage poolsadding 3-38

changinglocation of data 3-98

status 3-104

cleaning 3-153

reclaiming space 3-153

recovering 3-224

STORE command 3-278


on UNIX systems 2-13, A-2, A-3, A-5, A-7


Index

specifying a site-defined environment 3-282

Storingall files in a directory

on UNIX systems A-5

CADDS files and parts C-11

directories 3-284

files on tape 3-192

local files 3-278

new files 3-278

from tape 3-192

parts 3-287, C-11

UNIX files A-3

Subdirectorieson UNIX systems A-5, A-11

SUBNAME keywordADDSUB 3-39

Subscribingto changes in database objects 3-39

SUBTOTAL optionFORMAT command 4-15

SunOScommand line length 2-10





SYSTYPE keywordRESERVE 3-257, 3-258

STORE 3-278, 3-280

TTables

user-definedclosing 3-120

ending access 3-120

open for access 3-208

removing from Vault control 3-240

TAG keywordEXPORT 3-176

Tape commandsLOAD


TAPENUM keywordARCHIVE 3-58

UNLOAD 3-172, 3-296, 3-297

Tapesarchiving 3-58

backing up data 3-172, 3-291



density 3-174

formats 3-194

identifying devices 3-173

incremental backups 3-172

labels 3-59, 3-173

listing contents 3-269

loading files from 3-192

moving data from Vault 3-58

recovering single file from 3-221

renaming when copying 3-299

restoring from tape to Vault 3-264

scanning and listing 3-269

serial numbers 3-59

unlabeled 3-298

TAPEUNIT keywordARCHIVE 3-58

IBKUP 3-172

LOAD 3-192, 3-193

RECSF 3-221

RECSP 3-224

RESTORE 3-264

SCANTAPE 3-269

UNLOAD 3-296, 3-297

TAPPEND keywordARCHIVE 3-58

IBKUP 3-172

TBLNAME keywordADDT 3-42

REMT 3-240

TERMCNT keywordADDUSA 3-51

TESTVAL keywordADDRULE 3-35

TIME keywordRECSF 3-221

TOBASECLASS keywordADDREL 3-31

CHGATRBS 3-68

CHGDESC 3-76, 3-78

Index


TOINSTID keywordADDREL 3-31

CHGARTBS 3-68

CHGDESC 3-76, 3-78

TOONAME keywordADDREL 3-31

CHGARTBS 3-68

CHGDESC 3-76, 3-78

TOP command 4-34

TOREVISION keywordADDREL 3-31

CHGATRBS 3-68

CHGDESC 3-76, 3-78

TOTAL optionFORMAT command 4-15

Transaction logdeleting entries 3-149

Transferringfiles

from CADDS C-19

files to tapearchiving 3-58

from database to tape 3-296

partsfrom CADDS to Vault C-11

Vault fileson UNIX systems A-11

Transparent accessto distributed objects 3-196, 3-232

TTITLE optionFORMAT command 4-13

SHOW command 4-31

TYPE keywordREMVAULT 3-246

Typing errorscorrecting

UNIX systems 2-12

UUBKUP command 3-291

ULMNAME keywordADDMUL 3-26

REMMUL 3-239

ULMTYPE keywordADDMUL 3-26

REMMUL 3-239

UNITS keyword

ADDP 3-30

CHGP 3-100

Universal backupUBKUP command 3-291

UNIXemail trigger

using 2-18

UNLDNAME keywordLOAD 3-192, 3-193

UNLOAD 3-296, 3-297

UNLDTYPE keywordUNLOAD 3-296, 3-297

UNLOAD command 3-296

GET option 3-298

READ option 3-298

UPDATE commandon UNIX systems A-2

UPDATE PART command C-14

Updatingmodified data 3-303

User listsadding members 3-26

copying 3-56

defining names of 3-47

deleting 3-161

embedded 3-27

removing association with status code 3-245

removing members 3-239

sending messages to 3-271

sequence numbers 3-26

User-definedcommand triggers 3-74

file typesassigning 3-278

input parametersUNIX systems 2-13

tablesclosing 3-120

opening 3-208

removing 3-240

USERDESC keywordADDU 3-44, 3-45

CHGU 3-106, 3-107

USERGRP keywordADDU 3-44, 3-45

CHGU 3-106, 3-107

USERID keywordADDU 3-44

ADDUP 3-48


Index

CHGU 3-106

CHGUP 3-113

REMALIAS 3-235

REMUP 3-244

SENDMSG 3-271

SIGNON 2-3, 3-273

USERLIST keywordADDMUL 3-26

ADDUSA 3-51

REMMUL 3-239

REMUSA 3-245

SENDMSG 3-271

USERPW keywordADDU 3-44

CHGU 3-106, 3-107

CHGUPW 3-116

SIGNON 2-3, 3-273

Usersassigning to projects 3-48

changingpasswords 3-116

project authority 3-113

deleting 3-160

project authority 3-48

removingfrom projects 3-244

from user lists 3-239

USERTYPE keywordRESERVE 3-257, 3-258

STORE 3-278, 3-280

VVALATRBS command 3-309

VALUES keywordDEFENUM 3-134

Vaultcase sensitivity 2-8

file namescase exceptions


conversionon UNIX systems A-11, A-14

not conformingon UNIX systems A-12

storing in mixed case


filesCADDS attributes of A-10

EDM.DEFAULTSon UNIX systems 2-13

transferringon UNIX systems A-11

help 2-16

incremental backup 3-172

interactive promptUNIX systems 2-10, 2-11

messageshelp 2-17

signing off 2-4

VAULTID keywordCHGFA 3-79

CHGFCL 3-83

CHGFREV 3-92

CHGFSC 3-94

GET 3-164, 3-165, 3-271

READ 3-211, 3-212

REMVAULT 3-246

REMVLMEM 3-248

REPLACE 3-249

REQRVW 3-255

RESET 3-261

RSVP 3-267

VAULTLST keywordADDSUB 3-39

REMVLMEM 3-247, 3-248

WWBTIME keyword, CHGCTL 3-73

WETIME keyword, CHGCTL 3-73

WHERE keywordSELECT 4-28

WIDTH optionFORMAT command 4-14

WRITEA keywordADDU 3-44, 3-45

ADDUP 3-48, 3-49

CHGU 3-106, 3-107

CHGUP 3-113

WRITEAG keywordADDU 3-44, 3-45

Index


ADDUP 3-48, 3-49

CHGU 3-106, 3-107

CHGUP 3-113

Vault Command Reference - john-j- · PDF fileCommand Reference Optegra® Release 7 ......

Documents

Transcript of Vault Command Reference - john-j- · PDF fileCommand Reference Optegra® Release 7 ......