SAS/Warehouse Administrator Metadata Types

WHJOB

Metadata type for jobs

Category:

Object Types--Process Editor

Parent
Overview
Properties
Property Dependencies
Using WHJOB

Parent

WHPOBJCT

Overview

WHJOB models the metadata for a job. A job is a metadata record that specifies the processes that create one or more data stores (output tables).

Properties

The following table lists all of the properties for WHJOB 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.
Actual End Date	C	No	No	No
Actual Start Date	C	No	No	No
Administrator	L	Yes	Yes	No
Cvalue	C	Yes	Yes	No
Desc	C	Yes	Yes	No
Extended Attributes	L	Yes	Yes	Yes
External Job ID	C	Yes	Yes	No
Icon	C	Yes	Yes	No
Id	C	* Req	* Req	No
Input Objects	L	No	No	No
Input Sources	L	Yes	Yes	No
Input Tables	L	No	No	No
Job ID	C	No	No	No
Job Type	C	Yes	Yes	No
List	L	No	No	Yes
Log	L	No	No	Yes
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 Tables	L	Yes	Yes	No
Output Targets	L	Yes	Yes	No
Owner	L	Yes	Yes	No
Process Groups	L	* Req	Yes	No
Process Members	L	No	No	No
Recurring Month Days	C	Yes	Yes	No
Recurring Months	C	Yes	Yes	No
Recurring Week Days	C	Yes	Yes	No
Responsibility	C	Yes	Yes	No
Return Code	N	No	No	No
Run Command	C	Yes	Yes	No
Scheduled Start Date	C	See Property Dependencies	See Property Dependencies	No
Scheduling Server	L	Yes	Yes	No
Source Code	L	No	No	Yes
Source File	L	Yes	Yes	Yes
Status	C	No	No	No
Step Source Code	L	No	No	Yes
Sysin	L	No	No	Yes
Tracking	N	Yes	Yes	No
Tracking Epilog	L	Yes	Yes	Yes
Tracking Prolog	L	Yes	Yes	Yes
User Epilog	L	Yes	Yes	Yes
Userpe	N	Yes	Yes	No
User Prolog	L	Yes	Yes	Yes

New properties for WHJOB are as follows:

ACTUAL END DATE

indicates the SAS datetime when the job actually ended (a character value that is formatted with the SAS DATETIME. format) or N/A if not available. This read-only property is set by job tracking code and job scheduling code.

ACTUAL START DATE

indicates the SAS datetime when the job actually started (a character value that is formatted with the SAS DATETIME. format) or N/A if not available. This read-only property is set by job tracking code and job scheduling code.

EXTERNAL JOB ID

indicates an optional 8-character field that can contain a value that uniquely identifies the job. This read-only property is set by job tracking code and job scheduling code.

INPUT OBJECTS

specifies an SCL list of general identifying information about the objects that are input to this job.

INPUT SOURCES

specifies an SCL list of general identifying information about the sources that are input to this job. This list must be of type WHJOB or WHEVENT. Adding an object beneath itself is prevented.

INPUT TABLES

specifies a list of general identifying information about the tables that are used in this job to create the output tables. These tables are not created by this job; they are the inputs to the tables that are created by this job.

JOB ID

represents a unique identifier that is assigned by the Job Scheduler utility.

JOB TYPE

indicates how often the job runs. Valid values are ONCE, DAILY, WEEKLY, and MONTHLY.

LIST

specifies the location of the job list file. This property is a WHJOBFIL object. This read-only property is set by job tracking code and job scheduling code.

LOG

indicates the location of the job log file. This property is a WHJOBFIL object. This read-only property is set by job tracking code and job scheduling code.

OUTPUT OBJECTS

specifies an SCL list of general identifying information about the objects that are output from this job. This list points to successor jobs.

OUTPUT TABLES

specifies a list of general identifying information about the tables that are created by this job. This list must be of type WHTABLE, WHINFO, WHINFOFL, WHSUMDDB, WHEFILE, or subtypes of these.

OUTPUT TARGETS

specifies an SCL list of general identifying information about the targets that are output from this job. This list must be of type WHJOB or type WHEVENT.

RECURRING MONTH DAYS

