SAS/Warehouse Administrator Metadata Types

WHEFILE

Metadata type for external file inputs to ODDs

Category:

Object Types--Process Editor

Parent
Overview
Properties
Using WHEFILE

Parent

WHROOT

Overview

WHEFILE models the metadata for external file objects in the Process Editor. An external file is a file of type other than SAS that is an input to an operational data definition (ODD). Here is one way to add an external file in SAS/Warehouse Administrator:

In the Explorer, select an ODD with the right mouse button.
Select Process from the pop-up menu.
In the Process Editor, select the ODD with the right mouse button.
Select Add External File from the pop-up menu.
Select the external file with the right mouse button.
Select Properties.
Enter the external file information.

Properties

The following table lists all of the properties for WHEFILE and indicates how you can use each property with metadata API methods.

In the table, you can pass properties with a Yes in the Add column to the _ADD_METADATA_ method. Use this method to add a new object.

You can pass properties with a Yes 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.
Access Method	C	Yes	Yes	No
Creating Job	L	Yes	Yes	Yes
Cvalue	C	Yes	Yes	No
Desc	C	Yes	Yes	No
Extended Attributes	L	Yes	Yes	Yes
Fileref	C	Yes	Yes	No
Host	L	Yes	Yes	Yes
Icon	C	Yes	Yes	No
Id	C	* Req	No	No
Input Objects	L	No	No	No
Input Sources	L	No	No	No
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
Options	L	Yes	Yes	No
Output Objects	L	No	No	No
Output Targets	L	Yes	Yes	No
Path	L	Yes	Yes	No
Process	L	Yes	Yes	Yes

New properties for WHEFILE are as follows:

ACCESS METHOD: indicates the SAS filename access method specification.
CREATING JOB: specifies a list of general identifying information about the job that creates this file. This list 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 is removed, then any work tables in the chain of INPUT SOURCES will be deleted as well.
FILEREF: represents the fileref that is used to access this file using a SAS filename statement. The maximum length is 8 characters.
HOST: specifies an SCL List of general identifying information about the host on which this file is accessed.
ICON: indicates the catalog entry name of the associated icon. For more information about icons, see Using Icon Information.
INPUT OBJECTS: specifies an SCL list of general identifying information about the objects that are input to this external file. For more details about input objects, see INPUT and OUTPUT Properties.
INPUT SOURCES: specifies an SCL list of general, identifying information about the sources that are input to this file. For more details about input sources, see INPUT and OUTPUT Properties.
OPTIONS: represents an SCL list of filename statement options. The list contains multiple entries to support options that might be too long to fit in one list item.
OUTPUT OBJECTS: specifies an SCL list of general identifying information about the objects that are output from this external file. For more details about output objects, see INPUT and OUTPUT Properties.
OUTPUT TARGETS: specifies an SCL list of general identifying information about the targets that are output from this external file. For more details about output targets, see INPUT and OUTPUT Properties.
PATH: indicates an SCL list of host-specific path designations.
PROCESS: specifies an SCL list of general identifying information about the process that created this file.

Using WHEFILE

Add	Update	Delete
Yes	Yes	No

WHEFILE is an independent type.

Top of Page