User guide - Dashboard

Transcription

1 User guide - Dashboard

2 Table Of Contents About the Dashboard...2 Usage examples...2 Logging on to the Dashboard...3 Advanced login...3 Getting started with the Dashboard...5 Widget view...6 Widgets...6 Widget menu...6 Predefined widgets...8 Dialog Chart Widget...8 Gauge Widget...8 Number Widget...9 Chart Widget...9 Report Widget...9 Archived Report Widget...9 URL Widget...9 Dialog Widget...9 The Dashboard's menus The Dashboard's user types Edit view Entering Edit view Shared widgets and User widgets Elements in Edit view Adding new widgets Deleting widgets ii

3 Table Of Contents Closing widgets Restoring default settings Configuring widgets Moving widgets Configuring widgets Configuring widgets Editing the predefined widgets Dialog Chart Widget Properties Gauge Widget Properties Number Widget Properties Chart Widget Properties Report Widget Properties Archived Report Widget Properties URL Widget Properties Dialog Widget Properties Shared mode Entering Shared Mode Shared Mode How shared settings are combined with user settings Custom made widgets iii

4

5 Welcome to the Dashboard User Guide Portrait Dialogue Version Copyright Portrait Software International Limited All rights reserved. This document may contain confidential and proprietary information belonging to Pitney Bowes Inc. and/or its subsidiaries and associated companies. Portrait Software, the Portrait Software logo, Portrait, and Portrait Software's Portrait brand are the trademarks of Portrait Software International Limited and may not be used or exploited in any way without the prior express written authorization of Portrait Software International Limited. Acknowledgement of trademarks Other product names, company names, marks, logos and symbols referenced herein may be the trademarks or registered trademarks of their registered owners. 1

6 Getting started About the Dashboard The Dashboard is a module within Portrait Dialogue: a suite of software that supports Customer Relationship Management in modern businesses. It is used by marketers to define, manage and carry out structured communication processes with huge numbers of customers and is specifically designed to support the principles of 1:1 (one-to-one) marketing. The Dashboard provides you with an intuitive interface for displaying one or more graphical components called widgets. It comes with several predefined widgets, which can be configured to show a multitude of information, but it also supports custom made Widgets allowing you to create a widgets tailored especially to your needs. Usage examples The Dashboard can be used to:? Show real-time information about your customers.? Show the currently running Dialogs in a specified timeframe.? Show reports.? Show external web pages. To start the Dashboard see Logging on to the Dashboard. 2

7 Getting started Logging on to the Dashboard A user must be authorized in order to log on to the Dashboard. The Dashboard supports two login methods: Normal login and Windows login. The login type used by your organization is set up by your system administrator.? Normal login When using normal login (see Figure 1 below), you have to manually type in your username and password.? Windows login When windows login is enabled, and your windows user has log on rights to the Dashboard, you are automatically authorized and logged in to the Dashboard using your windows domain user. If your windows user does not log on rights then you will be taken to the log on page (Figure 1). The log on will in this case work as normal login described above. When you have logged on, you are taken to the Dashboard's Widget view. Figure 1 - Log on page. Advanced login 3

8 User guide - Dashboard The log on page used when manually logging on to Dashboard has some advanced settings. You can display these by clicking on the Advanced button in the lower right corner of the log on box (see Figure 1 above).? Instance Some organizations use several instances of Dialogue Server. If your organization has two or more instances then the Dashboard can be configured to allow you to choose which instance you log on to. You can select the instance in the drop down in the log on box' advanced area (see Figure 2 below).? Cache In order to speed up the performance in Dashboard, it caches data on the web server. This data cache has to be removed when the system administrator makes changes in the customer domain. You can clear this data by checking the Clear cache checkbox in the log box' advanced area (see Figure 2 below). Figure 2 - Login page with advanced options shown. 4

9 Getting started Getting started with the Dashboard This help file has two main sections: Using the Dashboard and Configuring the Dashboard. If you are a normal user who wants to learn how to use the Dashboard, you only need to read Using the Dashboard. If you are an administrator wanting to learn how to set up and configure the Dashboard, you should first read Using the Dashboard and then read Configuring the Dashboard. 5

