230 lines
9.9 KiB
HTML
230 lines
9.9 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>OTS Signs Command Center Documentation</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
|
|
|
<!-- favicon -->
|
|
<link href="../img/favicon.ico" rel="shortcut icon"/>
|
|
|
|
<!-- Bootstrap -->
|
|
<link href="../vendor/bootstrap/css/bootstrap.min.css" rel="stylesheet" media="screen">
|
|
|
|
<!-- Stylesheets -->
|
|
<link href="../manual.css" rel="stylesheet" media="screen">
|
|
|
|
<!-- META -->
|
|
<meta name="keywords" content="digital signage, signage, narrow-casting, ots-signs, open source, agpl, documentation" />
|
|
<meta name="description" content="OTS Signs Command Center is an open source digital signage solution. It supports all main media types and can be interfaced to other sources of data using CSV, Databases or RSS." />
|
|
</head>
|
|
<body data-toc="widgets">
|
|
<!-- Copyright 2020 Xibo Signage Ltd. Part of the Xibo Open Source Digital Signage Solution. Released under the AGPLv3 or later. -->
|
|
<nav id="top-nav" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#ss-navbar">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
<a href="#" class="navbar-brand">OTS Signs Command Center Documentation</a>
|
|
</div>
|
|
|
|
<div class="collapse navbar-collapse" id="ss-navbar">
|
|
<ul class="nav navbar-nav">
|
|
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div class="ss_body container">
|
|
<div class="row">
|
|
<div class="col-md-3">
|
|
<ul id="side-nav" class="nav nav-pills nav-stacked">
|
|
<li><a href="index.html" data-toc-name="getting_started">Getting Started</a></li><li><a href="layouts_editor.html" data-toc-name="layouts">Layouts</a></li><li><a href="media_library.html" data-toc-name="media">Media</a></li><li><a href="media_modules.html" data-toc-name="widgets">Modules</a></li><!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
|
|
<html><body><ul>
|
|
<li>
|
|
<a href="media_modules.html">Modules</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_modules_connectors.html">Connectors</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_audio.html">Audio</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_calendar.html">Calendar</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_clock.html">Clock</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_countdown.html">Countdown</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_currencies.html">Currencies</a>
|
|
</li>
|
|
<li class="active">
|
|
<a href="media_module_dashboard.html">Dashboard</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_dataset.html">DataSet</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_embedded.html">Embedded</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_emergency_alerts.html">Emergency Alert</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_flash.html">Flash</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_googletraffic.html">Google Traffic</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_hls.html">HLS</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_htmlpackage.html">HTML Package</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_image.html">Image</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_localvideo.html">Local Video</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_mastodon.html">Mastodon</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_menuboards_category.html">Menu Board Category</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_menuboards_products.html">Menu Board Products</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_national_weather_service.html">National Weather Service</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_notifications.html">Notifications</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_pdf.html">PDF</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_powerpoint.html">PowerPoint</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_shellcommand.html">Shell Command</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_stocks.html">Stocks</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_ticker.html">Ticker</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_video.html">Video</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_video_in.html">Video In</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_weather.html">Weather</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_webpage.html">Webpage</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_world_clock.html">World Clock</a>
|
|
</li>
|
|
</ul>
|
|
</body></html>
|
|
<li><a href="scheduling_events.html" data-toc-name="scheduling">Scheduling</a></li><li><a href="displays.html" data-toc-name="displays">Displays</a></li><li><a href="users_administration.html" data-toc-name="users">Users</a></li><li><a href="configure_cms_settings.html" data-toc-name="configure">Configuration and Organisation</a></li><li><a href="troubleshooting.html" data-toc-name="troubleshooting">Troubleshooting</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="col-md-9" role="main">
|
|
<h1 id="dashboards">Dashboards <a href="#dashboards" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h1>
|
|
<p><strong>Please note:</strong> If you would like to take advantage of this Widget, please contact your Administrator.</p>
|
|
<p>{nonwhite}
|
|
The Dashboards Widget is used to display <a href="media_dashboard_service.html">Dashboards</a> that have been configured to use the <a href="/docs/setup/ots-dashboard-service">OTS Signs Dashboard Service</a></p>
|
|
<p><strong>Please note:</strong> This commercial Widget is part of the <strong>OTS Signs Dashboard Service</strong> and requires an API for configuration as further explained <a href="/pricing#dashboards">here</a></p>
|
|
<h2 id="configuration">Configuration <a href="#configuration" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
|
<ul>
|
|
<li>Select the dashboard service to match the dashboards that have been configured in the connector.</li>
|
|
<li>Enter the URL to embed.</li>
|
|
</ul>
|
|
<blockquote class="tip"><p>Please see the following page for further information on obtaining a URL to use with this service, authentication mechanisms and possible limitations <a href="/docs/setup/ots-dashboard-service">OTS Signs Dashboard Service</a></p>
|
|
</blockquote>
|
|
<ul>
|
|
<li>Provide an update interval in minutes.</li>
|
|
</ul>
|
|
<p>On first entering a URL into the Dashboard Widget it may take a few moments to load as it is dependent on how long it takes to render your dashboard content, and how busy the service currently is.</p>
|
|
<p>Once you are showing your dashboards on displays, the service will keep your dashboards updated at the interval you specify so it will always be ready to show and appear instantly on Displays.</p>
|
|
<p>If you stop showing a dashboard on your displays for a time, then the service will stop refreshing it, but will start again automatically the next time that dashboard is shown.</p>
|
|
<blockquote class="tip"><p>By default reports in <strong>Power BI</strong> render with a US Date format. To use an alternative date format add the following parameters to the URL you pass in the Dashboards Widget as shown with the example below for <code>en-GB</code>:</p>
|
|
<p><code>&language=en&formatLocale=en-GB</code></p>
|
|
</blockquote>
|
|
<p><strong>Please note:</strong> If OTS Signs Command Center detects an error with a request for dashboard services, you will see a red banner message over the top of a screengrab to give an indication to the user where the problem has occurred. This will be shown in the Layout Designer previewer only for the logged in user. The Layout Preview and Displays showing the scheduled Layout will continue to show the last good capture or a spinner icon until the issue has been resolved.</p>
|
|
<p>Example Error message with screengrab shown below:</p>
|
|
<p><img src="img/v4_media_modules_dashboard_error.png" alt="Example Error Message" /></p>
|
|
|
|
</div>
|
|
</div>
|
|
</div> <!-- container-->
|
|
<footer class="ss_footer" role="contentinfo">
|
|
<div class="container">
|
|
<div class="pull-right">
|
|
<img class="img-responsive logo" src="../img/logo.png" alt="OTS Signs Command Center" />
|
|
</div>
|
|
|
|
<p class="ss_back_to_top">Back to Top</p>
|
|
|
|
<p class="ss_footer_links">Currently v4</p>
|
|
|
|
<p class="ss_languages"><a href="../en/index.html">en</a></p>
|
|
</div>
|
|
</footer>
|
|
|
|
<!-- JavaScript -->
|
|
<script src="../vendor/jquery/jquery.min.js"></script>
|
|
<script src="../vendor/bootstrap/js/bootstrap.min.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() {
|
|
$(".ss-sidebar .list-group li").addClass("list-group-item");
|
|
$(".ss_body img").addClass("img-thumbnail");
|
|
$(".ss_body table").addClass("table");
|
|
|
|
// Set the selected page based on the TOC name
|
|
// Mark the appropriate top nav element as the selected page
|
|
$("#top-nav a").each(function() {
|
|
if ($(this).data().tocName == $("body").data().toc)
|
|
$(this).parent().addClass("active");
|
|
});
|
|
|
|
$(".ss_back_to_top").click(function() {
|
|
$('html, body').animate({scrollTop : 0},800);
|
|
});
|
|
|
|
if (inIframe()) {
|
|
console.log("In Frame");
|
|
$("#top-nav").css("display", "none");
|
|
$(".ss-sidebar").parent().css("display", "none");
|
|
}
|
|
});
|
|
|
|
function inIframe () {
|
|
try {
|
|
return window.self !== window.top;
|
|
} catch (e) {
|
|
return true;
|
|
}
|
|
}
|
|
</script>
|
|
</body>
|
|
</html>
|