External widget dashboard extension

The External widget dashboard feature helps you to show card content in the dashboard panel based on external URL request.  

This feature is available from the OpenKM version 8.1.10.

This option is only available if you have enabled the External dashboard widget feature.

There are several parameters passed as request parameters in URL request:

  • The authentication token ( encrypted )
  • The record uuid
  • The userId

Configuration

Field / PropertyTypeDescription

extension.external.widget.dashboard

List

Each row is a couple of values with a tab content declaration, the format is: label;url;height

Label 1;http://localhost:8180/openkm/test.jsp;370
Label 2;http://www.openkm.com;240

The default height of the card in the dashboard is 370 pixels.

webservices.visible.properties

 List

To make accessible to all the users the values of the parameter "extension.external.widget.dashboard", must be added the value "extension.external.widget.dashboard" in the current list.

If you forget to add the property name, only administrator users will be able to get the value so some extensions may produce errors for regular users.

More information at Configuration parameters.

Sample

Configuration

Create file named test.jsp and copy into $TOMCAT_HOME/webapps/openkm folder.

<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>External URL request example</title>
</head>
<body>
	Request parameters
	<br />
	<br />
	<b>uuid:</b><%=request.getParameter("uuid")%><br />
</body>
</html>

Usage

  • Show the dashboard panel.