Friday, August 23, 2013

DataStage BASIC functions


These functions can be used in a job control routine, which is defined as part of a jobs properties and allows other jobs to be run and controlled from the first job. Some of the functions can also be used for getting status information on the current job; these are useful in active stage expressions and before- and after-stage subroutines. 


Specify the job you want to control
DSAttachJob


Set parameters for the job you want to control
DSSetParam

Set limits for the job you want to control
DSSetJobLimit

Request that a job is run
DSRunJob

Wait for a called job to finish
DSWaitForJob

Gets the meta data details for the specified link
DSGetLinkMetaData

Get information about the current project
DSGetProjectInfo

Get buffer size and timeout value for an IPC or Web Service stage
DSGetIPCStageProps

Get information about the controlled job or current job
DSGetJobInfo

Get information about the meta bag properties associated with the named job
DSGetJobMetaBag

Get information about a stage in the controlled job or current job
DSGetStageInfo

Get the names of the links attached to the specified stage
DSGetStageLinks

Get a list of stages of a particular type in a job.
DSGetStagesOfType

Get information about the types of stage in a job.
DSGetStageTypes

Get information about a link in a controlled job or current job
DSGetLinkInfo

Get information about a controlled jobs parameters
DSGetParamInfo

Get the log event from the job log
DSGetLogEntry

Get a number of log events on the specified subject from the job log
DSGetLogSummary

Get the newest log event, of a specified type, from the job log
DSGetNewestLogId

Log an event to the job log of a different job
DSLogEvent

Stop a controlled job
DSStopJob

Return a job handle previously obtained from DSAttachJob
DSDetachJob

Log a fatal error message in a job's log file and aborts the job.
DSLogFatal

Log an information message in a job's log file.
DSLogInfo

Put an info message in the job log of a job controlling current job.
DSLogToController

Log a warning message in a job's log file.
DSLogWarn

Generate a string describing the complete status of a valid attached job.
DSMakeJobReport

Insert arguments into the message template.
DSMakeMsg

Ensure a job is in the correct state to be run or validated.
DSPrepareJob

Interface to system send mail facility.
DSSendMail

Log a warning message to a job log file.
DSTransformError

Convert a job control status or error code into an explanatory text message.
DSTranslateCode

Suspend a job until a named file either exists or does not exist.
DSWaitForFile

Checks if a BASIC routine is cataloged, either in VOC as a callable item, or in the catalog space.
DSCheckRoutine

Execute a DOS or Data Stage Engine command from a before/after subroutine.
DSExecute

Set a status message for a job to return as a termination message when it finishes
DSSetUserStatus