Sync Popup Widget

The Sync Popup is a widget that allows to run one of all the available synchronization jobs for given ItemModel, list of ItemModels or for a CatalogVersion.

Widget Definition

Name Sync Popup
ID com.hybris.backoffice.widgets.syncpopup
Category Popup.
Description Sync Popup is a widget that allows to run one of all the available synchronization jobs for given ItemModel, list of ItemModels or for a CatalogVersion.
Applied In Backoffice
Based On Not applicable
Author SAP
Inputs Details of input sockets:
  • inputObject
    • Type: de.hybris.platform.core.model.ItemModel
    • Multiplicity: Single
    • Description: Only sync jobs suitable for passing inputObject are displayed in the popup.
  • inputObjects
    • Type: de.hybris.platform.core.model.ItemModel
    • Multiplicity: List
    • Description: Only sync jobs suitable for passing inputObject are displayed in the popup.
Outputs Details of output sockets:
  • syncTask
    • Type: com.hybris.backoffice.sync.SyncTask
    • Multiplicity: Single
    • Description: SyncTask containing SyncJob to be executed on inputObject(s).
  • cancel
    • Type: java.util.Object
    • Multiplicity: Single
    • Description: This output socket enables closing the popup.
  • syncTaskExecutionInfo
    • Type: com.hybris.backoffice.sync.SyncTaskExecutionInfo
    • Multiplicity: Single
    • Description: Synchronization task execution info which contains an id of a cronjob running the synchronization, and synchronization task with the synchronized items.
Generated Events No events

Configuration

Not applicable

Widget Preview

The widget is displayed after you click Sync Action in Editor Area.

Figures: The two images are the widget views before and after synchronization, when there's only one synchronization job.

Figures: The two images are the widget views when there're more synchronization jobs.

You can see the Push To Target and Pull From Source tabs in the popup. They are displayed according to the catalog version the product belongs to. It is also possible to use search in the widget. The search field becomes visible if there are more than one synchronization jobs.

Settings

Setting Type Description
searchVisibilityThreshold java.lang.String If the total number of sync jobs displayed in pull and push list is lower than value of this setting, then the filtering searchbox is not displayed. Default value: 4.
listitemRenderer java.lang.Integer Specifies the spring's bean name of the custom list renderer. Default value: <empty>.

The following is an example of this widget in the widgets.xml file:

<widget id="exampleSynchronizationPopup" widgetDefinitionId="com.hybris.backoffice.widgets.syncpopup" slotId="cockpitWidgetChildrenInvisible" template="true">
    <instance-settings socketEventRoutingMode="LAST_USED">
        <create onInit="false" reuseExisting="true">
            <all-incoming-events/>
        </create>
        <close>
            <outgoing-events>
                <socket-event id="cancel"/>
                <socket-event id="syncJob"/>
            </outgoing-events>
            <all-outgoing-events/>
        </close>
        <select onInit="false">
            <all-incoming-events/>
        </select>
    </instance-settings>
    <setting key="searchVisibilityThreshold" type="Integer">4</setting>
    <setting key="listitemRenderer" type="String"></setting>
    <virtual-sockets/>
</widget>

Widget Slots

slotID Multiplicity Type Slots Composition
cockpitWidgetChildrenInvisible multi Not applicable. A general-purpose slot available for widgets. Any widget placed on this slot is not displayed in the application view but can be accessed through its socket API.
Related Information