SAP ABAP Class CL_DB2_JOB_CONTROL (backend class for CL_DB2_ACTION_JOB_CONTROL)
Hierarchy
SAP_BASIS (Software Component) SAP Basis Component
   BC-DB-DB2 (Application Component) DB2 for z/OS
     STU2 (Package) CCMS for DB2 for OS/390
Properties
Class CL_DB2_JOB_CONTROL  
Short Description backend class for CL_DB2_ACTION_JOB_CONTROL    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package STU2   CCMS for DB2 for OS/390 
Created 20101201   SAP 
Last change 20140121   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
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
Class CL_DB2_JOB_CONTROL has no interface implemented.
Friends
Class CL_DB2_JOB_CONTROL has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 STATUS_ACTIVE Constant Public Type reference (TYPE) LAST_STAT 'active' Last status of JCL job 20110201
2 STATUS_FINISHED Constant Public Type reference (TYPE) LAST_STAT 'finished' Last status of JCL job 20110201
3 STATUS_HOLD Constant Public Type reference (TYPE) LAST_STAT 'hold' Last status of JCL job 20110201
4 STATUS_NOT_RUN Constant Public Type reference (TYPE) LAST_STAT 'not run' Last status of JCL job 20110201
5 STATUS_PURGED Constant Public Type reference (TYPE) LAST_STAT 'purged' Last status of JCL job 20110201
6 STATUS_SUBMITTED Constant Public Type reference (TYPE) LAST_STAT 'submitted' Last status of JCL job 20110203
7 STATUS_UNKNOWN Constant Public Type reference (TYPE) LAST_STAT 'unknown' Last status of JCL job 20110201
Methods
# Method Level Visibility Method type Description Created on
1 BUILD_FILEPATH Static method Public Method build filepath 20110117
2 BUILD_JCL_JOB Static method Public Method build jcl job 20101201
3 DELETE_JCL_JOB Static method Public Method delete jcl job 20110309
4 DELETE_JOBHEAD Static method Public Method delete jobhead 20110308
5 DELETE_OUTPUT Static method Public Method delete job output 20110207
6 DELETE_PARAMETER_LINE Static method Public Method delete one parameter 20110308
7 GET_JCL_DIR Static method Public Method build filepath 20110310
8 GET_JCL_JOB Static method Public Method get jcl job 20110309
9 GET_JOBHEAD Static method Public Method get jobhead 20101201
10 GET_JOBLIST Static method Public Method get joblist / get utility list 20110404
11 GET_JOB_INFO Static method Public Method get job info, if job already exists 20110404
12 GET_JOB_OUTPUT Static method Public Method get job output 20110118
13 GET_STATUS Static method Public Method get status of jobs 20110117
14 REFRESH_JOB_STATUS Static method Public Method refresh job status 20110117
15 REFRESH_STATUS_TABLE Static method Public Method refresh job status 20110317
16 REPLACE_ALL_PARAMETERS Static method Public Method replace all parameters 20110309
17 REPLACE_JOBHEAD Static method Public Method replace jcl job 20110309
18 REPLACE_ONE_PARAMETER Static method Public Method replace one parameter 20101201
19 SAVE_JCL_JOB Static method Public Method save jcl job 20101201
20 SAVE_JOBHEAD Static method Public Method save jobhead 20110222
21 SAVE_JOB_INFO Static method Public Method save job information 20110404
22 SUBMIT_JCL_JOB_ASYNCH Static method Public Method submit jcl job asynch 20110309
23 SUBMIT_JCL_JOB_SYNCH Static method Public Method submit jcl job asynch 20110310
Events
Class CL_DB2_JOB_CONTROL has no event.
Types
Class CL_DB2_JOB_CONTROL has no local type.
Method Signatures

Method BUILD_FILEPATH Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning FILEPATH Value transfer Type reference (TYPE) DB2FILEPATH 20110117
2 Importing JOBNO Call by reference Type reference (TYPE) JOBNO Number of JCL job 20110117

Method BUILD_FILEPATH on class CL_DB2_JOB_CONTROL has no exception.

