Skip to content

Commit e36243e

Browse files
mickeytpmickeytp
authored
docs(service-board): update documentation
1 parent d19952b commit e36243e

File tree

1 file changed

+0
-76
lines changed

1 file changed

+0
-76
lines changed

‎docs/products/service-board.md

-76
Original file line numberDiff line numberDiff line change
@@ -5,83 +5,7 @@ ServiceBoard is an app for managing service cases with minimal effort. The follo
55
* Service cases can easily be created and can be send directly to the correct service partner
66
* An easy to use video diagnosis with a service partner speeds up failure analysis
77
* Exchange of 3D-models and construction plans
8-
* Reduction of unplanned disruptions through maintenance planning
98

10-
## ServiceBoard network requirements
11-
12-
### ServiceBoard API
13-
14-
This is the URL where the tapio ServiceBoard receives all it's data from:
15-
<!-- markdown-link-check-disable-next-line -->
16-
<https://lcsservice.tapio.one/>
17-
18-
### Push notifications
19-
20-
In order to receive push notifications please read the following documentations provided by [Google](https://firebase.google.com/docs/cloud-messaging/concept-options#messaging-ports-and-your-firewall) (Android devices) and [Apple](https://support.apple.com/en-us/HT203609) (iOS) devices:
21-
22-
### Video diagnosis
23-
24-
<!-- markdown-link-check-disable-next-line -->
25-
The tapio ServiceBoard uses the [Video API by Vonage](https://www.vonage.com/communications-apis/video/) to enable In-App video calls.
26-
27-
<!-- markdown-link-check-disable-next-line -->
28-
Please read the [official guide](https://support.tokbox.com/hc/en-us/articles/360029733631) by Vonage (formerly Tokbox) for detailed information.
29-
30-
**Short version:**
31-
32-
- Open TCP port 443
33-
- Whitelist the following domains:
34-
- *.tokbox.com
35-
- *.opentok.com
36-
37-
## Create service cases with applinks
38-
39-
An app link is a link that opens an app. A common example is a web browser that will be opened when clicking on ```http://...``` or a mail client that will be opened as soon as the user clicks on an email (```mailto://...```).
40-
41-
tapio ServiceBoard enables tapio partner developers to communicate with ServiceBoard through an app link which is defined as follows:
42-
43-
```plaintext
44-
tapio-serviceboard://<createServiceCase>[?<queryParameters>]
45-
```
46-
47-
As query parameters the following options are valid:
48-
49-
| Query parameter | Required | Description | Example |
50-
| -------------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |
51-
| servicePartnerId | yes | The id of the service partners subscription (`Guid`). You must provide this value otherwise there will be an error. | 23683e0f-3f2b-4673-8add-6a090b8606ac |
52-
| machine | depends on the service partner | The tapio machine id. You can define if this field is required or not through your service partner configuration. | hg0011223344 |
53-
| stoppage | no | Set to "1" (true) if the problem causes a machine or production stoppage. Everything other than "1" will be evaluated as false. | 1 |
54-
| problemDescription | no | Text that describes the underlying problem and provides additional information that will help the tapio service partner to help fast. | |
55-
| title | no | Text that describes the topic of the ServiceCase | |
56-
| customerContactPhone | no | The phone number of the customer. | +49 176 12345678 |
57-
| {idOfATemplateField} | depends on the service partner | tapio service partners can define their own fields through service partner configuration. You can use the id of this field as a query parameter as well. **Templatefields are currently not supported by SerivceBoard Web** | |
58-
59-
### Further notes
60-
61-
* There is no length limit for links. However they should be as concise as possible.
62-
* The values of the query parameters must be url encoded.
63-
64-
### Example
65-
66-
```plaintext
67-
tapio-serviceboard://createServiceCase?servicePartnerId=23683e0f-3f2b-4673-8add-6a090b8606ac&machine=hg0011223344&problemDescription=ExampleDescription%20with%0ALinebreaks
68-
```
69-
70-
### Testing
71-
72-
You can easily test app links with html links:
73-
74-
```html
75-
<a href="tapio-serviceboard://createServiceCase?servicePartnerId=f6190e5c-cb33-411e-9654-8e1ce2c2eb0c&machine=hg0011223344&problemDescription=Test%20with%0ALinebreaks">Test</a>
76-
```
77-
78-
<!-- markdown-link-check-disable-next-line -->
79-
If you develop for Android devices you can use the [Android Debug Bridge (adb)](https://developer.android.com/studio/command-line/adb) command line tool.
80-
Your device must be connected via USB and USB debugging must be enabled. Please note that you must escape the ampersand ('\\&') for the query parameters to work.
81-
82-
```console
83-
adb shell am start -a android.intent.action.VIEW -d "tapio-serviceboard://createServiceCase?servicePartnerId=f6190e5c-cb33-411e-9654-8e1ce2c2eb0c\&machine=hg0011223344\&problemDescription=Test%20with%0ALinebreaks"
84-
```
859
### ServiceBoard Web prefill Service Case
8610

8711
Similar to the ServiceBoard native app we allow prefiling ServiceCase data via query parameters. We don´t want to run into limitations of query parameters so we accept only jwt tokens with a payload inside. The creation of the jwt token from your payload can be easily achieved by a lib like jose: [jose on github](https://github.com/panva/jose)

0 commit comments

Comments
 (0)