Advanced Telco Services: IoT & M2M. MyThings Builder User Guide V0.2. Date 28/01/2016 Sensitivity Unrestricted Contact

Transcription

1 Advanced Telco Services: IoT & M2M MyThings Builder User Guide V0.2 Date 28/01/2016 Sensitivity Unrestricted Contact

2 MyThings Builder V Introduction Login into MyThings Enrolment for new interested customers Invitation mail for new users MyThings Builder Menu Structure General functionalities Filter CSV generation / Reload data Data logs Menu History logs Things Charts Menu Option 1: Sensor Option 2: Container Logic Menu Sensor groups Companies Business rule event action VAT BE , Brussels Register of Legal Entities, Giro BE BPOTBEB1 25 Page 2 of

3 9.4. Business rules Business rule attribution Sensor in Sensor groups Business rules / Sensor groups Event Logs Logout Roles VAT BE , Brussels Register of Legal Entities, Giro BE BPOTBEB1 25 Page 3 of

4 1. Introduction The MyThings builder application is developed as a part of the Proximus MyThings suite (MyThings Manager and Scanner). With MyThings builder you are able to manage your Things by adding actions,. Requirement to use the MyThings Manager application A recent web browser VAT BE , Brussels Register of Legal Entities, Giro BE BPOTBEB1 Page 4 of 25

5 2. Login into MyThings Go to and the webpage below will be shown. The MyThings website is responsive and will also scale to tablets and smart phones. The menu will transform into the following: Menu Closed: Menu Open: VAT BE , Brussels Register of Legal Entities, Giro BE BPOTBEB1 Page 5 of 25

6 Press on Login. On this page a user is able to login into the MyThings application. Depending on the attributed role, the user will see his assigned tabs on the top of the screen. If a user forgot his password you can click the Forgot password link. You will then receive a change password link via mail. VAT BE , Brussels Register of Legal Entities, Giro BE BPOTBEB1 Page 6 of 25

7 3. Enrolment for new interested customers This page gives a new interested customer the ability to enroll in the MyThings IoT program. A not registered user can fill in his information and enroll. This information will be sent to Proximus and processed by the IoT back office team. A sales person will contact you as soon as possible. VAT BE , Brussels Register of Legal Entities, Giro BE BPOTBEB1 Page 7 of 25

8 4. Invitation mail for new users Hello, After the new account has been created, you will receive an invitation mail. Please open the link inside the mail within the first 24 hours after reception. Proximus has created an account for you in My Things After setting your password you can log in using this address and the password you will provide after clicking the link. To accept this invitation, please click the link below. Be aware that this link is only available 24 hours since the request. Kind regards, My Things The link will open the following registration form: The password had to be at least 8 characters long and have at least one character of the following four categories: - uppercase character - lowercase character - digit - non-alphanumeric VAT BE , Brussels Register of Legal Entities, Giro BE BPOTBEB1 Page 8 of 25

9 5. MyThings Builder Menu Structure Once you are logged in you will be able to navigate through the application using the tabs on the top. Datalogs: History logs (view the real time data from your Things) Things (view the list of Things you have) Cluster Values (for future use to view virtual Things that are a cluster of actual Things) Charts: Generate some basic charts using the Thing data Logic: Sensor groups Companies Business rule event actions Business rules Business rules attribution, Sensor by group Business rules by group Event logs User logs Subscriptions Logout: For logging out of the MyThings application. VAT BE , Brussels Register of Legal Entities, Giro BE BPOTBEB1 Page 9 of 25

10 6. General functionalities 6.1. Filter This application provides lots of overview screens to the user. To ease searches a filter can be applied to the overview tables. This is done by selecting a filter type and then inserting a value in the filter value. When the filter is added a purple box will appear with all the active filters. Clicking on the x will remove the filter and table will show the non-filtered data again CSV generation / Reload data Most web pages are equipped with a Reload data and Generate CSV functionality. Click Generate CSV to download the data and view it in excel. Click Reload data to refresh the data on the web page. VAT BE , Brussels Register of Legal Entities, Giro BE BPOTBEB1 Page 10 of 25

11 7. Data logs Menu 7.1. History logs This page gives the user an overview off all the Thing data history that are linked to his company and child company (if available and enabled on this user account). Every page contains a maximum of 100 records. Navigating through the sensor history can be done using the top right or bottom left navigation controls. VAT BE , Brussels Register of Legal Entities, Giro BE BPOTBEB1 Page 11 of 25

12 7.2. Things This page gives the user an overview off all the sensors that are connected to the companies the logged in user is assigned to. When clicking on the Square box on the sensor line, the containers connected to the selected sensor are shown (see image below). Depending on the user role, a logged in user can add multiple containers depending on the sensor type. In most cases a container has a subscription. This subscription can be stopped, started or refreshed on this screen. 8. Charts Menu On the top of the web page you have 2 options to search for the Thing you want to generate a chart for. Option 1 Option Option 1: Sensor Select company: In this first step the user needs to select the company where he wants to generate the charts for. The user will only see the companies he is assigned to. Select the sensor type depending on the type you want to display the chart for. VAT BE , Brussels Register of Legal Entities, Giro BE BPOTBEB1 Page 12 of 25

13 Select the sensor identifier (MAC address) Click on generate chart (create charts) VAT BE , Brussels Register of Legal Entities, Giro BE BPOTBEB1 Page 13 of 25

14 8.2. Option 2: Container Select company: In this first step the user needs to select the company for which he wants to generate the charts. The user will only see the companies he is assigned to. Select the container depending on the type you want to display the chart for. Select the sensor identifier (MAC address) Click on generate chart (create charts) VAT BE , Brussels Register of Legal Entities, Giro BE BPOTBEB1 Page 14 of 25

