SAP ABAP Class CL_FCC_BP_JOB_MGMT (Background Job Management)

Hierarchy

☛ FCCO (Software Component) Financial Closing Cockpit 200
   ⤷ CA-GTF-FCC (Application Component) Financial Closing cockpit Add-on
     ⤷ FCC_CLOSING (Package) Financial Closing Cockpit - SAPGUI and backend

Properties

Class	CL_FCC_BP_JOB_MGMT
Short Description	Background Job Management
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	FCC_CLOSING	Financial Closing Cockpit - SAPGUI and backend
Created	20110616	SAP
Last change	20141108
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_FCC_BP_JOB_MGMT has no forward declaration.

Interfaces

Class CL_FCC_BP_JOB_MGMT has no interface implemented.

Friends

Class CL_FCC_BP_JOB_MGMT has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	BP_FCC_CUST_JOB_NAME	Constant	Public	☐	Type reference (TYPE)	TBTCJOB-JOBNAME	'FCC_CUST_NOTI_BACKGROUND_JOB'	Name of a custom notification background job	20111207
2	BP_FCC_CUST_REPORT_NAME	Constant	Public	☐	Type reference (TYPE)	SY-REPID	'FCC_CUST_NOTI_BACKGROUND_PROG'	Program Name of Custom Background Job	20111207
3	BP_FCC_MGMT_JOB_JOBCLASS	Static Attribute	Public	☐	Type reference (TYPE)	BTCJOBCLAS	'B'	Job Class	20111207
4	BP_FCC_MGMT_JOB_NAME	Constant	Public	☐	Type reference (TYPE)	TBTCJOB-JOBNAME	'FCC_MGMT_BACKGROUND_JOB'	Job Name of FCC management background job	20111207
5	BP_FCC_MGMT_JOB_PRDMINS	Static Attribute	Public	☐	Type reference (TYPE)	BTCPMIN	05	Duration period (in minutes) for a batch job	20111207
6	BP_FCC_MGMT_REPORT_NAME	Constant	Public	☐	Type reference (TYPE)	SY-REPID	'FCC_BG_JOB_CHECK_PROGRAM'	Program Name of FCC management background job	20111207
7	BP_FCC_RETRY_NUM	Constant	Public	☐	Type reference (TYPE)	INT4	10	Natural number	20130103
8	BP_FCC_RETRY_WAIT	Constant	Public	☐	Type reference (TYPE)	INT4	30	Natural number	20130103
9	BP_FCC_RJ_JOB_NAME	Constant	Public	☐	Type reference (TYPE)	TBTCJOB-JOBNAME	'FCC_RJ_BACKGROUND_JOB'	Name of a background job for remote job status update	20111208
10	BP_FCC_RJ_REPORT_NAME	Constant	Public	☐	Type reference (TYPE)	SY-REPID	'FCC_RJ_JOB_UPDATE_STATUS_PROG'	ProgramName of a background job for remote job status update	20111208
11	BP_FCC_STD_JOB_NAME	Constant	Public	☐	Type reference (TYPE)	TBTCJOB-JOBNAME	'FCC_STD_BACKGROUND_JOB'	Name of a background job	20111207
12	BP_FCC_STD_REPORT_NAME	Constant	Public	☐	Attribute reference (LIKE)	SY-REPID	'FCC_STD_BACKGROUND_PROGRAM'	Program Name of Background Job	20111207
13	C_BTC_ABORTED	Constant	Public	☐	Type reference (TYPE)	BTCSTATUS	'A'	State of Background Job	20131002
14	C_BTC_FINISHED	Constant	Public	☐	Type reference (TYPE)	BTCSTATUS	'F'	State of Background Job	20131002
15	C_BTC_READY	Constant	Public	☐	Type reference (TYPE)	BTCSTATUS	'Y'	State of Background Job	20131002
16	C_BTC_RELEASED	Constant	Public	☐	Type reference (TYPE)	BTCSTATUS	'S'	State of Background Job	20131002
17	C_BTC_RUNNING	Constant	Public	☐	Type reference (TYPE)	BTCSTATUS	'R'	State of Background Job	20131002
18	C_BTC_SCHEDULED	Constant	Public	☐	Type reference (TYPE)	BTCSTATUS	'P'	State of Background Job	20131002
19	C_BTC_SUSPENDED	Constant	Public	☐	Type reference (TYPE)	BTCSTATUS	'Z'	State of Background Job	20131002
20	C_BTC_UNKNOWN	Constant	Public	☐	Type reference (TYPE)	BTCSTATUS	'X'	State of Background Job	20131002
21	LOGGER	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_FCC_APP_LOG_MANAGER		Update Status Management	20110705

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BP_JOB_ACTIVE	Static method	Public	Method	The Job is released or running	20120824
2	BP_JOB_CAN_EXIST	Static method	Public	Method	Check if the condition is statisfied to create a job	20111115
3	BP_JOB_CREATE	Static method	Public	Method	Create Background Job	20111207
4	BP_JOB_CREATE_P	Static method	Private	Method	Create Background Job	20130103
5	BP_JOB_DELETE	Static method	Public	Method	Delete Background Job	20110616
6	BP_JOB_EXIST	Static method	Public	Method	Check if background job exist	20110616
7	BP_JOB_EXIST_NUM	Static method	Public	Method	Check if background job exist	20111220
8	BP_JOB_MANAGE	Static method	Public	Method	Create Background Job	20111207
9	CUSTOM_JOB_CAN_EXIST	Static method	Public	Method	Check if the condition is statisfied to create a job	20111115
10	DELETE_JOB	Static method	Private	Method	Delete existing job	20131003
11	DELETE_RUNNING_JOB	Static method	Private	Method	Delete the running background job	20110621
12	FCC_BATCHJOB_SHOW	Static method	Public	Method	Show the batch job of FCC	20120824
13	GET_BP_JOB_SETTINGS	Static method	Public	Method	Set the background job structure	20111207
14	MGMT_JOB_CAN_EXIST	Static method	Public	Method	Should management job run?	20131002
15	RESET_BP_JOB	Static method	Public	Method	Reset the job structure and restart the job	20110621
16	RJ_JOB_CAN_EXIST	Static method	Public	Method	Check if the condition is statisfied to create a job	20111212
17	WRITE_LOG	Static method	Public	Method	Write log for automatic notification	20110705