Method BUILD_JCL_JOB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing JOBCREATOR Call by reference Type reference (TYPE) JCREATOR Creator of the JCL job 20110311
2 Importing JOBNAME Call by reference Type reference (TYPE) JOBNAME Name of a JCL job 20110311
3 Importing JOBSUFFIX Call by reference Type reference (TYPE) JN_SUFFIX 'B' Job name suffix 20110311
4 Exporting JOB_CONTENT Call by reference Type reference (TYPE) DB2JCL_JOBCARD_TAB table type for jcl job 20110310
5 Importing PREVIEW Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Build JCL to display in the GUI 20110318
6 Importing REMOTE_DBCON Call by reference Type reference (TYPE) DBCON_NAME Logical name for a database connection 20110307
7 Importing REPLACE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE Replace $variables with values 20110318
8 Importing SSID Call by reference Type reference (TYPE) DB2SWPSSID DB2 member name in data sharing environment 20110310
# Exception Resumable Description Created on
1 CX_DBA_ROOT DBA Cockpit: Root exception class 20110203
2 CX_SQL_EXCEPTION Exception Class for SQL Error 20110308

Method DELETE_JCL_JOB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing JOBCREATOR Call by reference Type reference (TYPE) JCREATOR Creator of the JCL job 20110311
2 Importing JOBNAME Call by reference Type reference (TYPE) JOBNAME Name of a JCL job 20110311
3 Importing JOBSUFFIX Call by reference Type reference (TYPE) JN_SUFFIX Job name suffix 20110311
# Exception Resumable Description Created on
1 CX_DBA_ROOT DBA Cockpit: Root exception class 20110309

Method DELETE_JOBHEAD Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CREATOR Call by reference Type reference (TYPE) JCREATOR 20110308
2 Importing REMOTE_DBCON Call by reference Type reference (TYPE) DBCON_NAME Logical name for a database connection 20110308
3 Importing SSID Call by reference Type reference (TYPE) DB2SWPSSID DB2 subsystem ID 20110308
# Exception Resumable Description Created on
1 CX_DBA_ROOT 20110308
2 CX_SQL_EXCEPTION Exception Class for SQL Error 20130410

Method DELETE_OUTPUT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing JOB_OUTPUT Call by reference Type reference (TYPE) DB2JSTATUS structure for editing job alv 20110310
# Exception Resumable Description Created on
1 CX_SY_FILE_ACCESS_ERROR DBA Cockpit: Root exception class 20110314

Method DELETE_PARAMETER_LINE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing JOB Call by reference Type reference (TYPE) DB2JCL_JOBCARD_TAB table type for jcl job 20110308
2 Importing VAR Call by reference Type reference (TYPE) DB2CHAR20 Data element of length 20 20110308

Method DELETE_PARAMETER_LINE on class CL_DB2_JOB_CONTROL has no exception.

Method GET_JCL_DIR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning FILEPATH Value transfer Type reference (TYPE) DB2FILEPATH 20110310

Method GET_JCL_DIR on class CL_DB2_JOB_CONTROL has no exception.

Method GET_JCL_JOB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing JOBCREATOR Call by reference Type reference (TYPE) JCREATOR Creator of the JCL job 20110311
2 Importing JOBNAME Call by reference Type reference (TYPE) JOBNAME Name of a JCL job 20110311
3 Importing JOBSUFFIX Call by reference Type reference (TYPE) JN_SUFFIX Job name suffix 20110311
4 Returning JOB_CONTENT Value transfer Type reference (TYPE) DB2JCL_JOBCARD_TAB table type for jcl job 20110310
# Exception Resumable Description Created on
1 CX_DBA_ROOT DBA Cockpit: Root exception class 20110309

Method GET_JOBHEAD Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CREATOR Call by reference Type reference (TYPE) JCREATOR User Name 20101201
2 Exporting DFLT_JOBHEAD Call by reference Type reference (TYPE) DB2FLAG c1 flag 20110308
3 Exporting JOBHEAD Call by reference Type reference (TYPE) DB2JCL_JOBCARD_TAB table type for jcl job 20101201
4 Importing REMOTE_DBCON Call by reference Type reference (TYPE) DBCON_NAME Logical name for a database connection 20110307
5 Importing SSID Call by reference Type reference (TYPE) DB2SWPSSID DB2 member name in data sharing environment 20101201
# Exception Resumable Description Created on
1 CX_SQL_EXCEPTION Exception Class for SQL Error 20110308

