SAP ABAP Interface IF_DBA_TASK_SCHEDULER (DBA: Task Scheduler)
Hierarchy
☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DB (Application Component) Database Interface, Database Platforms
     ⤷ SDBA_BACKEND (Package) DBA Cockpit: Backend Infrastructure
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Interface implementation (CLASS c. INTERFACES i_ref)  CL_DBA_TASK_SCHEDULER DBA: Task Scheduler 20081217
2 Interface implementation (CLASS c. INTERFACES i_ref)  CL_DBA_TASK_SCHEDULER_CTRL DBA: Task Scheduler Controller 20090109
Properties
Interface IF_DBA_TASK_SCHEDULER  
Short Description DBA: Task Scheduler    
General Data
Package SDBA_BACKEND   DBA Cockpit: Backend Infrastructure 
Created 20081217   SAP 
Last changed 20130531   SAP 
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 ABAP Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
Interfaces
Interface IF_DBA_TASK_SCHEDULER has no interface.
Friends
Interface IF_DBA_TASK_SCHEDULER has no friend.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 CO_SCHEDULE_10MIN Constant Public Type reference (TYPE) DBA_DBH_SCHEDULE '0,10,20,30,40,50 * * * *' DBA-DBH: Schedule for Firstrun / DB Scheduler 20090216
2 CO_SCHEDULE_12HOURS Constant Public Type reference (TYPE) DBA_DBH_SCHEDULE '0 0,12 * * *' DBA-DBH: Schedule for Firstrun / DB Scheduler 20090216
3 CO_SCHEDULE_15MIN Constant Public Type reference (TYPE) DBA_DBH_SCHEDULE '0,15,30,45 * * * *' DBA-DBH: Schedule for Firstrun / DB Scheduler 20091208
4 CO_SCHEDULE_1HOUR Constant Public Type reference (TYPE) DBA_DBH_SCHEDULE '0 * * * *' DBA-DBH: Schedule for Firstrun / DB Scheduler 20090216
5 CO_SCHEDULE_1MIN Constant Public Type reference (TYPE) DBA_DBH_SCHEDULE '*/1 * * * *' DBA-DBH: Schedule for Firstrun / DB Scheduler 20101201
6 CO_SCHEDULE_2HOURS Constant Public Type reference (TYPE) DBA_DBH_SCHEDULE '0 0,2,4,6,8,10,12,14,16,18,20,22 * * *' DBA-DBH: Schedule for Firstrun / DB Scheduler 20090216
7 CO_SCHEDULE_30MIN Constant Public Type reference (TYPE) DBA_DBH_SCHEDULE '0,30 * * * *' DBA-DBH: Schedule for Firstrun / DB Scheduler 20090216
8 CO_SCHEDULE_4HOURS Constant Public Type reference (TYPE) DBA_DBH_SCHEDULE '0 0,4,8,12,16,20 * * *' DBA-DBH: Schedule for Firstrun / DB Scheduler 20090216
9 CO_SCHEDULE_5MIN Constant Public Type reference (TYPE) DBA_DBH_SCHEDULE '0,5,10,15,20,25,30,35,40,45,50,55 * * * *' DBA-DBH: Schedule for Firstrun / DB Scheduler 20090216
10 CO_SCHEDULE_6HOURS Constant Public Type reference (TYPE) DBA_DBH_SCHEDULE '0 0,6,12,18 * * *' DBA-DBH: Schedule for Firstrun / DB Scheduler 20090216
11 CO_SCHEDULE_CUSTOM Constant Public Type reference (TYPE) DBA_DBH_SCHEDULE 'CUSTOM' DBA-DBH: Schedule for Firstrun / DB Scheduler 20090217
12 CO_SCHEDULE_DAILY12PM Constant Public Type reference (TYPE) DBA_DBH_SCHEDULE '0 0 * * *' DBA-DBH: Schedule for Firstrun / DB Scheduler 20090216
13 CO_SCHEDULE_NONE Constant Public Type reference (TYPE) DBA_DBH_SCHEDULE '' DBA-DBH: Schedule for Firstrun / DB Scheduler 20090216
14 CO_SCHEDULE_NOW Constant Public Type reference (TYPE) DBA_DBH_SCHEDULE 'NOW' DBA-DBH: Schedule for Firstrun / DB Scheduler 20091209
15 CO_SCHEDULE_WEEKLYSUN10PM Constant Public Type reference (TYPE) DBA_DBH_SCHEDULE '0 22 * * 0' DBA-DBH: Schedule for Firstrun / DB Scheduler 20090216
Methods
# Method Level Visibility Method type Description Created on
1 GET_CRON_FORMAT Instance method Public Method Return the Scheduling date and time in CRON format 20091125
2 GET_CRON_FORMAT_FOR_NOW Instance method Public Method Return Current Date+5 Minutes in CRON format 20091125
3 GET_TASK_SCHEDULE Instance method Public Method Return the Schedule of a Task 20090123
4 GET_TASK_SCHEDULE_LIST Instance method Public Method List of Scheduled Tasks 20090123
5 GET_TASK_STATUS Instance method Public Method List of Task Executions Status 20081217
6 IS_SCHEDULER_AVAILABLE Instance method Public Method Check if scheduler is available for this database connection 20090107
7 IS_TASK_SCHEDULED Instance method Public Method Check if task is scheduled 20081217
8 PRUNE_TASK_LOG Instance method Public Method 20120410
9 SCHEDULE_TASK Instance method Public Method Schedule a Task 20081217
10 UNSCHEDULE_TASK Instance method Public Method Unschedule a Task 20081217
Events
Interface IF_DBA_TASK_SCHEDULER has no event.
Types
Interface IF_DBA_TASK_SCHEDULER has no local type.
Method Signatures