Events

Class CL_FCC_BP_JOB_MGMT has no event.

Types

Class CL_FCC_BP_JOB_MGMT has no local type.

Method Signatures

Method BP_JOB_ACTIVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_JOB_ACTIVE	Call by reference	☐	Type reference (TYPE)	XFLAG		Is the job active?	20131002
2	Exporting	EX_OWNER	Call by reference	☐	Type reference (TYPE)	UNAME		Job owner	20120830
3	Exporting	EX_RELEASED_BY	Call by reference	☐	Type reference (TYPE)	UNAME		Job creator	20120829
4	Exporting	EX_RESCHEDULE	Call by reference	☐	Type reference (TYPE)	XFLAG		Create next instance of the job?	20131002
5	Importing	IM_JOB_NAME	Call by reference	☐	Type reference (TYPE)	TBTCJOB-JOBNAME		Background job name	20120824

Method BP_JOB_ACTIVE on class CL_FCC_BP_JOB_MGMT has no exception.

Method BP_JOB_CAN_EXIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	CHAR1		Single-Character Indicator	20111115

Method BP_JOB_CAN_EXIST on class CL_FCC_BP_JOB_MGMT has no exception.

Method BP_JOB_CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_JOB_CLASS	Call by reference	☑	Type reference (TYPE)	BTCJOBCLAS		Job classification	20111207
2	Importing	IM_JOB_NAME	Call by reference	☐	Type reference (TYPE)	TBTCJOB-JOBNAME		Background job name	20111207
3	Importing	IM_JOB_USER	Call by reference	☑	Type reference (TYPE)	FCC_TASK_OWNER		Task Processor	20111207
4	Importing	IM_PERIODIC_BP_JOB	Call by reference	☐	Type reference (TYPE)	BOOLEAN	' '	Boolean Variable (X=True, -=False, Space=Unknown)	20111207
5	Importing	IM_PRD_MINS	Call by reference	☑	Type reference (TYPE)	BTCPMIN		Duration period (in minutes) for a batch job	20111207
6	Importing	IM_REPORT_NAME	Call by reference	☐	Type reference (TYPE)	SY-REPID			20111207
7	Importing	IM_REPORT_VAR	Call by reference	☑	Type reference (TYPE)	RALDB-VARIANT		Variant Name	20111207

#	Exception	Resumable	Description	Created on
1	NO_AUTHORIZATION	☐	No authorization for creating the background job	20120830

Method BP_JOB_CREATE_P Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_JOB_CLASS	Call by reference	☐	Type reference (TYPE)	BTCJOBCLAS		Job classification	20130103
2	Importing	IM_JOB_NAME	Call by reference	☐	Type reference (TYPE)	TBTCJOB-JOBNAME		Background job name	20130103
3	Importing	IM_JOB_USER	Call by reference	☐	Type reference (TYPE)	FCC_TASK_OWNER		Task Processor	20130103
4	Importing	IM_PERIODIC_BP_JOB	Call by reference	☐	Type reference (TYPE)	BOOLEAN	' '	Boolean Variable (X=True, -=False, Space=Unknown)	20130103
5	Importing	IM_PRD_MINS	Call by reference	☐	Type reference (TYPE)	BTCPMIN		Duration period (in minutes) for a batch job	20130103
6	Importing	IM_REPORT_NAME	Call by reference	☐	Type reference (TYPE)	SY-REPID			20130103
7	Importing	IM_REPORT_VAR	Call by reference	☑	Type reference (TYPE)	RALDB-VARIANT		Variant Name	20130103

#	Exception	Resumable	Description	Created on
1	JOB_CREATE_FAILED	☐		20130103

