|
| 1 | +# HEADING for vfc-application example |
| 2 | +<!-- (mandatory) Insert a description for the example flow. Describe the use case or its specialty. --> |
| 3 | +This flow allows to send SMS notifications to a mobile phone. The template helps to specify the |
| 4 | +- recipient (name and phone number) |
| 5 | +- create template for the SMS |
| 6 | +- Create notification category to bind recipient and template |
| 7 | +- send SMS using category |
| 8 | +... in dedicated flows. |
| 9 | + |
| 10 | +<!-- Insert an example image --> |
| 11 | + |
| 12 | + |
| 13 | + |
| 14 | +## Setup & Configuration |
| 15 | +<!-- (mandatory) Describe the necessary steps to get this flow running --> |
| 16 | + |
| 17 | +1. Import the flow in Visual Flow Creator |
| 18 | +2. Specify the recipient of your notificaton in the flow *1) Create Recipient* using the function node and trigger it's excecution |
| 19 | +3. Set you message content in the function node in flow *4) Send SMS using Category ID* |
| 20 | +4. Save the flow |
| 21 | + |
| 22 | +:cloud: :heavy_check_mark: You're ready to receive your SMS notifications after all four flows are triggered in sequence 1-4. Enjoy! |
| 23 | + |
| 24 | + |
| 25 | +## How does this flow works |
| 26 | +<!-- (optional) Describe the flow and how it works --> |
| 27 | +To send a SMS via Notification Service, a recipient, SMS template and notification category need to be setup before the actuall message can be send. See also the Notification Service API descriptions to understand the overall workflow. |
| 28 | +During exection of flow 1), the recipient is added and it's ID is stored to a context variable as part of the VFC flow. Next a message template and template-set is created. It's internal IDs are also stored in context variables for usage in flow 3). Here, the notification category is set by linking the template to recipient(s). It feedbacks a category-ID which is then finally used in flow 4) to trigger the sending of the notification. Also the message content is specified in the last flow. |
| 29 | + |
| 30 | + |
| 31 | +## Result |
| 32 | +<!-- (optional) Description on what the results are from this flow --> |
| 33 | +Afer specifiying recipient (name, phone number) as well as message text, |
| 34 | +1. Execute flow *1) Create Recipient* |
| 35 | +2. Execute flow *2) Create Template Set for the SMS* |
| 36 | +3. Excecute flow *3) Create Category to bind above recipient and template* |
| 37 | +4. Execute flow *4) Send SMS using Category ID* |
| 38 | + |
| 39 | +And you should receive a SMS on the mobile number specified. :iphone: :bell: |
| 40 | + |
| 41 | + |
| 42 | + |
| 43 | + |
| 44 | +## See also |
| 45 | +<!-- (optional) Description on what the results are from this flow --> |
| 46 | +- [Notification Service – API Overview](https://developer.mindsphere.io/apis/advanced-notification/api-notification-api.html) |
| 47 | + |
| 48 | + |
0 commit comments