10 Using Dashboard Widget view Widget view is the Dashboard's main working area and where all widgets are presented. You will always find yourself in Widget view when you log on to the Dashboard. The widgets shown in Widget view have been added by an administrator or added by you. Se picture below for a simple example of how the Dashboard might look while in Widget view. Figure 1 - Widget view displaying Dialog Chart Widget and a Report Widget (only partially shown). Widgets There are several types of widgets which can be shown in Widget view. The Dashboard comes with several predefined widget types but it is also possible to create custom made widgets which can be shown exactly as the predefined ones. Widget menu All widgets have a menu in the top right corner (see figure below). The menu allows you to minimize the widget to only show the widget's title bar. If you have the appropriate access right you are also allowed to close widgets. The widget is then removed from Widget View. You can however re-add it from Edit view. 6

11 Using Dashboard Figure 2- A widget's menu. 7

12 User guide - Dashboard Predefined widgets The Dashboard comes with several predefined widgets which can be used to display a multitude of information. A short description of each widget type is found below. See Editing predefined widgets for how to configure each type of widget. Dialog Chart Widget A Dialog chart widget shows dialogs in a Gantt diagram. With the appropriate access right you can configure which dialogs are shown. See Editing predefined widgets for how to do this. Figure 1 - Dialog Chart Widget. The Dialog chart widget can be linked to a Dialog widget. You can then click on a dialog in the chart and the Dialog widget will then be updated with information from the selected dialog. Dialog specific information can also be viewed by hovering the mouse cursor over the dialog (see Figure 2 below). Figure 2 - Dialog information popup. Gauge Widget A Gauge widget shows a gauge displaying a value retrieved by using a SQL or by using a selection. 8

13 Using Dashboard Number Widget A Number widget show a number retrieved by using a SQL or by using a selection. Chart Widget A Chart widget displays chart based on values retrieved by using SQL. The following chart types are supported: pie, exploded pie, donut, column, horizontal column, line, area, cone and pyramid. Report Widget A Report widget can be used to display a report. The report can be a system report or a report created specifically for your organization. Archived Report Widget The Archived report widget is very similar to the Report widget. The only difference is that the Archived report widget displays archived reports, while the Report widget runs the report each time. A archived report is generally much faster than a normal report and it is for that reason highly recommended to use archived reports where possible. URL Widget The URL widget can be used to display an external web page inside the Dashboard. Dialog Widget The Dialog widget can be used to display information about a specific dialog. It shows reports as the Report widget does, but it can only show dialog specific reports. The widget is normally used in combination with a Dialog chart widget. 9

14 User guide - Dashboard The Dashboard's menus The Dashboard contains the following menus: Menu Command Function Settings Edit layout Changes to Edit view. Mode (only available to administrators) Help Dashboard preferences User Mode Opens the Dashboard's settings dialog where you can, among other things, change the language used by the Dashboard. Enters the Dashboard's default mode of operation. Most users will only work in this mode. Enters the Dashboard's administration mode. Widgets added and configured in this mode Shared Mode affect all Dashboard users. Only users with the Dashboard administrator access right can enter this mode. Displays the help file (the one you are currently reading). Sign Out Signs the user out of the Dashboard. 10

15 Configuring the Dashboard The Dashboard's user types There are three different user types in the Dashboard: normal users, normal users which can customize their own Widget view and administrators. Normal users Normal users are allowed to log on to the Dashboard and to view the widgets in Widget view. They are not allowed to add or configure widgets. Normal users which can customize their own Widget view These users have elevated access rights and are allowed to configure the widgets added by administrators and allowed to add and configure their own widgets. Administrators Administrators can in addition to what is described above also add and configure widgets shared by all users. See Shared mode for how this is done. 11

16 User guide - Dashboard Edit view You enter Edit view when you want to change which widgets are displayed in the Widget view and the widget's configuration. Edit view is only accessible to users with elevated access right (see User types for more information). In Edit view you can drag a widget to a new location, add new widgets, remove existing widgets and configure widgets. As long as you are not working in Shared mode, the changes you make while in Edit view are only shown to you. Entering Edit view Edit view can be entered by selecting 'Edit Layout' from the 'Settings' menu (see Figure 1 below). Figure 1 - 'Edit layout' on the 'Settings' menu. In Edit view you are presented with a page similar to the one shown below. Figure 2 - Layout view. Shared widgets and User widgets Widgets in the Dashboard can be shared widgets or user widgets. Shared widgets can only be added by administrators and are shared by all users. User widgets can be added by you and 12