Method BP_JOB_DELETE Signature

Method BP_JOB_DELETE on class CL_FCC_BP_JOB_MGMT has no parameter.
Method BP_JOB_DELETE on class CL_FCC_BP_JOB_MGMT has no exception.

Method BP_JOB_EXIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_JOB_NAME	Call by reference	☐	Type reference (TYPE)	TBTCJOB-JOBNAME		Background job name	20111115
2	Returning	RV_EXIST	Value transfer	☐	Type reference (TYPE)	CHAR1		Einstelliges Kennzeichen	20110616

Method BP_JOB_EXIST on class CL_FCC_BP_JOB_MGMT has no exception.

Method BP_JOB_EXIST_NUM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_JOB_NAME	Call by reference	☐	Type reference (TYPE)	TBTCJOB-JOBNAME		Background job name	20111220
2	Returning	RV_NUM	Value transfer	☐	Type reference (TYPE)	SY-DBCNT		Digit Indicator	20111220

Method BP_JOB_EXIST_NUM on class CL_FCC_BP_JOB_MGMT has no exception.

Method BP_JOB_MANAGE Signature

Method BP_JOB_MANAGE on class CL_FCC_BP_JOB_MGMT has no parameter.
Method BP_JOB_MANAGE on class CL_FCC_BP_JOB_MGMT has no exception.

Method CUSTOM_JOB_CAN_EXIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	CHAR1		Single-Character Indicator	20111115

Method CUSTOM_JOB_CAN_EXIST on class CL_FCC_BP_JOB_MGMT has no exception.

Method DELETE_JOB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_JOBCOUNT	Call by reference	☐	Type reference (TYPE)	BTCJOBCNT		Job ID	20131003
2	Importing	I_JOBNAME	Call by reference	☐	Type reference (TYPE)	BTCJOB		Background job name	20131003

Method DELETE_JOB on class CL_FCC_BP_JOB_MGMT has no exception.

Method DELETE_RUNNING_JOB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_JOB_NAME	Call by reference	☐	Type reference (TYPE)	TBTCJOB-JOBNAME		Background job name	20111115
2	Importing	IM_NO_FORCE_DELETE	Call by reference	☑	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20120215

Method DELETE_RUNNING_JOB on class CL_FCC_BP_JOB_MGMT has no exception.

Method FCC_BATCHJOB_SHOW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_JOB_NAME	Call by reference	☐	Type reference (TYPE)	TBTCJOB-JOBNAME		Background job name	20120824
2	Importing	IM_SIMPLE_MODE	Call by reference	☐	Attribute reference (LIKE)	SY-INPUT	SPACE	Internal ABAP System Field	20120824

#	Exception	Resumable	Description	Created on
1	NOTHING_SHOWED	☐	No Display	20120824

Method GET_BP_JOB_SETTINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_JOB_USER	Value transfer	☐	Type reference (TYPE)	FCC_TASK_OWNER		Task Processor	20111207
2	Exporting	EV_PRD_MINS	Value transfer	☐	Type reference (TYPE)	BTCPMIN		Duration period (in minutes) for a batch job	20111207
3	Exporting	EV_RESULT	Value transfer	☐	Type reference (TYPE)	CHAR1		Single-Character Indicator	20111207

Method GET_BP_JOB_SETTINGS on class CL_FCC_BP_JOB_MGMT has no exception.

Method MGMT_JOB_CAN_EXIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	CHAR1		Single-Character Flag	20131002

Method MGMT_JOB_CAN_EXIST on class CL_FCC_BP_JOB_MGMT has no exception.

Method RESET_BP_JOB Signature

Method RESET_BP_JOB on class CL_FCC_BP_JOB_MGMT has no parameter.
Method RESET_BP_JOB on class CL_FCC_BP_JOB_MGMT has no exception.

Method RJ_JOB_CAN_EXIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	CHAR1		Single-Character Indicator	20111212

Method RJ_JOB_CAN_EXIST on class CL_FCC_BP_JOB_MGMT has no exception.

Method WRITE_LOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_MSGID	Call by reference	☐	Type reference (TYPE)	SYMSGID	'FCC1'	Message Class	20110705
2	Importing	P_MSGNO	Call by reference	☑	Type reference (TYPE)	SYMSGNO		Message Number	20110705
3	Importing	P_MSGTY	Call by reference	☐	Type reference (TYPE)	SYMSGTY	'I'	Message Type	20110705
4	Importing	P_MSGV1	Call by reference	☑	Type reference (TYPE)	ANY			20110705
5	Importing	P_MSGV2	Call by reference	☑	Type reference (TYPE)	ANY			20110705
6	Importing	P_MSGV3	Call by reference	☑	Type reference (TYPE)	ANY			20110705
7	Importing	P_MSGV4	Call by reference	☑	Type reference (TYPE)	ANY			20110705

Method WRITE_LOG on class CL_FCC_BP_JOB_MGMT has no exception.

History

Last changed by/on	SAP	20141108
SAP Release Created in	607