Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

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

  1. Locate the folder config under the root folder where the portal is installed
  2. If the file external-widgets.json does not exist remove dist from external-widgets.dist.json and then modify that file
  3. 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" 
    			}
    		]
    	}
    ]
  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"

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

  1. Go to the properties tab of the user or customer that should have the widgets activated
  2. Add the following properties to the properties box (baseUrl is optional if it is configured in the wallboard installation)
  3. 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
    telepo_live.widgets_enabled=True
    micloud.baseUrl=https://MyTelepoApiUrl
    micloud.domain=MyDomain.com
    micloud.username=MyUsername
    micloud.token=MyTelepoToken
  4.  Click settings and make sure to click Update to save the changes

Test the widgets

  1. Go to the dashboard
  2. Click Add content
  3. The widgets should now be shown under the headline Live data from queues

Add ability to load configured wallboards into the Dashboard

  1. 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" 
			}
		]
	},
  • No labels