Sharperlight 3.0 Sample Dashboard

Transcription

1 Sharperlight 3.0 Sample Dashboard

2 Sharperlight 3.0 Sample Dashboard Published by philight Software International Pty Ltd All other copyrights and trademarks are the property of their respective owners Printed: March 2015 Document Version: Disclaimer: The information in this document remains the current view of philight Software International Pty Ltd and is subject to change without notice. This position is due to changing market conditions and should not be interpreted as a commitment to the correct operation of any technology or product contained herein. This document is intended as information only and philight Software International Pty Ltd makes no warranties, express or implied as to the information in this document. All rights reserved. The copyright of this document and the computer software described herein and provided herewith are the property of philight Software International Pty Ltd. No part of this publication or the computer software may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any human or computer language, in any form or by any means or otherwise used without the express written permission of philight Software International Pty Ltd. philight Software International Pty Ltd 15 Ohio Place Marangaroo WA 6065 AUSTRALIA

3 Contents 3 Table of Contents Part I Overview 6 Part II Setup 8 1 Step Restore Dashboard Database 8 2 Step Add Dashboard Datamodel 8 3 Step Import Published Queries and Dashboard Pages 8 4 Step Restart Sharperlight Service 8 5 Step Open Homepage 9 Part III Homepage 11 1 Start Dashboard Billboard Part IV Dashboards 16 1 Sales Today's... Sales 16 Top 5... Stock Lines by Quarter 17 Stock... Lines for Week 17 Fortnightly... Sales 18 Current... Stock Line Sales 18 Top 5... Customers 19 2 Purchases Purchase... Orders by Stock Line 20 Purchase... Orders by Week 21 Purchase... Orders by Supplier 21 Year... and Month Slicers 22 3 Compliance Days... Elapsed from Order To Approval 23 Days... Elapsed from Order To Invoice 23 Orders... Unreceipted in Last 60 Days 24 4 Financial Account... Balances by Period 25 Balances... by Period 25 Technical... Services 26 Event... Monitoring 26 5 Freight Freight... by Region 27 Carrier... by Packaging 28 Packaging Power... 29

4 4 Sharperlight 3.0 Sample Dashboard Solar... Generation 29 Solar... Generation for Today 29 Power... Consumption by Location 30 Power... Feed Schedule 30 Weather Part V Reports 33 1 Freight... by Region and Suburb 33 2 Month... To Date Profit and Loss 33 3 Sales... Key Performance Indicators 34 4 Sales... Orders with Attachments 35 5 Sales... Quantity by Month 36 6 Trial... Balance 36 7 Trial... Balance by Month 37 Index 0

5 Part I

6 6 1 Sharperlight 3.0 Sample Dashboard Overview This is a companion guide that explains how to setup the Sharperlight Sample Dashboard and it explains how the Dashboard was constructed and it highlights key functionality. The Sample Dashboard consists of Published Queries, Dashboard Pages, the Sample Dashboard database and a Sample Dashboard Datamodel. The Sample Dashboard is a demonstration environment, that uses practical examples to show the versatility and simplicity of Sharperlight and its Dashboard capabilities. The Homepage that hosts the dashboards can easily be used in production environments with minimal modifications.

7 Part II

