SAP ABAP Class CL_DMS_VE_VIEWER_INTEGRATION (Class for Visual Enterprise Viewer integration in DMS)

Hierarchy

☛ BBPCRM (Software Component) BBPCRM
   ⤷ CA-DMS (Application Component) Document Management System
     ⤷ CV (Package) Application Development: R/3 Document Management

Properties

Class	CL_DMS_VE_VIEWER_INTEGRATION
Short Description	Class for Visual Enterprise Viewer integration in DMS
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	CV	Application Development: R/3 Document Management
Created	20130114	SAP
Last change	20131127	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_DMS_VE_VIEWER_INTEGRATION has no interface implemented.

Friends

Class CL_DMS_VE_VIEWER_INTEGRATION has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CV_MUP_PHIO_CLASS	Constant	Private	☐	Type reference (TYPE)	SDOK_CLASS	'DMS_PHD1'	Document class	20130814
2	CV_USAGE	Constant	Private	☐	Type reference (TYPE)	DMS_USAGE	'DMS'	Usage	20130814
3	GO_CAT_GRID	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_ALV_GRID		ALV List Viewer	20130814
4	GO_DMS_VE_VIEWER_INTEGRATION	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_DMS_VE_VIEWER_INTEGRATION		Class for Visual Enterprise Viewer integration in DMS	20130814
5	GO_POP_UP	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_DIALOGBOX_CONTAINER		Container for Custom Controls in the Screen Area	20130814
6	GO_VE_VIEWER_MODEL	Static Attribute	Private	☐	Object reference (TYPE REF TO)	IF_GUI_VIEWER_CONSUMER_MODEL		Consumer model interface for viewer in SAP GUI	20130814
7	GV_DIRTY_FLAG	Instance attribute	Public	☐	Type reference (TYPE)	BOOLEAN		True=> New layer/ Conversation exist in viewer	20130814
8	GV_OK_CODE	Static Attribute	Private	☐	Type reference (TYPE)	SYST-UCOMM		ABAP-Systemfeld: Funktionscode, der PAI ausgelöst hat	20130814
9	MO_PARENT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Abstract Container for GUI Controls	20130814
10	MS_CAT_LAYOUT	Instance attribute	Private	☐	Type reference (TYPE)	LVC_S_LAYO		ALV control: Layout structure	20130814
11	MS_DRAW	Instance attribute	Private	☐	Type reference (TYPE)	DRAW		Document Info Record	20130814
12	MT_CAT_FIELDCATALOG	Instance attribute	Private	☐	Type reference (TYPE)	LVC_T_FCAT		Field Catalog for List Viewer Control	20130814
13	MT_MUP_CATEGORY	Instance attribute	Private	☐	Type reference (TYPE)	MT_MUP_CAT			20130814
14	MT_SAVE_LAYER_DONE	Instance attribute	Private	☐	Type reference (TYPE)	/PLMU/T_VWR_SAVE_LAYER_DONE		Tabletype of /PLMU/S_VWR_SAVE_LAYER_DONE	20130814
15	MT_TOOLBAR_EXCLUDING	Instance attribute	Private	☐	Type reference (TYPE)	UI_FUNCTIONS		Function Code Table	20130814
16	MV_CLOSE_VIEWER	Instance attribute	Private	☐	Type reference (TYPE)	BOOLEAN		(X=Close Viewer, Space=False)	20130814
17	MV_FILEPATH	Instance attribute	Private	☐	Type reference (TYPE)	DRAW-FILEP		Original of document	20130814
18	MV_LOIO_ID	Instance attribute	Private	☐	Type reference (TYPE)	SDOKOBJECT-OBJID		ID for documents and relations	20130814
19	MV_MUP_CATEGORY	Instance attribute	Private	☐	Type reference (TYPE)	DMS_MUP_CATEGORY		Markup category	20130814
20	MV_PHIO_ID	Instance attribute	Private	☐	Type reference (TYPE)	SDOK_DOCID		Physical Id	20130814
21	MV_STORAGE_CAT	Instance attribute	Private	☐	Type reference (TYPE)	DMS_STORAGE_CATEGORY		Storage Category	20130814
22	MV_URL	Instance attribute	Private	☐	Type reference (TYPE)	MCDOK-URL		URL	20130814

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CAT_ALV_LAYOUT	Instance method	Private	Method	ALV Grid layout for redlining caterogries pop up	20130814
2	CHECK_DIRTY_LAYERS	Instance method	Public	Method	Need to save layer or not (X = Need to save layer)	20130814
3	CLOSE_VIEWER	Instance method	Public	Method	Close open VE Viewer	20130814
4	CREATE_FIELD_CATALOG	Instance method	Private	Method	Create field catalog for ALV Grid	20130814
5	DELETE_ALV_MENU_BUTTON	Instance method	Private	Method	Delete ALV Grid menu button, which are not needed	20130814
6	DOC_FILE_GET_DATA	Instance method	Private	Method	Get document file data i.e. master path and storage category	20130814
7	GET_ADDTIONAL_ACTIONS	Instance method	Private	Method	Additional actions for viewer context menu	20130814
8	GET_EXCLUDE_ACTIONS	Instance method	Private	Method	Get actions which need to exclude from viewer context menu	20130814
9	GET_EXISTING_LAYER	Instance method	Private	Method	Get list of existing layer to display in VE Viewer	20130814
10	GET_INSTANCE	Static method	Public	Method	Get Instance of class CL_DMS_VE_VIEWER_INTEGRATION	20130814
11	GET_OK_CODE	Instance method	Public	Method	Get last ok code before triggering viewer action	20130814
12	HANDLE_ADDITIONAL_ACTIONS	Instance method	Private	Event handling method	Handle addtional actions	20130814
13	HANDLE_LAYER_CHANGE	Instance method	Private	Event handling method	Event to inform layers are changed	20130814
14	HANDLE_POP_UP_CLOSING	Instance method	Private	Event handling method	Event handler to close pop up	20130814
15	HANDLE_SAVE_LAYER	Instance method	Private	Event handling method	Event to inform layers are save	20130814
16	HANDLE_TOOLBAR	Instance method	Private	Event handling method	Event to create toolbar	20130814
17	HANDLE_USER_COMMAND	Instance method	Private	Event handling method	Event to handle usercomand	20130814
18	HANDLE_VWR_MESSAGE	Instance method	Private	Event handling method	Event to inform error/success msg while executing dispatch	20130814
19	INITIALIZE_CAT_POPUP	Instance method	Private	Method	Initialize required objects for redlining category popup	20130814
20	LOAD_VIEWER	Instance method	Public	Method	Load Original in VE Viewer	20130814
21	SAVE_CHANGED_LAYER	Instance method	Public	Method	Event to save the unchanged layer	20130814
22	SAVE_MUP	Instance method	Private	Method	Save Mark ups in KPRO	20130814
23	SELECT_LAYER_CATEGORY	Instance method	Private	Method	Select Redlining category to save redline or layer	20130814
24	SHOW_MSG_POPUP	Instance method	Public	Method	Show pop up for confirmation or error	20130814
25	START_DOC_CONVERSION	Instance method	Public	Method	Start Conversion of document	20130814
26	START_DOC_REGISTRATION	Instance method	Public	Method	Start Document Registration For Conversion	20130814
27	TRIGGER_SAVE_MUP	Instance method	Private	Event handling method	Trigger save mark ups or redlining	20130814

