Databases Job
Control-M for Databases enables you to define and monitor Stored Procedures, SQL Scripts, SQL Server Integration Services (SSIS) Packages, and Embedded Query database jobs.
The following table describes the Databases job type attributes.
Attribute |
Description |
---|---|
Connection Profile |
Determines the authorization credentials that are used to connect Control-M to Databases. Rules:
|
Database Type |
Defines the type of read-only database. |
Execution Type |
Determines the execution type of the Database job, as follows:
You can use additional databases to execute the Execution Type. For more information, see Adding a Database Type. Variable Name: %%DB-EXEC_TYPE |
More Options |
Opens more attributes. |
Enable auto Commit |
Determines whether to commit statements that complete successfully to the database. Available for all execution types except SSIS. Variable Name: %%DB-AUTOCOMMIT |
Append execution log to job output |
Determines whether to show the execution log in the job output A tab in the job properties pane of the Monitoring domain where the job output appears that indicates whether a job ended OK, and is used, for example, with jobs that check file location.. |
Append SQL output to job output |
Determines whether to show the SQL output in the job output. |
Output format |
Determines whether to define the output format as either text, XML, CSV, or HTML. |
Database Stored Procedure Attributes
The following table describes the Database Stored Procedure job attributes. Fields can contain 1–4,096 characters.
Attribute |
Description |
---|---|
Schema |
Defines the Database schema that contains the Stored Procedure. Variable Name: %%DB-STP_SCHEM |
Stored Procedure |
Defines the stored procedure. |
Parameters Table |
Lists the stored procedure parameters. |
Name |
Defines the name of the stored procedure parameter. Variable Names:
|
Data Type |
Defines the data type of the stored procedure, such as string or integer. Variable Name: %%DB-STP-PARAMS-Pnnn-PRM_TYPE |
Parameter Type |
Defines the variable name that stores the OUT and Return parameters result in the Stored Procedure submission. Variable Name: %%DB-STP_PARAMS-Pnnn-PRM_DIRECTION |
Value |
Defines the parameter values of the Stored Procedure and SQL script. Variable Names:
|
Variables |
Defines the variables of the Stored Procedure. Variable Name: %%DB-SCRPT-PARMS-Pnnn-VARIABLE |
Database SQL Script Attributes
The following table describes the Database SQL Script job attributes. Fields can contain 1–4,096 characters.
Attribute |
Description |
---|---|
File Name |
Defines the file path of the SQL Script. |
Script Variables |
Defines an SQL script variable and its value. |
Database SSIS Package
The following table describes the Database SSIS Package job attributes (MSSQL only). Fields can contain 1–4,096 characters.
Attribute |
Description |
---|---|
Package Source |
Defines the location of the SSIS Package in SQL Server, File System, or SSIS Package Store. Variable Name: %%DB-SSIS_PACKAGE_SOURCE |
Package Name |
Defines the name of the SSIS Package. Variable Name: %%DB-SSIS_PACKAGE_NAME |
Environment |
Defines the environment where an SSIS catalog executes. Variable Name: %%DB-SSIS_CATALOG_ENV |
SSIS Configuration File Names |
Defines the names of the configuration files that are added to the SSIS package. Variable Name: %%DB-SSIS_CONFIGFILES-Nxxx-NAME |
Properties Path |
Defines the name of each SSIS property path. Variable Name: %%DB-SSIS_SETVALPARAMS-Nxxx-NAME |
Value |
Defines the values of each SSIS property path. Variable Name: %%DB-SSIS_SETVALPARAMS-Nxxx-VALUE |
Database MSSQL Agent
The following table describes the Database MSSQL Agent job attributes (MSSQL only). Fields can contain 1–4,096 characters.
Attribute |
Description |
---|---|
Job Name |
Defines the name of MSSQL Agent Job, which was defined in MSSQL Server. Variable Name: %%DB-SSA_NAME |
Category |
Determines the category of the MSSQL Job. Variable Name: %%DB-SSA_CATEGORY_NAME |
Rerun from Point of Failure |
Determines whether the job reruns from the step that failed during the previous run. Variable Name: %%DB-SSA_RERUN_FROM_POINT_OF_FAILURE For example, if the job fails on step 3, it will rerun from step 3. |
Run from Step |
Determines whether the job runs from a specific step. Variable Name: %%DB-SSA_START_JOB_FROM_STEP Valid Values: 1-9999 Default: 1 |