ASPsms notification

🟢 Beginner

notification

osp-communications osp-reports

This example shows how to configure SMS notifications using the ASPsms provider: set up the provider credentials, create a notification with a FreeMarker template, and define an output linked to a contact.

• Configure an ASPsms provider with credentials and a status value.

• Create a notification referencing a FreeMarker template for the SMS body.

• Define an output linked to a contact from the directory.

• Monitor the provider status from a dashboard widget.

git checkout origin/osp-communications-configuration .
git checkout origin/osp-reports-configuration .
git checkout origin/example-communications-configure-aspsms-notification .

Structure

Steps

1. Configure the ASPSMS provider

root/providerSMS/provider.coms

{
    "moduleId": "modules.communications.communications-1",
    "providerType": "ASPSMS",
    "username": "${YOUR_USERNAME}",
    "passwordProvider": {
        "type": "PLAINTEXT",
        "password": "${YOUR_PASSWORD}"
    }
}

root/providerSMS/value.ospp

{
    "name": "ASPSMS Provider Value",
    "description": "",
    "type": "BOOLEAN"
}

2. Create the notification with the template

root/notification/notification.coms

{
  "moduleId": "modules.communications.communications-1",
  "template": {
    "shortMessageTemplateId": "root.notification.short"
  },
  "accessedValues": []
}

root/notification/short/template.ospp

{
    "description": "",
    "format": "plain",
    "name": ""
}

root/notification/short/template.reports

{
    "moduleId": "modules.reports.reports-1",
    "baseTemplatePath": "root/notification/short/template.ftl"
}

root/notification/short/template.ftl

Change on ${trigger["name"]}

3. Create the output and the contact

root/notification/output.coms

{
  "notificationId": "root.notification",
  "targets": [
    {
      "originator": {
        "smsSender": "OnSphere"
      },
      "providers": [
        {
          "providerId": "root.providerSMS"
        }
      ],
      "recipient": {
        "type": "FROM_STATIC_LIST",
        "contactsId": "root.directory"
      }
    }
  ]
}

root/directory/contacts.coms

{
    "moduleId": [
        "modules.communications.communications-1"
    ],
    "contacts": [
        {
            "type": "PERSONAL",
            "firstname": "Bob",
            "lastname": "Morane",
            "email": "bob.morane@localhost",
            "number": "0791234567"
        },
        {
            "type": "PERSONAL",
            "firstname": "Titi",
            "lastname": "Minet",
            "email": "titi.minet@localhost",
            "number": "0791234567"
        },
        {
            "type": "PERSONAL",
            "firstname": "Code",
            "lastname": "Lyoko",
            "email": "code.lyoko@localhost",
            "number": "0791234567"
        }
    ]
}