Versions Compared

Old Version 5

changes.mady.by.user Nael Kabbany

Saved on

compared with

New Version Current

changes.mady.by.user Henrik Ståhlberg

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Add external widget manifest route to Meridix portal

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

  3. Add the following JSON object to the array list

    Code Block
    languagexml
    firstline1
    titleexternal-widgets.json
    linenumberstrue
    [
	{
		"name": "Telepo live widget",
		"enabled": "true",
		"clientId": "UniqueIdOfStudio", // Exchange to for as an example partnerNameMeridixStudioxxx
		"enabledPropertyKey": "micloudtelepo_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" 
			}
		]
	}
]


  4. 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. 
  5. The key "externalEndpointBaseAddress" must have the value to the external source has the live information Ex.  "externalEndpointBaseAddress": "https://telepowallboard.meridix.se"

Add the properties on the user or customer

...

Code Block
languagetext
titleCopyable properties
collapsetrue
micloud.widgets_enabled=True
micloud.baseUrl=https://MyTelepoApiUrl
micloud.domain=MyDomain.com
micloud.username=MyUsername
micloud.token=MyTelepoToken

...

Test the widgets

...

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

  1. Add the following block in the external-widgets.json file
Code Block
languagexml
titleWallboard configurations into Dashboard
collapsetrue
{
		"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" 
			}
		]
	},