Skip to content

Commit 79f5db3

Browse files
committed
example for SMS notifications
1 parent 446c5da commit 79f5db3

File tree

7 files changed

+987
-1
lines changed

7 files changed

+987
-1
lines changed

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
# Dependency directories
2+
setFlowVariablesViaDashboard
3+
4+
15
# Logs
26
logs
37
*.log

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,19 @@ Please note, that the json-files are exported from another tenant. So their migh
3535
| [Create rule for asset type](./createRuleForAssetType/readme.md) | Create a rule for all assets of this type | :star: | |
3636
| [Generate sample data](./generateSampleData/readme.md) | Demo data for different data types in MindSphere | :star: | |
3737
| [Virtual machine simulator](./virtualMachineSimulator/readme.md) | | :star: | |
38-
38+
| [send SMS notifications](./sendSmsNotifications/readme.md) | | :star: | |
3939
### Examples which have to be added:
4040
| Name | Description | Complexity Rating | Prerequisites |
4141
| --- | --- | --- | --- |
42+
43+
| [in progress: Set Flow variables via dashboard](./setFlowVariablesViaDashboard/readme.md) | | :star: | |
4244
| [TODO: Create dashboard for Fleet Manager](./createDashboardForFleetManager/readme.md) | | :star: | |
4345
| [TODO: Integrate external API](./integrateExternalApi/readme.md) | | :star: | |
4446
| [TODO: Dashboard with dynamic data layover](./dynamicDashboards/readme.md) | | :star: :star: | |
4547

4648

49+
50+
4751
You can add here your ideas for further examples.
4852

4953
### Example template
5.09 MB
Loading

sendSmsNotifications/doc/example.png

38.9 KB
Loading
Loading

sendSmsNotifications/readme.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
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+
![image](./doc/sendSmsNotifications.png)
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+
![](.doc/../doc/SMS_result.gif)
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

Comments
 (0)