8 8 2 Sharperlight 3.0 Sample Dashboard Setup The Sample Dashboard requires an installation of Sharperlight or later. These setup instructions assume Sharperlight is already installed and configured. The Sample Dashboard collateral is packaged and distributed together inside a ZIP file. The following instructions assume the ZIP file has been extracted into a folder. 2.1 Step 1 - Restore Dashboard Database The Dashboard database backup is in a SQL Server 2008 R2 backup format and thus, it will not restore into a SQL Server 2008 or earlier database instance. 2.2 Step 2 - Add Dashboard Datamodel Open the Datamodel Installer and use the Add button to load the Dashboard.meta file into the local Datamodel instance. The description for the Dashboard.meta file is Sample Dashboard Data. Once the Dashboard Datamodel is successfully loaded, then open Client Setup to configure and test the connection details to Sample Dashboard database. 2.3 Step 3 - Import Published Queries and Dashboard Pages Open Publisher and right hand click on the Published Query List, this will display a menu with the option to Import Items. Use the Import and navigate to the Sample Dashboard directory and select the DSH.pbqlist file. This file contains all the Dashboard Published Queries and the Published Queries that create the Homepage website. The Homepage queries have a standard group of System and individual queries are named System.HomeMain, System.HomeMenu, System.HomeStart and System.HomeInfo. Selected Published Queries will overwrite any queries with the same name, so be careful to only select queries that do not exist or need to be replaced. After importing the Published Queries, use the same right hand click menu and select the Dashboard Pages item. This will open a form similar to Publisher but it is a list view of Dashboard Pages. The form has its own Import Items from the right hand click menu. The import can be used to import the DSH.dblist file that contains the Sales, Purchases, Compliance, Financial, Freight and Power Sample Dashboards. 2.4 Step 4 - Restart Sharperlight Service Once the Published Queries and Dashboard Pages have been imported, it is good idea to stop and start the Sharperlight Service. If the Service was running when the Dashboard Datamodel was added then it won't be available until the Service is restarted. If the Datamodel Service is running in manual mode, use the Service dialog and select the Stop Service button to close the Service. Start the Manual Service again using the Service shortcut in the Sharperlight All Programs Start Menu folder. If the Service is running as a Windows Service, use the standard Windows Services dialog to restart the Sharperlight Service.

9 Setup Step 5 - Open Homepage To open the Sample Homepage use the root address of the Sharperlight REST Service and add the path to the System.HomeMain report. For example, to connect to the localhost with a default configuration of the Web Channel and assuming it uses port 4001 for HTTP communication, the web address would be When someone attempts to access the System.HomeMain Published Query, it will enforce user authentication and require either a valid Sharperlight user and password or; if the Service is using Windows Authentication it will authenticate the browser user with the users detailed in Site Setup.

10 Part III

11 Homepage 3 11 Homepage The Sample Homepage uses a Report Layout in Publisher to integrate together a page header, individual tabs for dashboard pages, billboards for Published Query selection and HTML information pages. To investigate how the Homepage hangs together, open Publisher and edit the System.HomeMain Published Query. Select the Report tab and take special notice of how their is an enabled Layout and Custom Header. Homepage Use the Layout Edit button to review the Layout settings. The Layout is set to use a Tab Style where each item of content will be returned in its own Tab. Some of the content is referencing Publisher Reports but the Sales, Financial and Power items are Dashboard Pages. The System.HomeStart and System.HomeInfo items are returning Custom HTML whilst the System.HomeMenu Report is a query that returns a billboard of published queries restricted by the Publisher Group Code. The System.HomeMenu queries the Sharperlight System Datamodel and restricts the output to only queries that have the same Group Code as referenced in the URL Parameter (bottom right hand corner). System.HomeMain Layout The System.HomeMain uses a CUSTOM HTML Header to position a company logo in the top left hand corner and login details on the right. The HTML script can be viewed by selecting the Edit Custom Header button. This sample script was graphically designed using Microsoft Expression Web 4 which is a free download from Microsoft. In the HTML script there is a reference to SharperlightLogo.png file but the path to the file is not immediately clear. {*Url.Root}/Content/?product=Dashboard&file=SharperlightLogo.png Custom HTML in Publisher can refer to the Sharperlight Service and extract Content directly from a Datamodel. So the reference to the SharperlightLogo.png is using the Service to return an image file

12 12 Sharperlight 3.0 Sample Dashboard stored in the Dashboard Datamodel. System.HomeMain Custom Header This sample System.HomeMain could be easily changed to display other dashboards and different Published Query groups. This style of Homepage is normally given to customers during training and it provides a simple mechanism for hosting and deploying Published content. 3.1 Start The Tab Layout used in this Homepage will always display the tab on the far left. Rather than jumping straight into a Dashboard or Billboard the Start page is providing some instructional information. This is a good practice to follow because the Start page could be used for team based instructions and a simple noticeboard of up coming events. Start Tab The System.HomeStart Published Query contains the Custom HTML welcome page. From the Report tab in Publisher, open the Custom HTML dialog and the HTML code can be viewed. The HTML script can be modified in this dialog but anything beyond simple rewording of sentences can become technically challenging. A simpler alternative is to create and maintain the web page in Web Expressions, and then copy and paste the HTML code between the code pane in Web Expressions and into the Custom HTML dialog.

