The sgcUI Realtime UI Pack

TsgcUIPresenceModel keeps the users and their status (online, away, busy or offline) with a status text. The avatar controls follow the model, so a change of status repaints every avatar and indicator of that user at once.

• The presence model takes its changes from AddOrUpdate and SetStatus in code, or from one live message per change.
• An avatar, an avatar group with a "+N" chip for the users that do not fit, and a presence indicator with the status dot and the status text.
• The activity feed of sgcDashboard reads the same model, so every actor shows its avatar and status.

Product

sgcUICore, shared by every sgcUI product

Delphi and C++Builder

TsgcVCLAvatar, TsgcVCLAvatarGroup, TsgcVCLPresenceIndicator and their TsgcFMX twins

Edition

Every edition, Community included, the live presence messages too

Help: Presence and Avatars and Presence Indicator.

TsgcDashboardActivityModel records each activity as an actor, a verb and an object, with the fields that changed. The activity feed and the audit trail are two views of the same model.

• Activity feed: the newest activity first, with relative times and the avatar of each actor from the presence model.
• Audit trail: a table whose rows expand to the changed fields.
• Both are standalone controls and also activity and audit tiles for a dashboard.

Product

sgcDashboard

Delphi and C++Builder

TsgcVCLActivityFeed, TsgcVCLAuditTrail, TsgcVCLDashboardActivityTile, TsgcVCLDashboardAuditTile and their TsgcFMX twins

Edition

Every edition, Community included. The live activity messages are Registered.

Help: Activity Feed, Live Activity Messages, Activity Tile and Audit Tile.

• The source never connects, subscribes or sends. The URL, the credentials, TLS and the reconnection belong to the client, and the hook survives a reconnect by the WatchDog.
• One source feeds several models through its bindings, so one connection can drive a whole screen. A binding can unwrap an application envelope, and your own handler of the client event still fires.
• The models are always called in the main thread. Messages that arrive in a socket thread are queued and applied in one visit to the main thread, in arrival order.
• The bridge is inbound only. When the user reads or dismisses a notification, the application sends its own frame through the same client.

The four message shapes

There is no new protocol. Each model reads the live message of its feed: one JSON object per change, with a type member that names the feed and an op member.

{"type":"presence","op":"upsert","user":{"id":"u7","presence":"away","statusText":"Lunch"}}
{"type":"notification","op":"add","notification":{"id":"n2","title":"Build 812 passed","severity":"success"}}
{"type":"activity","op":"add","item":{"id":"a20","actorId":"u7","verb":"updated","objectName":"Invoice INV-17"}}
{"type":"log","op":"append","entry":{"level":"warning","source":"api","message":"Slow query"}}

oSource := TsgcUILiveSource_MQTT.Create(Self);
oSource.Client := MQTT;
// one binding per model, selected by its topic
oBinding := oSource.Bindings.Add;
oBinding.Target := PresenceModel;
oBinding.Topic := 'ops/presence';
oBinding := oSource.Bindings.Add;
oBinding.Target := NotificationModel;
oBinding.Topic := 'ops/notifications';
oBinding := oSource.Bindings.Add;
oBinding.Target := ActivityModel;
oBinding.Topic := 'ops/activity';
oBinding := oSource.Bindings.Add;
oBinding.Target := LogModel;
oBinding.Topic := 'ops/log/+';
// the source never subscribes: subscribe in OnMQTTConnect of the client
MQTT.Subscribe('ops/#');

The live sources are Registered only and need sgcWebSockets, like every sgcWebSockets bridge of sgcUI. Without a server, or in a Community build, the application calls the API of each model instead: AddOrUpdate and SetStatus of the presence model, Add or Post of the notification model, Add of the activity model and Append of the log model.

Read the Live Sources help topic

• Models: TsgcUIPresenceModel (namespace esegece.sgcUICore), TsgcNotificationModel and TsgcNotificationPreferences (esegece.sgcNavigation), TsgcToolbarBadgeLink (esegece.sgcToolbar), TsgcDashboardActivityModel (esegece.sgcDashboard) and TsgcGridLogModel with TsgcGridLogLink (esegece.sgcGrid).
• Controls: TsgcWinFormsAvatar, TsgcWinFormsToastManager, TsgcWinFormsNotificationInbox, TsgcWinFormsActivityFeed, TsgcWinFormsAuditTrail and the other controls, each with its TsgcWpf and TsgcAvalonia twin.
• Live sources: TsgcUILiveSource_WebSocket, TsgcUILiveSource_MQTT and TsgcUILiveSource_SSE in the package esegece.sgcUICore.sgcWebSockets, Registered only.
• The free Community packages on NuGet, such as esegece.sgcNavigation.Community and esegece.sgcGrid.Community, leave out the same parts as the Delphi Community builds.
• The .NET demo has WinForms, WPF and Avalonia hosts over one shared project with the models, the simulator and the self test.

Help: .NET Packages and Realtime UI Pack.