15 9. Logic Menu 9.1. Sensor groups This page gives the user an overview of all the sensor groups that are assigned to the companies of the logged in user. Depending on the assigned role a user can add and update a sensor group. Adding a sensor group is done by clicking on the Add sensor group button. Editing is done by clicking on the pencil button on each line. Press add a new sensor group After clicking the Add sensor group button the user is redirected to the screen above. Here a logged in user needs to fill in all the required fields in order to successfully create a new sensor group. VAT BE , Brussels Register of Legal Entities, Giro BE BPOTBEB1 Page 15 of 25

16 Edit sensor group. After clicking the pencil icon on a sensor group line the user is redirected to the screen above. Here a logged in user can update any field he desires. The update will be successful when all the required fields are filled in Companies This page gives a general overview of all the companies that the logged in user is assigned to. VAT BE , Brussels Register of Legal Entities, Giro BE BPOTBEB1 Page 16 of 25

17 9.3. Business rule event action This page gives the user an overview of all the business rules that are assigned to the companies of the logged in user. Depending on the assigned role a user can add and update a business rule. Adding a business rule is done by clicking on the Add business rule button. Editing is done by clicking on the pencil button on each line. Add business rule event action After clicking the Add business rule button the user is redirected to the screen above. Here a logged in user needs to fill in all required fields in order to successfully create a new business rule. Edit business rule event action After clicking the pencil icon on a business rule line the user is redirected to the screen above. Here a logged in user can update any field he desires. The update will be successful when all the required fields are filled in. VAT BE , Brussels Register of Legal Entities, Giro BE BPOTBEB1 Page 17 of 25

18 9.4. Business rules This page gives the user an overview of all the business rules that are assigned to the companies of the logged in user. Depending on the assigned role a user can add and update a business rule. Adding a business rule is done by clicking on the Add business rule button. Editing is done by clicking on the pencil button on each line. Add business rule After clicking the Add business rule button the user is redirected to the screen above. Here a logged in user needs to fill in all the required field in order to successfully create a new business rule. VAT BE , Brussels Register of Legal Entities, Giro BE BPOTBEB1 Page 18 of 25

19 Edit business rule After clicking the pencil icon on a business rule line the user is redirected to the screen above. Here a logged in user can update any field he desires. The update will be successful when all the required fields are filled in. TODO: Add more info perhaps on the different values that need to be filled in (like Delay, etc ) VAT BE , Brussels Register of Legal Entities, Giro BE BPOTBEB1 Page 19 of 25

20 9.5. Business rule attribution This page gives the user a consolidated and more readable view on which Business rule is attached to which sensor group and what is exactly configured in that business rule 9.6. Sensor in Sensor groups This page gives the user an overview of all the sensors / sensor groups that are assigned to the companies of the logged in user. Depending on the assigned role a user can add and update a business rule. Adding a sensor / sensor group is done by clicking on the Add sensor / sensor groups button. Editing is done by clicking on the pencil button on each line. VAT BE , Brussels Register of Legal Entities, Giro BE BPOTBEB1 Page 20 of 25

21 Add Sensor to Sensor groups After clicking the Add sensor to sensor groups button the user is redirected to the screen above. Here a logged in user needs to fill in all the required fields in order to successfully create a new sensor to sensor groups. Edit Sensor / Sensor groups After clicking the pencil icon on a sensor / sensor groups line the user is redirected to the screen above. Here a logged in user can update any field he desires. The update will be successful when all the required fields are filled in Business rules / Sensor groups This page gives the user an overview off all the business rules / sensor groups that are assigned to the companies of the logged in user. Depending on the assigned role a user can add and update a business rules / sensor groups. Adding a business rules / sensor groups is done by clicking on the Add business rules / sensor groups button. Editing is done by clicking on the pencil button on each line. VAT BE , Brussels Register of Legal Entities, Giro BE BPOTBEB1 Page 21 of 25

22 Add Business rules/ Sensor groups After clicking the Add business rules / sensor groups button the user is redirected to the screen above. Here a logged in user needs to fill in all the required fields in order to successfully create a new business rules / sensor groups. Edit Business rules / Sensor groups After clicking the pencil icon on a business rules / sensor groups line the user is redirected to the screen above. Here a logged in user can update any field he desires. The update will be successful when all the required fields are filled in Event Logs User logs This page keeps track of all the notifications, business rule checks, alerts, that are being managed and checked by the Proximus M2M factory platform. VAT BE , Brussels Register of Legal Entities, Giro BE BPOTBEB1 Page 22 of 25

23 This page keeps track of all the actions of all the users assigned to the same company as the logged in user have performed. These actions include all the possible CRUD action (create, read, update and delete). Subscriptions 10. Logout The logout button is visible under you login in the top right of the page. VAT BE , Brussels Register of Legal Entities, Giro BE BPOTBEB1 Page 23 of 25

24 Logout is successful when seeing this page VAT BE , Brussels Register of Legal Entities, Giro BE BPOTBEB1 Page 24 of 25

25 11. Roles Action God mode Superadmin Administrator User View sensors View companies (treeview) Add Sensor Group Edit Sensor Group View Sensor Group List Add Sensors/Sensor Groups Edit Sensors/Sensor Groups Remove Sensors/Sensor Groups View Sensor/Sensor Groups Add Business Rule Edit Business Rule Remove Business Rule View Business Rules + attribution Add Sensor Groups/Business rules Edit Sensor Groups/Business rules Remove Sensor Groups/Business rules View Sensor Groups/Business rules View Charts View Data logs View user logs View event logs View Subscriptions VAT BE , Brussels Register of Legal Entities, Giro BE BPOTBEB1 Page 25 of 25