Database Operation Task Properties
The Database Operation Task Properties window contains the settings for a job step that executes as Database Operation Task.
Property Pages
Property pages common to all Tasks
General
Name for this step (optional)
Optionally, specify a descriptive name for the step.
Enable this step
Uncheck this box to disable the step. If the step is not enabled, it will be skipped at execution.
Description/Notes
Enter any extended descriptive information or notes for this step.
Conditions
The Conditions page defines conditions that must be satisfied before the step is run.
Condition Criteria
The Condition Criteria determine how the conditions should be evaluated:
- Execute only if all conditions are met. The step is only executed if all of the listed conditions are met.
- Execute if any condition is met. The step is executed if any of the listed conditions is met.
If Conditions are not satisfied
The satisfaction options determine what adTempus should do if the conditions are not satisfied:
- Fail the step. The step is not executed; the status is set to Failed.
- Execute anyway. The step is executed anyway.
- Skip the step (do not report as a failure). The step is not run, but it is not treated as a failure. The status of the step is reported as "Skipped (conditions not met)."
Conditions List
The Conditions list lists the conditions that have been defined for the step. You can add, edit, or delete conditions. See the Conditions topic for information on the available condition types.
Variables
The Variables page allows you to define Job Variables for this step. You can add new Variables, or override the values of Variables inherited from the Job. Any Variables you define or override here affect only this step of the Job.
To set Variables that apply to the entire job, use the Variables page in the Job properties.
Responses
The Responses page defines the actions that adTempus should take in response to events that are fired during execution of the step. You can add, edit, delete, or reorder responses.
All job steps support the events listed below. Some tasks may define additional events .
| Event | Description |
| Step Started | Occurs at the beginning of the step. |
| Step Ended | Occurs at the end of the step, regardless of the step result. |
| Step Failed | Occurs if the step fails for any reason. |
| Step Restarted | Occurs if the step is restarted due to a Response. |
| Restart Limit Exceeded | Occurs if the restart limit is exceeded. |
| Step skipped | Occurs when the step is skipped, either because conditions were not met (if the Skip... option is selected on the Conditions page) or due to a skip option specific to the task. |
| One or more conditions failed | Occurs if one or more Conditions for the step is not satisfied. |
 Conditions not met within the specified time |
Occurs if the job or a step within the job has been waiting for conditions for longer than the specified time. |
In addition to the standard Response Events, this task supports the following special events:
| Event | Description |
| Value selected from database matches specified value | Applies only if the operation is "Select a scalar value into a Job Variable." The Response will run if the value returned by the query (i.e., the value assigned to the target Job Variable) matches the specified value. |
| The database job was canceled | Occurs if the database job being monitored by adTempus was canceled on the database server. |
Database Connection
Database Type
Select the type of database server you want to connect to. adTempus supports the following database servers:
- SQL Server. No additional configuration is required.
- Oracle. You must have the
Oracle client components and the Oracle OleDb provider (OraOLEDB.Oracle)
installed on the adTempus server.
- MySQL. No additional configuration is required.
- Other. Other database types are supported if there is an OleDb driver for the database installed on the adTempus server. You must enter the OleDb connection string below.
Specify custom connection string
Check this option to enter a custom OleDb connection string for connecting to the database.
If you include the tokens {userid} and {password} in your connection string, they will be replaced with the user ID and password from the Credential Profile specified in the Database Authentication section. This allows you to avoid having the password saved in clear text.
Database Connection
If you have not checked Specify custom connection string, enter the values needed to connect to the database.
For Oracle databases, you can choose to Use TNS, in which case you enter the service alias defined in the tnsnames configuration file (remember, this must be configured on the computer where the adTempus service is running, if that is different from where you are running the Console). Alternatively, adTempus can connect without using a TNS alias: enter the Host Name and Service Name directly.
Database Authentication
Select Use integrated (automatic) authentication if you want the database server to authenticate automatically based on the Windows identity used for the job.
Select Specify database credentials to enter explicit credentials for the database server. The Credential Profile selector will filter the available Credential Profiles to only those defined for the database server you have selected.
Test Connection
Click Test Connection to verify that adTempus can connect to the database server using the settings you have provided.
Database Operation
Specify the database operation to perform.
By default adTempus uses a timeout value of 20 minutes for database selection and update operations (all operations other than job execution). That is, if your SQL execution or selection takes more than 20 minutes, the database will abort it and the task will fail.
If you need to allow operations to run longer than this, change the timeout value in the Server Options window.
Execute SQL
adTempus will execute the SQL commands you provide. To execute multiple commands, you should separate commands with a line containing only "/" or "go".
Select a scalar value into a Job Variable
adTempus will execute the SQL query you provide, which should be a scalar selection query (a query that returns a single value, such as "select count(*) from MyImportTable"). The result of that query will be stored in the Job Variable that you specify, making it available for other operations within the job.
If you specify more than one command in the SQL editor, only the result from the last statement executed will be stored in the variable.
Select data into a DataSet
adTempus will execute the SQL query you provide and return the selected data as a .NET DataSet. The resulting DataSet can be sent to:
- A script. Select or create a .NET script to execute. In the script, the returned data will be available in Parameters.DataSet, which will be a System.Data.DataSet object.
- A file. The DataSet will be written to the file in the DataSet XML format.
If you specify more than one command in the SQL editor, only the result from the last statement executed will be stored in the DataSet.
Execute database job
adTempus will execute a job defined on the database server (e.g., a job defined in SQL Server Agent on SQL Server). This operation is only available for SQL Server and Oracle databases.
Specify the name of the job to run. This value is not validated when you enter it; it must be the name of a job on the target database server.
If you check Wait for job to complete, the adTempus job step will continue to run as long as the database job is running, and the status of the step will reflect the outcome of the database job (succeeded or failed). If the target job is already running, adTempus will not start a new copy of it, but will monitor the already-running job.
If Wait for job to complete is not checked, adTempus will submit the job but will not wait for it to run. The status of the adTempus job step will be "Succeeded" if the database job was successfully started, or "Failed" if the job could not be submitted. If the target job is already running, adTempus will log an informational message in the adTempus Job Log and the step will be reported as "Succeeded."
Related Concepts