Refresh and Pin

Refresh

If the user chooses the icon in the side panel, the content area receives an event to update the data context with the current data on the screen. SAP GUI data is extracted automatically by SAP Business Client. An HTML-based application receives a com.sap.lsapi.dataContext::update event. The update event handler should trigger an update of the data context and send an com.sap.lsapi.dataContext::updateFinished event. For more information, see Events.

This function is required because not all screen changes in the content area lead to an update of the data context. For dynpro applications this is done automatically only after the end of a roundtrip, for example, when the user chooses a pushbutton or presses ENTER.

Examples of user actions that may not result in a roundtrip:

• The user enters another value in an input field.

• The user selects another row in SAP List Viewer (ALV).

Pin

If the user chooses the icon in the side panel, the current side panel application receives a com.sap.lsapi.sidePanel::disconnected(true) event. As a result, a side panel application should ignore all changedWithXml events and therefore does not change its state until it receives a disconnected(false) event.

Even navigating away from the current application to an entry that does not have this side panel application assigned does not remove the side panel application (the session of the side panel application stays alive).

When reconnecting (that is, the user chooses the icon again), the current side panel application receives a com.sap.lsapi.sidePanel::disconnected(false) event. A side panel application should visualize the last received data context with a changedWithXml event.

The side panel application must implement this resfresh and pin logic.