Events

Class CL_DMS_VE_VIEWER_INTEGRATION has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	MS_MUP_CAT	Private	See coding			20130814	BEGIN OF ms_mup_cat, mup_cat(20) TYPE c, mup_desc(50) TYPE c, END OF ms_mup_cat
2	MT_MUP_CAT	Private	See coding			20130814	MT_MUP_CAT TYPE TABLE OF ms_mup_cat

Method Signatures

Method CAT_ALV_LAYOUT Signature

Method CAT_ALV_LAYOUT on class CL_DMS_VE_VIEWER_INTEGRATION has no parameter.
Method CAT_ALV_LAYOUT on class CL_DMS_VE_VIEWER_INTEGRATION has no exception.

Method CHECK_DIRTY_LAYERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_FLAG	Call by reference	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20130814
2	Importing	IV_OK_CODE	Call by reference	☐	Type reference (TYPE)	SYST-UCOMM		ABAP-Systemfeld: Funktionscode, der PAI ausgelöst hat	20130814

Method CHECK_DIRTY_LAYERS on class CL_DMS_VE_VIEWER_INTEGRATION has no exception.

Method CLOSE_VIEWER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_CLOSE	Call by reference	☐	Type reference (TYPE)	C		True if Viewer successfully closed	20130814

Method CLOSE_VIEWER on class CL_DMS_VE_VIEWER_INTEGRATION has no exception.