13 Homepage 13 System.HomeStart Custom HTML 3.2 Dashboard The Dashboards in Sharperlight are self-contained web pages that can enclose multiple individual tiles. The creation and maintenance of Tiles is completed within the Dashboard page. Each Tile has a Properties icon on its Title bar, and from here the Properties for the Dashboard Page and Tile can be configured. Dashboard Tab Dashboard Tiles can repositioned and resized from within the Dashboard Page container but these changes need to be saved through the Tile properties, for them to be retained.

14 14 Sharperlight 3.0 Sample Dashboard Tile Expanded Web Tables and Charts in Sharperlight inherit the Drill Throughs that have been configured for the Published Query. Even if the web content is returned through a Dashboard Tile, the Drill Throughs will be available using the right hand click row menu in a Table and left hand mouse clicking on a chart series. Tiles also have the concept of an Expanded View. If the Expanded URL is configured in the Tile Properties then double clicking on the Tile Title will open the Expanded content in another browser tab. This is equivalent to clicking on the right facing arrow on the Tile Title. The window expand icon on the Tile Title will maximise the current browser frame to just contain the Expanded View. 3.3 Billboard Billboards provide a simple mechanism for viewing lists of Published Queries and then selecting individual ones for viewing. The System.HomeMenu Published Query generates the billboard list and it uses a query with expressions to create the hyperlinks beneath the Title and a document icon. If the cursor is hovered over the query title, it will turn from the normal arrow pointer to a selection finger. Billboard Tab On selecting a Published Query from a Billboard, the query will either open a new browser tab or a new browser windows. The configuration of the browser will decide if it uses a new tab or browser window.

15 Part IV

16 16 4 Sharperlight 3.0 Sample Dashboard Dashboards To emphasis how Dashboards are used to visualise operating states, the tile data on the Sales, Financial and Power Dashboards will slowly creep into the future because they are all configured to refresh on a regular basis. The Purchases, Compliance and Freight Dashboards are designed to return performance measures for the current day and they do not automatically refresh. The Sample Dashboard Datamodel has some special query logic that will dynamically set the transaction dates. So the dates will always start from today, then increment into the future and after two hours the queries will reset and start refreshing again from the current date. 4.1 Sales The Sales Dashboard Page contains seven tiles and they all are set in Publisher to refresh every three minutes (180 Seconds). There are four tables with Filtered Columns and one has trend indicators, there are also two dual series charts and a high level sales summary tile. Sales Dashboard Page Today's Sales The Today's Sales Tile uses the DSH.SalesToday Published Query. The SalesToday query uses an Output Expression to format the Items Sold and Total Orders with a highly visible large font. It also has conditional logic that will format the font red if the Total Order value is less than 15,000 and otherwise green. The row has a By Salesperson Drill Through configured on it and this Drill Through provides Items Sold and Total Order values by Salesperson.

17 Dashboards 17 Today's Sales Tile If the cursor is hovered over the Today's Sales Title bar, it will display a Tooltip that has been written into the Tile Properties Top 5 Stock Lines by Quarter The Top 5 Stock Lines by Quarter Tile uses the DSH.Top5StockbyQuarter Published Query. The query is using Filtered Columns to calculate the calendar year quarters from 1 through to 4. The query is also using a scaling factor to return movements rounded to the nearest thousand. Top 5 Stock Lines by Quarter Tile Stock Lines for Week The Stock Lines for Week Tile uses the DSH.StockLineWeek Published Query and it has an Expanded View that displays a more detailed report on the stock line movements. When reviewing this area chart, it can be useful to disable one of the series to focus just on last week or this week. To disable a series, click on the colour square in the chart legend and this will turn the legend colour to grey, and the series will disappear from the chart.