17 Configuring the Dashboard are only shown in your own Widget view. Shared widgets are almost identical to user widgets, but the following differences apply: 1. You cannot delete shared widgets. Only administrators can do this. You can however close the widget, removing it from Widget view. 2. Shared widgets removed by an administrator are also lost to you. 3. You are automatically shown shared widgets added by an administrator. 4. If an administrator makes changes to an existing Widget's settings, then these changes are automatically reflected in your copy of the widget, unless you have overridden the settings. Elements in Edit view Widget zones The Widget zones are shown to the left in Figure 2 and it is in these areas widgets can be placed. Multiple widgets can be placed inside each zone. They will then be displayed below each other. Available widgets The available widgets can be found in the Settings area. Select 'All available widgets' if you want to add a new unconfigured widget (selected by default) or select 'Closed widgets' if you want to add a Widget already configured by you or an administrator. A list of all available widgets of the selected type will then be shown. Adding new widgets Use the following steps to add a new widget: 1. Select one of the widgets under 'All available widgets'. 2. Select the zone you want the widget to appear in from the 'Add to:' drop-down control. 3. Click the 'Add' button. An unconfigured widget will now appear in the zone you selected. To configure the widget you have to click on the widget's edit button. Deleting widgets When you delete a widget you remove the widget from the Widget zone and you lose all the widget's settings. Note that you can only delete widgets you have added yourself. Widgets added by administrators can only be deleted by administrators. Use the following steps to delete a widget: 1. Click on the garbage can icon on the widget's menu. 13

18 User guide - Dashboard Figure 3 - Deleting a widget. Closing widgets When you close a widget you remove the widget from the Widget zone, but you do not lose its settings. The widget is placed under 'Closed widgets' in the 'Available Widgets' area and you can at a later time re-add the widget. Use the following steps to close a widget: 1. Click on the cross icon on the widget's menu. Figure 4 - Closing a widget. Restoring default settings You can at any time restore Widget view to its original state. All changes you have done will then be lost. This applies to widgets you have added, widgets you have closed and widgets you have configured. The Dashboard will then be restored to the default settings specified by the Dashboard administrators. Use the following steps to restore the default widget settings: 1. Click on the 'Restore' button in the 'Settings' area. Configuring widgets. See Configuring widgets for how to configure a widget. Moving widgets Widgets already added can be moved around by using drag-and-drop. They can both be moved between zones and relative to other widgets inside a zone. Use the following steps to move a widget: 1. Move the mouse's cursor over the widget's title bar and click and hold the mouse button. 2. Drag the widget to its new location. When your mouse cursor hovers over an area where you can place the widget, a red line will be shown. Release the mouse button when the red line is shown where you want to place the widget. Note: All changes are saved automatically. You do not have to save the changes explicitly. 14

19 Configuring the Dashboard Configuring widgets Configuring widgets To configure a widget you first have to click on the pen icon on the widget's menu (see Figure 1 below). Figure 1 - Selecting a widget for editing. The 'Settings' area will then change to the 'Edit Widget' area where the selected widget's properties are shown. Figure 2 below shows the Dashboard when a URL widget has been selected for editing. Figure 2 - A widget selected for editing. See Editing predefined widgets for how to configure the Dashboard's predefined widgets. 15

20 User guide - Dashboard Editing the predefined widgets A user with the appropriate access rights can configure all of the standard Widget types. To change a Widget's properties you first have to enter Edit view. Below you can find a list of all the predefined widgets' configurable settings. Dialog Chart Widget Properties Title The Widget's title. Show the dialogs which are active in the timeframe Specifies the start date of the timeframe used by the chart to display dialogs. to Specifies the end date of the timeframe used by the chart to display dialogs. Show dialogs with status Only dialogs with the selected status are shown. The following status' can be selected: Show all dialogs, Show dialogs with status 'In production', Show dialogs with status 'Under construction', Show dialogs with status 'Obsolete', Domain to show dialogs from Only dialogs from the domain specified are shown. Number of dialogs shown on each page The number of dialogs to show on each grid page. Dialog chart widget width The dialog chart widget's width in pixels. Widget showing dialog information The widget used to show detailed dialog information when a dialog is selected in the dialog chart. 16

