SAS/Warehouse Administrator 2.3 Metadata API- P48 doc

232 WHSASSTR Chapter 3 Host L Yes Yes No Id C * Req * Req No Indexes L Yes Yes Yes Library L Yes Yes No Load Technique C Yes Yes No Metadata Created C * Auto supplied No No Metadata Updated C * Auto supplied No No Name C No No No Note L No No Yes NValue N Yes Yes No Table L * Auto supplied No No Table Name C Yes Yes No Table Options L * Default * Default No New properties for WHSASSTR are as follows: HOST specifies an SCL list of general identifying information about the host on which this data is accessed. LIBRARY specifies an SCL list of general identifying information about the SAS Library that contains this data store. TABLE OPTIONS specifies an SCL list of options that are used in creating or loading this table. The CREATE sublist contains the SQL options that are used to create the table. The LOAD sublist contains the DBLOAD statements that are used to load the table. See the Usage notes for details about the TABLE OPTIONS property and data set passwords. Using WHSASSTR Add Update Delete No Yes No WHSASSTR is a dependent type. To understand how it relates to other types, see the physical storage models in “Relationships Among Metadata Types” on page 53. TABLE OPTIONS Property and SAS Data Set Passwords The actual data set passwords will only be returned using the _GET_METADATA_ method if the application is running as a secure application. The only method that is currently supported to run as a secure application is to run as an add-in generator. See SAS/Warehouse Administrator Metadata Types WHSCRFIL 233 SAS/Warehouse Administrator User’s Guide for documentation on running as an add-in generator. You can determine the presence of passwords however, regardless of whether the application is secure. If the application is not secure and a password exists, the appropriate data set password option will be returned with a value of XXXXXXXX (8 uppercase Xs). If the application is secure, the actual password will be returned. The three supported password options are READ=, WRITE=, and ALTER=. You can search for these strings in the returned string (using the INDEX function) to determine if a password exists this type of access. It is the application’s responsibility of retrieving these passwords—by prompting the user, for example. An example of a data set with a WRITE password and the COMPRESS option follows: TABLE OPTIONS=( CREATE=( ’WRITE=XXXXXX COMPRESS’ )) When you use the _UPDATE_METADATA_ method, you can add passwords to an existing data set that has no password, but you cannot update an existing password. To update an existing data set password, see your administrator. Note that changes to the metadata alone can cause your metadata and data to become out of sync. You should use this functionality with extreme caution. WHSCRFIL Metadata type for SAS/CONNECT script files Category: Text File Types Parent “WHTXTFIL” on page 269 Overview WHSCRFIL models the metadata for SAS/CONNECT script files in SAS/Warehouse Administrator. These scripts are used to access a remote host. The location of such a script is specified as part of the host definition for a remote host. In SAS/Warehouse Administrator, to specify the location of a SAS/CONNECT script as part of a new remote host definition: 1 From the SAS/Warehouse Administrator desktop, select an environment with the right mouse button. 2 Select Edit. 3 From the Explorer pull-down menu, select File Setup 4 Select Hosts. 5 Click Add . 6 Enter the host information, including the SAS/CONNECT script field. Properties The following table lists all of the properties for WHSCRFIL and indicates how you can use each property with metadata API methods. 234 WHSCRFIL Chapter 3 In the table, you can pass properties with a Ye s in the Add column to the _ADD_METADATA_ method. Use this method to add a new object. You can pass properties with a Ye s in the Update column to the _UPDATE_METADATA_ method. Use this method to update properties of an existing object. * Req indicates that the property is required; you must provide a value for this property when you use a given method. * Default indicates that the system will provide a default value for that property if you do not provide one. Properties with a Yes in the Read Method Expand Parm column are valid with the expand parameter of the _GET_METADATA_ method. This method enables you to get detailed metadata about a property and its associated objects through a single method call. Properties Type Add Method Update Method Read Method Expand Parm. Cvalue C No Yes No Desc C No Yes No Extended Attributes L No Yes Yes Id C * Req * Req No Metadata Created C No No No Metadata Updated C No No No Name C No * Default No Note L No Yes Yes NValue N No Yes No Objects LNoNo No Using WHSCRFIL Add Update Delete No Yes Yes WHSCRFIL is a dependent type, like all subtypes of WHTFILE. To understand how all subtypes of WHTFILE relate to other types, see the process model in “Relationships Among Metadata Types” on page 53. Use of _DELETE_METADATA for this type deletes SAS/Warehouse Administrator metadata, not the corresponding script file. SAS/Warehouse Administrator Metadata Types WHSERV 235 WHSERV Base metadata type for the scheduling server Category: Global Metadata Types Parent “WHROOT” on page 226 Overview WHSERV is the base metadata type for scheduling servers in the Job Scheduler utility. Properties The following table lists all of the properties for WHSERV and indicates how you can use each property with metadata API methods. In the table, you can pass properties with a Ye s in the Add column to the _ADD_METADATA_ method. Use this method to add a new object. You can pass properties with a Ye s in the Update column to the _UPDATE_METADATA_ method. Use this method to update properties of an existing object. * Req indicates that the property is required; you must provide a value for this property when you use a given method. * Default indicates that the system will provide a default value for that property if you do not provide one. Properties with a Yes in the Read Method Expand Parm column are valid with the expand parameter of the _GET_METADATA_ method. This method enables you to get detailed metadata about a property and its associated objects through a single method call. Properties Type Add Method Update Method Read Method Expand Parm. Cvalue C No No No Desc C No No No Extended Attributes LNoNo Yes Icon C No No No Id C No No No Metadata Created C No No No Metadata Updated C No No No Name C No No No Note L No No Yes NValue N No No No 236 WHSRCCAT Chapter 3 WHSERV has the following new property: ICON specifies the four-level catalog entry name (such as libref.catalog.entry.IMAGE)of the icon associated with this object. For more information about icons, see “Using Icon Information” on page 69. Using WHSERV Add Update Delete No Yes No WHSERV is an independent type. WHSERV is not used to write metadata into a repository. It is a template for all of the scheduling servers in the Job Scheduler. WHSRCCAT Metadata type for SAS catalog entry source code files Category: Text File Types Parent “WHTXTCAT” on page 268 Overview WHSRCCAT is the metadata type for SAS catalog entry source code files for SAS/Warehouse Administrator. Properties The following table lists all of the properties for WHSRCCAT and indicates how you can use each property with metadata API methods. In the table, you can specify properties with a Ye s in the Indirect Add column when you indirectly add one object through another, as described in the documentation for the _UPDATE_METADATA_ method. Use this approach to add a new dependent object. For details, see “Using _UPDATE_METADATA_” on page 46. You can pass properties with a Ye s in the Update column to the _UPDATE_METADATA_ method, as described in the documentation for this method. Use this method to update properties of an existing object. For details, see “Using _UPDATE_METADATA_” on page 46. * Req indicates that the property is required; you must provide a value for this property when you use a given method. * Default indicates that the system will provide a default value for that property if you do not provide one. * Auto supplied means that the property is automatically supplied; any value that you specify for such a property is ignored. . application is to run as an add-in generator. See SAS/Warehouse Administrator Metadata Types WHSCRFIL 23 3 SAS/Warehouse Administrator User’s Guide for documentation on running as an add-in generator “Relationships Among Metadata Types” on page 53. Use of _DELETE _METADATA for this type deletes SAS/Warehouse Administrator metadata, not the corresponding script file. SAS/Warehouse Administrator Metadata. Administrator Metadata Types WHSERV 23 5 WHSERV Base metadata type for the scheduling server Category: Global Metadata Types Parent “WHROOT” on page 22 6 Overview WHSERV is the base metadata type for scheduling