Adding Live telepo data widgets to portal Dashboard

Requirements

Meridix Platform - v. 3.9.15.5288 or later

Meridix MiCloud Telepo Wallboard - v. x.x.1020 or later

Add external widget manifest route to Meridix portal

Locate the folder config under the root folder where the portal is installed
If the file external-widgets.json does not exist remove dist from external-widgets.dist.json and then modify that file

Add the following JSON object to the array list

external-widgets.json

[
	{
		"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" 
			}
		]
	}
]

You 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"

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 the properties on the user or customer

Requirements

An end-user API ticket from Telepo need to be set up with the following right granted [ACD/attendant queues] [Queue statistics] [User info] [Contact search]
All users including the ticket owner must also be in a user group that has the ACD Supervisor role granted

Go to the properties tab of the user or customer that should have the widgets activated
Add the following properties to the properties box (baseUrl is optional if it is configured in the wallboard installation)
Properties explanation
micloud.baseUrl: The URL to the Telepo System that exposes the API. Consult your Telepo service provider if this is unknown.
micloud.domain: The organization domain.
micloud.username: The username och the Telepo user that has the API ticket configured on them.
micloud.token: The API ticket token.
Note: if you have changed the value as explained in step 4 above then you need to change the value below "telepo_live.widgets_enabled=True" to "Telepo_live.Meridix_Sweden_enabled=true"
Copyable properties Expand source
```
telepo_live.widgets_enabled=True
micloud.baseUrl=https://MyTelepoApiUrl
micloud.domain=MyDomain.com
micloud.username=MyUsername
micloud.token=MyTelepoToken
```
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 queues

Add ability to load configured wallboards into the Dashboard

Add the following block in the external-widgets.json file

Wallboard configurations into Dashboard

{
		"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" 
			}
		]
	},