SAS 9.1.3 Open Metadata Interface: Reference, Second Edition
Total Page:16
File Type:pdf, Size:1020Kb
SAS® 9.1.3 Open Metadata Interface Reference Second Edition The correct bibliographic citation for this manual is as follows: SAS Institute Inc. 2005. SAS ® 9.1.3 Open Metadata Interface: Reference, Second Edition. Cary, NC: SAS Institute Inc. SAS® 9.1.3 Open Metadata Interface: Reference, Second Edition Copyright © 2002–2007, SAS Institute Inc., Cary, NC, USA ISBN 978–1–59047–812–7 All rights reserved. Produced in the United States of America. For a hard-copy book: No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, photocopying, or otherwise, without the prior written permission of the publisher, SAS Institute Inc. For a Web download or e-book: Your use of this publication shall be governed by the terms established by the vendor at the time you acquire this publication. U.S. Government Restricted Rights Notice. Use, duplication, or disclosure of this software and related documentation by the U.S. government is subject to the Agreement with SAS Institute and the restrictions set forth in FAR 52.227-19 Commercial Computer Software-Restricted Rights (June 1987). SAS Institute Inc., SAS Campus Drive, Cary, North Carolina 27513. 1st printing, July 2005 2nd printing, November 2006 3rd printing, June 2007 SAS® Publishing provides a complete selection of books and electronic products to help customers use SAS software to its fullest potential. For more information about our e-books, e-learning products, CDs, and hard-copy books, visit the SAS Publishing Web site at support.sas.com/pubs or call 1-800-727-3228. SAS® and all other SAS Institute Inc. product or service names are registered trademarks or trademarks of SAS Institute Inc. in the USA and other countries. ® indicates USA registration. Other brand and product names are registered trademarks or trademarks of their respective companies. Contents What’s New vii Overview of the SAS Open Metadata Interface vii Details of SAS Open Metadata Interface Enhancements vii PART1 Understanding the SAS Open Metadata Interface 1 Chapter 1 R Introduction 3 About This Book 3 Prerequisites 4 What Is the SAS Open Metadata Architecture? 4 What Can I Do with the SAS Open Metadata Interface? 5 How Does the SAS Open Metadata Architecture Work? 5 Important Concepts 7 Accessing Application Metadata 7 Creating Repositories 8 Controlling the SAS Metadata Server 8 Security 8 Authorization Facility 9 Chapter 2 R Open Client Requirements 11 Types of SAS Open Metadata Interface Clients 11 Connecting to the SAS Metadata Server 12 Call Interfaces 13 Java IOMI Class Signature Summary Table 15 Visual Basic IOMI Class Signature Summary Table 18 Visual C++ IOMI Class Signature Summary Table 21 Sample Java IOMI Client 24 Sample Visual Basic OMI Client 28 Sample Visual C++ IOMI Client 31 Using Server Output 36 PART2 SAS Metadata Model 37 Chapter 3 R Overview of the SAS Metadata Model and Model Documentation 39 Namespaces 39 Understanding Associations 40 Overview of the SAS Metadata Model Documentation 41 Using the Metadata Types Reference 42 SAS Metadata Model Conventions 44 Chapter 4 R SAS Namespace Submodels 45 Overview of SAS Namespace Submodels 46 iv Analysis Submodel 48 Authorization Submodel 49 Business Information Submodel 49 Foundation Submodel 50 Grouping Submodel 52 Mining Submodel 52 Property Submodel 53 Relational Submodel 55 Resource Submodel 57 Software Deployment Submodel 59 Transform Submodel 61 XML Submodel 64 Hierarchical Listing of Metadata Types 65 Chapter 5 R Hierarchy and Association Diagrams 69 Overview to Hierarchy and Association Diagrams 70 Diagrams for Analysis Metadata Types 71 Diagrams for Authorization Metadata Types 75 Diagrams for Business Information Metadata Types 77 Diagrams for Foundation Metadata Types 78 Diagrams for Grouping Metadata Types 80 Diagrams for Mining Metadata Types 81 Diagrams for Property Metadata Types 83 Diagrams for Relational Metadata Types 86 Diagrams for Resource Metadata Types 91 Diagrams for Software Deployment Metadata Types 95 Diagrams for Transformation Metadata Types 100 Diagrams for XML Metadata Types 105 Chapter 6 R REPOS Namespace Metadata Types 107 Overview of REPOS Namespace Metadata Types 107 Repository 108 RepositoryBase 109 PART3 Method Classes 113 Chapter 7 R Methods for Reading and Writing Metadata (IOMI Class) 115 Overview of the IOMI Class Methods 117 Constructing a Metadata Property String 118 Identifying Metadata 120 Functional Index to IOMI Methods 120 Using IOMI Flags 121 Summary Table of IOMI Flags 122 Summary Table of IOMI Options 129 <DOAS> Option 131 AddMetadata 132 v CheckinMetadata 135 CheckoutMetadata 137 CopyMetadata 139 DeleteMetadata 141 DoRequest 144 FetchMetadata 146 GetMetadata 148 GetMetadataObjects 152 GetNamespaces 155 GetRepositories 156 GetSubtypes 158 GetTypeProperties 160 GetTypes 162 IsSubtypeOf 164 UndoCheckoutMetadata 165 UpdateMetadata 167 Chapter 8 R Security Methods (ISecurity Class) 171 Overview of the ISecurity Class 171 FreeCredentials 172 GetAuthorizations 173 GetCredentials 175 GetIdentity 176 IsAuthorized 177 Chapter 9 R Repository and Server Control Methods (IServer Class) 181 Overview of the IServer Class 181 Pause 182 Refresh 184 Resume 186 Status 187 Stop 189 Chapter 10 R Program-Specific Method Examples 191 Overview to Program-Specific Method Examples 193 Program-Specific AddMetadata Examples 193 Program-Specific DeleteMetadata Examples 197 Program-Specific GetMetadata Examples 201 Program-Specific GetMetadataObjects Examples 205 Program-Specific GetNamespaces Examples 209 Program-Specific GetRepositories Examples 213 Program-Specific GetSubtypes Examples 216 Program-Specific GetTypeProperties Examples 220 Program-Specific GetTypes Examples 224 Program-Specific IsSubtypeOf Examples 227 Program-Specific UpdateMetadata Examples 231 vi PART4 SAS Language Metadata Interfaces 237 Chapter 11 R Procedures 239 METADATA Procedure 240 METALIB Procedure 245 METAOPERATE Procedure 262 Chapter 12 R DATA Step Functions 271 SAS Metadata DATA Step Functions 273 METADATA_DELASSN Function 276 METADATA_DELOBJ Function 278 METADATA_GETATTR Function 279 METADATA_GETNASL Function 280 METADATA_GETNASN Function 282 METADATA_GETNATR Function 284 METADATA_GETNOBJ Function 286 METADATA_GETNPRP Function 288 METADATA_GETNTYP Function 290 METADATA_GETPROP Function 291 METADATA_NEWOBJ Function 293 METADATA_PAUSED Function 295 METADATA_PURGE Function 295 METADATA_RESOLVE Function 297 METADATA_SETASSN Function 299 METADATA_SETATTR Function 301 METADATA_SETPROP Function 302 METADATA_VERSION Function 303 Chapter 13 R System Options 305 SAS Metadata System Options 305 Index 309 vii What’s New Overview of the SAS Open Metadata Interface The SAS Open Metadata Interface is an XML-based API for interacting with metadata. It is the basic interface that SAS clients use to deliver metadata services in the SAS Open Metadata Architecture, which was introduced with SAS 9. This section describes the features of SAS Open Metadata Interface that are new or enhanced since SAS 9. It also introduces a new SAS language interface for maintaining metadata. Details of SAS Open Metadata Interface Enhancements Beginning with SAS 9.1.3, Service Pack 3, the IServer class Status method supports <PlatformVersion/> and <ModelVersion/> parameters. These parameters enable clients to retrieve the SAS Metadata Server and SAS Metadata Model version numbers, respectively. For more information, see “Status” on page 187. Beginning with SAS 9.1.3, Service Pack 3, the IOMI class CheckinMetadata method supports an unlimited number of characters in the changeDesc parameter. changeDesc enables clients to store a description of object modifications in a Change metadata object that is generated by the checkin process. Information entered into changeDesc is now stored in a TextStore object instead of as a Change attribute. For more information, see “CheckinMetadata” on page 135. Beginning with SAS 9.1.3, Service Pack 3, the METALIB procedure is available to automate the creation and maintenance of the table metadata associated with a SAS library. For more information, see “METALIB Procedure” on page 245. viii What’s New 1 PART1 Understanding the SAS Open Metadata Interface Chapter 1..........Introduction 3 Chapter 2..........Open Client Requirements 11 2 3 CHAPTER 1 Introduction About This Book 3 Prerequisites 4 What Is the SAS Open Metadata Architecture? 4 What Can I Do with the SAS Open Metadata Interface? 5 How Does the SAS Open Metadata Architecture Work? 5 Important Concepts 7 Accessing Application Metadata 7 Creating Repositories 8 Controlling the SAS Metadata Server 8 Security 8 Authorization Facility 9 About This Book This book describes the SAS 9.1.3 Open Metadata Interface and contains all of the information you need to write a SAS Open Metadata Interface client that creates and manages metadata in SAS Metadata Repositories. This book describes the SAS Metadata Model namespaces metadata-related, security-related, and server-control methods call interfaces open client requirements. Hierarchy and association diagrams are provided to help you to understand the relationships between application-related metadata types in the SAS Metadata Model. You need to understand these relationships before you can issue SAS Open Metadata Interface method calls that read and write metadata. In addition, program-specific examples are provided that show how to issue SAS Open Metadata Interface method calls in Java, Visual Basic, and C++ clients. The SAS Open Metadata Architecture is a client-server