Method GET_JOBLIST Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing JOBCREATOR Call by reference Type reference (TYPE) JCREATOR Creator of the JCL job 20110404
2 Returning JOBLIST Value transfer Type reference (TYPE) DB2JSINF_TAB table type of DB2JSINF 20110404
3 Importing UTILS Call by reference Type reference (TYPE) DB2FLAG ABAP_FALSE c1 flag 20110404

Method GET_JOBLIST on class CL_DB2_JOB_CONTROL has no exception.

Method GET_JOB_INFO Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing JOBCREATOR Call by reference Type reference (TYPE) JCREATOR Creator of the JCL job 20110404
2 Returning JOBINFO Value transfer Type reference (TYPE) DB2JSINF Header Table of JCL Administration 20110411
3 Importing JOBNAME Call by reference Type reference (TYPE) JOBNAME Name of a JCL job 20110404

Method GET_JOB_INFO on class CL_DB2_JOB_CONTROL has no exception.

Method GET_JOB_OUTPUT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing JOB Call by reference Type reference (TYPE) DB2JSTATUS Status of Submitted JCL Jobs 20110310
2 Exporting JOB_OUTPUT Call by reference Type reference (TYPE) DB2JESOUT_TAB 20110310
3 Importing REMOTE_DBCON Call by reference Type reference (TYPE) DBCON_NAME Logical name for a database connection 20110314
# Exception Resumable Description Created on
1 CX_DBA_ROOT DB2: root class regarding exceptions 20110201

Method GET_STATUS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning JOBS Value transfer Type reference (TYPE) DB2JSTATUS_TAB table type of DB2JSTATUS 20110310
2 Importing SUBMITTER Call by reference Type reference (TYPE) JCREATOR Creator of the JCL job 20110117

Method GET_STATUS on class CL_DB2_JOB_CONTROL has no exception.

Method REFRESH_JOB_STATUS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing JOB Call by reference Type reference (TYPE) DB2JSTATUS Status of Submitted JCL Jobs 20110310
2 Importing REMOTE_DBCON Call by reference Type reference (TYPE) DBCON_NAME Logical name for a database connection 20110314
3 Returning STATUS Value transfer Type reference (TYPE) LAST_STAT Last status of JCL job 20110201
# Exception Resumable Description Created on
1 CX_DBA_ROOT DBA Cockpit: Root exception class 20110126

Method REFRESH_STATUS_TABLE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing REMOTE_DBCON Call by reference Type reference (TYPE) DBCON_NAME Logical name for a database connection 20110317
2 Importing SUBMITTER Call by reference Type reference (TYPE) JCREATOR Creator of the JCL job 20110317
# Exception Resumable Description Created on
1 CX_DBA_ROOT DBA Cockpit: Root exception class 20110317

Method REPLACE_ALL_PARAMETERS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing JOBCREATOR Call by reference Type reference (TYPE) JCREATOR Creator of the JCL job 20110311
2 Importing JOBNAME Call by reference Type reference (TYPE) JOBNAME Name of a JCL job 20110311
3 Importing JOBSUFFIX Call by reference Type reference (TYPE) JN_SUFFIX Job name suffix 20110311
4 Changing JOB_CONTENT Call by reference Type reference (TYPE) DB2JCL_JOBCARD_TAB table type for jcl job 20110309
5 Importing PREVIEW Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20110318
6 Importing REMOTE_DBCON Call by reference Type reference (TYPE) DBCON_NAME Logical name for a database connection 20110309
7 Importing SSID Call by reference Type reference (TYPE) DB2SWPSSID DB2 subsystem ID 20110310
# Exception Resumable Description Created on
1 CX_DBA_ROOT DBA Cockpit: Root exception class 20110309