21 Configuring the Dashboard Figure 1 - Editing a Dialog Chart Widget Gauge Widget Properties Title The widget's title. Get value using How the gauge value is obtained. Possible methods:? SQL? Selection SQL name The name of the SQL to use (the SQL queries are defined in Dialogue Admin). This 17

22 User guide - Dashboard field is only shown if 'SQL' is selected in the Get value using drop-down. The SQL used must return a singe row with a single value. Selection Which Visual Dialogue selection to use. This field is only shown if 'Selection' is selected in the Get value using drop-down. Gauge type The gauge type to use to display the gauge. Available types:? Full circle? Full circle with flat bottom? Half circle? Quarter of a circle Style The gauge's style. Available styles:? Black on white background? Black on gray background? White on black background? Red on white background? Green on white background? Blue on white background Height The gauge's height. Width The gauge's width. Minimum value The lowest value the gauge shows. Maximum value The highest value the gauge shows. Range marker minimum value The lowest value of the range marker. Range marker maximum value The highest value of the range marker. Range marker color The color of the range marker. 18

23 Configuring the Dashboard Number Widget Properties Title Figure 2 - Editing a Gauge widget 19

24 User guide - Dashboard The Widget's title. Get value using How the value is obtained. Possible methods:? SQL? Selection SQL name The name of the SQL to use (the SQL queries are defined in Dialogue Admin). This field is only shown if 'SQL' is selected in the Get value using drop-down. The SQL used must return a singe row with a single value. Selection Which Visual Dialogue selection to use. This field is only shown if 'Selection' is selected in the Get value using drop-down. Font size The number's font size. Color The number's color. Bold If the number should be bold. Italic If the number should be italic. Show as percentage If a percentage sign should be added after the number. 20

25 Configuring the Dashboard Figure 3 - Editing a Number widget Chart Widget Properties Title The Widget's title. SQL name The name of the SQL to use (the SQL queries are defined in Dialogue Admin). The SQL used must return one row for each value to display. The first column should contain the display name and the second should contain the value. Chart width The chart's width in pixels. Chart height The chart's height in pixels. Show in 3D 21

26 User guide - Dashboard If the chart is shown in 3D. Show legend If the chart's elements should be listed in a legend. Chart type The chart type to use. Available types:? Pie? Exploded pie? Donut? Column? Horizontal column? Line? Area? Cone? Pyramid Figure 4 - Editing a Chart Widget Report Widget Properties 22

27 Configuring the Dashboard Title The widget's title. Application to view report in The application to use to view the report.? Report Portal? Report Viewer Template The report template to use. Display mode Specifies how the report is displayed. Possible display modes:? Open - Shows the report as it is.? Browse - Shows the report with an interface for zooming and saving. Report format Specifies the format to display the report in. Possible formats:? HTML - one page? Jpg? Gif? Bmp Additional URL parameters Sets any additional URL parameters (for example: pname1=cid&pvalue1=1001). Height The Widget's height. Scrolling Specifies how the widget should handle reports which are too large to display inside its borders. Available scrolling options:? On? Off? Automatic Scramble URL If the URL's querystring parameters should be scrambled. 23

28 User guide - Dashboard Figure 5 - Editing a Report Widget Archived Report Widget Properties Title The Widget's title. Application to view report in The application to use to view the report.? Report Portal? Report Viewer 24

29 Configuring the Dashboard Archive ID ID of the archived report to use. Display mode Specifies how the report is displayed. Possible display modes:? Open - Shows the report as it is.? Browse - Shows the report with an interface for zooming and saving. Report format Specifies the format to display the report in. Possible formats:? HTML - one page? Jpg? Gif? Bmp Additional URL parameters Sets any additional URL parameters (for example: pname1=cid&pvalue1=1001). Height The Widget's height. Scrolling Specifies how the widget should handle reports which are too large to display inside its borders. Available scrolling options:? On? Off? Automatic Scramble URL If the URL's querystring parameters should be scrambled. 25

30 User guide - Dashboard Figure 6 - Editing a Archived Report Widget URL Widget Properties Title The Widget's title. URL The URL of the page to show in the widget. Height The Widget's height. 26

31 Configuring the Dashboard Scrolling Specifies how the widget should handle reports which are too large to display inside its borders. Available scrolling options:? On? Off? Automatic Scramble URL If the URL's querystring parameters should be scrambled. Figure 7 - Editing a URL Widget Dialog Widget Properties Title The Widget's title. Application to view report in The application to use to view the report.? Report Portal 27

