Efficy 11: customising notifications

Wed, 23 May 2018 11:41:30 +0000

Hi team,

Since Efficy 11 we have a new feature called "notifications". You probably discovered this feature in our Efficy.

The new build of Efficy 11 (r12835) added the possibility to customise those notifications by adding a parameter "customparams". You are able to retrieve information passed to this parameter inside the MacroNotifications.txt.

An example:

Serverscripts/customNotifications.js

var customParams = {
    "special": "Just some extra information I need in the macro...",
    "employee": "Jean Dupont",
    "ntEntity": ntRepo,
    "entityKey": 45
}

Efficy.sendNotification(
    'Your sales turnover has almost reached it's target!', //title
    'Well done $SALES_NAME$! Click on the notifications to have a full overview', //description
    VarArrayOf([2,88]), //users
    JSON.stringify(customParams, null, '  ') //customparams
);

The code above show you how to use server script / workflow code to generate a custom notification and add custom parameters to it.
After you created a notification this one will be loaded for the specific user(s) you chose.

Macros/MacroNotificationsCustom.txt

NotiItemVars {[
<# var notiItem = notifications[i],
    authors = notiItem.authors,
    entity = notiItem.entity,
    identifiers = notiItem.identifiers,
    fields = notiItem.fields,
    categories = notiItem.categories,
    relations = notiItem.relations,
    securities = notiItem.securities,
    owner = notiItem.owner,
    massupdate = notiItem.massUpdate,
    recurrence = notiItem.recurrence;

/* All the data you passed to the customParams will be available here */
var notiCustom = notiItem.customparams || null;

/* Simulate entities */
if (notiItem.kind === 'information') {
    entity = {"name":"info", "label":"<%GetLabel('Information', context=JS)%>"};
} else if (notiItem.kind === 'password') {
    entity = {"name":"key", "label":"<%GetLabel('Password', context=JS)%>"};
} #>
]}

Having this in your macro gives you all the imaginable possibilities. You could work with a custom type of notifications which calls a different macro template for example. You could create custom actions (like the 'Accept' / 'Decline' for an action).

If I forgot something or made an error somewhere in my explanation, please let me know.

Enjoy!

Maxime

Ps.: thanks to the R&D for this feature

Efficy Overflow Q&A - Recent questions tagged macronotification

Efficy 11: customising notifications