AcfUpDownload

AcfUpDownload enables large files to be uploaded to and downloaded from a KPro content server. Files up to 2 GB can be sent and received by AcfUpDownload.

Note Note

In the back end (content server) the file size is restricted. Presently, the content server supports files up to a size of 2 GB.

End of the note.

Caution Caution

The integration of AcfUpDownload in Web Dynpro ABAP popups is not supported.

End of the caution.

The upload/download takes place from a KPro content server to the local file system. The actual data exchange between the content server and Web Dynpro takes place using the ACF protocol.

More information:

SAP Content Server

Knowledge Provider (KPro)

Active Component Framework (ACF)

Methods

As with OfficeControl, methods can be executed. The CL_WDR_ACFUPDOWNLOAD_HNDL method handler is required for this.

Unlike other Web Dynpro ABAP UI elements, AcfUpDownload is implemented in a way that means the action can only be triggered by a method call. For AcfUpDownload, an upload/download only takes place with one of the following method calls:

IF_WD_ACFUPDOWNLOAD_SCMS~HTTP_PUT
IF_WD_ACFUPDOWNLOAD_SCMS~HTTP_GET

Note Note

Currently, the upload/download of large files from the application server without KPro is not possible.

End of the note.

File Selection Dialog

Some properties of the AcfUpDownload UI element are not set with the UI element properties but with IF_WD_ACFUPDOWNLOAD_SWFS instead. Here you can display a file selection dialog.

Notes

If the application calls get for AcfUpDownload and the file is already available on the client, the following points apply:

A large number of files can be downloaded for each method; a different error could occur for each file.
However, there is only one error string with one error code. This means that only the first error is ever returned and written to the context.
There are two different get methods: with and without override-Flag
There is an onCompleted event for which an application can register (or not) with an action.

Case 1:

The application calls get without the override-Flag, and has not registered on onCompleted.

In this case, the value 210 (FILE_PRESENT) is contained in the error string of the context, followed by a space and a comma-separated list of existing files.
If another error occurs beforehand, this other error is in the context instead.

Case 2

The application calls get without the override-Flag, and has registered on onCompleted.

In this case, the value 210 (FILE_PRESENT) is contained in the error string of the context, followed by a space and a list of existing files separated by commas.
In addition, the application receives an event with status 210 plus the comma-separated list as a statusMessage.
If a different error occurs beforehand, this error is in the event instead.

Case 3

The application calls get with override-Flag = true.

The local file is replaced by a newly downloaded file.
This does not affect the error string for the context or the event value.

Case 4

The application calls get with override-Flag = false.

The existing local file is retained.
This does not affect the error string for the context or the event value.

Implementation Details

Runtime Class

CL_WD_ACF_UP_DOWNLOAD

Properties in View Designer
Name	Type	Initial Value	Bindable
ID	`STRING`	(automatic)	No
archives	`STRING`		Yes
class	`STRING`		Yes
contextMenuBehaviour	`WDUI_CONTEXT_MENU_BEHAVIOUR`	`inherit`	No
contextMenuId	`WDY_MD_UI_ELEMENT_REFERENCE`		No
enabled	`WDY_BOOLEAN`	`true`	Yes
height	`STRING`		Yes
lifeTime	`WDUI_LIFE_TIME`	`whenVisible`	Yes
tooltip	Translatable text		Yes
visible	`WDUI_VISIBILITY`	`visible`	Yes
width	`STRING`		Yes

Events in View Designer
Name
onCompleted

Other properties that can be inherited are defined in the related higher-level classes. The related UI elements are:

Dynamic Programming

For dynamic programming, the same properties, events and aggregations are available as in the View Designer. But note that the spelling format and use of upper/lower case is different.

Dynamic Programming of Properties
View Designer Name	Runtime Name	Type
archives	`ARCHIVES`	`STRING`
class	`CLASS`	`STRING`
contextMenuBehaviour	`CONTEXT_MENU_BEHAVIOUR`	`WDUI_CONTEXT_MENU_BEHAVIOUR`
`contextMenuBehaviour: inherit`	`CL_WD_ACF_UP_DOWNLOAD=>E_CONTEXT_MENU_BEHAVIOUR-INHERIT`
`contextMenuBehaviour: provide`	`CL_WD_ACF_UP_DOWNLOAD=>E_CONTEXT_MENU_BEHAVIOUR-PROVIDE`
`contextMenuBehaviour: suppress`	`CL_WD_ACF_UP_DOWNLOAD=>E_CONTEXT_MENU_BEHAVIOUR-SUPPRESS`
contextMenuId	`CONTEXT_MENU_ID`	`WDY_MD_UI_ELEMENT_REFERENCE`
enabled	`ENABLED`	`WDY_BOOLEAN`
height	`HEIGHT`	`STRING`
lifeTime	`LIFE_TIME`	`WDUI_LIFE_TIME`
`lifeTime: whenAlive`	`CL_WD_ACF_UP_DOWNLOAD=>E_LIFE_TIME-WHEN_ALIVE`
`lifeTime: whenVisible`	`CL_WD_ACF_UP_DOWNLOAD=>E_LIFE_TIME-WHEN_VISIBLE`
tooltip	`TOOLTIP`	`WDY_MD_TRANSLATABLE_TEXT`
visible	`VISIBLE`	`WDUI_VISIBILITY`
`visible: none`	`CL_WD_ACF_UP_DOWNLOAD=>E_VISIBLE-NONE`
`visible: visible`	`CL_WD_ACF_UP_DOWNLOAD=>E_VISIBLE-VISIBLE`
width	`WIDTH`	`STRING`

Dynamic Programming of Events
View Designer Name	Runtime Name
onCompleted	`ON_COMPLETED`

Prerequisites

The following prerequisites must be fulfilled to enable AcfUpDownload to function smoothly on a client:

Installation of a Sun Java plug-in (Java 5 or higher)
See also SAP Note 1178747
Presence of a valid white list XML file.
Under Microsoft Windows this is %APPDATA%\SAP

Example

You can find a test example of this UI element in the system in the SWDP_TEST_ACTIVE_COMPONENT package in the WD_TEST_APPL_ACFUPDOWN component.