Method CREATE_FIELD_CATALOG Signature

Method CREATE_FIELD_CATALOG on class CL_DMS_VE_VIEWER_INTEGRATION has no parameter.
Method CREATE_FIELD_CATALOG on class CL_DMS_VE_VIEWER_INTEGRATION has no exception.

Method DELETE_ALV_MENU_BUTTON Signature

Method DELETE_ALV_MENU_BUTTON on class CL_DMS_VE_VIEWER_INTEGRATION has no parameter.
Method DELETE_ALV_MENU_BUTTON on class CL_DMS_VE_VIEWER_INTEGRATION has no exception.

Method DOC_FILE_GET_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PHIO_ID	Call by reference	☐	Type reference (TYPE)	SDOK_DOCID		ID for documents and relations	20130814
2	Returning	RV_ERROR_FLAG	Value transfer	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=Error , Space= No Error)	20130814

Method DOC_FILE_GET_DATA on class CL_DMS_VE_VIEWER_INTEGRATION has no exception.

Method GET_ADDTIONAL_ACTIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ACTIONS	Call by reference	☐	Type reference (TYPE)	/PLMU/T_VWR_ACTION		table of actions	20130814

Method GET_ADDTIONAL_ACTIONS on class CL_DMS_VE_VIEWER_INTEGRATION has no exception.

Method GET_EXCLUDE_ACTIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_EXCLUDE_ACTIONS	Call by reference	☐	Type reference (TYPE)	/PLMU/T_VWR_EXCLACTION		Viewer actions not allowed	20130814

Method GET_EXCLUDE_ACTIONS on class CL_DMS_VE_VIEWER_INTEGRATION has no exception.

Method GET_EXISTING_LAYER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_LAYERS	Call by reference	☐	Type reference (TYPE)	/PLMU/T_VWR_LAYERDATA		Tabletype of /PLMU/S_VWR_LAYERDATA	20130814
2	Importing	IV_DRAW	Call by reference	☐	Type reference (TYPE)	DRAW		Document Info Record	20130814
3	Importing	IV_FILEID	Call by reference	☐	Type reference (TYPE)	SDOK_PHID		Physical document	20130814

Method GET_EXISTING_LAYER on class CL_DMS_VE_VIEWER_INTEGRATION has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_DMS_VE_VIEWER_INTEGRATION	Value transfer	☐	Object reference (TYPE REF TO)	CL_DMS_VE_VIEWER_INTEGRATION		Class for Visual Enterprise Viewer integration in DMS	20130814

Method GET_INSTANCE on class CL_DMS_VE_VIEWER_INTEGRATION has no exception.

Method GET_OK_CODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_OK_CODE	Call by reference	☐	Type reference (TYPE)	SYST-UCOMM		ABAP-Systemfeld: Funktionscode, der PAI ausgelöst hat	20130814

Method GET_OK_CODE on class CL_DMS_VE_VIEWER_INTEGRATION has no exception.

Method HANDLE_ADDITIONAL_ACTIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_ACTION	Value transfer	☐	Attribute reference (LIKE)				20130814

Method HANDLE_ADDITIONAL_ACTIONS on class CL_DMS_VE_VIEWER_INTEGRATION has no exception.

Method HANDLE_LAYER_CHANGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SET_LAYER_CHANGE	Value transfer	☐	Attribute reference (LIKE)				20130814

Method HANDLE_LAYER_CHANGE on class CL_DMS_VE_VIEWER_INTEGRATION has no exception.

Method HANDLE_POP_UP_CLOSING Signature

Method HANDLE_POP_UP_CLOSING on class CL_DMS_VE_VIEWER_INTEGRATION has no parameter.
Method HANDLE_POP_UP_CLOSING on class CL_DMS_VE_VIEWER_INTEGRATION has no exception.

Method HANDLE_SAVE_LAYER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_SAVE_LAYER_DONE	Value transfer	☐	Attribute reference (LIKE)				20130814

Method HANDLE_SAVE_LAYER on class CL_DMS_VE_VIEWER_INTEGRATION has no exception.

Method HANDLE_TOOLBAR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	E_INTERACTIVE	Value transfer	☐	Attribute reference (LIKE)				20130814
2	Importing	E_OBJECT	Value transfer	☐	Attribute reference (LIKE)				20130814