Method REPLACE_JOBHEAD Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing JOB_CONTENT Call by reference Type reference (TYPE) DB2JCL_JOBCARD_TAB table type for jcl job 20110310
2 Importing REMOTE_DBCON Call by reference Type reference (TYPE) DBCON_NAME Logical name for a database connection 20110309
3 Importing SSID Call by reference Type reference (TYPE) DB2SWPSSID DB2 member name in data sharing environment 20110310
# Exception Resumable Description Created on
1 CX_SQL_EXCEPTION Exception Class for SQL Error 20110309

Method REPLACE_ONE_PARAMETER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing JOB Call by reference Type reference (TYPE) DB2JCL_JOBCARD_TAB table type for jcl job 20101201
2 Importing OBSERVE_COMMENT Call by reference Type reference (TYPE) ABAP_BOOL 20101201
3 Importing VALUE Call by reference Type reference (TYPE) DB2CHAR40 Data element of length 40 20101201
4 Importing VAR Call by reference Type reference (TYPE) DB2CHAR20 Data element of length 20 20101201

Method REPLACE_ONE_PARAMETER on class CL_DB2_JOB_CONTROL has no exception.

Method SAVE_JCL_JOB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing JOB Call by reference Type reference (TYPE) DB2JSINF Header Table of JCL Administration 20110311
2 Importing JOB_CONTENT Call by reference Type reference (TYPE) DB2JCL_JOBCARD_TAB table type for jcl job 20101201
# Exception Resumable Description Created on
1 CX_DBA_ROOT DBA Cockpit: Root exception class 20130404

Method SAVE_JOBHEAD Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing DFLT_FLAG Call by reference Type reference (TYPE) DB2FLAG c1 flag 20110222
2 Importing JOB_CONTENT Call by reference Type reference (TYPE) DB2JCL_JOBCARD_TAB table type for jcl job 20110309
3 Importing REMOTE_DBCON Call by reference Type reference (TYPE) DBCON_NAME Logical name for a database connection 20110307
4 Importing SSID Call by reference Type reference (TYPE) DB2SWPSSID DB2 subsystem ID 20110222
# Exception Resumable Description Created on
1 CX_DBA_ROOT DBA Cockpit: Root exception class 20110308
2 CX_SQL_EXCEPTION Exception Class for SQL Error 20110308

Method SAVE_JOB_INFO Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing JOB Call by reference Type reference (TYPE) DB2JSINF Header Table of JCL Administration 20110404
# Exception Resumable Description Created on
1 CX_DBA_ROOT DBA Cockpit: Root exception class 20130404

Method SUBMIT_JCL_JOB_ASYNCH Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing JOBCREATOR Call by reference Type reference (TYPE) JCREATOR Creator of the JCL job 20110311
2 Importing JOBNAME Call by reference Type reference (TYPE) JOBNAME Name of a JCL job 20110311
3 Importing JOBSUFFIX Call by reference Type reference (TYPE) JN_SUFFIX Job name suffix 20110311
4 Importing JOB_CONTENT Call by reference Type reference (TYPE) DB2JCL_JOBCARD_TAB table type for jcl job 20110309
5 Importing REMOTE_DBCON Call by reference Type reference (TYPE) DBCON_NAME Logical name for a database connection 20110309
# Exception Resumable Description Created on
1 CX_DBA_ROOT DBA Cockpit: Root exception class 20110309

Method SUBMIT_JCL_JOB_SYNCH Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing JOB_CONTENT Call by reference Type reference (TYPE) DB2JCL_JOBCARD_TAB table type for jcl job 20110310
2 Exporting JOB_MAX_RC Call by reference Type reference (TYPE) DB2CCRETURN Return code of stored procedure 20110310
3 Exporting JOB_OUTPUT Call by reference Type reference (TYPE) DB2JESOUT_TAB table type of structure DB2JESOUT 20110310
4 Importing REMOTE_DBCON Call by reference Type reference (TYPE) DBCON_NAME Logical name for a database connection 20110310
# Exception Resumable Description Created on
1 CX_DBA_ROOT DBA Cockpit: Root exception class 20110310
History
Last changed by/on SAP  20140121 
SAP Release Created in 731