applies only to monthly jobs. An 85-character string indicates what day(s) in the month a job runs. Valid values are a list of integers from 1 through 31, delimited with a comma or a semicolon. At least one integer is required. No duplicates are permitted. The string is converted to a comma-delimited list with no embedded blanks.

RECURRING MONTHS

applies only to monthly jobs. A 30-character string indicates what months a job runs, where 1=January and 12=December. Valid values are a list of integers from 1 through 12, delimited with a comma or a semicolon. At least one integer is required. No duplicates are permitted. The string is converted to a comma-delimited list with no embedded blanks.

RECURRING WEEK DAYS

applies only to weekly jobs. A 15-character string indicates what weekday(s) a job runs, where 0=Sunday and 6=Saturday. Valid values are a list of integers from 0 through 6, delimited with a comma or a semicolon. At least one integer is required. No duplicates are permitted. The string is converted to a comma-delimited list with no embedded blanks.

RESPONSIBILITY

specifies the character string that indicates who is currently responsible for the creation of the code that is associated with this process.

SAS indicates that SAS/Warehouse Administrator is creating this code dynamically based on the current metadata. USER indicates that the user has written the code for this process and is responsible for it.

RETURN CODE

specifies a numeric variable that indicates the return code from the job or N/A if not available. This read-only property is set by job tracking code and job scheduling code.

RUN COMMAND

indicates a 200-character string that contains the command that is issued to run the job.

SCHEDULED START DATE

represents the SAS datetime when the job is scheduled to start. (A character value that is formatted with a SAS DATETIME. format.)

SCHEDULING SERVER

indicates the scheduling server that this job runs on. This property is a subtype of WHSERV, such as WHSRVAT.

SOURCE CODE

specifies an SCL list of general identifying information about the source code for this process. This source code is the same as is seen when selecting View Code All in the SAS/Warehouse Administrator Process Editor.

The source code information that is returned here will be that of a temporary working location of a copy of the source code and might be different for each request for this information.

SOURCE FILE

specifies an SCL list of general identifying information about any user-registered code for a process. This list must be of type WHSRCCAT or a subtype of WHSRCCAT. However, WHJOBCAT or any subtype of WHJOBCAT will be rejected. For process steps that consist of user-written code, this property returns the registered source code location. For process steps that consist of code that is generated by SAS/Warehouse Administrator, this property will return an empty list.

STATUS

represents a 12-character string that indicates the status of the job. Valid values are a blank, SCHEDULED, RUNNING, COMPLETE, or N/A if not available. This read-only property is set by job tracking code and job scheduling code.

STEP SOURCE CODE

specifies an SCL list of general identifying information about the source code of the individual step in the process. This source code is the same as is seen when selecting View Code Process in the SAS/Warehouse Administrator Process Editor.

The source code information that is returned here will be that of a temporary working location of a copy of the source code and therefore might be different for each request for this information.

SYSIN

indicates the location of the job sysin file. This property is a WHJOBFIL object. This read-only property is set by job tracking code and job scheduling code.

TRACKING

enables or disables code generation for tracking prologs and epilogs. Values are

-1 -- default to server definition

0 -- disable

1 -- enable

The default value for this property is -1 (default to server definition).

TRACKING EPILOG

indicates the location of the tracking epilog, which is given to the Job Scheduler by the user. This property returns a WHJOBCAT object. The tracking epilog is appended to the input source code in order to update the job information file with the job completion information.

TRACKING PROLOG

indicates the location of the tracking prolog, which is given to the Job Scheduler by the user. This property returns a WHJOBCAT object.

USER EPILOG

indicates the location of the user epilog, which is given to the Job Scheduler by the user. This property returns a WHJOBCAT object.

USERPE

enables or disables code generation for user prologs and epilogs. Values are:

0 -- disable

1 -- enable

The default value for this property is 0 (disable).

USER PROLOG

indicates the location of the user prolog, which is given to the Job Scheduler by the user. This property returns a WHJOBCAT object.

Property Dependencies

If the JOB TYPE property is blank, then SCHEDULED START DATE is ignored. If the JOB TYPE is non-blank, then a valid SCHEDULED START DATE is required.

Using WHJOB

Add	Update	Delete
Yes	Yes	Yes

WHJOB is an independent type. To understand how jobs relate to other types, see the diagram on the foldout in Appendix 2.

Top of Page