Method HANDLE_TOOLBAR on class CL_DMS_VE_VIEWER_INTEGRATION has no exception.

Method HANDLE_USER_COMMAND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	E_UCOMM	Value transfer	☐	Attribute reference (LIKE)				20130814

Method HANDLE_USER_COMMAND on class CL_DMS_VE_VIEWER_INTEGRATION has no exception.

Method HANDLE_VWR_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_MESSAGE	Value transfer	☐	Attribute reference (LIKE)				20130814

Method HANDLE_VWR_MESSAGE on class CL_DMS_VE_VIEWER_INTEGRATION has no exception.

Method INITIALIZE_CAT_POPUP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_INITIALIZE_SUCCESS_FLAG	Value transfer	☐	Type reference (TYPE)	BOOLEAN		True =Objects initialized & False = initialization failed	20130814

Method INITIALIZE_CAT_POPUP on class CL_DMS_VE_VIEWER_INTEGRATION has no exception.

Method LOAD_VIEWER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_PARENT	Value transfer	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Abstract Container for GUI Controls	20130814
2	Importing	IS_DRAW	Value transfer	☐	Type reference (TYPE)	DRAW		Document Info Record	20130814
3	Importing	IV_FILEPATH	Value transfer	☐	Type reference (TYPE)	DRAW-FILEP		Original of document	20130814
4	Importing	IV_MASTER_LOIO	Value transfer	☐	Type reference (TYPE)	SDOKOBJECT-OBJID		ID for documents and relations	20130814
5	Importing	IV_MASTER_PHIO	Value transfer	☐	Type reference (TYPE)	SDOKOBJECT-OBJID		ID for documents and relations	20130814
6	Importing	IV_URL	Value transfer	☑	Type reference (TYPE)	MCDOK-URL		URL	20130814

Method LOAD_VIEWER on class CL_DMS_VE_VIEWER_INTEGRATION has no exception.

Method SAVE_CHANGED_LAYER Signature

Method SAVE_CHANGED_LAYER on class CL_DMS_VE_VIEWER_INTEGRATION has no parameter.
Method SAVE_CHANGED_LAYER on class CL_DMS_VE_VIEWER_INTEGRATION has no exception.

Method SAVE_MUP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_SAVE_LAYER_DONE	Call by reference	☐	Type reference (TYPE)	/PLMU/T_VWR_SAVE_LAYER_DONE		Tabletype of /PLMU/S_VWR_SAVE_LAYER_DONE	20130814

Method SAVE_MUP on class CL_DMS_VE_VIEWER_INTEGRATION has no exception.

Method SELECT_LAYER_CATEGORY Signature

Method SELECT_LAYER_CATEGORY on class CL_DMS_VE_VIEWER_INTEGRATION has no parameter.
Method SELECT_LAYER_CATEGORY on class CL_DMS_VE_VIEWER_INTEGRATION has no exception.

Method SHOW_MSG_POPUP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_ANSWER	Call by reference	☐	Type reference (TYPE)	C		Return values: '1', '2', 'A'	20130814
2	Importing	IV_ERROR_POPUP	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE	Boolean Variable (X=True, Space=False)	20130814
3	Importing	IV_MSG_TEXT	Call by reference	☑	Type reference (TYPE)	STRING		message text which we need to display in pop up	20130814

Method SHOW_MSG_POPUP on class CL_DMS_VE_VIEWER_INTEGRATION has no exception.

Method START_DOC_CONVERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_DRAW	Call by reference	☐	Type reference (TYPE)	DRAW		Document Details	20130814

Method START_DOC_CONVERSION on class CL_DMS_VE_VIEWER_INTEGRATION has no exception.

Method START_DOC_REGISTRATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_DRAW	Call by reference	☐	Type reference (TYPE)	DRAW		Document Info Record	20130814

Method START_DOC_REGISTRATION on class CL_DMS_VE_VIEWER_INTEGRATION has no exception.

Method TRIGGER_SAVE_MUP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	E_COLUMN	Value transfer	☐	Attribute reference (LIKE)				20130814
2	Importing	E_ROW	Value transfer	☐	Attribute reference (LIKE)				20130814

Method TRIGGER_SAVE_MUP on class CL_DMS_VE_VIEWER_INTEGRATION has no exception.

History

Last changed by/on	SAP	20131127
SAP Release Created in