You are here:
Synchronization Transparency
Use the SyncCardContainer control to view the latest synchronization status from the cockpit without having to navigate to the dashboard. You can also trigger a synchronization from within the cockpit with this control. This control is optional, and you can add it during customization.
Required Editions
| Available in: Lightning Experience in Performance, Unlimited, and Enterprise Editions that have Consumer Goods Cloud enabled. |
<UIDescription name="Application::CockpitUI" schemaVersion="0.0.0.5" xmlns="UISchema.xsd">
<Page pagePattern="SingleSectionPage" navigation="Off">
<PageHeader>
<Bindings>
<Resource target="title" type="Label" id="CockpitTitle" defaultLabel="Your Day" />
</Bindings>
</PageHeader>
<Section sectionName="masterSection" sectionPattern="SingleAreaSection">
<Bindings>
<Resource target="LogoIcon" type="Image" id="LogoSalesforce" />
<Resource target="AltLogoIcon" type="Image" id="EmptyImage" />
</Bindings>
<Area areaName="mainArea" areaPattern="Card">
<!-- Card sync start -->
<SyncCardContainer name="SystemSyncCard">
<Bindings>
<Resource target="Title" type="Label" id="SyncStatusCardTitle" defaultLabel="Sync status" />
</Bindings>
<VisibilityRoles allRoles="true" />
</SyncCardContainer>
</Area>
</Section>
</Page>
</UIDescription>You can configure these SyncCardContainer control options.
- Attributes
- Bindings
- Events
- Sub-elements
Attributes
| Element | Description |
|---|---|
| showCardContainerHeader | Defines whether the title area (including title, maximize button, and collapse button) is shown. The default is to show the area (true). |
| loadPriority | Defines the card loading priority. It can be any integer from 1 through 5 where 1 is the highest priority and 5 is the lowest. Card area uses this attribute to decide the sequence of the second phase loading of the card containers. The element. |
Bindings
| Element | Description |
|---|---|
| Visible | Defines the visibility of the sync card container. |
| Title | Defines the binding for the title text to display for the sync card container. |
| Information | Defines the binding for the additional information text to display for the sync card container. |
| DisplayedSubcomponentName | Determines the control to be displayed if the sync card container has more than one control for displaying card content. The sync card container shows the control with the name specified in the binding value. If this binding isn’t specified, the first control for content in the children is rendered. |
| IsCollapsible | Specifies whether the card is collapsible. |
| CollapseState | Specifies whether the card is displayed as collapsed during launch. |
| IsReadyToLoad | Specifies whether the UI Plugin must be rendered. |
| ShowMaximizeButton | Specifies whether the maximize button is displayed. |
| CardStatusColor | Displays a colored bar at the top of the card container. This element is optional. |
Events
| Element | Description |
|---|---|
| ButtonPressedEvent | An event that is triggered when a user taps on the Maximize button. Only one ButtonPressedEvent must be implemented for a card container. |
| LoadContainerData | An event that is triggered to inform business logic (contracts) to load the required data for the plug-in. |
| CollapsedEvent | An event that is triggered when a user taps the collapse toggle. The new state of the card container (collapsed state) is passed as a parameter. |
Sub-Elements
| Element | Description |
|---|---|
| ActionBar | Displays the action buttons. It has no supported attributes, bindings, or events. The valid sub-element is ImageButton. If more than two buttons are provided, only the first two buttons are considered. |
| LinkBar | Displays primary and secondary link buttons. It has no supported attributes, bindings, and events. The valid sub-element is ImageButton. If more than two button elements are provided, only the first two buttons are rendered. By default, the first ImageButton inside the link bar the primary link and the next one is considered as the secondary link. |
| Card Event Subscription | Defines the subscription of sync card containers to the events. |
| EA Rights | Defines the visibility rights. |
| Styling | Defines the styling for the sync card container. |
Sync Card Details Area
The Sync Card Details area shows the sync status. If the sync is in progress, one of these sync statuses is displayed:
- Uploading data
- Downloading data
- Downloading attachments
- Purging data
If the sync isn’t initiated, the Details area displays the pending items that are yet to be synced. Items displayed in the Details area must already be configured in the backend.
The labels displayed in the Details area are manually maintained in the Locale Contracts in the Global Section. If the labels aren’t defined, sfSingularLabel or sfPluralLabel is used. The general label syntax is:
ReplicationSyncCard_Objectname_[Singular|Plural]
For example:
fwPluralLabel="ReplicationSyncCard_Contract__c_Plural"
fwSingularLabel="ReplicationSyncCard_Contract__c_Singular"
Where,
Contract__c is the object.
Plural defines the plural form.
Singular defines the singular form.If there’s data error while uploading or downloading data during last sync, a red exclamation mark appears between the timestamps and the sync icon in the sync card.
If there’s an no network connectivity while uploading or downloading data during last sync, a broken chain appears between the timestamps and the sync icon in the sync card.
If a data error and no network connectivity both occur, only a red exclamation mark icon appears.
If no issues are encountered during the next sync, the sync error indicator disappears from the sync card and is no longer displayed.
When the sync error indicator is displayed, the back-end admin is notified and the error log messages are synchronized to the backend.