18 18 Sharperlight 3.0 Sample Dashboard Stock Lines for Week Tile Fortnightly Sales The Fortnightly Sales Tile uses the DSH.FortnightSales Published Query. The chart combines a line and column series style and the disparity between the value of Orders and Freight is a good example where the Order series might be disable, and the chart will then rescale to show a more indicative Freight series. To disable the Order series, click on its legend colour square and it will change to grey and the Orders series will disappear from the chart. Reselect the Orders colour square in the legend and the series will return to the chart. The Published Query has two Drill Throughs available, one by Stock Line and the other by Salesperson. To use these Drill Throughs in the chart, click on a measurement point in either of the chart series and it will display a pop up Drill Through menu. Select the required Drill Through and the Drill will be opened in another browser pane. Fortnightly Sales Tile Since this chart uses the date on an axis, it will clearly show how the automatic refreshes will move forward in time because new dates will appear and older dates will fall off the charting series. Obviously, this is for illustrative purposes and the Sample Dashboard Datamodel is specifically designed to allow this time shift Current Stock Line Sales The Current Stock Line Sales Tile uses the DSH.StockLineCurrTrend Published Query. This query uses Filtered Columns to return the weekly and daily Stock Line values. It also uses an Expression with a formatting script to return the trend icons with the green triangle trending up and the red triangle trending down. The Tile Properties also have a Tooltip description for the Tile, so this will pop up when the cursor is hovered over the Tile Title bar.

19 Dashboards 19 Current Stock Line Sales Tile Top 5 Customers The Top 5 Customers Tile uses the DSH.Top5Customers Published Query. This query uses Filtered Columns to return the different reporting periods and it uses an Expression to abbreviate the Customer Name. Top 5 Customers Tile 4.2 Purchases The Purchases Dashboard returns purchase order performance based on the current year and month. On the left hand side their are slicers for Year, Month and Manager which will on row selection, force a refresh of the charts and tables.

20 20 Sharperlight 3.0 Sample Dashboard Purchases Dashboard Page Purchase Orders by Stock Line The Purchase Orders by Stock Line Tile uses the DSH.PurOrdByStoLin Published Query and it has a Drill Through to display Purchase Orders by Stock Items. Purchase Orders by Stock Line Tile

21 Dashboards Purchase Orders by Week The Purchase Orders by Week Tile uses the DSH.PurOrdByWK Published Query and it charts the value of purchase orders using a radar chart. Purchase Orders by Week Tile Purchase Orders by Supplier The Purchase Orders by Supplier Tile uses the DSH.PurOrdBySupPer Published Query and it uses a stacked column chart to visualise the value of orders. This example uses a filter in the Tile to restrict the order value by Stock Line. Note that the filter is using a dropdown picklist which uses less space than the default filter list. Purchase Orders by Supplier Tile

22 Sharperlight 3.0 Sample Dashboard Year and Month Slicers The Year and Month Slicer Tiles use the DSH.PurOrdYearSli and DSH.PurOrdMonthSli Published Queries. These Tiles are defined as Slicers by the &rowselectfilter=1 command, that has been added to there Content URL. These Dashboard Slicers provide a simple method of filtering the Tiles on a Dashboard Page. By individually or multi-selecting values in the Slicer list, the Tiles on the page will be refreshed if there queries have the same filter names. Year and Month Slicers 4.3 Compliance The Compliance Dashboard uses three simple Tiles to illustrate how a user process can be monitored to ensure visibility and compliance. Compliance Dashboard This Dashboard has a Notes Tile in the bottom left hand corner. Tiles have a rich text editor pane in there properties pane and it can be used to display paragraphs of text and bullet points.

23 Dashboards 23 Tile Contents Days Elapsed from Order To Approval The Days Elapsed from Order To Approval Tile uses the DSH.PurOrdTimeElapOrdApp Published Query. This query uses Query Unions to stack the timeframes and it uses a Report Layout to display both a Table and Pie Chart of the same information. In the right hand top corner of the Tile there is a small downward facing triangle, clicking on this triangle will display a filter for the Stock Line. This is a collapsed filter bar and this behaviour is configured in Publisher. Days Elapsed from Order To Approval Tile Days Elapsed from Order To Invoice The Days Elapsed from Order To Invoice Tile uses the DSH.PurOrdToInvTol Published Query. The Chart has a Drill Through available, double click on any of the column bars and the Drill Through menu will display a To Order Details drill.