Method GET_CRON_FORMAT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning CRON_FORMAT Value transfer Type reference (TYPE) DBA_DBH_SCHEDULE DBA-DBH: Schedule for Firstrun / DB Scheduler 20091125
2 Importing DATE Call by reference Type reference (TYPE) SYDATUM Current Date of Application Server 20091125
3 Importing TIME Call by reference Type reference (TYPE) SYUZEIT Current Time of Application Server 20091125

Method GET_CRON_FORMAT on Interface IF_DBA_TASK_SCHEDULER has no exception.

Method GET_CRON_FORMAT_FOR_NOW Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning CRON_FORMAT Value transfer Type reference (TYPE) DBA_DBH_SCHEDULE DBA-DBH: Schedule for Firstrun / DB Scheduler 20091125
# Exception Resumable Description Created on
1 CX_DBA_ADBC DBA Cockpit: ADBC Errors 20091125

Method GET_TASK_SCHEDULE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ROUTINENAME Call by reference Type reference (TYPE) STRING Routine Name 20090123
2 Importing ROUTINESCHEMA Call by reference Type reference (TYPE) STRING Routine Schema 20090123
3 Returning SCHEDULE Value transfer Type reference (TYPE) DBA_DBH_SCHEDULE DBA-DBH: Schedule for Firstrun / DB Scheduler 20090123
4 Importing TASK_ID Call by reference Type reference (TYPE) STRING Suffix for Uniqueness of Name 20091127
# Exception Resumable Description Created on
1 CX_DBA_TASK_SCHEDULER DBA: Task Scheduler Exception 20090123

Method GET_TASK_SCHEDULE_LIST Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning TASK_SCHEDULE_LIST Value transfer Type reference (TYPE) DB6_ADMIN_TASK_SCHEDULE_LIST Task Schedule List 20090123
# Exception Resumable Description Created on
1 CX_DBA_TASK_SCHEDULER DBA: Task Scheduler Exception 20090123

Method GET_TASK_STATUS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing BEGIN_TIME Call by reference Type reference (TYPE) DB6DATETIM DB6: Built-In UDB Type Timestamp 20081217
2 Importing END_TIME Call by reference Type reference (TYPE) DB6DATETIM DB6: Built-In UDB Type Timestamp 20081217
3 Importing ROUTINENAME Call by reference Type reference (TYPE) STRING 20120509
4 Importing ROUTINESCHEMA Call by reference Type reference (TYPE) STRING 20120509
5 Importing TASK_ID Call by reference Type reference (TYPE) STRING 20120509
6 Returning TASK_STATUS_LIST Value transfer Type reference (TYPE) DB6_ADMIN_TASK_STATUS_LIST Admin Task Status List 20081217
# Exception Resumable Description Created on
1 CX_DBA_TASK_SCHEDULER DBA: Task Scheduler Exception 20081217

Method IS_SCHEDULER_AVAILABLE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RESULT Value transfer Type reference (TYPE) ABAP_BOOL 20090107
# Exception Resumable Description Created on
1 CX_DBA_TASK_SCHEDULER DBA: Task Scheduler Exception 20090109

Method IS_TASK_SCHEDULED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RESULT Value transfer Type reference (TYPE) ABAP_BOOL True If Scheduled 20081217
2 Importing ROUTINENAME Call by reference Type reference (TYPE) STRING Routine Name 20081217
3 Importing ROUTINESCHEMA Call by reference Type reference (TYPE) STRING Routine Schema 20081217
4 Importing SCHEDULE Call by reference Type reference (TYPE) DBA_DBH_SCHEDULE Task Schedule 20081217
5 Importing TASK_ID Call by reference Type reference (TYPE) STRING Suffix for Uniqueness of Name 20091127
# Exception Resumable Description Created on
1 CX_DBA_TASK_SCHEDULER DBA: Task Scheduler Exception 20081217

Method PRUNE_TASK_LOG Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ROUTINENAME Call by reference Type reference (TYPE) STRING 20120410
2 Importing ROUTINESCHEMA Call by reference Type reference (TYPE) STRING 20120410
3 Importing TASK_ID Call by reference Type reference (TYPE) STRING Suffix for Uniqueness of Name 20120410
# Exception Resumable Description Created on
1 CX_DBA_TASK_SCHEDULER DBA: Task Scheduler Exception 20120410

Method SCHEDULE_TASK Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ROUTINENAME Call by reference Type reference (TYPE) STRING Routine Name 20081217
2 Importing ROUTINEPARAMS Call by reference Type reference (TYPE) DBA_DATA_REF_TAB Input Parameters for SP 20091127
3 Importing ROUTINESCHEMA Call by reference Type reference (TYPE) STRING Routine Schema 20081217
4 Importing SCHEDULE Call by reference Type reference (TYPE) DBA_DBH_SCHEDULE Cron Schedule 20081217
5 Importing TASK_ID Call by reference Type reference (TYPE) STRING Suffix for Uniqueness of Name 20091127
# Exception Resumable Description Created on
1 CX_DBA_TASK_SCHEDULER DBA: Task Scheduler Exception 20081217

Method UNSCHEDULE_TASK Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ROUTINENAME Call by reference Type reference (TYPE) STRING Routine Name 20081217
2 Importing ROUTINESCHEMA Call by reference Type reference (TYPE) STRING Routine Schema 20081217
3 Importing TASK_ID Call by reference Type reference (TYPE) STRING Suffix for Uniqueness of Name 20091127
# Exception Resumable Description Created on
1 CX_DBA_TASK_SCHEDULER DBA: Task Scheduler Exception 20081217
History
Last changed by/on SAP  20130531 
SAP Release Created in 720