SAS/Warehouse Administrator 2.3 Metadata API- P28 pot

132 WHINFO Chapter 3 3 Select the information mart item with the right mouse button. 4 Select Properties. 5 Enter the information mart item information. Properties The following table lists all of the properties for WHINFO 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 Ye s 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. Note: A CREATING JOB property is required if the INPUT SOURCES property is also specified. Properties Type Add Method Update Method Read Method Expand Parm. Administrator L Yes Yes No Cvalue C Yes Yes No Creating Job L Yes (see Property Dependencies) Yes (see Property Dependencies) Yes Desc C Yes Yes No Entry C Yes Yes No Extended Attributes L Yes Yes Yes Full Entry C No No No Group L * Req Yes No Host L Yes Yes No Icon C Yes Yes No Id C * Req * Req No Input Objects L No No No Input Sources L Yes (see Property Dependencies) Yes (see Property Dependencies) No Library L Yes Yes No Members L No No No SAS/Warehouse Administrator Metadata Types WHINFO 133 Metadata Created C No No No Metadata Updated C No No No Name C * Default Yes No Note L Yes Yes Yes NValue N Yes Yes No Output Objects L No No No Output Targets L No No No Owner L Yes Yes No Process L Yes Yes Yes Resolved View Code LNoNo Yes Using Processes L No No No View Code L Yes Yes Yes New properties for WHINFO are as follows: CREATING JOB specifies a list of general identifying information about the job that creates this InfoMart item. Must be a WHJOB or a subtype of WHJOB. A valid CREATING JOB property is required before you can add any INPUT SOURCES. If the CREATING JOB property is removed, then any work tables in the chain of INPUT SOURCES will be deleted as well. ENTRY represents the three-level name of the catalog entry that contains the InfoMart item. An example would be source.loadfile.source. FULL ENTRY represents the four-level name of the catalog entry that contains the InfoMart item. An example would be libref.source.loadfile.source. HOST specifies an SCL list of general identifying information about the host on which this InfoMart item is accessed. INPUT OBJECTS specifies an SCL list of general identifying information about the objects that are input to this InfoMart item. For more information about input objects, see “INPUT and OUTPUT Properties” on page 64. INPUT SOURCES specifies an SCL list of general identifying information about the sources that are input to this InfoMart item. For more information about input sources, see “INPUT and OUTPUT Properties” on page 64. LIBRARY specifies an SCL list of general identifying information about the SAS library that contains this InfoMart item. For details about SAS library metadata, see “WHLIBRY” on page 175. 134 WHINFO Chapter 3 OUTPUT OBJECTS specifies an SCL list of general identifying information about the objects that are output from this InfoMart item. For more information about output objects, see “INPUT and OUTPUT Properties” on page 64. OUTPUT TARGETS specifies an SCL list of general identifying information about the targets that are output from this InfoMart item. For more information about output targets, see “INPUT and OUTPUT Properties” on page 64. PROCESS specifies an SCL list of general identifying information about the process that created this InfoMart item. RESOLVED VIEW CODE specifies an SCL list of general identifying information about the source code that is used to view (open) this InfoMart item. This property will return a copy of the source code with the &loc reference replaced with the appropriate location information. See the Note below. VIEW CODE specifies an SCL list of general identifying information about the source code that is used to view (open) this InfoMart item. This property will return a copy of the source code with the &loc reference unresolved. See the Note below. Note: The VIEW CODE and RESOLVED VIEW CODE properties are very closely related. When writing the source code to view (open) an InfoMart, you can insert &loc into the text as a placeholder for the InfoMart’s location information—information such as libref.catalog.entry.type, for example. The VIEW CODE property will return a copy of the source code with the &loc reference unresolved. The RESOLVED VIEW CODE property will return a copy of the source code with the &loc reference replaced with the appropriate location information. The RESOLVED VIEW CODE property is provided as a convenience and removes the burden from the application of parsing the returned code and replacing the &loc reference. If the source code does not contain the &loc placeholder, the returned source code is the same for both properties. Property Dependencies You must define a CREATING JOB in order to add any INPUT SOURCES to a table. If a table does not have a CREATING JOB property, then you must specify one when you add an input source to the table. Using WHINFO Add Update Delete Ye s Ye s Ye s WHINFO is an independent type, like all subtypes of WHOBJECT. To understand how all subtypes of WHOBJECT relate to other types, see the general information model in “Relationships Among Metadata Types” on page 53. When you update or add the VIEW CODE property, the VIEW CODE source must be in a catalog SOURCE entry. The source will be copied word for word with one blank appended between each word. SAS/Warehouse Administrator Metadata Types WHINFOFL 135 There are three ways to specify the source’s location. In order of precedence, they are: FULL ENTRY, LIBRARY/ENTRY, and ID. FULL ENTRY signifies that the passed entry name is currently accessible and should be read as the source code. LIBRARY/ENTRY signifies that the specified ENTRY name in the specific library should be read as the source code. The LIBRARY property contains a reference to a defined WHLIBRY object. If necessary, the referenced library will be allocated before reading the entry. ID signifies that the source code exists in an already defined source code catalog object (WHSRCCAT), whose ID is passed. In this scenario, the library that is associated with the passed source code object will be allocated, if necessary. To get the ID for the existing VIEW CODE, you must issue a _GET_METADATA_ call for the WHINFO type’s VIEW CODE property. WHINFOFL Metadata type for InfoMart files Category: Object Types—Explorer Parent “WHOBJECT” on page 182 Overview WHINFOFL models the metadata for an information mart file. An InfoMart file is a metadata record that specifies the location of a file and the technique for opening that file. It is used to specify a file other than a SAS file that you want to register in a SAS/Warehouse Administrator environment. The file can be a spreadsheet, an HTML report, or any file that you can using an external application. To add an InfoMart file with the SAS/Warehouse Administrator Explorer: 1 Select an information mart with the right mouse button. 2 Select Add Item Information Mart File 3 Select the information mart file with the right mouse button. 4 Select Properties. 5 Enter the information mart file information. Properties The following table lists all of the properties for WHINFOFL 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. 136 WHINFOFL Chapter 3 * 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 Ye s 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. Note: A CREATING JOB property is required if the INPUT SOURCES property is also specified. Properties Type Add Method Update Method Read Method Expand Parm. Administrator L Yes Yes No Cvalue C Yes Yes No Creating Job L Yes (see Property Dependencies) Yes (see Property Dependencies) Yes Desc C Yes Yes No Extended Attributes L Yes Yes Yes File Type C Yes Yes No Group L * Req Yes No Host L Yes Yes No Icon C Yes Yes No Id C * Req * Req No Input Objects L No No No Input Sources L Yes (see Property Dependencies) Yes (see Property Dependencies) No Location C Yes Yes No Members L No No No Name C * Default Yes No Note L Yes Yes Yes NValue N Yes Yes No Output Objects L No No No Output Targets L Yes Yes No Owner L Yes Yes No Process L Yes Yes Yes Resolved View Code LNoNo Yes View Code L Yes Yes Yes . Property Dependencies) No Library L Yes Yes No Members L No No No SAS/Warehouse Administrator Metadata Types WHINFO 133 Metadata Created C No No No Metadata Updated C No No No Name C * Default Yes No Note. 1 32 WHINFO Chapter 3 3 Select the information mart item with the right mouse button. 4 Select Properties. 5. will be copied word for word with one blank appended between each word. SAS/Warehouse Administrator Metadata Types WHINFOFL 135 There are three ways to specify the source’s location. In order of