24 24 Sharperlight 3.0 Sample Dashboard Days Elapsed from Order To Invoice Tile Orders Unreceipted in Last 60 Days The Orders Unreceipted in Lasted 60 Days Tile uses the DSH.PurOrd60DaysUnrec Published Query. In the query there is a Report Layout that stacks the status summary above the order details. The two queries have a relationship where a row selection in the status summary will filter and refresh the order details. Orders Unreceipted in Last 60 Days

25 Dashboards Financial The Financial Dashboard is configured the same way as the Sales Dashboard, so all the tiles will automatically refresh every three minutes. The dashboard introduces some inline graphical elements with sparklines, horizontal bars and shortcuts. Financial Dashboard Page Account Balances by Period The Account Balances By Category Tile uses the DSH.AccntBalbyCat Published Query. This query uses Filtered Columns extensively to return the year balance and the balance for every month which is then used in the Sparkline. The Sparkline is an Expression that takes the monthly balances for the year and generates a small inline bar chart. The positive values are return in blue and negative values in red. If the Financial Dashboard is left to run for an hour it will roll into 2014 and the column titles will change to reflect the year. The column titles for This Year and Last Year are Expressions that use the filter value to label the column. The Tile Properties for this example has commentary in the Tooltip, it will be displayed if the cursor is hovered over the Tile Title bar. Account Balances by Period Tile Balances by Period The Balances By Period Tile uses the DSH.BalbyPer Published Query. The area chart showing Revenue and Expenses is fairly difficult to interpret, the close alignment of two series makes it difficult to visualise the true difference. If the user clicks on the chart area it will display a pop up

26 26 Sharperlight 3.0 Sample Dashboard menu with Zoom In, Zoom Out and Refresh. Select the Zoom In and it will display a sectional slicer and by clicking on the slice, the chart will zoom in and rescale the area with a focus on the top of the series. Balances by Period Tile Technical Services The Technical Services Tile uses the DSH.TechServProjSum Published Query. The query uses an Expression to generate a horizontal bar with a percentage complete label. To focus on the outstanding projects the query uses an Expression to suppress all projects where the completion is higher than 99 percent. Technical Services Tile Event Monitoring The Event Monitoring Tile uses the DSH.EventMon Published Query. This is a simple example of how customers can use a custom message queue table for reporting business events. The messages get written into the queue table and they should have a priority value, an expiry date and a field to show they can be disabled. From within the Event Monitoring Tile the messages can be reviewed in more detail and disabled using the Disable shortcut which opens a standard Sharperlight Writeback Webform. Event Monitoring Tile Writeback Webforms are automatically generate when a table in a Datamodel is Writeback enabled. The Webform uses the field structure, lookups and data types to determine the form

27 Dashboards 27 layout and behaviour. With the Message Queue Webform, the record can be disabled by switching the Disabled radio button to Yes and selecting the Submit button at the bottom. Message Queue Webform 4.5 Freight The Freight Dashboard uses four Tiles to illustrates how a cost intensive element of a bigger business process can be focused on. Also the bold colours show how dashboard colour schemes can be tailored to corporate branding and different dashboards can have there own unique colour schemes. Freight Dashboard Page Freight by Region The Freight by Region Tile uses the DSH.FreByReg Published Query. The Tile has an Expanded view, by double clicking on the Tile Title another web browser pane will be opened and the generated report has freight costs and percentages for the day, week, month, quarter, half year and year.

28 28 Sharperlight 3.0 Sample Dashboard Freight by Region Carrier by Packaging The Carrier by Packaging Tile uses the DSH.FreCharByPack Published Query. The query is using Filtered Columns to arrange freight costs by the types of packaging. Carrier by Packaging Tile Packaging The Packaging Tile uses the DSH.FrePackTab Published Query but it has Report Layout that returns different timeframe based queries on separate tabs. Packaging Tile