32 User guide - Dashboard? Report Viewer Report template The report template to use. Display mode Specifies how the report is displayed. Possible display modes:? Open - Shows the report as it is.? Browse - Shows the report with an interface for zooming and saving. Report format Specifies the format to display the report in. Possible formats:? HTML - one page? Jpg? Gif? Bmp Height The Widget's height. Scrolling Specifies how the widget should handle reports which are too large to display inside its borders. Available scrolling options:? On? Off? Automatic Scramble URL If the URL's querystring parameters should be scrambled. 28

33 Configuring the Dashboard Figure 8 - Editing a Dialog Widget 29

34 User guide - Dashboard Shared mode User with the administrator access right can use the Dashboard as a normal user but he can also change the Dashboard's shared settings. Shared settings are settings that affect all users. For an administrator to change shared settings he has to enter Shared mode. Entering Shared Mode To make changes to the shared settings, the administrator first has to enter Shared mode. Shared mode can be entered by selecting 'Shared mode' from the 'Mode' menu (see image below). Figure 1 - 'Shared mode' on the 'Mode' menu. Shared Mode Only widgets added while in shared mode are shown when in shared mode. This means that any widget a user has added while in user mode are not shown if the user changes to shared mode. Other than that the only visible difference between shared mode and user mode is that the Dashboard's menu bar says 'Shared mode'. Dashboard's behavior is similar in shared mode and in user mode. Widgets can be added, moved and configured as specified in Edit view. The only difference is that the changes made in shared mode are shared by all users instead of only shown in the user's Widget view. How shared settings are combined with user settings Below is a short description of how changes done in shared mode affect a user's Widget view. Adding a widget in shared mode A widget added to a widget zone in shared mode is automatically displayed in that widget zone for all users. Closing a widget in shared mode Widgets closed in shared mode are removed from all users widget view. This applies to all users except those that at an earlier time explicitly added the widget from the Closed widget area in Edit view. A user's widget settings are retained if the widget 30

35 Configuring the Dashboard is closed in shared mode and it can fully restored by re-adding it from the Closed widget area in Edit view. Deleting a widget in shared mode A widget deleted in shared mode is removed for all users. Changing a widget's settings in shared mode Changes done to a widget while in shared mode is reflected to all users as long as they have not made any changes to the settings changed. A user will for example keep the changes he has made to a widget's title, even if an administrator changes the widget's title while in shared mode. 31

36 User guide - Dashboard Custom made widgets In addition to the predefined widgets, the Dashboard also support custom made widgets. These widgets can be tailored to support you organization's needs and can easily be included and used in the Dashboard. A framework has been provided to simplify the creation of this kind of widgets. The framework is located on the product installation CD. 32

37 Index A About Dashboard... 2 Adding Widgets Layout View Shared Mode Adding Widgets Archived Report Widget Editing Archived Report Widget... 9 C Chart Widget Editing Chart Widget... 9 Clear cache... 3 Closing Layout View Shared Mode Closing Custom Made Widgets Customer Relationship Management... 2 D Deleting Layout View Shared Mode Deleting Dialog Chart Widget Editing Dialog Chart Widget...9 Dialog Info Popup...9 Dialog Widget Editing Dialog Widget...9 E Edit Layout Edit View Entering Edit View Edit Widgets Editing Archived Report Widget Dialog Chart Widget Dialog Widget Report Widget Standard Widgets URL Widget Widget Editing Entering Edit View Layout View

38 User guide - Dashboard Shared Mode Entering G Gantt Diagram... 9 L Layout View Entering Layout View Logging on... 3 M MH Dashboard's menus MH Report... 9 MH System Report... 9 Mode N Normal View... 7 P Preferences R Remove Widget Remove Report Portal Report Viewer Report Widget Editing Report Widget...9 S Shared Mode Entering Shared Mode Shared Widgets Sign Out Standard Widgets U URL Widget Editing URL Widget...9 User Mode User types MH Dashboard's user types User Widgets W Widget Zone Edit View Layout View Shared Mode Widget Zone Widgets Add in Layout View Add in Shared Mode Close in Layout View

39 Index Close in Shared Mode Delete in Layout View Delete in Shared Mode Editing Widgets... 2, 9 Widgets Widgets Widgets Widgets Widget's menu Widgets