API Functions
Use the functions provided in the InfoSphere® DataStage® API to perform various tasks with projects and jobs.
This section details the functions provided in the InfoSphere DataStage API. These functions are described in alphabetical order. The following table briefly describes the functions categorized by usage:
Usage | Function | Description |
---|---|---|
Accessing projects | DSCloseProject | Closes a project that was opened with DSOpenProject. |
DSGetProjectList | Retrieves a list of all projects on the engine | |
DSGetProjectInfo | Retrieves a list of jobs in a project. | |
DSOpenProject | Opens a project. | |
DSSetServerParams | Sets the host name, user name, and password to use for a job. | |
Accessing jobs | DSCloseJob | Closes a job that was opened with DSOpenJob. |
DSGetJobInfo | Retrieves information about a job, such as the date and time of the last run, parameter names, and so on. | |
DSLockJob | Locks a job prior to setting job parameters or starting a job run. | |
DSOpenJob | Opens a job. | |
DSRunJob | Runs a job. | |
DSStopJob | Aborts a running job. | |
DSUnlockJob | Unlocks a job, enabling other processes to use it. | |
DSWaitForJob | Waits until a job has completed. | |
Accessing job parameters | DSGetParamInfo | Retrieves information about a job parameter. |
DSSetJobLimit | Sets row processing and warning limits for a job. | |
DSSetParam | Sets job parameter values. | |
Accessing stages | DSGetStageInfo | Retrieves information about a stage within a job. |
Accessing links | DSGetLinkInfo | Retrieves information about a link of an active stage within a job. |
Accessing log entries | DSFindFirstLogEntry | Retrieves entries in a log that meet the specified criteria. |
DSFindNextLogEntry | Finds the next log entry that meets the criteria specified in DSFindFirstLogEntry. | |
DSGetLogEntry | Retrieves the specified log entry. | |
DSGetLogEntryFull | Retrieves the specified log entry, including the message ID and the invocation ID. | |
DSGetLogEventIds | Retrieves a list of event log IDs for a given job invocation. | |
DSGetNewestLogId | Retrieves the newest entry in the log. | |
DSLogEvent | Adds a new entry to the log. | |
Administering Projects and jobs | DSAddEnvVar | Adds a new environment variable. |
DSAddProject | Add a project. | |
DSDeleteEnvVar | Delete an environment variable. | |
DSDeleteProject | Delete a project. | |
DSListEnvVars | List environment variables. | |
DSListProjectProperties | List the properties of a project. | |
DSSetEnvVar | Set an environment variable. | |
DSSetProjectProperty | Set property for a project. | |
Handling errors | DSGetLastError | Retrieves the last error code value generated by the calling thread. |
DSGetLastErrorMsg | Retrieves the text of the last reported error. |