Go-Lab Notification Format

The following information is taken from deliverables D4.2 and D4.4. D4.2, section 2.4.6 describes the initial specification of the notification format. D4.4, section 2.2.1 gives a simplified grammar for the notification format.

Notification format (from D4.2, section 2.4.6)

As activity logs, notifications can be serialised in JSON format. In this initial specification the notification message must contain four fields, namely type, importance, target and content. The following listing displays a notification message in more detail. In this initial specification the type of a notification can be a textual message, a concrete resource e.g. for recommendations or configuration parameters for scaffolding apps. It should also be possible to specify importance levels for messages which can result in different handling of a message on the client side. The target must contain the id of a receiving client. An app can be addressed uniquely by the ID of the inquiry learning space in which it lives and its own identifier within the ILS. Until now, the receiving clients are apps in the ILS platform. However, in the future an ILS itself could also be a client, listening to notifications. Feedback can then be displayed on a more upper level not related to a particular app, for example resource recommendations. Hence, the target should also contain a type argument which indicates the type of receiver. Consequently the content field comprises message text, resource URLs or configuration parameter according to the type of notification.

    type : "prompt | resource | configuration",
    importance : "1...10",
    target : {
        type: "ILS | app | ...",
        id: "{uuid}"
    content : {
        text : "Consider the following concepts ...",
        url: "http :\\...",
        image−url: "http:\\...",
        configuration : { property−value list }

back to top

Notification format (from D4.4, section 2.2.1)

In order to enable immediate feedback for students by the system it is necessary to implement mechanisms that allow server-side analytics components to actively send messages to apps in the ILS platform (c.f. D4.2 in Section 2.4.6). Notifications can be feedback messages that may result in prompts on the client side, resource recommendations or re-configuration of tools. To make sure that these notifications can be handled by apps they have to be in an agreed format. The preliminary notification format has been described in D4.2. In this release deliverable the specific construction of a notification will be discussed more specifically. The following grammar specifies a valid notification object.

notification : type, importance, target, content
type: "prompt"|"resource"|"configuration"
importance: [1| ... |10]

target : type, id
target.type: "ILS"|"app"|...
target.id : uuid

content : (messageId, messageParams) | url | configuration
messageId: Id of the notification message
messageParams : Message parameters
url : Resource url
configuration: Configuration object for a specific app.

In order to make sure that a client app can be addressed uniquely by the server component the target id must be composed of the id of the current ILS, the id of the current user and the specific id of the current app instance.

back to top