How To Save Screenshots in SAP ABAP


This short blog post contains an ABAP snippet that allows saving a screenshot to the SAP ERP user's hard drive, using the well-known class CL_GUI_FRONTEND_SERVICES.

Recommended Now

All-new Echo Dot Smart speaker with Alexa

This bundle includes Echo Dot (3rd Gen) Charcoal and Philips Hue White A19 Medium Lumen Smart Bulb, 1100 Lumens. Built in Smart Home hub. Ask Alexa to control Zigbee-compatible devices. No additional Philips Hue hub required. Two choices for easy smart lighting - Start setting the mood with Hue Smart bulbs and your Echo device, supporting up to 5 Hue Bluetooth & Zigbee smart bulbs. Add the Hue Hub for whole-home smart lighting (up to 50 light points) and bonus features.

Check it out on →

The ABAP class CL_GUI_FRONTEND_SERVICES is quite a versatile tool that every SAP ABAP developer should know. It contains a lot of extremely helpful tools that help dealing with basic user interface requirements, such as showing confirmation dialogs, downloading data, or, obviously, taking screenshots.

Here is a short ABAP snippet that demonstrates how to save a screenshot in ABAP. While using the cl_gui_frontend_services=>get_screenshot method seems obvoius enough, knowing how to convert the raw image data into the SOLIX format is something that may require help. This code piece demonstrates how to do it.

ABAP Program: How to Take and Download a Screenshot in ABAP

DATA lv_imagebytes TYPE xstring.
DATA lv_mimetype TYPE string.
DATA lv_user_action TYPE i.
DATA lv_file_name TYPE string.
DATA lv_full_path TYPE string.
DATA lv_filepath TYPE string.

* Wrap everything in a try/catch block to capture exceptions
    * Capture a screenshot, using CL_GUI_FRONTEND_SERVICES
    * After this operation, lv_mimetype will contain the MIME type of the image, such as "image/jpg"
            mime_type_str = lv_mimetype
            image         = lv_imagebytes

    * Show the default "save file" dialog
            default_file_name = 'screenshot.jpg'
            default_extension = 'jpg'
            file_filter       = '(*.jpg)|*.jpg|'
            filename          = lv_file_name
            path              = lv_filepath
            fullpath          = lv_full_path
            user_action       = lv_user_action

    * Check if the user confirmed the dialog.
    * TODO: implement the cancel action.
    IF lv_user_action = cl_gui_frontend_services=>action_ok.

        * Create an internal table, converting the image bytestring to SOLIX.
        DATA(it_solix_data) = cl_bcs_convert=>xstring_to_solix(
                iv_xstring = lv_image_bytes

        * Download the screenshot to the user's file system.
                filename     = lv_full_path
                filetype     = 'BIN'
                bin_filesize = xstrlen(lv_image_bytes)
                data_tab     = it_solix_data


    CATCH cx_root INTO DATA(e_error_message).