...
Add external widget manifest route to Meridix portal
- Locate the folder plugins config under the root folder where the portal is installed
- If the file external-widgets.json does not exist create itremove dist from external-widgets.dist.json and then modify that file
Add the following
jsonJSON object to the
arraylistarray list
Code Block language xml firstline 1 title external-widgets.json linenumbers true [ { "name": "Telepo live widget", "enabled": "true", "clientId": "UniqueIdOfStudio", // Exchange to for as an example partnerNameMeridixStudioxxx "enabledPropertyKey": "telepo_live.widgets_enabled", "externalEndpointBaseAddress": "UrlToMeridixMiCloudTelepoWallboard", // Exchange with correct url "externalEndpointServerSideBaseAddress": "UrlToMeridixMiCloudTelepoWallboard", // Exchange with correct url "manifestPath": "/api/externalwidgets/manifest", "manifestPathVerb": "POST", "endpointRequiredProperties": [ { "propertyKey": "micloud.baseUrl", "defaultValue": "customerTelepoBaseUrl" // Can be omitted if the customer domain is configured in the wallboard installation }, { "propertyKey": "micloud.domain", "defaultValue": "test.com" // Will show test data when this property is not set }, { "propertyKey": "micloud.username", "defaultValue": "testusername" }, { "propertyKey": "micloud.token", "defaultValue": "testtoken" } ] } ]
Add the properties on the user or customer
- Go to the properties tab of the user or customer that should have the widgets activated
- Add the following properties to the properties box
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
micloud.widgets_enabled=True
micloud.baseUrl=https://MyTelepoApiUrl
micloud.domain=MyDomain.com
micloud.username=MyUsername
micloud.token=MyTelepoToken |
3. Click settings and make sure to click Update to save the changes
Test the widgets
- Go to the dashboard
- Click Add content
- The widgets should now be shown under the headline Live data from queuesYou can change the enabled Property key-value "telepo_live.widgets_enabled" in the JSON object to any name Ex. "Telepo_live.Meridix_Sweden_enabled" but it must be added exactly the same value to customer properties in Meridix studio.
- The key "externalEndpointBaseAddress" must have the value to the external source has the live information Ex. "externalEndpointBaseAddress": "https://telepowallboard.meridix.se"
Note |
---|
The properties micloud.baseUrl, micloud.domain, micloud.username, micloud.token may be added either in the config file external-widgets.json or under properties for a specific customer/user in the web portal. To add it in the config file see step 3 above. To add it under customer/user see steps below. |
Add ability to load configured wallboards into the Dashboard
- Add the following block in the external-widgets.json file
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"name": "Meridix MiCloud Wallboard Configured wallboards",
"enabled": "false",
"clientId": "UniqueIdOfStudio", // Exchange to same as above
"enabledPropertyKey": "micloud_wallboard_widgets.enabled",
"externalEndpointBaseAddress": "UrlToMeridixMiCloudTelepoWallboard", // Exchange with correct url
"externalEndpointServerSideBaseAddress": "UrlToMeridixMiCloudTelepoWallboard", // Exchange with correct url
"manifestPath": "/api/externalwidgets/manifest/wallboards",
"manifestPathVerb": "POST",
"endpointRequiredProperties": [
{
"propertyKey": "micloud.baseUrl",
"defaultValue": "meridix.com"
},
{
"propertyKey": "micloud.domain",
"defaultValue": "meridix.com"
},
{
"propertyKey": "micloud.username",
"defaultValue": "testusername"
},
{
"propertyKey": "micloud.token",
"defaultValue": "testtoken"
}
]
}, |