29 Dashboards Power The Power Dashboard has similar concepts to the Sales and Financial Dashboards. The Power Dashboard will refresh automatically but it is much more frequent with a 30 second interval. It also introduces gauges and shows how tabs can be used within a tile. Power Dashboard Page Solar Generation The Solar Generation Tile uses the DSH.PowerConNowGauge Published Query. The query uses a Query Union to stack the Gauge on top of the calculated value. The gauge is an Expression where the label, yellow and red zones, and the minimum and maximum values can be specified. The calculated value uses an Expression to format the value with font size and the KW-H label. Solar Generation Tile Solar Generation for Today The Solar Generation for Today and 30 Days Tile uses the DSH.SolarGenToday30Days Published Query. The query uses a Sub Query to return the 30 day average and then uses Expressions to format the output values.

30 30 Sharperlight 3.0 Sample Dashboard Solar Generation for Today and 30 Days Tile Power Consumption by Location The Power Consumption by Location Tile uses the DSH.PowerConTab Published Query. This query uses a Report layout with seven independent tabs to return consumption values for Now, Today, the Week, the Month, etc. Each of the tabs corresponds to another Published Query. This example illustrates how multiple slices of similar information can be condensed in a small space by using tabs within a Tile. Power Consumption by Location Tile Power Feed Schedule The Power Feed Schedule Tile uses the DSH.PowFeeSch Published Query. The query uses six Query Unions to report the different timeframes. Power Feed Schedule Tile Weather The Weather Tile uses the DSH.Weather Published Query. The query uses four Query Unions to stack the weather conditions.

31 Dashboards 31 Weather Tile

32 Part V

33 Reports 5 33 Reports To complement the Sample Dashboards, there are also Sample Reports that demonstrate some of the Sharperlight web reporting functionality. 5.1 Freight by Region and Suburb The Freight by Region and Suburb Report uses the DSHS.FreByRegSub Published Query. The query uses Filtered Columns, Sub Queries and Expressions to return freight costs. Right hand clicking on the report table will display a Table menu, from this menu the web report can be printed and saved to a local file. Freight by Region and Suburb 5.2 Month To Date Profit and Loss The Month To Date Profit and Loss Report uses the DSHS.MTDProfitLossMain Published Query. This query uses a Report Layout to combine together separate reports under there own tabs. The Summary and Detailed reports have Drill Through icons alongside the actual and budget values. The use of Drill Through icons allows more flexibility on the positioning of the link and it is has more visual impact to the end-user.

34 34 Sharperlight 3.0 Sample Dashboard Month To Date Profit and Loss - Summary Selecting any of the other tabs will display another report. The detailed and summary reports have a similar layout but the detailed report returns actual and budget values down to the account level. Month To Date Profit and Loss - Detailed 5.3 Sales Key Performance Indicators The Sales Key Performance Indicators Report uses the DSHS.SalesKPI Published Query. The query uses Filtered Columns, Sub Queries and Expressions to calculate Percentage and for the inline charts.

35 Reports 35 Sales Key Performance Indicators 5.4 Sales Orders with Attachments The Sales Orders with Attachements Report uses the DSHS.SalOrdAtt Published Query. This query is relatively simple but take note of the far right hand side column which has a document icon that will return the sales order in PDF into the web browser. Sales Orders with Attachments

36 Sharperlight 3.0 Sample Dashboard Sales Quantity by Month The Sales Quantity by Month Report uses the DSHS.SalQtyMth Published Query. This query uses Filtered Columns and an expression to create the sparkline chart. Sales Quantity by Rolling Months 5.6 Trial Balance The Trial Balance Report uses the DSHS.TrialBal Published Query. The query uses an OR statement to conditionally return the balance of balance sheet accounts and the year to date balance of profit and loss accounts. Trial Balance

37 Reports Trial Balance by Month The Trial Balance by Month Report uses the DSHS.TrialBalMth Published Query. This query uses Query Unions to stack and subtotal account categories. Note that the Retained Earnings is a calculated value based on the previous years profit or loss, so the grand total balances to zero. Trial Balance by Month