Sentinel Web Dashboard...Tips and tricks 20 JAWS shortcuts 20 Troubleshooting 21 2 Sentinel Web...

U S E R G U I D E

Sentinel Web DashboardVersion 4.2.0

26 March 2020

Copyright © 2019 Axway. All rights reserved.

This documentation describes the following Axway software:

Axway Sentinel Web Dashboard4.2.0

No part of this publication may be reproduced, transmitted, stored in a retrieval system, or translated into any human or computer language, in any form or by any means, electronic, mechanical, magnetic, optical, chemical, manual, or otherwise, without the prior written permission of the copyright owner, Axway.

This document, provided for informational purposes only, may be subject to significant modification. The descriptions and information in this document may not necessarily accurately represent or reflect the current or planned functions of this product. Axway may change this publication, the product described herein, or both. These changes will be incorporated in new versions of this document. Axway does not warrant that this document is error free.

Axway recognizes the rights of the holders of all trademarks used in its publications.

The documentation may provide hyperlinks to third-party web sites or access to third-party content. Links and access to these sites are provided for your convenience only. Axway does not control, endorse or guarantee content found in such sites. Axway is not responsible for any content, associated links, resources or services associated with a third-party site.

Axway shall not be liable for any loss or damage of any sort associated with your use of third-party content.

Contents

Preface 7Who should read this guide 7How to use this guide 7Support services 7Training services 8

Sentinel accessibility 9Sentinel accessibility strategy 9Accessibility categories 9Accessibility prerequisites 10Screen reader support 10

Documentation accessibility 10Screen reader support 10Support for high contrast and accessible use of colors 10

1 Web Dashboard accessibility user scenarios 11Log in and out from the application 11Browse reports and dashboards 12Access table reports 13Refresh reports 13Filter report data 13Drill down into reports and searches 15Execute commands on search results 16Access error notifications 17Access last seen documents 18Customize reports 18Access the Web Dashboard Help (User Guide) 19Tips and tricks 20JAWS shortcuts 20Troubleshooting 21

2 Sentinel Web Dashboard concepts 22Worlds 22Data dictionaries 22Types of data dictionaries 22

Reports 24Web Dashboards 24

AxwaySentinelWeb Dashboard 4.2.0 | List all user docs User Guide 3

https://docs.axway.com/search?labelkey=prod-sentinel-420&labelkey=ct-category

3 Getting started with Web Dashboards 26Getting Oriented with the Web Dashboard UI 26Web Dashboard main menu folders 27

Design a Web Dashboard 28

4 Web Dashboard basic setup 29Create a world 29Build a data dictionary 33Create a standard data dictionary 35Create an SQL query data structure 41Create a multi-dictionary data structure 44

Set up reports 45Getting started with a dashboard report 45Add fields to a report 47Design your report. 48Calculated field 49Accessibility design recommendations for reports and dashboards 50Specify report design options 51Apply dashboard report table filters 76Import and export objects 80Flow monitoring with searches 85

Visualize reports 86Accessing reports using an URL 89Time Axis Charts 90

Create a Web Dashboard 90Add dashboard filters 93Add templates and blocks 94

Visualize dashboards 96Global actions 96Block-specific actions 98Accessing dashboards using an URL 98

Customize your Web Dashboard appearance 99Customize the log-in page 99Customize the dashboard 100Customize the About 100

5 Web Dashboard advanced set up 102User access managment 102Axway PassPort 102Sentinel Administration 104Custom User Exit 105Upgrade to Sentinel 4.2.0 105Working with entities 106Workspaces and user access 108



Create a workspace 108Assign entities and workspaces using Sentinel Administration or custom user exit 110Assign entities and workspaces using PassPort 110

Server-side resources and folders 112Create folders 112Access files from and upload files to folders 113

In-memory database 114Create an H2 in-memory database 114Create a persistent H2 database 116Create a data dictionary 117Populate an H2 in-memory database 118Execute the task 120

Snapshot mode for reports and dashboards 120Monitor reports and send notifications (controls) 121Create a control 122Execute controls 125Create a control group 127Use the control panel 127

Tasks 128Create a task group 128Create a task 129About the Task Manager 132Datamart task 133Script task 137Export settings task 138Generate XSL-FO document task 139Generate image task 143Generate document task 145Export document task 146

Dynamic links 146Create a dynamic link 146

Personalized fields 148Use case for personalized fields 149Create Personalized fields 149Add context field to a Data dictionary 150

Maps 152Create a map 152Deploy the map 153Create a mapping file containing area labels 153Register the map in definition.xml 153

Calculated fields 155Define a calculated field 156Examples of calculated fields 157

Forms 162



Create a form 162Visualize Forms 165

System values 165Date extraction 166Relative date 168User session 169

Formatted text messages 170Create formatted text messages 170HTML tags for text messages 170

Commands 172Define Sentinel commands for Web Dashboard 173Deploy Sentinel commands for Web Dashboard 175

Search 177Field groups 178Create field groups 178

Driver management 179Metrics and strategic maps 180About Perspectives 181About Strategic objectives 182About Metrics 183Metric Panel 187Strategic map 188

Visualize requests and graphic objects from Sentinel Monitoring 188Access requests and graphic objects from Sentinel Monitoring 189Define Sentinel Monitoring URLs 189

External component 192Create an external component 192Examples of external components 194

Import Excel files 198Internationalize Web Dashboard 201Make languages available 201Provide internationalization values 202Select a user language 203Best practice for language management 203

Languages in Web Dashboard 204Add a new language 204

Data formats used in Web Dashboard 205Specify a data format 205Valid data formats 206

Publicly accessible Web Dashboard objects 212Integrate dashboard into third-party software 212Examples 215

6 Web Dashboard logs and troubleshooting 219



Preface

This user guide describes the functionality and configuration of the Sentinel Web Dashboard.

Who should read this guideThis guide is intended for enterprise architects, other enterprise personnel, and Axway Professional Services personnel who are responsible for the set up and configuration of the Sentinel Web Dashboard. Other technical or business users may find parts of this guide useful as well.

Familiarity with Axway Sentinel products is recommended.

How to use this guideThe information in this guide is designed to be used in conjunction with, but does not replace, the product documentation. Before you begin, review this guide thoroughly.

The following is a brief description of the contents of each chapter:

Accessibility – Describes the accessibility features of the Sentinel Web Dashboard.

Web Dashboard concepts – Provides a high level description of the key concepts and features that comprise Sentinel Web Dashboard.

Getting Started– Describes the basic concepts of how to get started with your first Web Dashboard.

Web Dashboard basic setup – Describes the basic set up tasks and steps required to complete before you can use Sentinel Web Dashboard to monitor your system.

Web Dashboard advanced setup – Describes the advanced set up options you can use to enhance your experience with Sentinel Web Dashboard.

Web Dashboard troubleshooting – Describes how to troubleshoot the Web Dashboard application.

Support servicesSupport services are available:

l Documentation at https://docs.axway.com

l Product downloads, service packs and patches at support.axway.com


https://docs.axway.com/

https://support.axway.com/


Preface

The Axway Global Support team provides worldwide 24 x 7 support, subject to validation of your license agreement. Email [email protected].

Training servicesAxway offers training across the globe, including on-site instructor-led classes and self-paced online learning. For details, go to:

http://www.axway.com/support-services/training


mailto:[email protected]

http://www.axway.com/support-services/training


Sentinel accessibility

Axway strives to create accessible products and documentation for users. The following describes the accessibility features of Sentinel Web Dashboard and its documentation. Accessibility in Sentinel is understood as the design of Sentinel and its services for people with disabilities and is standardized by United States government Section 508 requirements and by the Web Content Accessibility Guidelines (WCAG) Version 2.0.

Sentinel accessibility strategyFor Sentinel, a pragmatic accessibility approach is used, with immediate benefit for users with disabilities. The strategy identifies and focuses on the following:

l Correct personas

l Key use cases

Sentinel personas can fall within three categories:

l Administrators: users who install, operate, configure and maintain Sentinel.

l Developers: users who provide content, for example who create reports and dashboards.

l End Users: users who work with reports and dashboards created by developers.

Users matching the End User persona outnumber other users in Sentinel; therefore, they are the main target of accessibility in Sentinel. The only strategic application destined for End Users is Sentinel Web Dashboard.

Accessibility categoriesSentinel accessibility focuses on the following accessibility categories:

l Visual perception (browser zoom, Windows Magnifier, High Contrast themes)

l Keyboard-only usage

l Screen reader

In our effort to be as accessible as possible, we assure that users with disabilities can successfully perform their day-to-day activities.



Sentinel accessibility

Accessibility prerequisitesFor maximum use of Sentinel accessibility, we recommend using Internet Explorer 11 and JAWS screen reader (version 15).

Screen reader supportSentinel Web Dashboard supports JAWS (Job Access With Speech), a computer screen reader program for Microsoft Windows that enables blind and visually impaired users to read the screen with a text-to-speech output or by a refreshable Braille display. However, you must configure your screen reader before using JAWS.

You interact with JAWS using keyboard shortcuts. Typically, you press the JAWS key in combination with other keys. By default, the JAWS key is the Insert key.

To use the arrow keys and keyboard shortcuts with Sentinel Web Dashboard, turn off the virtual PC cursor by pressing the JAWS key+Z.

Documentation accessibilityThe product documentation provides the following accessibility features:

l Screen reader support

l Support for high contrast and accessible use of colors

Screen reader support l Alternative text is provided for images whenever necessary.

l The PDF documents are tagged to provide a logical reading order.

Support for high contrast and accessible use of colors l The documentation can be used in high-contrast mode.

l There is sufficient contrast between the text and the background color.



1 Web Dashboard accessibility user scenarios

The following user scenarios are used for Sentinel Web Dashboard accessibility:

l Log in and out from the application on page 11

l Browse reports and dashboards on page 12

l Access table reports on page 13

l Refresh reports on page 13

l Filter report data on page 13

l Drill down into reports and searches on page 15

l Execute commands on search results on page 16

l Access error notifications on page 17

l Access last seen documents on page 18

l Customize reports on page 18

l Access the Web Dashboard Help (User Guide) on page 19

Log in and out from the applicationYou can log in or log out of the application with the keyboard or you can use the keyboard and JAWS screen reader.

To log in or log out with the keyboard:

1. When the login page is displayed, use TAB or SHIFT+TAB to access the User ID field.

2. Enter your Sentinel user identifier.

3. Press the TAB key to access the Password field.

4. Enter you Sentinel password.

5. Press TAB key to access the Domain combo box

6. Use ARROWS to navigate on the domains list and select your domain

7. Press TAB to focus the Log In button.

8. Press ENTER or SPACE to log in.

9. Press TAB until the focus is set to the toolbar containing the logout button. Navigate with the left/right arrow keys to the logout button.

10. Press SPACE or ENTER to trigger the logout process.




Note Steps 5 and 6 are only applicable if you use PassPort for access management.

To log in with the keyboard and JAWS screen reader:

l When the Sentinel Web Dashboard login page is displayed, press JAWS+F5 to browse through the form elements and edit the different input fields.

l Alternatively, use the up and down arrow keys to navigate through the different UI items and to fill in the required fields.

To log out with the keyboard and JAWS screen reader:

l Use the JAWS+F3 (Buttons list) to locate the logout button and press SPACE or ENTER to log out.

l Alternatively, use the up/down arrow keys to navigate through the different UI items until you locate the logout button. Press SPACE or ENTER to log out.

Browse reports and dashboardsYou can browse reports and dashboards with the keyboard only or with the keyboard and JAWS.

To navigate reports and dashboards with the keyboard only:

1. Use TAB or SHIFT+TAB to focus on the Main toolbar and use the left and right ARROW keys to move between buttons.

2. Highlight the Menu button and press SPACE or ENTER to open the Menu dialog.

3. Inside the Menu dialog use TAB or SHIFT+TAB to focus the navigation pane.

4. Use the up and down ARROWS to select a folder, and left and right arrows to enter or exit folders.

5. Use up and down ARROW keys to focus a report and press SPACE to display the report.

To browse reports and dashboards with the keyboard and JAWS:

1. Use the up and down ARROW keys to access the Menu button in the main toolbar. Alternatively use JAWS+F5. Press the Menu button to display the Menu dialog that allows to browse reports.

2. Use the up and down ARROW keys to access the navigation region with a list of items. The first level of items are grouping folders.

3. Use SPACE or ENTER to select a folder, followed by L to enter the selected folder. Use SHIFT+L to go back to the previous list of folders.

4. Use the up and down ARROW keys to navigate list items.

5. If one of your folder contains reports, these will be accessible as links. You can navigate link lists with the up and down ARROW keys and you can display the report at the current virtual cursor by pressing ENTER or SPACE. Note: When displaying a report, the Menu dialog will be automatically closed. To browse your reports, open the Menu dialog again.




Access table reportsYou can access table reports with the keyboard only or with the keyboard and JAWS.

To access table reports with the keyboard only:

l To navigate between report or search pages, use TAB and SHIFT+TAB to focus the pagination widget at the bottom of the report.

l To navigate between the pages, use the left and right ARROW keys

To access table reports with the keyboard and JAWS:

l To identify the table that is displayed, when the report is displayed, press T.

l To navigate between the available headings, press H and SHIFT+H or use JAWS+F6 of the application. There are headings that help you jump quickly to menus, toolbars or to the report table area.

l To switch pages, use the up and down ARROW keys to locate the pagination toolbar. Each button in the toolbar corresponds to a page in the report. Use the up and down ARROW keys to navigate between the different page buttons. Press SPACE or ENTER to access the corresponding report page. Alternatively use JAWS+F5 to list and access the pagination buttons.

Refresh reportsYou can refresh report data with the keyboard only or with the keyboard and JAWS.

To refresh reports with the keyboard only:

1. When a report is displayed, use TAB and SHIFT+TAB to locate the report toolbar.

2. Use the left and right ARROW keys to navigate between the available buttons in the toolbar.

3. Once the focus on the Refresh button, press SPACE or ENTER to refresh your report.

To refresh reports with the keyboard and JAWS:

l When a report is displayed, use the up and down ARROW keys to locate the Refresh button in the report toolbar.

l Alternatively use JAWS+F3 to list the virtual HTML features, where you can locate the Buttons list, and within the Refresh button. Press SPACE or ENTER to launch the refresh.

Note Depending upon the underlying data and data connection, the refresh of data may take a considerable amount time.

Filter report dataYou can filter data with the keyboard only or with the keyboard and JAWS.

To filter report data with the keyboard only:





2. Use the left and right ARROW keys to navigate through the buttons of the toolbar.

3. Once the focus on the Filter document button, press SPACE or ENTER to display the filter dialog.

4. In the filter dialog, use TAB and SHIFT+TAB to navigate between the different form elements.

5. Use SPACE to select, deselect check-boxes, and the up and down ARROW keys to navigate lists. In multiple selection lists use SHIFT+ up or down ARROW keys to make multiple selections.

6. Once the form is complete, navigate to the OK button by using TAB or SHIFT+TAB and press SPACE or ENTER to filter your report.

7. To close the filter dialog and discard values entered in the form, navigate to the close button using TAB and SHIFT+TAB and press SPACE or ENTER. Alternatively use ESC to close the dialog.

To filter report data with the keyboard and JAWS:

1. When the report is displayed, use the up and down ARROW keys to locate the Filter document button in the report toolbar. Alternatively use JAWS+F3 to list the virtual HTML features, where you can locate the Buttons list, and within the Filter document button. Press SPACE or ENTER to display the filter dialog.

2. Navigate with the up and down ARROW keys in the dialog. Alternatively use JAWS+F5 to read, navigate and fill in the dialog. The structure of the dialog is as follows:

l Dialog title (Filters)

l Report name

l List of items; each list item represents a parameter you can filter your data by. Whenever accessing the list of items, JAWS will announce the number of elements in the list. This coincides with the number of parameters the report can be filtered by.

Note List items consist of a check-box controlling if the respective filter parameter is enabled or disabled, a label describing the filter parameter and an input field to enter or select values. When the check-box is selected, the filter parameter is enabled, when the check-box is not selected, the filter parameter is disabled. By default, if you fill in or select a value for a parameter, it triggers the enabling of the parameter without the need of selecting the associated check-box manually.

l OK button

3. Locate the OK button by using the up and down ARROW keys of by JAWS+F5 and press SPACE or ENTER to apply you filter settings.

4. To discard your changes and close the filter dialog, locate the close button by using the up and down ARROW keys, or by JAWS+F5.

Tips

l For correct date and time input you have to respect the right format. As such, when the filter dialog is first displayed and JAWS reads all the content of the dialog it will also read the necessary patterns to be used. However, for an enhanced usability, rely on the JAWS virtual form




by pressing JAWS+F5 to fill in these fields.

l To select values from unique or multiple selection lists, press SPACE to activate a list. In multiple selection lists use SHIFT+up/down ARROW keys to make multiple selections. Press ENTER when you have finalized your selection, to be able to navigate in the rest of the form.

Drill down into reports and searchesYou can drill down into reports and searches using the keyboard only or using the keyboard and JAWS.

To drill down into reports with the keyboard only:

1. When a report is displayed that contains dynamic links, use the TAB and SHIFT+TAB keys to access the links.

2. When a link is focused, press SPACE or ENTER to activate the link. A pop-up dialog is displayed.

3. Use TAB and SHIFT+TAB to navigate inside the pop-up dialog and to focus the close button, or the area containing the list of links. Focus the right dynamic link with the up and down ARROW keys (even if there is only one link in the list). Press SPACE or ENTER to activate the links.

4. Close the dialog either with the close button or press ESC.

Note Dynamic links can be located in a table, by identifying underlined text. When navigating with the keyboard, only dynamic links can be focused inside the table.

To drill down into reports with the keyboard and JAWS:

1. When a report is displayed that contains dynamic links, identify the links by navigating the table using the up and down ARROW keys. Dynamic links are read by the screen reader as ”link” followed by the displayed cell content. Alternatively, identify the links in the page by using JAWS+F3 and selecting the Link list.

2. Press SPACE or ENTER to access a dynamic link. Once accessed, a pop-up dialog called Detail will be opened. Navigate the dialog with the up and down ARROW keys. The structure of the pop-up window is as follows:•Window title and close button

l Description on several lines of the table cell that hosted the dynamic link

l Menu elements, each triggering the display of the target report.

3. To trigger a menu element, press SPACE or ENTER. The target report will be displayed.

4. Close the dialog

Notes

l Dynamic links may be configured so when executing them they won't trigger the opening of a pop-up dialog, but will directly display the target report instead.

l Dynamic links are not HTML links, so not all JAWS features applicable to HTML links can be applied to dynamic links (see for example listing of visited links).




Design recommendation: For designing accessible drill-down in reports, it is recommended to activate the Direct dynamic link option in System Preferences. This will have the effect of displaying the pop-up dialog mentioned in the scenario, only if there is more than one dynamic link configured for the same cell.

Export reports to PDF or Excel

You can export report to PDF or Excel with the keyboard only or with the keyboard and JAWS.

To export reports with the keyboard only:



3. Once the focus is on the PDF export button or Export to Excel button, press SPACE or ENTER to launch the export.

4. When the export finishes, a browser pop-up will prompt you for action. Focus the dialog with ALT+N and navigate between the different buttons (Open, Save, Cancel) with TAB or SHIFT+TAB.

5. Press SPACE or ENTER when the focus is on the desired button.

To export reports with the keyboard and JAWS:

1. When a report is displayed, use the up and down ARROW keys to locate the PDF export button or the Export to Excel button in the report toolbar. Alternatively use JAWS+F3 to list the virtual HTML features, where you can locate the Buttons list, and within the Filter document button. Press SPACE or ENTER to launch the export process.

2. When the export finishes, you are prompted by the browser to either open the resulting document, to save it or to discard it. Press ALT+N to focus on the message dialog from the browser. Use TAB or SHIFT+TAB to navigate through the different buttons (Open button, Save button, Cancel button). Use SPACE or ENTER to activate the desired button, or follow the screen reader's indications.

3. Press ESC to close the browser's message dialog.

Execute commands on search resultsYou can execute command on search results with the keyboard only or with the keyboard and JAWS.

To execute commands on search results with the keyboard only:

1. When a search is displayed, use TAB and SHIFT+TAB to focus on the check-boxes inside the table, situated at the beginning of each row.

2. Use SPACE to select or deselect check-boxes. By selecting a check-box you mark the corresponding row to be taken into account for command execution.

3. When all the desired rows are marked properly, use TAB and SHIFT+TAB to locate the report toolbar.





5. Once the focus is on the Command execution button, press SPACE or ENTER to display the list of available commands.

6. Use TAB to focus the drop-down menu followed by the up and down ARROW keys to navigate between the different available commands. Press ENTER to execute a command.

7. Use TAB and SHIFT+TAB to focus on the command dialog and to access any of its buttons. Press SPACE or ENTER to press a focus button.

To execute commands on search results with the keyboard and JAWS:

1. When the result of a search is displayed, use the up and down ARROW keys to navigate through the table and to locate the check-box at the beginning of each line. Alternatively use the JAWS Virtual form fields dialog via JAWS+F5.

2. Press SPACE or ENTER to select or deselect check-boxes.

3. Once the desired rows are marked for command execution by selecting the associated check-box, use the up and down ARROW keys to locate the Perform action button in the report tool bar. Alternatively use JAWS Virtual form fields dialog via JAWS+F5.

4. Press SPACE or ENTER to activate the list of available commands.

5. Use the up and down ARROW keys to navigate through the menu items listed in the Perform action sub-menu. To trigger a menu item (command), press SPACE or ENTER.

6. Once a command is triggered, the result execution message is read by the screen-reader. Use the up and down ARROW keys, to navigate in the dialog.

Access error notificationsYou can access error notification with the keyboard only or with the keyboard and JAWS.

To access error notifications with the keyboard only:

1. When an error or another type of notification occurs, a warning icon is displayed in the report toolbar. Use TAB and SHIFT+TAB to locate the report toolbar.

2. Use the left and right ARROW keys to navigate through the buttons of the toolbar to locate the Messages button.

3. Press SPACE or ENTER to display the message dialog with the latest notifications.

4. Use TAB and SHIFT+TAB to focus the message dialog.

5. Focus the Close dialog with TAB and SHIFT+TAB and press SPACE or ENTER to close the dialog Alternatively press ESC to close the message dialog.

To access error notifications with the keyboard and with the screen reader:

1. When an error or another type of notification occurs in the system, the user is automatically alerted.

2. The user can also open the message dialog using down or up ARROWS to locate the Message button from the right area menu and then press SPACE or ENTER. Alternatively use the JAWS Virtual form fields dialog via JAWS+F5.




Access last seen documentsYou can access last seen documents with the keyboard only or with the keyboard and JAWS.

To access the last seen documents with the keyboard only:

1. Use TAB and SHIFT+TAB to access the left menu area containing the user name. Once focused the menu area, use left and right ARROWS to focus on the user menu.

2. When focused on the user name, press SPACE or ENTER to display the drop-down menu. Use the up and down ARROW keys to navigate between the different menu items.

3. When the focus is on the Last seen documents option, use the right ARROW key to display the list of last seen documents.

4. Use the up and down ARROW keys to navigate the list of last seen documents. Press SPACE or ENTER to display a report.

5. Press ESC whenever you want to close the drop-down menu.

To access last seen documents with the keyboard and JAWS:

1. Use the up and down ARROW keys to locate the user menu in the left menu area. Alternatively use the JAWS Virtual form fields dialog (JAWS+F5) and select Left menu area. Use up and down ARROW to locate the user menu.

2. Press SPACE or ENTER to expand the user menu.

3. Navigate with the down ARROW key to the Last seen docs sub-menu. Use the right ARROW key.

4. Use the up and down ARROW keys to navigate the list of last seen documents. Press SPACE or ENTER to display a report from the list.

Customize reportsYou can customize reports with the keyboard only with the keyboard and JAWS.

To customize reports using the keyboard only:



3. Once the focus is on the Customize button, press SPACE or ENTER to display the filter dialog.

4. In the Customize dialog, use TAB and SHIFT+TAB to navigate through the different elements.

5. When the focus is on the tabs panel, use the left and right ARROW keys to switch between the tabs.




6. When completing the different fields in the customization dialog:•Use up and down ARROW keys to select values in combo-boxes.

l Use SPACE to select or deselect check-boxes

l Use SPACE to trigger buttons (see for example, the add or delete sort buttons in the Sort tab)

l Use left, right, up and down ARROW keys to navigate between the different chart type in the Chart picker (see the Charts tab)

7. Use ESC to close the customization dialog or the chart picker or locate the close button of the dialog and press SPACE or ENTER.

8. If you are displaying a customized report, in the toolbar the Delete customization button will be available. Use this button to delete the customization and reset the report to its default state.

To customize reports using the keyboard and JAWS:

1. When a report is displayed, use the up and down ARROW keys to locate the Customize button in the report toolbar. Alternatively use JAWS+F3 to list the virtual HTML features, where you can locate the Buttons list, and within, the Customize button. Press SPACE or ENTER to open the customization dialog.

2. Navigate in the customization window with the up and down ARROW keys. Alternatively you can use JAWS+F5 (virtual form fields) to navigate and access the different page elements. The structure of the customization window is the following:•Window title

l Label with the report name

l Tab panel, containing the following tabs: Design, Sort, Filters. Note that as there is a reduced number of chart types that are recommended in case of accessibility, the Charts tab is not available for the screen reader.

3. If you want to work in a tab, press ENTER when your virtual focus is on the desired tab.

4. Use up and down arrows to go through the different input fields.

5. To apply your customizations, locate the OK button by using the up and down ARROW keys or JAWS+F5 and press SPACE or ENTER.

6. To discard you current customization settings, locate the Close button by using the up and down ARROW keys or JAWS+F5 and press SPACE or ENTER. Alternatively you can press ESC.

7. If you are displaying a customized report, in the toolbar the Delete customization button will be available. Use this button to delete the customization and reset the report to it's default state.

Recommendation As the Customize chart button in the toolbar opens the customization dialog focused on the Chart tab, it does not make sense to use it in case an accessibility-compliant report.

Access the Web Dashboard Help (User Guide)You can access the Web Dashboard Help (User Guide) with the keyboard only or with the keyboard and JAWS.

To access Web Dashboard help with the keyboard only:




1. Use TAB and SHIFT+TAB to navigate to the Help menu in the application header and press ENTER to display the drop-down menu.

2. Use the up and down ARROW keys to navigate between the different menu option.

3. Press SPACE or ENTER to activate the Help menu option.

4. To close the drop-down menu, press ESC.

To access Web Dashboard help with the keyboard and JAWS:

1. Use the up and down ARROW keys to locate the Help menu in the application header area. Alternatively use the JAWS Virtual form fields dialog (JAWS+F5).

2. Once the virtual cursor is focused on the Help menu option, press SPACE or ENTER to open the user guide.

3. Press SPACE or ENTER to display the menu dialog. Use the up and down ARROW keys to navigate between the different menu option.

Tips and tricks

JAWS shortcutsKeyboard shortcut Description

X or SHIFT+X Move from one check-box to another in the current form. This is especially useful when you select rows in search results for command execution.

JAWS+NUM PAD PLUS Route PC cursor to JAWS cursor.

JAWS+ESC Refresh the JAWS cursor.

JAWS+CTRL+E Lists text input fields.

JAWS+CTRL+C Lists the combo-boxes displayed on the screen.

JAWS+CTRL+B Lists the buttons displayed on the screen.

ALT+CTRL+UP ARROW Move to the previous cell in a column (for example, move up).

ALT+CTRL+NUMPAD 5 Reads information about the current table cell.

ALT+CTRL+DOWN ARROW

Move to the next cell in a column (for example, move down).




TroubleshootingIf JAWS refuses to execute commands, perform a refresh with the following shortcut:INSERT+ESC, followed by INSERT+NUM PAD PLUS to switch to JAWS cursor.



2 Sentinel Web Dashboard concepts

Sentinel Web Dashboard allows you to build dynamic management dashboards based on the data Sentinel collects.

Sentinel Web Dashboard is comprised four key components:

l Worlds on page 22

l Data dictionaries on page 22

l Reports on page 24

l Web Dashboards on page 24

After you create your Web Dashboards they will provide real time business process visibility and flow analytics.

WorldsA world is a collection of information you use to connect to a database. It consists of:

l A driver

l The URL that points to the database

l Log in credentials

Once defined, it is only necessary to specify a world rather than each piece of database connection information.

Data dictionariesA data dictionary represents a selection of data on which reports, metrics and alerts (and ultimately, Web Dashboards) are based. Typically, a data dictionary represents a subset of a database and includes a reference to a world, which is a collection of the information required to log in to a database.

Types of data dictionariesThere are three different types of data dictionaries:



2 SentinelWeb Dashboard concepts

l Standard data dictionary on page 23

l SQL data dictionary on page 23

l Multi-World data dictionary on page 24

Standard data dictionaryYou can create a standard data dictionary based on the data returned from Sentinel Web Dashboard. A standard data dictionary has what is commonly referred to as a star structure.

When you create a standard data dictionary, Web Dashboard automatically generates SQL code based on this model. Standard mode makes it possible to generate the most appropriate SQL query because the query is generated after the columns have been selected and any filters have been specified.

A standard data dictionary is implemented as a measurements table and related dimension tables. In this example:

l PRODUCTS is the measurements table.

l PRODUCTCATEGORY, SALES, AND GLCATEGORY are the dimension tables.

SQL data dictionaryWhen you create a SQL data dictionary, you enter SQL directly into the data dictionary definition. The SQL you enter is used to extract data from worlds. SQL mode allows you to process DBMS-specific queries or queries that are as complex as you like. You can use the database explorer to help you write your SQL.

The list of possible report-level filters contains only filters defined for the data dictionary.




Note SQL queries entered by the user must be compatible with the Sentinel Web Dashboard database.

Multi-World data dictionaryMultiple data dictionaries can be combined to form a multi-world data dictionary.

This type of data dictionary is defined like a standard dictionary, except the world selection function is disabled. You create the data structure like you would a standard data dictionary without the constraint of the tables belonging to the same world. Instead, data dictionaries only need to belong to the same entity or one of its parents.

Similar to the standard data dictionary, Sentinel Web Dashboard generates SQL code automatically based on the model you create.

ReportsA report is a representation of a set of data (typically, a data dictionary) in any of a variety of forms. The simplest report is a table based on a data dictionary consisting data from a single table. However, it is possible to build complex, graphical reports based on data from multiple tables.

You can run a report in either Interactive mode or Static mode. In Static mode, the database is queried each time the report is displayed, which is useful if you require a real-time view of your data.

Web DashboardsA Web Dashboard is used to display the data you capture. Each dashboard consists of one or more pages called templates. There are several page layouts available for templates and each template can use a different page layout. Each template can contain one or more blocks. There are several different types of blocks available:

l Report

l Text session

l External session

l Control

l Dashboard

l Metric

l Metric dashboard

l Strategy map






3 Getting started with Web Dashboards

Sentinel enables you to design and use dashboards that can be displayed as a web page or on a mobile device. Your dashboards provides users with up-to-date information in a centrally managed, easily accessed, location. For example, users can view file transfers, B2B transactions, web services and APIs in one central location.

Getting Oriented with the Web Dashboard UIWhen you log into the Sentinel Web Dashboard UI, the main menu is displayed:

From this menu you can design and manage your Sentinel Web Dashboard.



3 Getting started withWeb Dashboards

Web Dashboard main menu foldersDepending upon the user, the main menu folders can have different options. The following provides an example of the options you have in each folder:

Main Menu folder Options

Administration l Control group

l Folder

l Menu item

l System preferences

User Management l Entity

l Personalized field

l Workspace

Data Management l Data dictionary

l Excel import

l Field group

l Driver

l World

Dashboard Design l Control panel

l Dashboard

l Dynamic Link

l External component

l Form

l Metric

l Perspective

l Report

l Strategic map

l Strategic objective Text

Look and Feel l Color list

l Page

l Page Layout

l Stroke and dot type

l Style Theme



3 Getting started withWeb Dashboards

Main Menu folder Options

My Documents l Activity Reports

l Product log

l Latest notifications

l All notifications

l Transfer details

l User Guide

Control l Controls

Strategy Map l Metric

Task l Task

l Task group

l Task manager

Design a Web DashboardTo design a Web Dashboard, you perform the following steps:

Create a world on page 29 A world is the data source that will contain the data you collect using Sentinel. Once your world is defined, you can use it to setup data dictionaries. To get started with your world, from the Main menu, select Data management > World.

Build a data dictionary on page 33Data dictionaries are used to extract data from worlds. The data dictionary represents the data structure where Reports, Metrics, Alerts, and Dashboards are based. To get started with your data dictionary, from the Main menu, select Data management > Data dictionary.

Set up reports on page 45The reports, alerts, and metrics are based on your data dictionaries. To get started with your report, from the Main menu, select Dashboard design > Report.

Create a Web Dashboard on page 90Once you have created reports, you can create Dashboards to display them. To get started with your dashboard, from the Main menu, click Dashboard design > Dashboard.

After you create your dashboard, a user of your Web Dashboard can monitor the system.



4 Web Dashboard basic setup

As a Web Dashboard Designer or Administrator, you can perform the following basic set up tasks for your Web Dashboard. After these tasks are completed, a user of your Web Dashboard can monitor the system:

1. Create a world on page 29

2. Build a data dictionary on page 33

3. Set up reports on page 45

4. Visualize reports on page 86

5. Create a Web Dashboard on page 90

6. Visualize dashboards on page 96

7. Customize your Web Dashboard appearance on page 99

Create a world A Web Dashboard stores database connection information in a world object. Once defined, you can use the world objects to setup data structures called data sets, which are the basis of Reports and Dashboards.

To create a world:

1. On the Main menu, select Data management > World. For example:




2. Click the Add button to create a new world. A new document opens and the Description tab displays.

3. On the Description tab, enter values for the following:

Field Description

Name This value must be unique for your world.

Description Enter additional information about the world's content. This field can be internationalized.

JDBC Driver Select the driver from the drop down that corresponds to the database you want to use. You will not be able to establish a valid database connection until you have a driver that corresponds to your database.In this drop down, driver names are prefixed with a dot (.), which indicates a driver is ready to use, or a question mark (?), which indicates the driver is unavailable.

Note Web Dashboard comes with four prepackaged drivers: H2, MS Excel, MySQL, and ODBC. Other drivers not prepackaged will need to be configured. See Driver management on page 179.




Field Description

JNDI Select the radio button and enter the name of the Java Naming and Directory Interface (JNDI) connection you want to use for your database.

Tip You must choose either JNDI or URL to specify your database connection. You cannot choose both.

URL Select the radio button and enter the URL for your Sentinel Web Dashboard database. For example:

l Oracle™: jdbc:oracle:thin:@<server name>:<port>:<database name>

l SQL Server™ : jdbc:mssqlserver:jtds://<server name>/<database name>

l MySQL: jdbc:mysql://<server name>/<database name>

For in-memory databases, see In-memory database on page 114.This field supports personalized fields. See Personalized fields on page 148.

Tip You must choose either JNDI or URL to specify your database connection. You cannot choose both.

User name If you choose URL, you must enter user name to log in to the database.This field supports personalized fields. See Personalized fields on page 148.

Standard password

The password for the specified database user.This field supports personalized fields. See Personalized fields on page 148.

Contextualized password

The password for the specified database user. This field can be personalized; it is displayed in clear text.

Read only Select if you want your database connection to be read-only. If you plan to exclusively read from the database, select read only. However, if you are setting up an in-memory database, do not select read only. See In-memory database on page 114




Field Description

Limit to Catalog/Schema

Select to restrict access to certain catalogs or schemas in your database. If you do not select this, you can still make this restriction at the data dictionary level. By clicking the Connection test button under the Description tab, your database connection is tested using the specified data. The output information may contain information about available database catalog or schema objects. These fields support personalized fields. See Personalized fields on page 148.

4. (Optional) Select More Details to reveal the following fields:

Field Description

Transaction isolation

Controls concurrent access to the database. Depending on this setting, Web Dashboard will activate transaction-related mechanisms that constrain database data access timing to assure some level of transaction isolation. The higher the isolation level, the greater the performance loss. The highest isolation level is Serializable, and the lowest is Read uncommitted. Not all databases support transaction isolation.

Default settings

Select if you want to disable editing for the Resultset type, Resultset concurrency, and Fetch size fields. Unselect to enable editing.

Resultset type

SQL statements that read data from the database return the data in a resultset. Choose from the following types of resultsets: Forward only, Scroll insensitive and Scroll sensitive. The default value for a result set type is Forward only. See your JDBC documentation for more information.

Resultset concurrency

Choose from the following options: Read only (default) and Updatable.

Fetch size Enter the number of rows to be retrieved in any subsequent trips to the database for a resultset. Most JDBC drivers have a default value of 10.

Override pool configuration

Select to override the current, default connection pool configuration for Web Dashboard.

Use pooled connection

Select to use one single connection between the World object and the database. This option has a negative impact on performance. If selected, you can customize parameters related to the database connection pool.




Field Description

Max active connections

Specify the maximum number of active connections that can be allocated from this pool at the same time. Specify a negative number for no limit.

Max idle connections

Specify the maximum number of connections that can remain idle in the pool without releasing the extra ones being released. Specify a negative number for no limit.

Max wait time in millis

Specify the maximum time (in milliseconds) that the pool should wait (when there are no available connections) for a connection to be returned before throwing an exception. Specify -1 to wait indefinitely.

Min evictable idle time in millis

Specify the minimum time (in milliseconds) an object may sit idle in the pool before it is eligible for eviction by the idle object evictor (if any).

Min idle connections

Specify the minimum number of connections that can remain idle in the pool, without extra ones being created. Specify zero to create none.

Time between eviction runs in millis

The time (in milliseconds) to sleep between runs of the idle object evictor thread. Specify a negative value if you do not want the idle object evictor thread run.

Validation query

Enter the SQL query used to validate connections from this pool before returning them to the caller. If specified, this query must be an SQL SELECT statement that returns at least one row.

5. On the Properties tab, you can configure database connection properties provided directly by the JDBC driver you chose. These are for advanced use. See you JDBC driver documentation for information about configuring these properties.

6. On the Internationalization tab, you can define labels to be displayed in different languages supported by your Web Dashboard installation. In the case of the World object, you can do so with the Description field from the Description tab.

7. Click the Save icon.

Your world is now ready to be used.

Build a data dictionaryWeb Dashboard stores data structures in the object called the data dictionary. The data dictionary represents the data structure where Reports, Metrics, Alerts, and Dashboards are based.




You can build data dictionaries using SQL queries or a wizard. You can also combine multiple data dictionaries into a single data dictionary. The procedure to create a data dictionary is essentially the same whether you are creating a standard (or star schema) data structure, SQL data structure or multi-dictionary.

In general, perform the following steps to create a data dictionary:

1. On the Main menu, select Data management > Data dictionary. A list of existing data dictionaries are displayed.

2. Select the Add button to create a new data dictionary. A new document opens and the Description tab displays.


Field Description

Name Enter a unique identifier for the data dictionary object.

Description Enter a label for your data dictionary. This label provides additional information about the object and is displayed across the GUI. This field can be internationalized.

Type A list of data dictionary types from which you can select.

l Standard — Star schema. You can use a wizard to create this type of data structure. See Standard data dictionary details.

l SQL — SQL-based data structures. See SQL data dictionary.

l Multi-dictionary — Combination of multiple data dictionaries. See Multi-World data dictionary.

World A previously defined database connection used for accessing data.

Entity The entity with which the data dictionary is associated. See User access managment on page 102.

4. Optionally, select More Details to display advanced settings for data dictionary set up.

Field Description

Max lines in memory

Limits the number of lines retrieved from the database. Specify -1 for unlimited lines.

Note Please set this field to a value close to the actual number of records that you intend to monitor. Specifying a very high number or -1 (unlimited) will have a negative impact on the report's loading time. In order to avoid performance issues caused by overlooking this field, starting with Service Pack 7, the default value for a newly created Data Dictionary was set to 10000.




Field Description

Comment Add a comment to the data dictionary.

Available for multi-dictionaries

Specify whether this dictionary can be used to compose a multi-dictionary. This is only available for type standard.

Available for forms

Specify whether this dictionary can be used by forms. This is only available for type standard.

Available for tasks

Specify whether this dictionary can be used in associate with tasks.

Version Version number of the object. The version of the object is automatically incremented each time you modify it. You can also manually set a custom version using the following format: dd.dd.ddd (where d represents a digit.) This version number is used during XML export/import. See Import and export objects on page 80

5. If you select Standard or Multi-dictionary in the Type list, the Data structure tab is made available. If you select SQL in the Type field, the SQL tab is made available.

6. Select the Data structure tab or SQL tab to continue creating your data dictionary. See the following for more information about creating data structures for each type of data dictionary:

l Standard structure — Create a standard data dictionary on page 35

l SQL — Create an SQL query data structure on page 41

l Multi-dictionary — Create a multi-dictionary data structure on page 44

Create a standard data dictionary When you select Standard as your data dictionary type, the Data structure tab is made available. You use the Data structure tab to specify details about your data set, including which tables to use and how they are related.

Getting started with your data dictionary 1. Click the Data structure tab and then click the Wizard button .

The Choose a table window displays.




Depending on the database type associated with the selected World, Sentinel Web Dashboard displays only the Schema drop down list or both the Catalog and Schema drop down lists. Depending on the database and whether the world you specified is restricted to a single catalog and schema, there can be more than one value available in each drop down.

2. Choose a Table type: LOCAL TEMPORARY, TABLE or VIEW. The types of tables available depend on the JDBC driver and the type of database accessed.

3. Choose a table from the drop down and then click OK.

4. Specify the level of Depth of your star model.

5. Choose an option from the Import fields list. You could specify to import All the fields, All but keys or None.

6. Click OK. The data dictionary is created.

When the first table is added to the data structure, the PDF Export button is displayed. Select this button to export a PDF of the graphical representation of the data set you just defined.

Note To internationalize, click the Internationalization tab and enter the necessary information.

Modify Table detailsWhen you click a table header, a pop-up menu becomes available.

Option Description

Modify The description of the table and configure its columns. See Modify the table configuration on page 37.




Option Description

Delete Removes the selected table and any child tables from the data structure (but not from the database)

Wizard Allows you to make modifications to your data structure (for example, modify the Depth parameter)

Add a table Opens the Choose a table pop-up and allows you to add more tables to the star model. When you add a table the Join edit (link to Modify Links between tables) pop-up is displayed. You can manually define a relationship between two tables without the relationship being represented by integrity constraints.

Add context field Allows you to set a filter depending on personalized fields. See Add Context fields on page 38.

Modify the table configuration When you select the Modify option in the pop-up menu the Table edit pop-up is available. The list of fields displayed is provided by the JDBC driver.

Field Description

Catalog All data managed by same execution engine.

Name The name of the table in the database.

Description

A custom name of the table displayed across the GUI. You can set different values for this parameter depending on the user's language via the Internationalization tab.

SQL field Includes or excludes each field from your data structure.

Field name Used to customize the name associated with different table columns. Field names of the same data dictionary must be unique. These names are used by certain objects (for example, reports, dynamic links and tasks) to refer the table columns. It is recommended not to change the name once the column has been referred by another object

Description A custom name of the field name which will be displayed across the GUI. You can set different values for this parameter depending on the user's language using the Internationalization tab.

Field group

Select the field group associated with the table column. See Modify field details on page 39.




You can access advanced settings in the More details section:

Field Description

Updatable Allows updating the table.

Insertable Allows inserting new entry in the table.

Deletable Allows deleting from the table.

Data type The data type of the field.

Size The size in bytes of the data type.

Scale The number of digits to the right of the decimal point in a number.

Nullable Allows the field to be set to the value NULL.

Insertable The field can be inserted in a table.

Updatable The field options can be updated.

Auto-increment

Automatically creates the value of the primary key field every time a new record is inserted.

Add Context fieldsEach row in this screen describes a Contextualization on page 40, which will be reflected at the Report level:

Field Description

Field name The first list contains all the fields in the table.

Operator The second list contains the most frequently used operators (<, <=, =, >= and >).

Personalized Field

This list contains any defined personalized fields.

Add Adds a new contextualization.

Delete Deletes the contextualization.




Modify field detailsLeft-click a field in a table to make a pop-up menu available. The options on this menu allow the modification of a specific column in the table.

Option Description

SQL field The name of the column in the database.

Field name The name of the column to be used on the SQL queries.

Description The name of the field to be displayed in the GUI.

Optionally, click More details to access advanced setting of fields properties:

Option Description

Field group The field group with which the column is associated.

Data type The data type of the filed.



Nullable Allows the file to be set to the value NULL.

Insertable The field can be inserted in a table.

Updateble The field options can be updated.

Auto-increment

Automatically creates the value of the primary key field every time a new record is inserted.

Modify Links between tablesLeft-click a link between two tables to make a pop-up menu available.

l Delete removes the child table from the star model, along with any child tables that it may need to remove.

l Modify opens the Join edit pop-up, which contains the following options:




Option Description

Join name The join name is not mandatory. If it is not specified manually, it will be generated automatically when the dictionary is saved.

Join type The join type can be:

l INNER Join

l LEFT Join

l RIGHT Join

l FULL Join You must then select which field(s) in the two tables allow the join to be made.

Add Select to add a new element to the join.

Delete Select to deletes the element from the join.

Contextualization

Each row describes a contextualization.

1. The Field name list displays the fields in the table affected by the contextualization.

2. The Operator list contains the most frequently-used operators (<, <=, =, >= and >) and allows you to compare table fields to

3. The final list contains any personalized fields that have been defined.

4. Click the Add button to add a new contextualization or click the Delete button to delete the contextualization.




Modify the joinThe join name is not mandatory. If it is not specified manually, it will be generated automatically when the dictionary is saved.

The join type can be:

l INNER Join

l LEFT Join

l RIGHT Join

l FULL Join

You must then select which field(s) in the two tables allow the join to be made.

Click the Add button to add a new element to the join..

Click the Delete button to delete the element from the join.

Create an SQL query data structureWhile you build your data dictionary and you select SQL as your data dictionary type, the SQL query tab is enabled. Use this tab to enter the SQL data structure that describes the data you want to extract from your Sentinel Web Dashboard database to populate your Web Dashboard.

1. Select the SQL query tab.

2. Select the SQL edition button .

3. Enter SQL to select data from your database.

SQL queries you enter must be comprehensible to the selected DBMS.




4. (Optional) Add filters to your SQL.

a. Add SQL to your query to represent the filters. You must use the correct syntax in your SQL. For example:

SELECT CycleId, ObjectId

FROM Sentinel

WHERE CycleId = ?[1]

AND ObjectId = ?[2]

In this example, the ? character is interpreted as a filter. The string ?[1] represents the first filter, ?[2] the second filter, and so on. Each of these filters must be defined (by clicking the button).

b. Select the filters button to define filters for the SQL query. You must define your filters before you can specify the columns or preview the query result. The list of possible report-level filters contains only filters defined for the data dictionary and is shown in this tab. You must enter the following details:

Field Description

Name The filter name must be unique within the data dictionary. This name is used by certain objects (including reports, dynamic links and tasks) to identify the column that must be used. It is never visible to the user. It is recommended that you never change this name once the column has been used by another object.

Description The description displayed for this filter throughout the GUI. This is the internationalized description in the current user's language. This description can be specified for other languages using the Internationalization tab.

Data type The data type, as expected by the database.

Default value

This can be a constant, a personalized field or a system value.

Visible A filter declared as visible can be applied cumulatively at report level (setting the value and visibility in use). A filter that is declared as not visible will be hidden when the report is configured.




Field Description

Filter type You can define different types of filter to suit different purposes:

l value: Specify either Simple value or Unique selection value list filter type at the Report level.

l field and value: Required if you want to use expression filters in the reports based on this query. In this case, you must specify the field to which the filter applies in the following text box. For example, instead of having where year = ? in a query, you would have where ? and set the field parameter to year.

l text value: The filter's value is processed as a string. This is useful when the filter is a parameter of a stored procedure.

Field Specify the field name when you select field and value filter type.

5. (Optional) Select columns. Click the add column button to display the column definition screen.

To access this tab, the SQL query must be valid and any filters must have been specified.

Use these fields to specify the names of the columns returned by the SQL query:

Field Description

SQL field The name of the column in the database.

Name The name of the column to be used in the SQL queries.

Description A user-friendly name for the field. This value is displayed in the GUI.

Type The group of files with which the column is associated.

6. (Optional) Select More details to display additional fields.

Field Description



Nullable Allows the field to be set to the value, NULL.

7. (Optional) Select the Query help button to display a list of fields or values you can add to the query. Choose from the following:




Field Description

Catalog A list of all data managed by the same execution engine.

Schema A list with the namespace within the server.

Table A list of tables available in the selected schema.

Field The list of fields from the selected table.

String A list of scalar functions that perform an operation on a string input value.

Numeric A list of SQL numeric functions used primarily for numeric manipulation and/or mathematical calculations.

Date-Time

A list of date and time functions.

System A list of system functions.

Field A list of personalized fields already defined.

8. (Optional) Select the Preview button to display the first ten lines of the query result.

Create a multi-dictionary data structureMultiple data dictionaries can be combined to form a multi-dictionary data structure. This type of data dictionary is defined similar to a star structure dictionary, except the world selection function is disabled and the metadata comes from the data dictionaries (not the databases).

After you specify the common data dictionary information, select the multi-dictionary data dictionary type and perform the following steps:

1. On the Data structure page, select Multi-dictionary as your data dictionary type. The Data Structure tab is enabled.

2. Select the Wizard button . The Choose a table window displays.

3. Select a specific Table (data dictionary) from drop-down list, then click OK. You will notice that only tables of type standard dictionary are available, you cannot create a multi-dictionary based on SQL dictionary.

4. Specify the level of depth for your star model.

5. Choose an option from the Import fields list. You can specify to import All the fields, All but keys or None. The star structure data dictionary is created when you click OK.

6. Enter values for the basic data dictionary fields. See Build a data dictionary on page 33.

7. Optionally, specify values for the fields under More Details:




Field Description

Max lines in memory

Limits the number of lines retrieved from the database. Specify -1 for unlimited lines.

Note Please set this field to a value close to the actual number of records that you intend to monitor. Specifying a very high number or -1 (unlimited) will have a negative impact on the report's loading time. In order to avoid performance issues caused by overlooking this field, starting with Service Pack 7, the default value for a newly created Data Dictionary was set to 10000.

Comment Add a comment to the data dictionary.

Available for reports

Determines if this dictionary can be used to set up a report.

Available for tasks

Determines if this dictionary can be used to set up a task.

Version Version number of the object.

Set up reportsA dashboard report provides a format for the data supplied by a Data Dictionary. You can generate reports in interactive mode or snapshot mode. Once you create a Report, you can include it in a Dashboard.

To create a report, the following general steps are used:

1. Provide information about the report, including a name and description, as well as a data dictionary.

2. Select fields from the data dictionary you want to include in the report.

3. Choose a design and specify design options.

4. Choose a filter.

Getting started with a dashboard report 1. On the Main menu, select Dashboard design > Report. A list of existing reports displays.

2. Select the Add button to create a new report. A new document opens and the Description tab displays.




On the Description tab, enter values for the following fields:

Field Description

Name A unique identifier for the Report object.

Description A user-friendly label of your Report to be displayed across the GUI. The description can be internationalized (translated into the language defined for each user) using Internationalization tab.

Data dictionary

Select the data dictionary you want to use to retrieve data from the Sentinel Web Dashboard database.

Version Version number of the object. Sentinel Web Dashboard increments this number when the object is saved. Sentinel Web Dashboard increments the correction number when the object is saved. This version number is used during XML export/import.

(Optional) Click More Details for access to advanced report configuration settings.




Field Description

Comment Add a comment to the report. The report users will be able to read this comment.

Rows per page

The number of lines displayed on each page of the report.

Page layout

Layout used for exporting to PDF.

Execution mode

Select the mode to execute the report:

l Interactive: (Default value ) Query the database each time the report is displayed. Use interactive mode when you require a real-time view of the data.

l Snapshot: Allows you to display reports based on a large amount of data in just a few seconds. In snapshot mode, Web Dashboard records a history of the data at set intervals. A typical use case would be to display a Dashboard every morning based on the data loaded during the night. You can use a specific Task to generate the snapshot Dashboard, which is persisted in form of an XML file. When a snapshot Dashboard is displayed, the data is read from the XML.

Entity The container with which the Report is associated.

Automatic filter validation

Allows you to enable automatic refresh of reports and dashboards when you select a value from the filter pop-up. The filter pop-up should be fixed on the right or left side of the screen.This option is enabled if the Display automatic filter validation checkbox check box from Administration > System preferences > Ergonomy is selected.

Show filter first

Use this parameter when there are one or more user prompt filters. In this case, the prompt is shown first when the Report is displayed, enabling the user to set the filter values.

Show comment on display

Displays the comments when the Report is executed.

Add fields to a report 1. Select the Field Selection tab to display a list of the fields you can include in the Report.




2. Select the fields you want to include in the Report. Any fields not selected will not be included in the Report.

3. Field names are truncated if too long, but a tooltip always displays the full names of the fields.

4. (Optional) If there are too many fields on the tab, use the text entry field at the top of the tab to filter the list. The filter is case-insensitive.

5. (Optional) Add a calculated field. See Calculated field on page 49.

Design your report. 1. Click the Design tab.

2. Specify the various design options for your report. See Specify report design options on page 51.




Calculated fieldA calculated field contains a combination of functions, fields, and constants. For example, you can calculate the sum of two fields or divide a field by a constant.

1. Use the add calculated buttons and to add calculated fields.

2. Complete the following fields:

Field Description

Field name A unique identifier for the Field.

Description A user-friendly name for the Field. This value will be displayed in the Report design tab.

Field group

The group with which the calculated field is associated. The default group is Calculated fields.

Add Create a new calculated field.




Field Description

Operand type

Select from the following types of calculated fields:

l Function

l Constant

l Filled

Type Select from a list of data types to be associated with a certain field.

Value Select from a list of possible values for a file. Values listed here depend on the Operand Type selected above.

Edit Modify the configuration of a calculated field by clicking the Edit button.

Delete Removes the selected calculated field.

Copy Left-click a calculated field to display the Copy option. By choosing this option, a copy of the selected calculated field is created. A unique name will be associated with the new field.

Accessibility design recommendations for reports and dashboardsSentinel Web Dashboard does not have out-of-the-box accessibility content for end users; although, Sentinel Web Dashboard provides the option for developers to create accessible content. In this section, we provide recommendations for the Sentinel Web Dashboard developer to create accessible content.

Types of accessible reportsWeb Dashboard allows you to create many types of reports; although, only two of the reports can be used to accommodate full accessibility requirements:

l The table report

l The searches

Note All report types can be converted into table reports.

Information displayed in colorFor accessibility reasons, when you create table reports, do not display information with color only. It is recommended to use text to transmit specific information. The most straightforward way to do this is to use calculated fields. For details, see Calculated fields on page 155




DashboardsDashboards in Sentinel Web Dashboard are reports grouped within the same screen. Dashboards themselves are not fully accessible, and their use is not recommended. However, you can group your reports in an accessible way, by organizing them in specific folders.

Create dedicated contentWhen you design reports and dashboards, it is important to take into consideration the creation of accessible versions of your reports. You can group these reports under specific folders. This makes it easier for your users to identify and use the reports.

Specify report design optionsUse the Design tab to specify visual attributes of your report. You can choose between two different kinds of tables on which to base your report and from many different types of charts to display your report.

The Design tab contains a toolbar and the Graphic design menu.

Select your report design display modeYou use the Design tab toolbar to specify how to display your report on the Design tab. Choose between Design mode and Preview mode. In addition, you can display the SQL used to select data for your report and to display and hide the Graphic design menu. See Specify graphic design attributes on page 52

The toolbar contains the following buttons:

Button Description

Design mode toggle

Toggles Design mode. In Design mode you can add fields, sections, and groups to the report, as well as any other configuration related on the chart.

Preview Shows the report preview.

Display SQL

Shows the SQL query that will be run in order to display the report.

Display the properties

Shows or hides Graphic design menu.




Specify graphic design attributes To specify graphic design elements and attributes, use the Graphic design menu. You can specify the following attributes:

l Chart type - Type of chart and attributes specific to the type you choose.

l Table type - Standard or cross table. Options include switching rows and columns, sorting rows, and ranking rows. Options vary depending on the type of table your choose.

l Style - A pre-defined style.

Select a chart typeAt the top of the Graphic design menu, an icon is displayed to represent the type of chart currently selected for the report. Use the Graphic design menu to select a chart type and specify its attributes.

1. Click the chart icon at the top of the Graphic design menu.

The Chart Properties dialog box is displayed.

By default, the selected chart type is Table, which has no attributes.

2. To select a different chart type, click the chart type icon in the Chart Properties dialog box. See Dashboard chart types on page 58 for information about available chart types.

The Chart Properties dialog box is redisplayed with the new chart type selected, including fields for you to specify values for attributes particular to the new chart type.

The following table provides information about individual chart properties. Note that not all properties will be applicable to all charts.

Field Description

Show legend

Specifies the location of the legend next to the chart: top, bottom, left, right. You may also choose to have no legend.

Number of intermediate values

Specifies the number of ticks on the axis.




Field Description

Extent calculation

Specifies the graduation of data. The possible values are:

l Keep unchanged - (default) Graduations range from the minimum to the maximum value of displayed data at regular intervals.

l Enlarged - Adds a lower and a higher margin to the graduations over the displayed data for better readability. Each margin represents 20% of the displayed data. Other graduations are created at regular intervals as in the default behavior.

l Zero included - Forces the display of zero among graduations, modifying the limits if necessary. This option is used when all data is either positive or negative. In the first case, graduations will go from zero to the max value and, in the second case, from the min value to zero. Other graduations are created at regular intervals as in the default behavior.

l Rounded - Same as the default behavior, but graduation values are rounded to an appropriate level of precision depending on the data.

l Rounded and zero included - Combines the Rounded and Zero included modes, forcing the display of zero among graduations and using rounded values.

l Average/Standard deviation - Graduations are created in order to get close to a fair distribution of data on the intervals. Thus, these intervals may not be even. The calculation is based on a Gaussian distribution of data.

l Integer average/standard deviation - Same as the Average/Standard deviation option above with graduations rounded to integer values.

l Integer values - Same as the default behavior but graduation values are rounded to integers.

l Customized - Uses the "Min ordinate" and "Max ordinate" parameters and creates the other markings at regular intervals.

l Logarithmic scale - Displays the different values using a logarithmic scale, appropriate to large differences in values.




Field Description

Min ordinate Specifies the lower limit of the axis when using the Customized extent calculation.

Max ordinate

Specifies the higher limit of the axis when using the Customized extent calculation.

Extent calculation 2nd axis

Defines the graduation of the second ordinates axis. Possible values are the same as for the Extent calculation.

Min ordinate 2nd axis

Specifies the lower limit of the second axis when using the customized extent calculation.

Max ordinate 2nd axis

Specifies the lower limit of the second axis when using the customized extent calculation.

Color list Colors used by the chart.

Stroke type Defines the stroke type to be displayed in the chart.

2nd stroke type

Defines the stroke type of the second line in the chart.

Display mode

Specify the display mode of certain charts as either line or area type.

Axis units max width

Number of characters displayed for the labels on each axis.

Label max width

Number of characters displayed for the labels inside the chart.

Interactive In interactive mode, the Report displays more details for each section of the chart by mousing over it.

Show values You can show data inside or outside the chart. You can also display no data.

Customize thresholds

Specify the type of threshold and color code. Customize the threshold by specifying the threshold values, which must be in descending order from top to bottom.




Field Description

Use different colors

By default, multiple colors are used and each line defines a different variable. If only one color is used for all the bubbles, the color is the one of the text used for the first line.

Show percentages

You can show percentages inside or outside the chart. You can also display no percentages.

Explode You can detach a certain area of the chart

Orientation [-180..180]

Specify the orientation of the chart in degrees from horizontal.

Diameter / Surface

Specify whether the bubble size ratio is based on the diameter or the surface area of the bubbles.

Number of left lines

Number of lines in the left.

Number of right lines

Number of lines in the right.

Thresholds display mode

Specify whether to show a threshold in your chart. Thresholds are displayed as a colored line or area.

Zoom If checked, areas containing information are magnified and the rest of the map is discarded.

Show Missing

Displays a legend for the regions in a map chart that do not have a corresponding code.

Color for Missing

Specify the color used to highlight the regions in a map chart that do not have a corresponding code.

Map type Specify which map is displayed.

Threshold pattern

Choose the format of the data of the values on the horizontal axis. Specify {0} to allow data to be formatted automatically.




Field Description

Gauge display mode

Choose from the four available display modes:

l Background thresholds: Default.Gauges are filled according to the value to be displayed and thresholds are shown as background colors.

l Outline thresholds: Gauges do not use all the available width, as the outline is used to display thresholds.

l Cursors on various gauges: Values are displayed by cursors and thresholds by background colors.

l Cursors on single gauge: Values are displayed by cursors and thresholds by background colors, but all values are displayed on a single gauge.

Number of bars

Number of bars to be displayed.

Number of lines

Number of lines to be displayed.

Bind axis Use this option to synchronize the scale of both ordinate axes of the graph.

Linear regression lines

Specify whether the graph draws the regression line for each set.

Show milestones

Specify whether to show milestones for each task. Available on Gantt view chart.

Axis starts today

Force the axis to start with the current date. This option is available only for time axes.

Use different colors

By default, multiple colors are used, and each line defines a different variable. If only one color is used for all the bubbles, the color is that of the text used for the first line.

3. Specify values for the attribute fields and click OK.

Select a table typeBelow the chart icon in the Graphic design menu, you select the type of table to display report data. Choose from the following:




l Standard table – a table containing a series of columns (based on data dictionary fields you select) on which you can define sections, breaks, groupings, and calculation. See Standard table design on page 67.

l Cross table – a table containing a number of dimensions and data objects. You can define sections, calculations and rankings for cross tables. See Cross table design on page 73.

Some of the features in this menu are common to standard and cross tables:

Feature Description

Switch cols and rows

With standard tables, this feature displays data in rows rather than columns.With cross tables it swaps the rows and columns. Selecting the menu item a second time restores the normal display.

Add a sort

You can specify a sort order for the data displayed in the report.

l When you click Add a sort, the Sort dialog displays.

l In the dialog, click the Add button to add a line to the field.

l You can delete a line by clicking on Delete button.

l Field : specify the field on which to apply the sort.

l Sort : choose ascending or descending type of sort.

l Click OK to add the sort criteria.Note This option is available only for a standard report.

Add a ranking

You may apply a ranking to the table:

l Values number on top : number of lines that you want to keep from the beginning of the table

l Values number on bottom : number of lines to be kept from the end of the table.

l Display other values : by checking this option you may display the cumulative total of the intermediate lines.

l Other values label : provide a description for the line above.

l Click OK to add a ranking.

l If you want to delete the ranking, you must remove the first and last values and then click OK.

Note This option is available only for a standard report.




Feature Description

Group duplicate values

For reports based on standard dictionaries or multi dictionaries, you have the option to eliminate duplicates from the result set. By default, this option is selected for all types of reports except the search type. To display the results as they are in the database, deselect the option Group duplicate values. If Aggregations are used in reports the Group duplicate values option is automatically disabled as it is not applicable.

Note This option is not available for reports based on SQL type data dictionaries. In this case, to group your results, add a GROUP BY statement in your SQL query.

Hide header

Hide the header of your table. Note This option is available only for a standard report.

Style You can select which style to apply to the table by clicking on it in the menu. All the styles created in the Look and feel > Style session are shown in the menu.

Select a styleThe Graphic design menu provides a list of styles. Each style consists of graphic design elements, such as line thickness and color scheme.

Select the name of a style to apply it to the current chart.

Dashboard chart typesWhen you select the Chart icon on the Chart properties dialog box, the available chart types display as icons in rows organized by chart type. This section provides information about each chart type, including illustrations of each button. The following table provides a quick reference to the Web Dashboard chart and chart types that are available:

Chart Chart types

Column charts l Column Chart

l Column Chart 3D

l Stacked Column chart

l Stacked Column chart 3D

l Bar Chart In Rows

l Stacked Column Chart (%)




Chart Chart types

Gauge charts l Gauge Chart

l Gauge Chart 2

l Horizontal Gauge Chart

l Vertical Gauge Chart

Line and Area charts l Line Chart

l Line Chart 3D

l Line Chart (Time Axis)

l Line Chart 3D (Time Axis)

l Pareto Chart

l Bar Line Chart

l Area Chart (Time Axis)

l Area Chart

l Stacked Area Chart

l Stacked Area Chart (Time Axis)

l Line and Line Chart

l Line and Line Chart (Time Axis)

l Stacked Step Chart (Time Axis)

l Step Chart (Time Axis)

l Stacked Bar Line Chart

Pie and bar charts l Pie Chart

l Pie Chart 3D

l Bar Chart

l Bar Chart 3D

l Pie Chart In Bar

l Horizontal Bar Chart

l Donut chart




Chart Chart types

Other charts l Table

l Radar Chart

l Map Chart

l Age Chart

l Color Table Chart

l Gantt View Chart

l Scatter Plot Chart

l Bubble Plot Chart

l Funnel Chart

l Kiviat

Column charts

Column Chart and Column Chart 3D

These charts show comparisons among categories by vertical bars. It is produced using the input data set as follows:

l The first column contains the specific categories being compared. They are shown along the X-axis.

l The following columns represents discrete values that will be displayed by vertical bars positioned in the corresponding categories.

Stacked Column Chart and Stacked Column Chart 3D

The stacked bar chart stacks bars that represent different groups on top of each other. The height of the resulting bar shows the combined result of the groups. It uses the input data set as follows:

l The first column contains the various categories to be compared. They are shown along the X-axis.

l The values in the following columns, represented by different colors, combine the values of the groups.

Bar Chart In Rows

This three-dimensional chart it is very similar to the stacked column chart, with the difference that the values are displayed in distinct vertical bars. The following input data set is used:




l The first column contains the names of the rows in the chart. These are the different categories to be displayed.

l The values contained in each of the following columns will be represented by vertical bars on the various rows in the chart.

Stacked column chart (%)

This chart illustrates various distributions of values as a series of vertical bars that are the same size, but have different compositions. It uses the input data set as follows:

l The first column contains the various cases for which the values are to be compared. They are shown along the X axis. There is a bar for each row in the data set.

l The values in the following columns are represented by the sections in the vertical bar.

Gauge charts

Gauge chart and Gauge chart 2

Gauge charts use needles to show information as a reading on a dial. This chart type is often used in executive dashboard reports to show key business indicators. Gauge charts are useful for comparing values between a small number of variables either by using multiple needles on the same gauge or by using multiple gauges:

l Only one row is processed.

l The first column establishes the relationship between the various values. Its content (a text label) is shown above the graph.

l The values of the following columns will be represented as needles on the gauge.

Horizontal Gauge Chart and Vertical Gauge Chart

These charts let you compare a number of values shown as horizontal or vertical gauges. They use the input data set as follows:

l The first column contains the gauge labels.

l Each of the following columns contains the values that will be represented in the gauges.




Area and line charts

Bar and Line chart and Stacked Bar Line Chart

These charts track the evolution of a number of values displayed as a series of vertically aligned bars or vertically stacked bars or curves. The input data set is as follows:

l The first column contains the various cases for which the values are to be compared. They are shown along the X-axis.

l The values of the following columns are represented by a vertical bar or a point in a curve, depending on the setup.

Area Chart Line Chart and Line Chart 3D

These charts track the evolution of a number of values displayed as curves. Area charts are like line charts, but the areas below the lines are filled with colors or patterns. The input data set is as follows:

l The first column contains the various cases. They are shown along the X-axis.

l Data in the following columns are represented as different-colored curves.

Area Chart (Time Axis) Line Chart (Time Axis) and Line Chart 3D (Time

Axis)

These charts track the evolution in time of multiple values displayed as curves, using the input data set as follows:

l The first column must contain dates, as it is used for the time axis (along the X-axis),

l Data in the following columns are represented as different-colored curves.

Line and Line Chart

These charts compare a number of variables with two different scales. These variables are displayed as curves using the input data set as follows:

l The first column contains the various cases and are shown along the X-axis.

l Data in the following columns is represented as different-colored curves.




Stacked Area Chart

This chart shows the evolution of the cumulative total of a number of values by stacking up the corresponding number of curves and coloring the included value areas. It uses the input data set as follows:

l The first column contains the various cases for which the values are compared. They are shown along the X-axis.

l The values in the following columns, represented by different colors, are totaled in the bar on the chart that corresponds to the row.

Stacked Area Chart (Time Axis) and Stacked Step Chart (Time Axis)

These charts show the evolution over time of the total of a number of values by stacking the corresponding number of curves and coloring the included value areas. It uses the input data set as follows:

l The first column must contain dates, as it will be used for the time axis (along the X-axis.)

l The values in each of the following columns will generate a separate curve.

Pareto Chart

Pareto charts help you to improve processes by identifying the primary causes of an event. A Pareto chart is a bar chart that ranks categories from the most frequent to the least frequent. These charts are frequently used for quality control data, so that you can identify and reduce the primary cause of problems.Pareto charts include an accumulation line that shows the percentage of the cumulative total of all the columns or bars.

This chart requires a data set that satisfies the following criteria:

l Two columns are required, the second of which must contain numeric values.

l The first column contains the data labels.

l The second column contains the data to be processed.

Pie and Bar Charts

Pie Chart Pie chart 3D and Donut chart

Pie charts are useful for highlighting proportions. They use segments of a circle to show the relationship of parts to the whole, using the input data set as follows:




l The first column provides the labels of the different slices of the pie.

l The chart uses the values of one of the following columns, the second by default.

Bar Chart Bar Chart 3D and Horizontal Bar Chart

Bar charts are useful for showing trends over time and plotting many data series. This charts require a data set with the following criteria:

l Only one row is processed.


l The values in each of the following columns form one of the bars in the chart.

Pie Chart In Bar

This chart illustrates various distributions of values with as many pie charts, whose heights represent their respective totals. It uses the input data set as follows:

l The first column contains the labels of the pie charts' slices.

l Each of the following columns matches a pie. The values are represented by the slices and their total by the pie's height.

Other charts

Table

Displays the data as a standard or cross table.

Age Chart

This chart shows an age pyramid based on the input data set as follows:

l The first column contains the various tiers in the pyramid. They are displayed one above the other in the center of the pyramid.

l The second column contains the values displayed on the left of the pyramid.

l The third column contains the values displayed on the right of the pyramid.




Kiviat

This chart, also known as a spiderweb chart, compares the distribution of a series of variables among multiple axes, each axis having its own range of values. The data set must comply with the following criteria:

l Each row represents a different axis. There must therefore be at least three rows.

l The first column contains the labels for the various axes.

l The second column contains the minimum value of the range of each axis.

l The third column contains the maximum value of the range of each axis.

l Data in the following columns will be represented as different-colored spiderwebs.

Radar chart

Radar charts integrate multiple axes into a single radial figure. For each figure, data is plotted along a separate axis that starts at the center of the chart.

This chart is a specialization of the Kiviat chart as all axes share the same range. It is not necessary to have two columns to define this range. The data set must comply with the following criteria:

l Each row represents a different axis. There must be at least three rows.

l The first column contains the labels for the various axes.

l Data in the following columns will be represented as different-colored spiderwebs.

Bubble plot chart

Bubble charts, like scatter charts, use data points and bubbles to plot measures anywhere along a scale. The size of the bubble represents a third measure. Bubble charts are usually useful for representing financial data.

In addition to its X- and Y-coordinates, the size of a dot can be varied in order to represent a third component. Such dots are referred to as "bubbles." This chart can be created using the input data set as follows:

l Four columns are required, the first three of which must contain numerical values.

l A bubble is generated for each row.

l The first column contains the variable labels.

l The second column contains the X-coordinates of the bubbles.

l The third column contains the Y-coordinates of the bubbles.

l The fourth column contains the sizes of the variables.




Color Table Chart

This chart displays data in table form, with slightly inclined column headings. It is produced using the input data set as follows:

l The first column contains the row labels.

l The second column contains the column labels.

l The third column contains the data.

Gantt View Chart

A Gantt chart is a type of bar chart that illustrates a project schedule. This chart displays a Gantt diagram representing various tasks over time. You can view the details of a particular task by clicking on its bar. This chart requires a data set that satisfies the following criteria:

l Each row defines a task.

l The first column contains the task label.

l The second column must contain a date that defines the start of the task.

l The third column must contain a date that defines the end of the task.

Scatter Plot Chart

Scatter charts use data points to plot two measures anywhere along a scale. Scatter charts are useful for exploring correlations between different sets of data. It is produced using the input data set as follows:

l Three columns are required.

l The first column specifies the variable to which the dot defined on the row belongs. Each value in this column corresponds to a different variable (and a different color), and there is a dot for each row in the data set.

l The second column contains the point's X-coordinate.

l The third column contains the point's Y-coordinate.

Funnel chart

Funnel charts are often used to represent stages in a sales process and show the amount of potential revenue for each stage. This type of chart can also be useful in identifying potential problem areas in an organization’s sales processes. A funnel chart is similar to a stacked percent bar chart.

This chart requires a data set that satisfies the following criteria:





l Values in each of the following columns will be represented in ascending order from the bottom.

Map Chart

This displays one of the available maps and visually highlights the weights of its constituent areas for a particular variable. The data set must comply with the following criteria:

l The first column contains the codes representing the areas on the map.

l The second column must contain a numerical value. This value will be represented by the area's color level.

Work with dashboard report tablesReport data can be displayed in two types of tables:

l Standard table - a table containing a series of columns (based on data dictionary fields you select) on which you can define sections, breaks, groupings, and calculation. See Standard table design on page 67.

l Cross table - a table containing a number of dimensions and data objects. You can define sections, calculations and rankings for cross tables. See Cross table design on page 73.

Standard table designA standard table is a series of columns (see Columns on page 67, where you can define sections, breaks, groupons and calulations. For details, see, Sections on page 71, Breaks on page 72, Groupings on page 73, and Calculations on page 72.

Columns

A column in a standard table is a field previously selected in the Field selection tab. It contains a heading (in which a label text will be entered) and a number of lines of data.

You can perform certain actions on columns using the pop-up menu that opens when you left-click on the column heading.

Add or remove a columnTo add a column, do the following:

1. Left-click on the column heading next to where you want to add the new column.

2. The pop-up menu opens and there are two possible locations to add the new column: Add left or Add right, relative to the selected column.




3. Select the field group (Attribute, Metric or Time Axis).

The Metric group contains all numeric fields. By adding a numeric field, this will be used as a metric, by automatically adding a default (sum) aggregation. If no aggregation is needed, Aggregation none can be selected.

4. Select a specific field to be added to your table.

You can also add All the selected fields or All the remaining fields in a single click.

To remove a column, click the Delete column button in the pop-up menu.

Update Column propertiesTo update column properties:

1. Left-click on the heading for the column for which you want to update properties.

The pop-up menu opens.

2. Select Column properties from the pop-up menu.

The Column properties dialog box displays.

3. Specify values for the following properties.

Some of the properties described below (Aggregation, Inline calculation, Inline calculation scope, Visible) are accessible directly from the pop-up menu.




Property Description

Header caption

Description displayed in the column heading. This can be internationalized.

Data format Lets you format the data by clicking the button next to the label. In the Format definition pop-up menu you may choose special formats for Number, Date or Interval data.

Filed The field containing the values to be displayed.

Inline calculation

Lets you perform calculations that take into account the values on the preceding lines. Example: it is possible to calculate a cumulative total that adds line values to the previous values on a running basis.

Inline calculation scope

Determines when inline calculations are reset.

Aggregation It is possible to aggregate the values in the column. If the data in the column is non-numeric, the only permitted aggregation actions are Minimum, Maximum and Count.

Distinct values on aggregation

Any values already included in the aggregation process can be ignored.

Visible It is possible to hide a column, for example if its values are used for a dynamic link. .

Delete duplicates

When the same value is repeated several times in a particular column, this property merges all the cells and shows the value only once.

Width You can customize width of the rows in a column. If you do not set this value, the table adapts to fit the content. This value will apply to all the columns in the table

Height The height of each rows in a column can be customized. If you do not set this value, the table adapts to fit the content. This value will apply to all the columns in the table.

Header You can apply style attributes to the header of a column by clicking the button next to the label. The Style definition pop-up menu contains the following options: Color, Background color, Fond, Size, Style, Weight, Alignment.





Data You can apply style attributes to the data in a column by clicking the button next to the label. The Style definition pop-up menu contains the following options: Color, Background color, Fond, Size, Style, Weight, Alignment.

4. Click OK.

Move a columnYou can change the position of a column by drag and drop.

1. Click on the column heading and hold down the mouse button.

2. Move the mouse pointer over the heading of the destination column and then release the button.

When you move columns, the following rules apply:

l The moved column (column 1) takes the place of the destination column (column 2).

l When you move a column from left to right, all columns located between the source column and the destination column, including column 2, are shifted one place to the left, and column 1 is placed to the right of column 2.

l Similarly, when you move a column from right to left, all columns located between the source column and the destination column, including column 2, are shifted one place to the right, and column 1 is placed to the left of column 2.

Conditional formatYou can use the conditional format option to apply particular styles and formats to data, based on certain criteria. For standard reports, formats are accessible from the pop-up menu for each column. For cross reports, formats are accessible for each data field.

1. Left-click on a column heading and select Conditional format from the pop-up menu.

2. Click the Add button to add a field and specify values for the following fields:

Field Description

Field Select the field for which to apply the conditional format.

Operand Select an operand from the drop down list.

Value Specify a value for the field.

Threshold pattern Specify a pattern to be displayed when the value is reached.




Field Description

Style Define the style to apply if the condition is true.

Add You can add as many lines as you like by clicking the Add button.

Delete You can delete them by clicking the button Delete.

3. Click OK.

4. (Optional) Repeat steps 2 and 3.

Sections

A section groups together a table's data by distinct field value. Each group is shown in a different table, with the field value as the section title. When you add a section, the section is also added to the table with a row after it. This row is used to specify any calculations that must be performed at the end of the section.

Add a section 1. Click the No section button.

2. Select Add section.

3. Specify the field to which the section relates.

Add multiple sectionsYou can add multiple sections to a report. In this case, they will be organized hierarchically. Any actions that apply to the sections are accessible in the pop-up menu.

When adding multiple sections, set the position of the new break. Select Add before section or Add after section from the pop-up menu.

Each section is also added to the table with a row after it. This row is used to specify any calculations that must be performed at the end of the section.

Delete a sectionTo delete a section click on its label and click Delete.

Edit propertiesLeft-click the section title and select Properties from the pop-up menu.

Each section has the following properties:




Field Description

Field The field to which the section relates.

Sort The order in which the sections display.

Format The format applied to the section's title.

Style The style applied to the section's title.

Breaks

A break is defined for a column in the table and is used to enable intermediate calculations to be performed on data objects grouped by value. The data and calculation lines are displayed in the same table.

Actions are performed on breaks via the pop-up menu that opens when you click No break or click on an existing break.

To add a break, select a column, You can add a break from the menu, selecting the column concerned by the new break, which can be added before or after the existing one. For that use the following options: Add break, Add before break, Add after break.

To delete a section, click on its label and then click Delete.

In the break Properties pop-up, you can specify the order in which the break's data objects are displayed.

Calculations

Calculations can be added in three places:

l the section level

l the break level

l the table level (globally)

In all cases, the calculations are shown at the end of the section, break, or table.

To add a Calculation, select Add calculation line (before or after) from the pop-up menu.

Calculations are configured in the same way in all three cases. Each calculation line contains blank cells by default. You can use each cell's menu to set it as either a Calcul or a Label.

To edit the label click on Label > Properties and change this Label to suit your requirements.

With calculation cells, you can define the calculation to be applied directly from the menu. You can edit the properties to change the Calcul performed, or Format the calculation result. You can also specify the line Height, which will be the same for all calculation lines. You can also choose whether or not to use Distinct values, Conditional format or Raw data; that is, the basic values before any aggregation operations.




Groupings

Use a grouping row to group columns together. The grouping row is located above the column headings.

To show the grouping row, click on No grouping to open the pop-up menu and then click Add grouping line.

An additional row is displayed. This row contains a single block spanning all the columns. If you require more than one block, click on the cell to open a menu and click Split as blocks. Selecting this option opens a sub-menu that lets you split the block in several different ways. The first digit represents the number of columns in the left block and the second represents the number of columns in the right block.

You can repeat this block splitting procedure until you have the desired number of blocks.

You can edit each block's Properties to define a Grouping label, the Style that will be applied to the block and the Height of the grouping line. The height of the grouping line is the same for all blocks.

If you are not satisfied with the blocks that you have created, you can merge two blocks by selecting the appropriate menu option Right merge or Left merge, according to whether you want to merge with the block to the right or the one to the left (if one exists). The name and style of the block from which you opened the menu will be adopted for the new merged block.

Remove a grouping by clicking Delete this line in the pop-up menu.

Cross table designA cross table consists of a number of dimensions and data objects at the intersection between the axes. You can define sections, calculations, and rankings for cross tables.

Dimensions

A cross report consists of two axes, each having one or more dimensions, and data (at the intersection between the axes).

Click on a dimension to display a pop-up menu. From the pop-up menu, you can Add dimensions above, under, left, right, Add calculation column or line, Delete the dimension, show all values by selecting Visible, and edit the Properties.

The Properties pop-up menu for a dimension contains the following information:

Field Description

Caption A label.

Field The field containing the data to be displayed.

Sort The sort criteria that specifies the field used as the basis for the sort and the sort order .




Field Description

Mode A list of categories to which you can apply the dimension properties. The possible modes are:

l All

l All non-empty

l Selected - Only the rows containing a specified value for this dimension are displayed

l Group - The values of this dimension are grouped based on the existing values from the other dimensions. In the below example, the Group mode is applied to the dimension created for the Department field.

Attention! This Group mode should not be mistaken with the SQL clause “group by”.

Selected value

A value you can specify so that only the rows containing this value will be displayed. This field is editable only if you choose Selected in the Mode list.

Dimension The dimension of the row.

Format The format of the data for this dimension.

Style The style applied to the data for this dimension.

Visible Specifies whether to display all the values in the base, including those not used by the data in the table.

For the data inside the cells, the menu lets you add data in the table: Add left or Add right, Delete data and make it Visible or not.

It also lets you specify a Ranking and Conditional formats.

The Properties pop-up menu for a data object contains the following information:




Field Description

Caption A label.

Format The format of the data.

Field The field containing the data to be displayed.

Aggregation The aggregation merges the data for display purposes.

Distinct values on aggregation

Any values already included in the aggregation process can be ignored.

Style The style applied to the data.

SectionsA section is defined by a selected field. As in a standard table, sections can be used in cross tables to group together data in different tables, sorting them by value. However, sections in cross tables do not have directly linked calculation lines.

You can use the pop-up menu to delete or edit the properties of the current section, or add other sections before or after it.

CalculationsIn cross tables, each calculation line relates to a dimension. These dimensions will be displayed after the table's data.

Calculations involving cross tables are different from standard calculations in the way that the first cell Label in the dimension represents the row name, and the cells located in the data part can be calculations. Concerning the data, there is a calculation cell on each calculation line for each data object defined.

If the Calculations option from the pop-up menu is not selected the cell will remain empty.

You can use the pop-up menu to add another calculation line: Add calculation line before or Add calculation line after the current line on the same dimension. You may also Delete this line or edit its Properties.

For more details, see Calculations on page 72.

Ranking

With cross tables, you can use a ranking to keep only one end of a table along the X- and Y-axes.

The ranking is defined in the data objects pop-up menu.

Rankings have the following properties:




Field Description

Nb on X axis The number of rows or columns to keep on the X-axis.

Nb on Y axis The number of rows or columns to keep on the Y-axis.

Descending Indicates whether or not data is sorted by descending order of value.

Display other value

By checking this option you may display the cumulative total of the intermediate lines.

Other values label

Provides a description for the line above.

Apply dashboard report table filtersYou can apply filters to help control the data displayed in your reports. The available filters depend on whether the type of data dictionary underlying the report table is standard or SQL.

Filters for standard data dictionaries For standard data dictionaries, there are three types of filters available.

l Constant: Add a condition between a field and a constant, like in the WHERE clause of an SQL query.

l Field: Add a condition between two fields, like in the WHERE clause of an SQL query.

l Prompt: display a user prompt when visualizing a report to allow the user to change the filter's value.

To apply a filter for a standard data dictionary:

1. Select the Filter tab.

2. Modify the existing filter.

If there are no filters available, click the Add button in the left upper corner of the screen.

The Edit operand dialog box opens.

3. Specify values for the fields.

Field Description

Field A list of fields selected in the Field section tab on which the filter will be applied.




Field Description

Value type Choose one of the following filter types:

l Constant: add a condition between a field and a constant, like in the WHERE clause of a SQL query.

l Field: add a condition between two fields, like in the WHERE clause of a SQL query.

l Prompt: display a user prompt when visualizing a report to allow the user to change the filter's value.

Operand This list contains the most frequently used operators (<, <=, =, >= and >)




Field Description

Field Value/Value

l Field: A list of fields selected in the Field section tab used that you want to compared with the first field selected. This list is displayed only for the Field type filter.

l Value(field): Enter the value of a constant. This field is displayed only for the Constant type filer.

l Value (list): A list of prompt types:

o Simple value: the user enters a value in the input box.

o Unique selection value list: available values are displayed allowing the user to select one.

o Multiple selection value list: available values are displayed allowing the user to select more than one.

o Expression: filter based on an expression which is interpreted when the search is run. The following wildcards and patterns are supported:

o *represents an unknown character string. For example, T* returns all values beginning with the letter T.

o ? replaces one or zero unknown characters. For example, A?B returns AB and all three-character strings that begin with A and end with B.

o "a phrase": quote marks can be used to specify a series of words taken together, failing which the words will be treated as different possible values for the filter.

o - indicates that the pattern following the character is not permitted.

o \ indicates that the following character must not be interpreted. For example, \? searches for a question mark, rather than "any single character". Similarly, to find a \ character, you must enter \\.

Field name A unique identifier for the filter object.

Description A user-friendly name to be shown in the report's filters.

Use default value

This option allows you to specify a default value for the filter.

Default value

You can specify a default value for the filter. In the case of a multiple selection list you can set several default values using "|" (for example, FR|UK|USA). If the field selected is a date or a time, you should use the calendar pop-up to select the default value.




Field Description

Mandatory Specify whether or not the filter is mandatory. If so, you should set a default value. When displaying a report, you will not be able to uncheck a filter which is mandatory.

Visible It is possible to specify that a filter is not visible in the report, in which case, it is advisable to declare it as mandatory and set a default value.

Hierarchical filter

Hierarchical filters should be used when there are too many values in a selection list and the list can be reduced based on additional criteria. For example, if a selection list contains all the towns in England, it might be useful to filter the list by region first, and then by county. The resulting selection list would be easier to read. To have a hierarchical filer check the Hierarchical filter option and then click Add. The different options displayed should be completed: Description, Field, Use prompt, Data format, Sort. It is not mandatory to specify a Data format.

Format You can specify a format for the filter. The different values of the selection list will be shown in that format. This option is available only for Unique and Multiple selection value list.

Sort order This option allows you to sort Ascending or Descending the values in the selection list. This option is available only for Unique and Multiple selection value list.

Complete list

If you select this option, all values in the data base (including any values not returned by the query) are shown in selection lists of the filter.

4. Click OK.

The new filter is displayed on the Filter tab.

5. (Optional) Add another operand to the new filter.

a. Click the Add icon in the filter to display the Edit operand dialog box.

b. Repeat steps 3 and 4.

Filters for SQL Data dictionariesSQL filters are defined at the data dictionary level. For more details on how to create a filter, see Create an SQL query data structure on page 41.

This section concentrates on describing the filters customization at the report level.

The customization of the filters with SQL data dictionaries is very similar to filters with standard data dictionaries. It is possible to define the filter's Description and Default value, specify whether it is Visible in the report, and set one of the following Prompt types:




l Simple value

l Unique selection value list

l Multiple selection value list

l Expression

The Value list contains a list of data dictionaries that are the list values for the filter. For that it is necessary to create a separate data dictionary with o simple select of the column to obtain the list of values for the filter.

The value list option is enabled only for the Field and value type of filter defined at the data dictionary level.

Import and export objectsThe Web Dashboard import and export functionality is used to backup Web Dashboard objects or to export them in another Sentinel Web Dashboard installation. The import and export can be accomplished from the GUI Import and Export on page 80 or the Command Line Import and Export on page 84. For example, the result file produced by the export command may be used to import objects into Web Dashboard using the GUI or the import command.

Use CaseThe following steps provide a typical use case scenario for an export and import from a Sentinel test environment to a Sentinel production environment:

1. Define and test objects in a test environment.

2. Export them to a locally saved archive file.

3. Import the archive file into a production environment.

Note The export file of a Data Dictionary holds the schema/catalog information. The default behavior is to use this information at import time. But there are situations where the import needs to be done on a schema/catalog with different name, so the information present in the export file should be ignored. In order to activate this latter behavior, a new property is available starting with Service Pack 8. The property webdashboard.schema.independent.import= true needs to be manually added in server.properties.

GUI Import and ExportYou can use the Web Dashboard GUI to import and export Web Dashboard objects.




Export objects from the GUI 1. Go to Administration > XML Export.

2. Select the Add button .

The Add Objects tab displays a list from you can choose object types.

3. Click objects in the list to select them. Select consecutive objects by pressing and holding Shift and clicking objects from the list. Select non-consecutive objects by pressing and holding Ctrl while clicking objects from the list.

4. Optionally, use the following fields to specify further constraints regarding object dependencies and versions.

Field Description

Version Filter selected objects to include only the version you specify. If you do not specify any, all objects, regardless of their version, are returned on the next page.

Modification date

Filter selected objects to include only those modified on the date you specify. If not specified all objects, regardless of their modification date, will be returned on the next page.

Dependent objects

Check to include dependencies of the selected objects. For example, if you select this check box and you select Dashboard as the object type to be exported, Reports will also be automatically considered for export.

Dependency level

Filter dependent objects to only those having the dependency level equal to or less than the level you specify. For example, a Dashboard is made of Reports, which rely on Data dictionaries, which rely on Worlds. In this situation, relative to the Dashboard, Reports are dependency level 1, Data dictionaries are level 2, and Worlds are level 3.

5. Select the Right arrow button on the bottom of the page.

The Search Results tab displays the a table listing the objects that match the criteria you specified.

6. On the Search Results tab, select the check box next to each object you want to include in the export and then select the Right arrow button on the bottom of the page.

The Objects to export tab displays only those objects for which the user has read rights.




7. Optionally, on the Objects to export tab, you can do the following:

l Add objects to the list: Select the Add button to display the Add Objects tab.

a. Select the Add button in the toolbar to display the Add objects tab, where you select objects and filter them by their type, name and version.

b. Click the Right arrow button to display the Search results page and select objects to be included in the Add operation.

c. Click the Right arrow button to display Objects to export tab, where the new results are appended to the original ones.

l Add the Delete action to your export operation for an object instance: When you add the Delete action for an object, the object will be deleted from the target environment when you import the data again.

a. Select the Close button on the toolbar to display the Delete objects tab, where you select objects and filter them by their type, name and version.

b. Select the Right arrow button to display the Search results page and select objects to be included in the Delete operation.

c. Select the Right arrow button to display Objects to export tab, where the new results are appended to the original ones.

Note The Close button cannot be used in conjunction with the check boxes in the Objects to export view.

l View dependencies

a. Select one or more objects from the list and select to display the Search Results tab.

b. Select one or more objects from the Search Results tab.

c. Click the Right arrow button to display Objects to export tab, where the new results are appended to the original ones.

l Reorder your list

a. Select the check box for one or more objects you want to move up or down the list.

b. Click next to an object in the list to move the selected objects above it on the list.

l Delete objects from your list – Click the Close button Close button next to the object in the list you want to remove.




8. After you have established your list of objects to be exported, you can:

l Click XML Export to generate your export file. You will be prompted to save the resulting archive on your local host.

l Click Save to save your current export setup (i.e. list of objects, actions) on the server host. To save your export setup , you must first manually create the folder prelytis/var on your server in the Tomcat runtime directory. After your setup is saved, next time you access the Administration > XML Export option, you can use the Load button to work with the previously saved setup.

Import objects from the GUIYou can import your previously exported and saved XML files.

1. Go to Administration > XML Import.

2. Choose the file you want to import. Either identify it on the server or navigate to it on your local system.

Select the file and click the Right arrow button to continue.

The contents of the archive are displayed in the order established at export time.

For each object, the following data is displayed:

Field Description

Objects The object type

Name, Description

The name and the description of the object

XML version

The version of the object stored in the export archive

DB version The version of the object stored in the database (if any)

NONE, UPDATE, DEL

The action specified for the object when importing.

l NONE – the object will be ignored.

l UPDATE – the object in the database will be updated if its version is earlier than the version in the export file, or created if it does not exists.

l DEL – the object will be deleted if its version in the database is earlier than the version in the export file.

3. Even if the application has selected an action for each object by default, you can override it and specify a different action; for example, NONE.




Reset the default actions by pressing the button on the toolbar.

4. Optionally, test your import. Click the button.

5. Import your data. Click the button on the toolbar.

Command Line Import and ExportYou can use the command line to import and export Web Dashboard objects. Commands provide a brief output on the console, and more details in the Web Dashboard logs.

Export objects from command LineThe following export batch files are delivered in Sentinel Web Dashboard:

l export.bat - Windows platforms

l export.sh - Linux/UNIX platforms

The command is located in the following server side folder:

<SENTINEL_INSTALLATION_DIRECTORY>/Sentinel/jetty/webapps/SentinelWebDashboard/tools

Use the argument -help to run the command and display its use.

Note If Web Dashboard is deployed on a Tomcat instance rather than on the internal web server, set the JAVA_HOME environment variable before running the import or export command. For Linux/UNIX platforms, use chmod to grant access to these commands.

In the example below, the export command is used to export a list of objects. The objects are specified in the order they are exported. When you import the resulting file into Web Dashboard, the import is done in the same order.

export.bat -u foo -p pass123 -d Acme -nameAndType "MyDashboard Dashboard MyReport1 Report MyReport2 Report MyData Dictionary" -f c:\impexp\myexport.zip

Note Quotation marks are mandatory when specifying the value for the -nameAndType option. The type of each object can be listed when running the export command with the option -help.

Exit Codes:

l 0 - Successful export

l 1 - Unsuccessful export

Import objects from the command lineThe following import batch files are delivered in Sentinel Web Dashboard:




l import.bat - on Windows platforms

l import.sh - on Linux/UNIX platforms

The command is located in the following server side folder:

<SENTINEL_INSTALLATION_DIRECTORY>/Sentinel/jetty/webapps/SentinelWebDashboard/tools

Use the argument -help to run the command and display its use.

Note If Web Dashboard is deployed on a Tomcat instance rather than on the internal web server, set the JAVA_HOME environment variable before running the import or export command. For Linux/UNIX platforms, use chmod to grant access to these commands.

When you import the results of the export file into Web Dashboard, the objects are imported in the same order as they were exported. For example, the following import command is used:

import.bat -u foo -p pass123 -d Acme -f c:\impexp\myexport.zip

Each time an import is attempted, Web Dashboard will calculate the appropriate action according to the object's version. For example, if a newer version of an object already exists in Web Dashboard, the application will skip the update when importing an older version of the same object. The import command will return exit code 1 when there are objects skipped during the import. By using the -force option with the import command, you will force the update of objects, regardless of their version.

Exit Codes

l 0 - Successful export

l 1 - Unsuccessful export

Flow monitoring with searchesWeb Dashboard allows you to search for results within data and monitor data flow transactions. To accomplish this, at the Report design select the Search chart type.

Set up and visualize a searchReports containing the Search chart type behave similar to Web Dashboard table reports, taking into account specific aspects, for example:

l Creation

l Modification

l Execution

l Filtering

l Customization




l Exporting

l Importing employment in controls

l Embedding in dashboards

For more details about how to set up and visualize reports, see the following:

l Set up reports on page 45

l Visualize reports on page 86

Visualize reportsA report is actually a chart, a representation of a set of data in a variety of forms, the simplest of which is a table. See Dashboard chart types on page 58 for information about the kinds of charts you can create using Web Dashboard.

1. On the Main menu, select My documents.

A list of existing reports displays.

2. Select the report you want to visualize.

The report displays.

3. In the left upper corner of the screen is a bar with several buttons that allow you to perform the following actions on the report:

Button Description

Filter Document

Displays a prompt that allows you to filter the data set used by the report. Select a filter and set a value. Add more filters if necessary.

Refresh Reloads the report.




Button Description

Customize Displays the Customization dialog box. Use the Customization dialog box to modify the appearance of the report. Multiple users can customize a report. You can only see those modifications you make yourself. The Customization button is available only if the user has the appropriate rights.You can delete a customization to display the report in its original form. The Customization dialog box has the following tabs:

l Design: Change the Style of the report, but not the structure of the report. Select a Style from the drop down menu.

o Switch columns and rows using the Columns inversion button.

o Hide a column by right clicking the column header and deselecting the Visible option.

o Add a calculation line to the report. Right click the footer of the table and select Add calculation line from the pop-up menu.

l Sort: Sort the data in the report. Click the Sort tab, select a field to sort on and specify the sort order for that field.

Use the Add button to add a new sort field. Use the Delete button to delete a sort field.

l Filters: Filter the report results. Select the Filter tab, select a field, and select a filter value for the field.

l Charts: Change the type and properties of the chart used for the report. Select the Chart tab and select a chart type. See Dashboard chart types on page 58 for more information.

Select OK to save your changes and redisplay the report.

Customize chart

Select the Customize chart button to go directly to the Chart tab of the Customization dialog box. Select the Chart tab and select a chart type. See Dashboard chart types on page 58 for more information.

Delete customization

Deletes customizations currently applied. This button is displayed only if the report has already been customized.




Button Description

Excel Export

Generates an Excel file that you can either save or open directly. This button is available only if the user has total access to the report. Please see also the Performance considerations on page 88 section below.

PDF Export Generates a PDF file that you can either save or open directly.Please see also the Performance considerations on page 88 section below.

Previous This button is shown only if the report is displayed following a dynamic link. The button is displayed in the drop-down menu accessible from the title bar if the report is included in a dashboard.

Edit document

Invokes the Design mode for this report. See Specify report design options on page 51.

Notepad Allows you to make notes when visualizing a Report. You can add multiple notes to a Report. This option is displayed in a drop-down menu when you right-click in the window.

Add bookmark

Allows you to add a bookmark to a report. Select the name of the report in the upper left portion of the window to drop down a menu, and then select Add a bookmark. To delete the bookmark, click the name of the report, and then select Delete bookmark.You access existing bookmarks by clicking on the username in the upper-left portion of the window, and then selecting the bookmark.

Performance considerationsWhen a huge report needs to be exported from the Web Dashboard interface, the memory on web server side (Jetty) needs to be adjusted accordingly. Also, the CPU load will spike, but will come back down once the task is finished.

Example of behavior for exporting a dashboard/report in PDF format

Note that this is just a guideline for observing the trend. The export time is depending on different factors (the amount of data being exported for each row, application load, machine performance, etc)

1. Java memory on Jetty side is set to the default 1024m. You can notice that the time needed to export PDF format will increase exponentially relative to the number of rows.




2. If Java memory on Jetty side is increased to 2048m, the time varies as follows:

Accessing reports using an URLYou can access reports directly by entering the appropriate URL into the browser. You might be asked to authenticate before proceeding.

Use the following syntax when specifying an URL:

http://<web-dashboard-host>:<web-dashboard-

port>/SentinelWebDashboard/document/report/<report-name>, where:

l <web-dashboard-host> is the host where Web Dashboard is accessible

l <web-dashboard-port> is the port where Web Dashboard is accessible (default: 8443)

l <report-name> is the name of the report you want to access

You can specify filters in the URL by appending the required information to the URL.

Use the following syntax when specifying filters:




?f:<filter-name-1>=<filter-value-1>&f:<filter-name-2>=<filter-value-2>&<filter-name-3>=<filter-value-3>

where:

l <filter-name-1> is the name of the first filter

l <filter-value-1> is the value of the first filter

l <filter-name-2> is the name of the second filter

l <filter-value-2> is the value of the second filter

Note Make sure your URL is valid after you add filters. For example, if a filter value contains white space, like to to, convert the white space to make the URL valid, like this: to%20to

You can enable or disable a filter. Use the following syntax to enable or disable a filter:

l Disable a filter: u:<filter-name>=0

l Enable a filter: u:<filter-name>=1

ExampleYou have a report (Employees) listing employees and you want to filter them by Country and Department. You have set up two filters one called country and the other named departmentId.

You can access the report filtering for all the employees from the United States belonging to the Accounting department with the following URL:

http://reports.acme.com:1234/SentinelWebDashboard/document/report/Employees?f:country=United%20States&f:departmentId=Accounting

Time Axis ChartsSome reports display a time axis. You can zoom into the graphic on a narrower time range and then return to the initial time range.

Click and drag around the specific area you want to maximize. To return to the initial time range, select Refresh from the drop-down menu.

l When visualizing a Dashboard these buttons are displayed when you click the title bar of a report. A drop-down menu with this options will then be available.

Create a Web DashboardOnce you have created reports, you can create Dashboards to display them. A Dashboard consists of pages called templates. Templates are made up of blocks. Blocks can contain the following objects: Report, Control, Control panel, Metric, Metric panel, Strategy map, External session, Text session.

To create a new web dashboard:




Note After you create and save a dashboard, it is immediately available in the My documents folder.

1. On the Main menu, click Dashboard design > Dashboard. A list of existing dashboards displays.

2. Click the Add button to create a new Web Dashboard. A new document opens and the Description tab displays.

3. Enter a name and a description.

4. Optionally, select Activate the type of comments to allow users to add comments when executing the dashboard.

5. Select More details to display additional fields.

6. Enter information in the following fields:

Field Description

Execution mode Select whether to execute the dashboard in interactive or snapshot mode.

l Interactive: (default) Query the database each time the dashboard is displayed. Use interactive mode when you require a real-time view of the data.

l Snapshot: Use a snapshot of data to display a dashboard. Snapshot mode allows you to display reports based on a large amount of data in just a few seconds. In snapshot mode, Web Dashboard records a history of the data at set intervals. A typical use case would be to display a Dashboard every morning based on the data loaded during the night. You can use a specific Task to generate the snapshot Dashboard, which is persisted in form of an XML file. When a snapshot Dashboard is displayed, the data is read from the XML. See Snapshot mode for reports and dashboards on page 120.

Page layout Used for PDF exports.

Entity Specifies the owning entity. The owning entity is a container with which the report is associated.

Refresh delay Specifies how often the selected blocks are updated. If a negative number is entered, the dashboard will not be updated.




Field Description

Collaboration mode Select how comments are displayed.

l Share (default): Each comment is visible to all users.

l Information: Comments are visible only for child entities.

l Report: Comments are visible only for parent entities.

Filter's location Specify the position of the filters on when executing a dashboard. Several positions are available.

Automatic filter validation

Enables automatic refresh of reports and dashboards when you select a value from the filter pop-up. The filter pop-up should be fixed on the right or left side of the screen.

Note This option is only enabled if the Display automatic filter validation checkbox check box from Administration > System preferences > Ergonomy is selected.

Show filter first Displays the filter prompt before the report to allow the user to set the filter values. Only applies when there are one or more user prompt filters.

Export PDF as booklet (on multiple pages)

If this option is checked (by default is checked), all the defined dashboard templates will be on multiple pages. If the option is unchecked, the PDF generator will try to maintain the layout of the blocks defined in the dashboard. In this way, all the defined dashboard templates will be on a single page.

Caution Please uncheck the option only if it truly suites your dashboard! In case the dashboard contains table data on a large number of pages and the option is unchecked, the PDF generator will try do organize too much data on a single page, resulting in slowness and data be truncated.

Version Version number of the object. Sentinel Web Dashboard increments this number when the object is saved. This version number is used during XML export/import.




Add dashboard filtersYou can apply filters to help control the data displayed in your dashboard. To add a filter, you need to be in Dashboard design > Dashboard under the Design tab.

1. Select the Add Filter button. The Filters screen displays.

2. Select Add a filter.

3. Select the Add button . Additional fields display to allow you to create the filter.

4. In the Edit a field section, enter values for the following fields:

Field Description

Filter driven by Specifies the report that sets the filter's selection list.

Name A unique identifier for the filter.

Description A label used to identify your filter throughout the GUI. The description can be internationalized (translated into the language defined for each user) using Internationalization tab.

Prompt This field is just for information purposes and it displays the prompt chosen at the report level. If you need a different prompt value, you will need to change it in the report.

Required Specifies whether the filter must be used for the dashboard.

Use Filter Activates the filter by default.

Default value Specify a default value for the filter. This value will be used for the filter on execution.

5. In the Linked report fields section, enter values in the following fields:

Field Description

Filter mapped on Choose the block in which to apply your filter.

6. Select Add button to add the report/field combination to add to the current filter.

7. Repeat steps to add more report/field combinations to the filter.

8. Select OK.




Add templates and blocksA Sentinel Web Dashboard consists of pages called templates. Templates are made up of blocks. Blocks can contain the following objects: Report, Control, Control panel, Metric, Metric panel, Strategy map, External session, Text session.

To add a template or block, you need to be in Dashboard design > Dashboard under the Design tab.

1. Select the Add Template button .

2. Select a template layout from the pop up and click OK.

The layout is applied to the template and is displayed. Each box in the layout represents a block.

3. Select one of the blocks.

A pop up dialog displays to allow you to configure the entire template and the block you clicked to open the dialog box.




4. Specify the following template properties:

l Description

l Width

l Height

l Background image - Must be an image file located in the user's Theme, which is accessible from the Look and feel section of the main menu.

5. Specify the following block properties:


Block's header display Choose from the following:

l Visible – the title is displayed.

l Mouse Over – the title is displayed when the mouse hovers the block's header.

l Hidden – the title is not displayed.

l Hidden with context menu – The title is not displayed but the context menu is available.

Block type Choose the kind of data you want to display in this block from this list:

l Report

l Control

l Control panel

l Metric

l Metric panel

l Strategic map

l External component

l Text

l Form

Block document The name of the document to be displayed in this block.

Dynamic link target block

Choose the target block of the dynamic link. This option is only useful with links that open reports; therfore, when you select the link, you can specify the block the report will be opened. If the dynamic link is defined to open a dashboard, the Dynamic link target block option has no effect.

Top/Left Specify the position of the block on the dashboard.

Width/Height Specify the size of the block.





Auto-refresh Specify how often the dashboard should be refreshed. The auto-refresh setting is only available if the Refresh delay option was enabled on the Description tab.

Visualize dashboardsThe Sentinel Web Dashboard comes complete with visualizations including reports, metrics, strategy maps, external sessions and more. There are many customizations available for these options. By visualizing them properly you empower your Web Dashboard users the best way to view your business data exactly how you imagined.

After you create and save a Web Dashboard, it is immediately available in the My documents folder. At this point you can visualize

To visualize a dashboard, double-click its name in the My documents folder.

Once a dashboard has been visualized:

l Use the Tab key to move focus from block to block.

l Perform some actions that affect the dashboard globally (see Global actions on page 96) and others that affect only the selected block (see Block-specific actions on page 98.)

Global actionsOnce a dashboard is displayed, the following buttons are available at the top of the window. Actions invoked by these buttons affect the entire dashboard:

Button Description

Filter Dashboard

Displays a prompt that allows you to filter the data displayed by the dashboard. Select a filter and set a value. Add more filters if necessary.

Refresh Reloads the report.

PDF Export Generates a PDF file that you can either save or open directly. Please see also the Performance considerations on page 97 section below.

Comment Opens a window where you can add a new comment and see existing comments.




Button Description

Edit document

Invokes the Design mode for this report. See Specify report design options on page 51.

Automatic refresh

Starting with Service Pack 5, the Automatic Refresh field is also available, at the top right of the window. This field specifies how often the currently displayed dashboard is being updated. In order to use it, you need to enter a value (number of minutes) in the text box and then press the Enter key or click on the Right arrow.

When using this feature you should also be aware of the following:

l Only positive, integer numbers are allowed

l By default the automatic refresh is disabled, corresponding to 0 minutes selection

l The automatic refresh setting is only working for the current page displaying a dashboard. If the page is left or refreshed, the user’s settings regarding the automatic refresh will be lost.

l The automatic refresh set in this edit box outweighs the automatic refresh configured when designing the dashboard

Performance considerationsWhen a huge report needs to be exported from the Web Dashboard interface, the memory on web server side (Jetty) needs to be adjusted accordingly. Also, the CPU load will spike, but will come back down once the task is finished.

Example of behavior for exporting a dashboard/report in PDF format

Note that this is just a guideline for observing the trend. The export time is depending on different factors (the amount of data being exported for each row, application load, machine performance, etc)

1. Java memory on Jetty side is set to the default 1024m. You can notice that the time needed to export PDF format will increase exponentially relative to the number of rows.




2. If Java memory on Jetty side is increased to 2048m, the time varies as follows:

Block-specific actionsOnce a dashboard is displayed, certain actions are available on a per-block basis. They vary depending on the content of the block.

Use the Tab key to move focus from block to block.

Accessing dashboards using an URLYou can access dashboards directly by entering the appropriate URL into the browser. You might be asked to authenticate before proceeding.

Use the following syntax when specifying an URL:

http://<web-dashboard-host>:<web-dashboard-port>/SentinelWebDashboard/document/dashboard/<dashboard-name>

where:

l <web-dashboard-host> is the host where Web Dashboard is accessible

l <web-dashboard-port> is the port where Web Dashboard is accessible (default: 8443)

l <dashboard-name> is the name of the dashboard you want to access

You can specify filters in the URL by appending the required information to the URL.

Use the following syntax when specifying filters:

?f:<filter-name-1>=<filter-value-1>&f:<filter-name-2>=<filter-value-2>&<filter-name-3>=<filter-value-3>

where:




l <filter-name-1> is the name of the first filter

l <filter-value-1> is the value of the first filter

l <filter-name-2> is the name of the second filter

l <filter-value-2> is the value of the second filter

Note Make sure your URL is valid after you add filters. For example, if a filter value contains white space (for example, to to), convert the white space to make the URL valid, like this: to%20to

You can enable or disable a filter. Use the following syntax to enable or disable a filter:

l Disable a filter: u:<filter-name>=0

l Enable a filter: u:<filter-name>=1

ExampleYou have a dashboard (Employees) listing employees and you want to filter them by Country and Department. You have set up two filters one called country and the other named departmentId.

You can access the dashboard filtering for all the employees from the United States belonging to the Accounting department with the following URL:

http://reports.acme.com:1234/SentinelWebDashboard/document/dashboard/Employees?f:country=United%20States&f:departmentId=Accounting

Customize your Web Dashboard appearanceYou can customize the Web Dashboard log-in page and the Web Dashboard home page.

Customize the log-in pageYou can customize the following items on the Web Dashboard log-in page:

Customizable item

Description

Browser tab icon

The Browser tab icon file, favicon.ico, is stored in the directory, <Web server deployed folder>\SentinelWebDashboard. You can replace favicon.ico with any 32x32 icon you choose.

Tab name The original tab name is Axway|Sentinel Web Dashboard. You can change this value from the login.html fileThis change is available only in the log-in page.




Customizable item

Description

The Axway logo

The Axway logo file, login-title-42x410.png, is stored in the directory <Web server deployed folder>\SentinelWebDashboard\img2\

You can replace login-title-42x410.png with any graphic you choose.

The splash-curves

The file, splash-curves.png, is stored in the directory, <Web server deployed folder>\SentinelWebDashboard\img2. This file is displayed on each of the Web Dashboard pages. You can replace it with any graphics file you choose. As soon as you save the new image, it is available in all the Web Dashboard pages.

Customize the dashboardYou can customize the following items on the Web Dashboard home page:

Customizable item

Description

Axway logo This logo is displayed in the left corner of the Web Dashboard home page.The logo file, header-title-32x395.png, is stored in the directory <Web Server deployed folder>\SentinelWebDashboard\img2.You can replace header-title-32x395.png with any graphic you choose.

Tab browser title after login

Make the following update in the database: update in_langdata set Description="<new name>" where datakey="P_S23_O1"

Customize the AboutYou can customize the Copyright message in the About page by manually updating the following tag in Web Dashboard's web.xml file:

<env-entry>

<env-entry-name>copyright.info</env-entry-name>

<env-entry-type>java.lang.String</env-entry-type>

<env-entry-value> your copyright message here </env-entry-value>

</env-entry>




Note The xml special characters aren't permitted in the Copyright value: <, >, ', ", &.



5 Web Dashboard advanced set up

This section contains information about some advanced set up designed to enhance your experience with Web Dashboard.

l User access managment on page 102

l Server-side resources and folders on page 112

l In-memory database on page 114

l Snapshot mode for reports and dashboards on page 120

l Monitor reports and send notifications (controls) on page 121

l Tasks on page 128

l Dynamic links on page 146

l Personalized fields on page 148

l Visualize requests and graphic objects from Sentinel Monitoring on page 188

l Web Dashboard logs and troubleshooting on page 219

User access managmentIn most cases, the Web Dashboard Administrator is responsible for managing user access. Access management in Web Dashboard is accomplished using one of the three access management tools:

l Axway PassPort on page 102

l Sentinel Administration on page 104

l Custom User Exit on page 105

Axway PassPort is the recommended access manager for Sentinel. It is the Axway component that handles access management in the most efficient and extensive way offering features like component self registration, LDAP connectivity, Single-Sign On, and role based access control (RBAC).

Axway PassPortUsers are defined in Axway PassPort or in an external repository (for example, LDAP). Users will have specific roles and privileges. Access can be set up relying on the predefined roles Sentinel Administrator and Sentinel Viewer or on custom roles. Custom roles can have predefined privileges and/or custom privileges.




There are several levels of control when implementing access management in Web Dashboard:

1. Level 1: Granting Predefined Privileges on page 103 relies on three predefined privileges. These privileges decide the user's overall profile and provide a level of authorization that is necessary, but not sufficient on its own.

2. Level 2: Granting Access to Actions on Resources on page 103 defines access to resources (for example, reports and dashboards). Some resources allow conditions (for example, viewing a report with a certain name).

3. Define access to groups of objects by creating Entity objects and associating them with reports and dashboards. Link users or user groups to entities to control the access of the users or user groups to objects in these entities. For this, create a public user or user group property with the name WDUserEntity (for users) or WDEntity (for user groups) and assign it as the value, the name of the entity.

4. Control access to data by creating variables linked to users or user groups and referring their values in SQL queries (Data dictionaries), filters and more. Public properties defined at user or group level, trigger the creation of Personalized fields in Web Dashboard.

Level 1: Granting Predefined PrivilegesIn PassPort, there are three predefined privileges for Sentinel:

1. Manage Web Dashboards, access, reports and database - confers the administrator profile.

2. Create Web Dashboards and reports - identifies content developers (for example, developers who create reports and dashboards).

3. View Web dashboards and reports - identifies end-users who display and work with reports and dashboards.

Note These privileges are cumulative, meaning if you assign more than one of these privileges to a user, the higher privilege will prevail.

The Sentinel Administrator predefined role, has the Manage Web Dashboards, access, reports and database privilege

The Sentinel Viewer role has only the View Web dashboards and reports privilege.

If you assign a PassPort user one or more of these three privileges, this user will have access to Web Dashboard (privileges to log in to the application), but will not have access to any action, on any resource. This level of authorization is necessary, but not sufficient for the use of Web Dashboards.

Level 2: Granting Access to Actions on ResourcesAt this level, appropriate privileges have to be granted to each Sentinel user. This can be done by relying on the existing predefined privileges or roles, or by creating custom privileges and roles.

To list the predefined privileges for Web Dashboard:

In the PassPort UI, under section Access > Privileges, filter the privileges in PassPort by




l Product=Sentinel

l Type=Predefined

l Resource=HTML

To create your own custom privileges and roles:

1. Browse the available resources for Web Dashboard and the actions available on these resources. You can see the list of resources in the PassPort UI, under section Administration > Products.

2. Select the item Sentinel and in the pop-up dialog, select the Resources tab. All items listed in this dialog are the Sentinel resources. The ones starting with HTML are specific to Web Dashboard.

3. Select a resource to see its description, available actions and its properties.

For example, the resource HTMLReport allows execution of Web Dashboard reports. It has a single action VIEW, and a single property name. When a resource has a property it means that conditional privileges can be constructed for that resource. In the case of the HTMLReport resource you can create a custom privilege restricting the access to a specific report by adding a condition on the privilege, for example name=MySpecialReport.

In comparison, other resources are more generic, for example the HTMLDashboard resource. This resource has three actions: VIEW, VIEW_DESIGN and MANAGE. A custom privilege that grants access to this resource and the action MANAGE, allows you to create dashboards. However, it will also allow the creation of other objects that are necessary for creating dashboards, (for example report, external components, and text). In this case, if you add a condition on the resource property name it will have no effect.

Sentinel AdministrationUsers are defined in Sentinel and belong to a group. Groups own a profile; while a profile is a set of rights. Unlike in PassPort, all rights available in Sentinel Administration are predefined. The creation of custom rights is not possible.

Similar to PassPort, there are several layers of control when implementing access management in Web Dashboard:

1. First level access relies on the following three rights:

l Manage Web dashboards, access, reports and database - confers full rights on Web Dashboard and is most likely, used for administrators.

l Create Web dashboards and reports - used for developers who create reports and dashboards.

l View Web dashboards and reports - used for end users who execute reports and dashboards.

2. Define read and write access on object instances by creating a Workspace object, configuring it appropriately and linking it to a user or a group. To link a workspace to user or a group, create a variable with the name WDUserWorkspace (for users) or WDWorkspace (for groups) and assign it as the value the name of the workspace.




3. Define access to groups of objects by creating Entity objects and placing in them reports and dashboards. Link users or groups to an entity to control the access of the users to objects in the entity. For this, create a variable with the name WDUserEntity (for users) or WDEntity (for groups) and assign it as the value the name of the entity.

4. Control access to data by creating variables linked to users or groups and referring their values in SQL queries (Data dictionaries), filters and more. Variables defined in Sentinel Administration trigger creation of Personalized fields in Web Dashboard. Read more about Personalized fields here.

Note The following variable names are reserved for setting user preferences: Language, Timezone, Home and Theme.

Custom User ExitJust as Sentinel Administration relies on a set of predefined rights, a custom user exit has the same list that is available in Sentinel Administration, including the different layers of authorization:

Use the rights defined in the class com.axway.sentinel.common.server.user.Rights to manage user's access to Sentinel, in the isUserRightStatus(String, String) of your implementation. Specifically to Web Dashboard, the following rights apply:

l Rights.RIGHT_WD_SUPER_ADMIN_PROFILE

l Rights.RIGHT_WD_ADMIN_PROFILE

l Rights.RIGHT_WD_USER_PROFILE

Use the getUserVariable(String, String) method to pass the WDUserEntity and WDUserWorkspace parameters of a user or the getGroupVariable(String, String) method to pass the WDEntity and WDWorkspace properties for a group, this links a user or a group to a Web Dashboard entity or workspace.

To control access to data, create user or group variables that will be translated as Personalized fields in Web Dashboard. For this, your user exit implementation should implement the WebDashboardPersonalizedFieldsProvider interface.

Upgrade to Sentinel 4.2.0 This information is only applicable when you upgrade from 4.1.0 to 4.2.0 and the access manager used is Axway PassPort.

For Sentinel release 4.2.0, access management in Web Dashboard using PassPort has changed. Since no automated migration is possible, when you upgrade from 4.1.0 to 4.2.0, you use the previous way of managing access. It is recommended to use the new access management mechanism, as it ensures more coherency with the other Sentinel modules and it is more powerful. In order to switch from the old access management system to the new one, two manual actions must be completed:

1. Remove the parameter webdashboard.access.management=webdashboard from Sentinel's server.properties file.




2. Review the changes that need to be applied to your users in PassPort:

l Users who rely on the default PassPort roles (Sentinel Administrator and Sentinel Viewer) will automatically have access to Web Dashboard. This requires no additional action.

l Users who rely on custom roles can log in to Web Dashboard; however, they will need to have additional privileges assigned. See Level 2: Granting Access to Actions on Resources on page 103.

Important changes when you switch to the new access management:

l In Sentinel 4.2.0, :Workspace" is not available. Instead, you have the "Menu" and the "Public menu". The Menu can be used to customize the application menu for all users. The "Public menu" is used to make reports and dashboards publicly available.

l Since Workspace is not be available, use one of your previously defined workspaces as the template for the new Menu item.

o To configure this, in the server.properties set the parameter webdashboard.templateworkspace=Foo (replace Foo with the name of your workspace).

o This is an optional setting. If it is not configured, Web Dashboard will use the former superadmin workspace as the template for the menu.

Working with entitiesSentinel Web Dashboard entities are hierarchical objects that use a simple tree-structure. They are used to control access to different objects for different users. By default, Web Dashboard has two predefined entities:

l Default - default Entity is the pre-defined root of the hierarchy.

l Public - optional Entity, used to manage publicly available objects.

Note You can create a number of custom entities within Web Dashboard. Also, you can associate a Sentinel user with a Web Dashboard Entity by using public properties in PassPort, user and user group variables in Sentinel Administration, or in your custom authorization implementation.

Each Entity object has a simple hierarchical tree-like structure:

l A name - uniquely identifies the Entity object among others.

l A description - describes the Entity object, used throughout the user interface.

l A parent - each Entity object, except the default Entity, must have a parent Entity.

By default, every Web Dashboard object (except World objects) is associated with the default Entity. For example, when you create a report, dashboard, or user, it must be associated with an entity, whether it is the default or an entity you create.

By default, the following set of rules apply when working with entities:




l Users have full access to objects associated with the same Entity as themselves, or with the child Entities of their own Entity.

l Users have read-only access to objects associated with parent Entities of their own Entity.

l Users do not have access to objects that are associated with Entities in a separate Entity branch from their own.

There is an alternative set of rules reserved for backwards compatibility reasons with releases prior to Sentinel 4.2.0. To activate these rules, deselect the Use uniform access management for entities option in Web Dashboard (Main menu > Administration > System Preferences > Server ).

This set of alternative rules is different depending on the type of activity you want to perform. For example, if you are performing developer work, creating Reports, Dashboards, and so on, the following set of rules apply:

l Users have full access to objects associated with the same Entity as themselves, or with the child Entities of their own Entity.

l Users have read-only access to objects associated with parent Entities of their own Entity.

l Users do not have access to objects associated with Entities in a separate Entity branch from their own.

If you are executing an already defined Report (for example, you act as a viewer), the following set of rules apply:

l Users have full access to objects associated with the same Entity as themselves, or with the parent Entities of their own Entity.

l Users do not have access to objects associated with child Entities of their own Entity, or with Entities in a separate Entity branch from their own.

ExampleThe following Entity tree-structure is defined in Web Dashboard, where John is associated with the Human Resources Entity:

l Default Entity

o Public Entity

o Accounting Entity

o Human Resources Entity (John's Entity)

o New Hires Entity

o Old Employees Entity

By default, John has the following access rights on the different objects, regardless of the type of activity he performs (for example, creates or visualizes reports):

l Full access to the reports associated with the Human Resources Entity, as well as with the New Hires Entity and the Old Employees Entity.

l Read-only access to the reports associated with the Default Entity.

l No access to the reports placed in the Accounting Entity.




If the alternative set of rules are activated and if John is a Report designer, meaning he creates reports, he has:

l Full access to the definition of Reports associated with the Human Resources Entity, as well as with the New Hires Entity and the Old Employees Entity.

l Read-only access to the definition of Reports associated with the Default Entity.

l No access to the definition of the Reports placed in the Accounting Entity.

If the alternative set of rules are activated and if John is a Report consumer, meaning he visualizes reports, he has:

l Full access to the definition of reports associated with the Human Resources Entity and the Default Entity.

l No access to Reports placed in the Accounting Entity, New Hires Entity and Old Employees Entity.

Workspaces and user accessImportant: Starting with Sentinel 4.2.0, when access management is done with PassPort, workspaces are kept for backwards compatibility only. If you have upgraded from a previous Sentinel version and use Axway PassPort for access management, refer to the section Upgrade to Sentinel 4.2.0 on page 105

Workspace objects are used to configure the Web Dashboard menu, and to grant access to users to specific objects. Each user is associated with one workspace, while one workspace is typically associated with many users.

By default, there are three pre-defined workspaces available: superadmin, admin and public.

l The superadmin workspace features an extensive menu and is suitable for full administrator profiles.

l The admin workspace enables a subset of the menu items and is suitable for the content developer profile.

l The public workspace is used to make objects like reports and dashboards publicly accessible (for example, without authentication).

See Publicly accessible Web Dashboard objects on page 212.

By default, each user defined in Sentinel is associated with one of the two default workspaces (superadmin or admin), depending on the assigned privileges or rights.

Create a workspace 1. On the Web Dashboard main menu, select User management > Workspace. A list of

existing workspaces displays.

2. Click the Add button . A new document opens and the Description tab displays.





Field Description

Name Enter the name of the workspace. This value must be unique among all workspaces. This value will be the one you have to assign to the PassPort public property or the Sentinel Administration variables to link a user or a group with this workspace.

Description Enter a human readable description of the workspace. This value will be displayed in the GUI whenever there will be a reference to this workspace. This field can be internationalized.

4. Select the Sessions tab. A list of folders displays. These folders represent the available menu options in the workspace.

5. Select one of the folders. The Add button displays next to the open folder.

6. Click the Add button to add that session to the group. For example:

A dialog box displays several lists of objects you can make available for the selected folder. They are labeled Dashboards, Reports, and Sessions and contain the items you can add to your workspace.

The items in the Dashboards and Reports lists are the dashboards and report objects that exist in the system. You can make them available from the folder you selected.




The items in the Sessions list represent new instances of objects. When you include these session items, you make it possible for the user to create new objects.

7. Select one or more items from one of the lists and select OK.

The selected items display in the list of folders under the folder you selected. Once you select an item and click OK, it is no longer available to be placed in any other folders.

8. For each of the items you just added, you can specify access rights from a drop down. Choose all rights, read-only rights or none.

9. Click Save.

Assign entities and workspaces using Sentinel Administration or custom user exitYou can use Sentinel Administration or your user exit implementation to link users to a certain Entity or Workspace using user and group variables. You must define user variables of type String, and name them as follows:

l WDEntity - to specify a Web Dashboard Entity for a group of users; this variable must be defined on a group

l WDWorkspace - to specify a Web Dashboard Workspace for a group of users; this variable must be defined on a group

l WDUserEntity - to specify a Web Dashboard Entity for a specific user; this variable must be defined for a specific user

l WDUserWorkspace - to specify a Web Dashboard Workspace for a specific user; this variable must be defined for a specific user

The value of the variable must contain the name of the Entity or Workspace in Web Dashboard.

These variables are not mandatory. If not specified, the user will be associated with the root or default Entity and it will be associated with the full administrator or the content administrator workspace.

If you define variables on a group and also on one of the group's members, the variables defined on the member will take precedence over the variables defined on the group.

Assign entities and workspaces using PassPortYou can use PassPort to link Users and User Groups to Entities and Workspaces defined in Web Dashboard using the User Properties or the User Group Properties. You must define the properties with values pointing to the Entity or Workspace name.

When you define properties in PassPort, follow the same naming convention as in the Sentinel Web Dashboard Administration:

l WDEntity - to specify an Entity for a user group.

l WDWorkspace - to specify a Workspace for a user group.




l WDUserEntity - to specify an entity for a specific user.

l WDUserWorkspace - to specify a Workspace for a specific user.

If you define properties at the user level and at the user group level, the properties at the user level take precedence.

Once defined, select the corresponding check box in the PassPort GUI to classify the properties as public. This enables Sentinel Web Dashboard to retrieve this information from PassPort.

Expose properties without making them publicIt is recommended that you use public properties.

To expose the properties to Sentinel Web Dashboard without making them public:

1. Set up a special Role and associate it with all your User Groups. This role is necessary to allow the Sentinel Web Dashboard component to retrieve the defined properties from PassPort.

2. Make sure the Role contains the four special privileges, as shown in the following table. These privileges must be created manually.

3. Use a different naming convention when you create properties at the User Group or User level. See the Right operand column in the following table.

4. When you create these four privileges, perform the following for each:

l Use the names in the following below.

l Associate each with the Component Sentinel and the Resource Variable.

l Select the check box near the action VIEW".

l Add an IF condition in the Content Editor tab. Use the is operator and specify the left and right operands, as shown in the following table. For example, for the privilege, Web Dashboard Group Entity Enabler, use WDEntity as the left operand and select the property defined on your User Group for specifying an entity name as the right operand.

Suggested privilege name Left operand(Resource property)

Right operand(Group or user property)

Web Dashboard Group Entity Enabler WDEntity Group level property for specifying Entity name. For example, GroupEntity.




Suggested privilege name Left operand(Resource property)

Right operand(Group or user property)

Web Dashboard Group Workspace Enable WDWorkspace Group level property for specifying Workspace name.For example, GroupWorkspace

.

Web Dashboard User Entity Enabler WDUserEntity User level property for specifying Entity name. For example, UserEntity.

Web Dashboard User Workspace Enabler WDUserWorkspace User level property for specifying Workspace name.For example, UserWorkspace.

Server-side resources and foldersWeb Dashboard allows you to use server-side folders using the Folder object. You can use folders to save different types of documents generated with tasks (see Tasks on page 128) or to upload files for the XML import (see Import and export objects on page 80.)

Create foldersYou can create Folder objects from the main menu, under Administration > Folder. Make sure the directory path associated with the Folder object points to an existing folder on the server-side host. Although the application allows you to create a Folder object pointing to nonexistent path, processes relying on that Folder object will fail.

For example, if you create a periodic Task object to automatically generate reports and, for the target folder, you choose a Folder object that refers to a nonexistent physical folder, your task will fail at execution time.

The following directories referred to by predefined folders are created automatically by Web Dashboard:

<WEBSERVER_HOME>/webapps/SentinelWebDashboard/webdashboard/pub/theme3/img (see Folder object Default Image Path)




<WEBSERVER_HOME>/webapps/SentinelWebDashboard/webdashboard/var/xsl (see Folder object Default XSL Path)

When defining the path for the Folder object (see the field Directory) you can use the variable {WEBDASHBOARD-DIR} to build your path relative to the currently configured base directory on the server side. For example, {WEBDASHBOARD-DIR}/myfolder/foo. If you omit the variable, the path is considered relative to the base directory. For example, a path /myfolder/foo is equivalent to {WEBDASHBOARD-DIR}/myfolder/foo.

The default value of the {WEBDASHBOARD-DIR} parameter is <WEBSERVER_HOME>/webapps/SentinelWebDashboard/webdashboard, where <WEBSERVER_HOME> is the full path of the home directory of the Jetty/Tomcat installation.

The value of the {WEBDASHBOARD-DIR} can be customized in:

l Jetty: the jetty-web.xml file associated with Web Dashboard (<JETTY_HOME>/webapps/SentinelWebDashboard/META-INF/jetty-web.xml) by adding the following entry:

<New class="org.eclipse.jetty.plus.jndi.EnvEntry">

<Arg></Arg>

<Arg>webdashboardBase</Arg>

<Arg type="java.lang.String">C:/myfolder/foo</Arg>

<Arg type="boolean">false</Arg>

</New>

l Tomcat: the context.xml file associated with Web Dashboard (<TOMCAT_HOME>/webapps/SentinelWebDashboard/META-INF/context.xml) by adding the following entry:

<Environment name="webdashboardBase" value="C:/myfolder/foo" type="java.lang.String" override="false"/>

For this change to take effect, you must restart Sentinel Server or, if you are using external Tomcat, restart your Tomcat server. If you personalize the base directory, make sure you manually create the folder referred to on the server-side host.

Note When you define the folder path (see field Directory) you cannot use the ".." notation. Also, you can use personalized fields in the directory path. See Personalized fields on page 148.

Access files from and upload files to foldersYou can access files from folders created on the server or upload new files directly from the Web Dashboard UI. You must add the folder object you have created in the menu and grant the appropriate rights. See the User management > Workspace > Sessions tab. When accessing this object from the menu all the files in the folder will be displayed. This is useful when you want to give web access to different documents, like reports and dashboards.




l Delete or rename -You can delete or rename files directly from the interface. You can also define Read-only access at the workspace level. In this case, you can only visualize the available files; you cannot delete, edit or upload.

l Upload - You can upload new files to be saved on server side. For example, if you want to share a document with other users. When a file is uploaded with the same name as an existing file, you can choose to overwrite it.

In-memory databaseIn-memory databases rely primarily on main memory for storage. They are faster than disk-based databases due to the following:

l In-memory optimization algorithms are simpler and execute fewer CPU instructions.

l Eliminate data access seek time.

l More predictable than more traditional disk-based databases.

However, because in-memory databases store data on volatile memory devices, stored information is lost when the device powers down or is reset.

Web Dashboard enables you to work with in-memory databases using support for the H2 Database Management System. For details, visit www.h2database.com.

This information describes how to create an in-memory database using Web Dashboard and how to populate it with data. When your in-memory database is ready, you can use it as the basis for reports and dashboards, as you would any other type of database.

Because in-memory databases rely on main memory, make sure you have the necessary memory available for Web Dashboard.

Follow these high-level steps to create an in-memory database:

1. Create an H2 in-memory database on page 114—the source of the in-memory database

2. Populate an H2 in-memory database on page 118— populate the in-memory database.

Create an H2 in-memory databaseCreating an H2 in-memory database is a straightforward process: You create a Web Dashboard World object and as soon as you initiate the first connection to the database using that World object, your in-memory database is created. Depending on your settings, your database will exist until the last connection to it is closed (the default behavior,) or as long the Web Dashboard is running.

You create the World object that corresponds to your in-memory database like you would any other World object, except you must select the H2 JDBC driver and modify the URL parameter to indicate that Web Dashboard can create an in-memory database. See Create a world on page 29. Use the following details when you set up a World object.


http://www.h2database.com/



1. To create an in-memory database, use the following values:

Field Name Description

JDBC driver Select the H2 JDBC driver from the drop down.

URL Enter an URL for an in-memory database using the following syntax:

jdbc:h2:mem:<databaseName>

where <databaseName> is the name of the in-memory database you want to create. This URL is for a public in-memory database, which means the database can be accessed using one or more simultaneous connections.Using this basic URL, your database will run until the last connection to it is closed. For example, assume you have created a World object with the URL specifying an in-memory database. You save the object and select the Test connection button in the toolbar. For testing, Web Dashboard will initiate a connection, and because this is the first connection, it will create the database. As soon as the connection is successful, the test is finished, and the connection is closed. Since this is the only connection to the database, when it is closed the database is deleted.To keep the database running for as long as the application runs, you can use the option, DB_CLOSE_DELAY. Use the following syntax:

jdbc:h2:mem:<databaseName>;DB_CLOSE_DELAY=<time>

where <time> is the length of time (in seconds) to keep the database open after the last connection to is was closed. The default value is 0 and will allow the database to close when the last connection is closed. To allow the database to stay open indefinitely, specify value of -1. For example, to set up a database called test that will stay open when the last connection is closed, use the following URL:

jdbc:h2:mem:test;DB_CLOSE_DELAY=-1

For a detailed list of options see www.h2database.com

User name and Password

Specify the user name and password required to log in to the database.





2. Create a data dictionary using the procedure provided in Build a data dictionary on page 33. Creating a source data dictionary allows you select a subset of the database defined in the source world.

a. On the Description tab, use the following values:


Name and Description

Provide a name and description of the data dictionary you will use as the source of data for your in-memory database. Note that the value you provide for the Description field is displayed when the data dictionary is included in a list.

Type Select SQL.This indicates you want to use a SQL query to retrieve data from your source world. You enter the SQL query statement on the SQL Query tab.

World Select the source world that was created.

b. On the SQL Query tab, enter an SQL statement that will choose the data with which you want to populate your in-memory database. You can write this statement to select any or all of the data in your source world. For example, you could select some combination of data from multiple tables in your source world as an aggregate.


Create a persistent H2 databaseTo create a persistent H2 database you have to set up a World object to enable the connection to the database. See Create a world on page 29 for procedural information and use the following details setting up a World object.

Field Name

Description

JDBC driver

Select the H2 JDBC driver from the drop down.




Field Name

Description

URL Enter an URL for an in-memory database using the following syntax:

jdbc:h2:[file:]<path><databaseName>

The prefix file is optional. If you use no path or only a relative path, then the current working directory is used as a starting point. The case sensitivity of the path and database name depend on the operating system. However, it is recommended that you use lowercase letters only. The database name must be at least three characters long. To point to the user home directory, use ~/, as in: jdbc:h2:~/test.In order to have the same performance as with the in-memory database, you can set up a cache size. This setting can be appended to the database URL:

jdbc:h2:test;CACHE_SIZE=8192

This option sets the size of the cache in KB for the current database. The default value is 16384 (16 MB). The value is rounded to the next higher power of two. Depending on the virtual machine, the actual memory required may be higher.This setting is persistent and affects all connections, as there is only one cache per database. This setting only affects the database engine (the server in a client/server environment). It has no effect on in-memory databases.For a detailed list of options, see www.h2database.com.

User name and Password

Specify the user name and password required to log in to the database.

Create a data dictionary Creating a source data dictionary allows you select a subset of the database defined in the source world. Create a data dictionary using the procedure provided in Build a data dictionary on page 33, and use the following details.





1. On the Description tab, use the following values:



Provide a name and description of the data dictionary you will use as the source of data for your in-memory database.

Note The value you provide for the Description field is displayed when the data dictionary is included in a list.

Type Select SQL.This indicates you want to use a SQL query to retrieve data from your source world. You enter the SQL query statement on the SQL Query tab.

World Select the source world you created above.

2. On the SQL Query tab, enter an SQL statement that will select the data with which you want to populate your in-memory database. You can write this statement to select any or all of the data in your source world. For example, you could select some combination of data from multiple tables in your source world as an aggregate.


Populate an H2 in-memory databaseWeb Dashboard enables you to populate in-memory databases using the Task object. This object will use a Data Dictionary to fetch data from a source database identified by a World, and will populate the target in-memory database.

At this point, you have three objects defined:

l source World

l source Data dictionary

l target World (pointing at your in-memory database)

Next, create a Task object to populate your target database with the data from the source database. You must create a Task Group first, as every Task must belong to a Task Group. Task Groups are logical objects grouping Tasks.

Create a task to populate in-memory database To use a task to take data from your source World, create a table in your destination World, and put the data in the table.

1. On the Main menu, click Task > Task. A list of existing tasks displays.

2. Click the Add button to create a new task. A new document opens and the Description tab displays.

3. Specify values for these fields on the Description tab:






Provide a name and description of the task you will use to populate your in-memory database. Note that the value you provide for the Description field is displayed when the task is included in a list.

Task Type Select Datamart.This type of task reads data from a source, applies a transformation if necessary, and then stores the result at a specified destination. You specify a source and destination on the Execution tab.

Task Group Specify a task group you want your new task to be associated with.

Start date and End date

Specify a date range during which you want your task to be executed. If you do not enter values for these fields, Sentinel Web Dashboard will execute the task indefinitely.

Frequency Specify how often you want your task to be executed. You can specify Frequency in terms of minutes, hours, days, weeks, or months.

CRON expression

(Optional) Enter a CRON expression to indicate when the task should be executed.

4. Click the Execution tab and specify values for the following fields.


Source Select Query. This will enable you to select the SQL-type Data Dictionary you created earlier in this process.

Transformation Select None.

Destination Select Table. This indicates that the output from this task will be a table. You will provide more specific information about the destination table on the Settings tab.

5. Click the Settings tab and specify values for the following fields:


Source - SQL Query

Select the name of the source data dictionary you defined above. As this data dictionary is SQL-based , the query used to define this data dictionary will also be used to retrieve data from your source world.

Transformation None is displayed as you did not choose to perform any transformation in the Execution tab.





Destination - World

Select the destination world you defined above. This world is defined as an in-memory database.

Destination - Table

Enter the name of the table you want to populate with data from your source world. This table will reside in the destination world.

Insert type Select Insert.This is the operation Sentinel Web Dashboard will use to populate your destination table.

Clear first Select this check box to ensure that if the table you specified above already exists, it will be cleared of data before this task populates it as the destination table.

Create table if needed

Select this check box to ensure that if the table does not exist, it will be created before Sentinel Web Dashboard attempts to populate it.


Execute the taskUse the Task Manager to execute the task to create the in-memory database.

1. Go to Task >Task Manager.

2. Click the Stop button to stop all tasks.

3. Click the Refresh button. The new task group and tasks are displayed.

4. Click the Start button to restart the tasks.

5. While the tasks are executing, you can click the Refresh button and mouse over your task to see its status.

6. When task is finished, check the My Documents folder for your new table.

When your table is successfully created, you can access it using a report.

Snapshot mode for reports and dashboardsIn addition to the default interactive execution mode, reports and dashboards can be run in snapshot mode. A snapshot can display a dashboard or a report based on a large amount of data in just a few seconds. In snapshot mode, Web Dashboard records a history of the data in a Report or Dashboard at set intervals. A typical use case would be to display a dashboard every morning based on the data loaded during the night.




You can use a specific Task to generate the snapshot Report or Dashboard, which is persisted in form of an XML file. When a snapshot report or dashboard is displayed, the data is read from the XML.

1. Make sure you have a database connection and a data dictionary. See Create a world on page 29 and Build a data dictionary on page 33

2. Define a report or dashboard. See Set up reports on page 45 or Create a Web Dashboard on page 90.

3. Set the execution mode to Snapshot. The procedure is the same for reports and dashboards.

a. Go to the Description tab on the Report or Dashboard design page.

b. Expand the More details section.

c. Set Execution mode to Snapshot.

4. Click the Document generation task button in the upper right corner of the screen.

A Task screen opens and a task of type Document Generation is created.

5. In the Task screen, specify a Frequency in the Description tab. This is the frequency with which the database will be queried.

6. If the Execution to be kept box is selected in the Settings tab, any generated documents older than the specified time will be deleted the next time the task is performed.

7. If a Report or Dashboard contains filters, you can specify which filter combinations to use when the document is generated.

8. After saving the modification on the Task, you might need to stop Task Manager, refresh it and start it again so your Tasks to be executed as scheduled.

In order to have a Snapshot available on many Workspaces, the Task should be executed after defining the Workspaces.

Monitor reports and send notifications (controls)

A control is a task that monitors the values of a data field in a report and notifies you if and when those values reach thresholds you specify. Severity ratings can be associated with thresholds in order to determine the highest severity value reached. The severity can be determined on a per-user basis based on the contextualization of the World and the Data set used, as well as any thresholds customized at user level.

The access rights of controls are set at Workspace level. A control task is executed at a set frequency by the task manager.

You can:

l Create a control on page 122

l Execute controls on page 125




l Create a control group on page 127

l Use the control panel on page 127

Create a controlTo create a control object:

1. Go to Menu> Control > Control. A list of existing controls is displayed.

2. Click on the Add button to create a new Control. A new document opens and the Description tab displays.

3. Enter values for the following fields:

Field Description

Name A unique identifier for the Control object.

Description A user-friendly label for your Control that is displayed across the GUI. The description can be internationalized (translated into the language defined for each user) using the Internationalization tab.

Report The report on which to monitor the values of a data field. The email is sent based on these values. This report can also be attached to the email in PDF or Excel format.

Field Name The name of the field in the report used as the condition for triggering the email. This must be a numeric field.

Entity Owning entity (see User access managment on page 102), a container with which the Control is associated. This choice will impact the access rights for this Control.

Thresholds Choose a type of threshold with a certain color code by clicking the threshold icon. The different colors are associated with different types of messages: green for information, yellow for warning, and red for alert. The horizontal lines on the colored arrow represent the thresholds for which you can specify values in the associated text fields to the right of the arrow.

Comments Add a comment to the control. This comment is visible to users of the control.

Remove information lines

If this option is checked, the information lines from the threshold (the values that in the green interval) are removed from the report, whether exported in PDF or Excel format.




Field Description

Version The version number of the Control object. Sentinel Web Dashboard increments this number when the object is saved. This value is used during XML export and import. See Import and export objects on page 80.

4. Click the Schedule tab.

5. Specify whether the task associated with the control execution is a Master task or a Child task.

l Master task- has an execution defined (CRON or frequency).

l Child task - The execution of a Child task depends on another task. In the task manager, the Child task is displayed under the Master task.

For a Child task, two fields must be completed:

o Parent task: The reference task

o Run when: Use the selection list to choose the execution condition from the following:

n Parent Task OK

n Parent Task Ok/Warning

n Parent Task Ok/Warning/Error

n Parent Task Warning

n Parent Task Warning/Error

n Parent Task Error

6. Fill in the fields to establish a schedule for when the control is executed.

Field Description

Task group

Select a task group for this Control object. If you do not have one, you can create one in the Task group section in Main menu > Task.

Cron expression

Use a standard cron expression to specify the schedule for this Control. Cron is an operating system utility used to execute commands at scheduled times. For example, the cron expression can be0 30 1 * * ? and it means launch at 1h30 every day.Available for a master task only.

Time zone Select the time zone for the Start date and End date fields.

Start date and End date

The start date and end date for the execution of this Control. Available for a master task only.




Field Description

Frequency and Time unit

The periodicity and the unit of measure for the execution of this Control. This is an alternative to the Cron expression. One of the following time units can be associated to the frequency: day, hour, minute, month, week.Available for a master task only.

7. Select the Message tab and compose the message to be sent. Specify the users to receive the message. Specify values for the following fields:

Field Description

Send to users with access to this control

If you check this option, then all the users with access to this Control will receive the message.

Send to additional users

Select specific message recipients out of the Web Dashboard existing users.

Send to additional email addresses

Use this option in order to send emails to addresses that do not correspond to Web Dashboard users. Once you check this, two other fields will get enabled and you will need to:

l add the email addresses in the "Additional email addresses (separated by new line)" box

l select a Message Type. This is mandatory, as the message type object is keeping all the message provider information.

Note This option is available starting with 4.2.0 Service Pack 9.

Subject Displays as the subject of your email or SMS. This information can be contextualized. For details, see the following field, Message.

Message The body of the email or SMS. This information can be contextualized when you:

l Create personalized fields for system information. The value of a personalized field, or default value (if the value is not set), should be the desired system variable (for example, {s:now}). See Sentinel Web Dashboard User Guide, Advanced Setup for a list of the system variables.

l Add each personalized field in the body of the email. Choose it from the drop list found to the right of the Message box or type it ({p:pers_field_name}).

Attachment Specify whether you want to have the the Report selected in Description tab attached to the email as PDF or Excel file.




Field Description

Attachment name

The custom name of the attachment. If nothing is written in this edit-box, the default name will be used: <report name><timestamp>.<type of the file>.This information can be contextualized. For details, see the Message field.

Note This field is available starting with 4.2.0 Service Pack 8.

Message sending policy

Use this matrix to set the conditions under which your message will be sent. If you select a check box, your message will be sent if that condition is met. Each condition evaluates both the initial and the final state of the report. If you do not select any check boxes, no message will be sent. If you select all the check boxes, a message will be sent each time the Control is executed.

8. Optionally, go to the Internationalization tab and specify an international value for the object description, message subject and message body. The values you specify here will be used throughout the GUI.

9. Select the Save button to save your object.

Execute controlsAfter configuring your control object, you are ready to send and receive messages.

But firstly, if you choose to send the messages to all users who have access to your control object, add the control to the desired workspace (User management > Workspace > Controls tab). If you choose to send the message to individual users, there is no need to add the control to any workspace.

Create a Message Type To create a new message type object:

1. From the Main menu, select Administration > Message type.

2. Select the Add button to display the Description tab on the New message type page.

3. Fill in the Name and Description of the object. The description you provide will be used to identify this object throughout GUI and can be internationalized.

4. Select your Message Provider, choosing between several email and SMS options.

5. Depending on the selected message provider, you will have other fields to fill in. For instance, if




you chose email, you should provide the following information:

Field Description

Smtp Host The hostname of the SMTP server you want to use to send emails.

Smtp Port The port of the SMTP server you want to use to send emails. This field is optional. If a value isn't specified or it is not a valid port number, then the default SMTP port, 25, will be used.

Note This field is available starting with Service Pack 10.

From Address

The email address of the sender.

URL The URL to access the application.

Username and Password

The credentials used to authenticate to the SMTP server.These fields are displayed only if you have chosen a message provider that uses authentication.

SSL Indicate whether to use SSL when communicating with the SMTP server using authentication. Specify one of the following:

l 1 – enable SSL

l 0 – disable SSL

6. Click the Save icon to save your message type object.

Configure users to receive emailsDepending on the employed access manager, do the following:

l If users are listed in Web Dashboard, then they must be manually configured. This happens when the access manager is Sentinel Administration or user exit, but also when Passport is used and the property webdashboard.access.management=webdashboard is present in sentinel.properties.

o From the Main menu, select User management > User. A list of available users displays.

o Double-click the user you want to configure to receive your emails. The Description tab displays.

o Go to the bottom of the page and select the check box that corresponds to the message type object you created.

o In the value field associated with the check box you selected, enter the email address or phone number you want to use for this user.

o Make sure the Allow messaging access check box is selected.

o Select the Save icon .

o Repeat these steps for each that will receive emailed reports.




l If in Web Dashboard no users are listed under User management, it means that email addresses and phone numbers are automatically retrieved from PassPort and used to send mail or SMS notifications. Note that phone numbers cannot be retrieved for users in case PassPort is retrieving users from LDAP.

Note A message type will still be used for sending emails, but it cannot be configured: it will always be the first from the message type list.

Execute the control in Task ManagerIn order for the control to get executed according to its scheduling, make sure your Task Manager is started.

Create a control groupA control group can be used to group controls together in a folder. This organizational tool is not dependent on any access right.

1. On the Main menu, click Administration > Control group. A list of existing controls displays.

2. Click the Add button to create a new control group. A new document opens and the Description tab displays.

3. On the Description tab, enter a Name and a Description for the object to be created.

The new Control group will be available on the user's Workspace (User management > Workspace > Controls tab) where you can add the Controls you want to execute.

Use the control panelThe Control panel allows you to view the alert levels of all the controls. An alert summary is displayed for the various control groups.

1. Go to Dashboard design > Control panel.

The control panel displays a list of controls in the current group.

2. Double-click the name a control to display the Control detail window. Alternatively, right-click the name of the control and select Properties from the pop-up menu.

The Control detail window displays the alert level and the threshold values for the control.

3. Right-click the name of a control to display the pop-up menu and select one of the following options:

l Properties – displays the alert level and the threshold values for the control.

l Report Name – displays the report on which the control is based. You can perform various procedures on the report. See Set up reports on page 45.




l Customize – displays the Customize this control window. Change values for thresholds and click OK.

l Delete customization – deletes the last customization.

TasksA task is an object that facilitates multiple scheduled actions. For example, data import, document generation, and script execution. The following types of tasks available:

l Datamart

l Script

l Export Settings

l Generate XSL-FO document

l Generate image

l Generate document

l Export document

A task group is a tool only visible to administrators that allow you to organize tasks. It allows you to enable and disable task execution on a global basis.

You can use the Task Manager to sequence your tasks.

Create a task groupBefore you define a task, you should create a task group where your task will be associated:

1. On the Main menu, click Task > Task group.

A list of existing task groups displays.

2. Select the Add button to create a new Task group.

A new document opens and the Description tab displays.




3. On the Description tab, enter values for the following fields:

Field Description

Name A unique identifier for the task group.

Description A user-friendly label for your Task group that is displayed across the GUI. The description can be internationalized (translated into the language defined for each user) using the Internationalization tab

Active Indicates if the tasks in the task group are present and have been executed in the task manager.

4. Click Save.

Create a taskThe general steps necessary to create a task are the same for all types of tasks. The information you must provide for each type of task is different for each type. This section covers the general steps. The information required for each type of task is provided in its own section.

1. On the Main menu, click Task > Task.

A list of existing tasks displays.

2. Click the Add button to create a new Task.



Field Description

Name A unique identifier for the task.

Description A user-friendly label for your Task that is displayed across the GUI. The description can be internationalized (translated into the language defined for each user) using Internationalization tab




Field Description

Task Type Choose the type of the task. The task you choose determines which other tabs displayed as well as the fields on displayed on those tabs. The following task types are available:

l Datamart – Reads data from a source (XML, CSV, SQL query, etc), applies a transformation, if necessary, and stores the result at a specified destination (table, XML,CSV, etc). See Datamart task on page 133.

l Script – Enables you to execute a script. See Script task on page 137.

l Import Settings – Uses an XML file to automate the process of reconfiguring Web Dashboard.

l Export Settings – Generates an XML file containing all the objects that, together, form the Web Dashboard setup. Export settings task on page 138.

l Generate XSL-FO document – Parses XML code and format all types of document. See Generate XSL-FO document task on page 139.

l Generate image – Generates the desired types of image in the following formats: PNG file, JPG file, SVG file, GIF. See Generate image task on page 143.

l Generate document – Generates a PDF documents for a Report or Dashboard identical to those obtained by a PDF export. See Generate document task on page 145.

l Export document – Generates snapshot reports and dashboards. See Export document task on page 146.

Entity Owning Entity, a container to which the Data dictionary is associated. This filed is available only for the "Document export" type of task.

Version Version number of the object. Sentinel Web Dashboard increments this number when the object is saved. Sentinel Web Dashboard increments the correction number when the object is saved. You can also manually set a custom version, using the following format: dd.dd.ddd, where d represents a digit.This version number is used during XML export/import.

Master task

A Master task has an execution defined by a CRON job or a specified frequency) .




Field Description

Child task The execution of a Child task depends on another task. In the task manager, the Child task is displayed under the Master task. For a Child task, two fields must be completed:

l Parent task: The reference task

l Run when: Use the selection list to choose the execution condition from the following:

o Parent Task OK

o Parent Task Ok/Warning

o Parent Task Ok/Warning/Error

o Parent Task Warning

o Parent Task Warning/Error

o Parent Task Error

Task group Choose a group to associate the task.

Start date The date and hour when a master task will start.

End date The date and hour when a master task will end.

Frequency The frequency of task execution in one of the following time units: day, hour, minute, month, week.

Cron expression

Enter the Cron expression in the field and choose the time zone from the drop down list For example, the cron expression can be 0 30 1 * * ? and it means launch at 1h30 every day.

4. Specify values for the following fields on the Execution tab for all task types:

Field Description

Single execution

If a task is executed on a one-time basis, the default values of any personalized fields are used to resolve the directory/file name and the destination base. This means that only one task will be executed, for a single base.

Multiple execution on all entities

Personalized fields are resolved consecutively for all entities. It may be possible to execute a different task with an alternative base for each entity.




Field Description

Multiple execution on entities where

Personalized fields are resolved for entities that match the specified criteria.

Condition Condition applied on entities. This option is available only for the Multiple execution on entities where field.

5. Provide values required on other tabs based on the task type. See the following topics for more information about information require for each task type:

l Datamart task on page 133

l Script task on page 137

l Export settings task on page 138

l Generate XSL-FO document task on page 139

l Generate image task on page 143

l Generate document task on page 145

l Export document task on page 146

About the Task ManagerThe Task Manager is a task sequencer dedicated to Sentinel Web Dashboard. It works the same for all types of task.

Select a task and assign it to a task group. Tasks can either be performed according to time-based criteria or in connection with parent task.

1. On the Main menu, click Task > Task manager.

A list of existing tasks belonging to active groups displays.

2. Perform any of the following actions:

Action Description

Refresh Updates all information related to task, for example, date, period, and status. If the Task Manager is stopped when you click Refresh, newly created tasks are displayed.

Execute tasks

Activates all the tasks in the Task Manager.

Stop Stops the Task Manager. This allows you to add new tasks. This action will not interrupt the task processes.




Datamart taskA datamart task reads data from a source (XML, CSV, SQL query, etc), applies a transformation, if necessary, and then stores the result at a specified destination (table, XML,CSV, etc).

Execution tabSpecify values for the following fields on the Execution tab:

Field Description

Source Choose from the following:

l XML

l CSV

l SQL data set

l standard log file

l Excel file

Transformation The XSL transformation performs the conversion from one format to the other

Destination Choose from the following:

l a table

l an XML file

l a CSV file

l an Excel file

Settings tabThere are three sections on the Settings tab: Source, Transformation, and Destination. The fields available in each of these sections depend on the source and destination you choose on the Execution tab.




Section Type of source/destination

Field and Description

Source XML file l Directory: The location of the file. The directory must be created in Administration > Folder.

l File: The name of the source file included in the Directory specified above. The file can have personalized fields.

l Delete after import: The file is deleted after the task ends.

CSV file l Directory: The location of the file. The directory must be created in Administration > Folder.


l Encoding: List of character encodings.

l Import the file: Choose from the following

o From the beginning

o From the line

o To the end

o To the line

l Separation character: The separation character used in the CSV file.

l Text delimiter: The delimiter text used in the CSV file.


Query SQL query: SQL type of dataset.






Std Log file l Directory: The location of the file. The directory must be created in Administration > Folder.




Excel file l Directory: The location of the file. The directory must be created in Administration > Folder.



Transformation l None : no transformation available

l Directory: The location of the file. The directory must be created in Administration > Folder.

l XSL File: The XSL file that facilitates the conversion from one format to the other.






Destination Table l World: The database connection where the table will be created or updated.

l Table: The name of the table to be populated with the source data.

l Catalog: The name of the database catalog.

l Schema: The name of the database schema.

l Insert type: Choose from Update-Insert, Insert, and Replace.

l Clear first: If this option is checked, the table is emptied before inserting the new data.

l Create table if needed: The table is created if it does not exist.

l Delete type : Choose from Delete and Truncate.

l Commit type: Choose from Line by line(Auto commit), Global commit, and Number of lines before a commit.

l Batch execution: Choose from Deactivated, Global batch, and Number of lines in a batch.

XML file l Directory: The location of the file. The directory must be created in Administration > Folder.







CSV file l Directory: The location of the file. The directory must be created in Administration > Folder.



l Import the file: Choose from the following:


o From the line

o To the end

o To the line


l Export the headings: The headers from the CSV file are also exported.

Excel file Directory: The location of the file. The directory must be created in Administration > Folder.File: The name of the source file included in the Directory specified above. The file can have personalized fields.

Script taskA script task executes a script. When you choose a script task, neither the Execution tab or the Settings tab is displayed. Instead, only the Script tab is displayed. The system locates the script to be executed by the supplied file name and directory. The destination base is the one to which the World object points.

Enter values for the following fields:

Field Description

Directory The location of the file. The directory must be created in Administration > Folder.

File The name of the source file included in the Directory specified above. The file can have personalized fields.




Field Description

World The database connection used to access data.

On error Choose what happens when an error occurs: interrupt script execution or allow it to continue.

Show SQL

The task execution trace log can include the executed SQL query either systematically or in the event of an error only, depending on the parameter set in the "Show SQL" list box

Export settings taskThe export settings task generates an XML file containing all the objects that together form the Web Dashboard setup. You can use this type of task to synchronize two Web Dashboard repositories or to synchronize user accounts.


Field Description

Source The only available value is Param.

Transformation The XSL transformation performs the conversion from one format to the other.

Destination The only available value is XML file.

Settings tabThere are three sections on the Settings tab: Source, Transformation, and Destination. Specify values for the following fields:



Source Param Refers to database settings.






Transformation l None: no transformation available.

l Directory: The location of the file. The directory must be created in Administration > Folder. See Server-side resources and folders on page 112.


Destination XML file l Directory: The location of the file. The directory must be created in Administration > Folder. See Server-side resources and folders on page 112.

l File: The name of the source file included in the specified directory. The file can have personalized fields.

Generate XSL-FO document taskThe generate XSL-FO document generation task parses XML code and formats all types of document.


Field Description


l XML

l CSV

l Query

l Std Log file

l Param



l an XML file

l a PDF file




Settings tabThere are three sections on the Settings tab: Source, Transformation, and Destination. The fields available in each of these sections depend on the source and destination you choose on the Execution tab:






Source Query SQL query: SQL type of dataset.

XML file l Directory: The location of the file. The directory must be created in Administration > Folder. See Server-side resources and folders on page 112.


l Delete after import: Select to delete the file after the task is ended.

CSV file l Directory: The location of the file. The directory must be created in Administration > Folder. See Server-side resources and folders on page 112.





o From the line

o To the end

o To the line


l Text delimiter: The delimiter text used in the CSV.







Std Log File l Directory: The location of the file. The directory must be created in Administration > Folder. See Server-side resources and folders on page 112.




Param Refers to database settings.

Transformation l None: no transformation available.



Destination XML file l Directory: The location of the file. The directory must be created in Administration > Folder. See Server-side resources and folders on page 112.


PDF file l Directory: The location of the file. The directory must be created in Administration > Folder. See Server-side resources and folders on page 112.





Generate image taskA generate image task generates images in the following formats: PNG File, JPG File, SVG File, GIF. To enable the generation of an image you can use a SVG file as source or an XSL transformation.

Execution tabSpecify values for the following fields on the Execution tab.

Field Description


l XML

l CSV

l Query

l Std Log file

l Param



l PNG file

l JPG file

l SVG file

l GIF file

Settings tabThere are three sections on the Settings tab: Source, Transformation, and Destination. The fields available in each of these sections depend on the source and destination you choose on the Execution tab.






Source XML file l Directory: The location of the file. The directory must be created in Administration > Folder. See Server-side resources and folders on page 112.



CSV file l Directory: The location of the file. The directory must be created in Administration > Folder. See Server-side resources and folders on page 112.





o From the line

o To the end

o To the line


l Text delimiter: The delimiter text used in the CSV file.


Query SQL query: SQL type of dataset.






Std Log file l Directory: The location of the file. The directory must be created in Administration > Folder. See Server-side resources and folders on page 112.




Param Refers to database settings.

Transformation l None: no transformation available



Destination PNG file, JPF file, SVG file, GIF file



Generate document taskA generate document task automates creation of PDF documents for a report or dashboard identical to those generated by a PDF export.

Settings tabThere are three sections on the Settings tab: Source, Transformation, and Destination. The fields available in each of these sections depend on the source and destination you choose on the Execution tab:




Section Field and Description

Source A Report or a Dashboard.

Destination l Directory: The location of the file. The directory must be created in Administration > Folder. See Server-side resources and folders on page 112.


Export document taskThe export document task generates snapshot reports and dashboards. This task logs a history of the data in a report or dashboard at set intervals.

The document data is stored in XML format in the database. When you display a static document, the data from the time the task was run is read from the database.

For additional details on this type of task, see Snapshot mode for reports and dashboards on page 120.

Dynamic linksA dynamic link allows the navigation between a report and another report, a dashboard, or an external session. When you create a dynamic link, you select an object to which the dynamic link gives you access. This object is called the destination. When you specify a destination, you can configure it with certain parameters of the source report, for example, setting a filter value, or specifying which report elements are visible or hidden.

You can set up more than one dynamic link for the same field in a report. However, when only one dynamic link is defined for a particular field, clicking on the link either opens a pop-up or displays the target object directly, depending on how the dynamic link is configured.

If you include a dynamic link in a dashboard, you can configure the block in which you want to execute the dynamic link object. See Create a Web Dashboard on page 90.

Create a dynamic linkTo create a dynamic link:

1. On the Main menu, select Dashboard design >Dynamic link.

A list of existing dynamic links displays.

2. Click the Add button to create a new Dynamic link. A new document opens and the




Description tab displays


Field Description

Name A unique identifier for the dynamic link object.

Description A user-friendly label for your dynamic link displayed across the GUI. The description can be internationalized (translated into the language defined for each user) using Internationalization tab. See Internationalize Web Dashboard on page 201.

Sort order When many links are displayed on a column, you can set up a sort order to be applied in the pop-up menu. For example, if you have two links named A and B, enter -1 in the Sort order field of the link A so that the order will be B A. For no predefined order, enter 0, and sort order will be ascending.

Entity Owning entity (see User access managment on page 102). A container with which the dynamic link is associated. This will impact the access rights for this dynamic link.

From report

The source Report where the dynamic link will be applied.

Destination type

Three destination types are available: Report, Dashboard, External session. The destination is the object to which the dynamic link provides access.

Destination session

The destination object depending on the destination type chosen above.

Dynamic link preview

When this option is checked a preview of the dynamic link will be available when executing the Dashboard. This option is enabled only for a Report destination type.

Open destination in new window

If you choose this option the destination object will be opened in a new window. This option is enabled only for an External session destination type.

Open in pop-up

This check box becomes active when the destination type is set to Forms and has effect on how the target form will be displayed. It can be displayed inline or it can be displayed as a pop-up.




Field Description

Refresh on validation

This option is enabled when the following two conditions are met:

l The dynamic link is configured between a report and a form object.

l The “Open in pop-up” option is checked (in the dynamic link Description tab).

When executing the dynamic link and this option is checked, after executing the link, the source report page is automatically refreshed.

Version Version number of the object. Sentinel Web Dashboard increments this number when the object is saved. Sentinel Web Dashboard increments the correction number when the object is saved. This version number is used during XML export and import. See Import and export objects on page 80.

When multiple links are defined for the same column in the source report, the links will be displayed in ascending order of classification.

4. Go to the Properties tab to establish where to access the dynamic link in the specified report.

In the Hypertext link on, select the field where you want the link to display.

A dynamic link will be set for the column specified in this screen when the source report configured in the first tab is displayed. Before the dynamic link is displayed the system checks that the user has the necessary rights to the destination at Workspace level.

Certain information may be sent when the user navigates away from the source report:

l A value from the data row (standard table)

l A value from the data column (standard table)

l A value from the data column (cross table)

l A value from the filter applied to the source report

This data is submitted to any filters specified for the destination.

Personalized fieldsFor dashboards to be truly powerful, they need to deliver meaningful information for each targeted group of users in the same graphical representation. Data segregation according to different groups of users presented in the same dashboard can be obtained in Web Dashboard using personalized fields.

A personalized field is a variable, the value of which is determined when the user logs in. Personalized fields can be associated directly with users or with groups of users. See User access managment on page 102.

When you personalized a field in a Web Dashboard object (for example, a World, Data dictionary, Folder, External component, and so on) the object is said to be contextualized.




Use case for personalized fieldsConsider a use case where Sentinel is used to monitor file transfers with external partners for two departments in a company: Sales and Marketing. Both departments are coordinated by one Manager.

The users from the Sales department require access to transfers made between partners and their department. The users from the Marketing department want to access their own transactions.

The Manager has access to all data.

Web Dashboard can provide access to the correct data for all users and the Manager while defining only one report. The desired result is achieved by contextualizing the data dictionary with the usage of personalized fields.

The personalized field can be applied to the user, the entity or the workspace, depending on this parameter.

The actual value assigned to the personalized field will be determined when the user logs in.

To implement personalized fields for this use case scenario:

1. Create a personalized field named business-unit. See Create Personalized fields on page 149.

2. Create a parent entity named Manager. Create a child entity for each department (Sales and Marketing), with Manager as the parent entity and assign the appropriate code to the business-unit personalized field.

3. Define three users : Admin, Sales, and Marketing. Each of these users has access to different data. To accomplish this, each user is associated to a separate Entity. For more details about how to define users and entities, see User access managment on page 102.

4. Define a database connection. See Create a world on page 29.

5. Create a data dictionary and add a Context field (see Add context field to a Data dictionary on page 150) to it by associating the data dictionary with the business-unit personalized field. See Build a data dictionary on page 33.

6. Design a report. Associate to it the parent entity. The actual value assigned to the personalized field will be determined when the user logs in.

Create Personalized fields To create personalized fields:

1. On the Main menu, click User management > Personalized field.

A list of existing personalized fields displays.

2. Click the New document button to create a new Personalized field. A new document opens and the Description tab displays.





Field Description

Name A unique identifier for the Personalized field object.

Description A friendly label of your Personalized field to be displayed across the GUI. The description can be internationalized (translated into the language defined for each user) using Internationalization tab.

Parameters A personalized field can be configured at various levels:

l User

l Workspace

l User, workspace

l Workspace, user

l Entity

Data type The data type of the personalized field's values. Valid data types include String, Numeric, Date, Time and DateTime.

Default value

The implicit value of the personalized filed. A default value is not mandatory.

Storage There are three types of storage: Standard, Raw and Encrypted. The radio buttons are enabled only if the data type of the personalized field is string.

l Standard: Basic use of the value. The value will be modified by the application at SQL level. For example, personalized fields on string values are delimited by double quotation marks.

l Raw: The value of the field will not be modified in the SQL query.

l Encrypted: The value of the personalized field is not displayed in clear. This can be used as a contextualized password when defining a World.

Add context field to a Data dictionaryTo add context fields to a data dictionary:

1. On the Main menu, click Data management > Data dictionary.

2. Create or edit a Standard or Multi-dictionary data dictionary.

For SQL data dictionaries you have to include the personalized filed directly in the query in a where clause. See the example below.

For more details about how to create data dictionaries, see Build a data dictionary on page 33.

3. In the Data structure tab add one or more tables.




4. Click the header of a table to display a pop-up menu and select the Add context field option.

5. In the Add context field window, click the Add button to add a line to the list of context fields.

6. Select values from the drop downs for the following items.

Field Description

Field name Select the name of the field you want to use for contextualization.

Operator Select the operator you want to use to compare the values of the field you selected above with the value of the personalized field.

Personalized field

Select from the list of personalized fields defined in Web Dashboard.

7. Optionally, create another line to add a context field. Click the Add button to create another line in the list of context fields and select values.

8. Optionally, delete a context field. Click the Delete button next to a context field to delete it.

9. When you are finished working with context fields, click OK.

Additional example The following example provides information about using personalized fields for both a standard data dictionary and a SQL data dictionary.

In this example, you have three user groups (User Group A, User Group B, and User Group C) associated with three separate entities (Entity A, Entity B, and Entity C.)

There is a personalized field attached to these entities called customerlist.

l User Group A can see data related to customers: BLACK_INC and WHITE_INC

l User Group B can see data related to customers: RED_INC and BLUE_INC

l User Group C can see all data: BLACK_INC, WHITE_INC, RED_INC, BLUE_INC, and others

Set up a standard data dictionaryFor a standard data dictionary, you set up a data-level filter and put a condition on the customerid={p:customerlist}

where customerid is the column in the data dictionary containing the names of the companies, BLACK_INC, WHITE_INC, RED_INC, and BLUE_INC.

Define the value of the personalized field, cusomterlist, as follows:

l Entity A: customerlist=BLACK_INC|WHITE_INC

l Entity B: customerlist=RED_INC|BLUE_INC




l Entity C: customerlist=*

Set up a SQL data dictionaryIn this case there are many possibilities and it is recommend the usage of “like” or “regexp” in the query. Below is an example of a MySQL query:

select * from mytable where customerid regexp {p:customerlist}

Define the value of the personalized field as follows:

l Entity A: customerlist=BLACK_INC|WHITE_INC

l Entity B: customerlist=RED_INC|BLUE_INC

l Entity C: customerlist=.+|.?

MapsSentinel Web Dashboard allows you to build Map reports that provide an extensive list of predefined maps. Also, it is possible to add custom maps to the list of predefined maps.

Predefined maps are delivered in the folder:

SentinelWebDashboard/webdashboard/var/map/default

The content of this folder should not be modified, as this is managed by the application. Custom maps can be created in the folder:

SentinelWebDashboard/webdashboard/var/map/custom

The following steps are used to add custom maps to your system:

1. Create a map on page 152

2. Deploy the map on page 153

3. Create a mapping file containing area labels on page 153

4. Register the map in definition.xml on page 153

Create a mapCreate a map in the form of a SVG file. SVG maps are available online or you can build them from scratch using various tools, for example InkScape, a free open-source software (https://inkscape.org/). The following elements are important in the SVG file:


https://inkscape.org/



Height and widthUse various tool (for example, InkScape) to identify or to adjust the size of your map. The SVG file can also be edited in a plain text file editor. In this case, the height and width are specified as attributes of the <svg> XML element. The following is a sample from an SVG file:

01.<svg width="600" height="400" viewBox="0 0 550.00001 600.000001" id="svg3345" version="1.1">

Path identifierSVG files contain so called "paths", and each path is identified by an ID. This ID is essential as it will be used later in different configuration files. If opened in a text editor, path are identified by <path> XML elements. See below a fragment of an SVG file containing a path definition with an ID.

01.<path id="RO-CV" d="...

Deploy the mapIt is recommended to create a specific folder in the directory destined for custom maps. Copy the SVG file there. The following is an example of a map called myfirstmap.svg:

SentinelWebDashboard/webdashboard/var/map/custom/myfirstmap/myfirstmap.svg

Create a mapping file containing area labelsFor a map, each area code must be associated with a label. This is done with an XML file that is created manually. The following example shows two area codes mapped to human readable labels. These labels are displayed in the Graphical User Interface (GUI).

Register the map in definition.xmlAny custom map must be registered in a file named definition.xml situated in the folder

SentinelWebDashboard/var/map/custom

By default, there is no definition.xml file and it must be created manually. Each time a new map is added into the system, it must be registered in this file. The example displays two registered maps:




The following elements are important in the definition.xml file.

Note It is sufficient to refresh the report that contains a map and for modifications in the associated files to be taken into account.

Map IDEach map will have an id; in the example provided, one map has the ID 10001 and the other 10002. IDs must uniquely identify each map. It is recommended to use integer values for identifiers, starting with 100000.

NameThe name tag defines the name of the map. This value is used as the default label to display in the GUI. In the example provided, one map is named MyCountry and the other YourCountry.




FileThe file tag contains the relative path to the SVG file containing the actual map, and it must begin with the folder custom.

Mapping FileThe mapping-file tag points to the relative path of the mapping file created.

Area typeThe area-type tag's value must match the name attribute's value in the mapping file created. In the provided example this value is counties.

MappingThe <mapping> tag's value must match the mapping-name attribute's value of the <area-type> in the mapping file. In the provided example, this value is ISO-3166-2.

TranslateThe <translate> tag is used to specify two integer values (negative or positive) separated by a comma (,), representing the number of pixels. The first number determines the horizontal translation of the displayed map, while the second number influences the vertical translation of it. Start with the values 0,0 and adjust the values to obtain the desired display.

SizeThe <size> tag is used to specify two positive integer values separated by a comma (,). These numbers represent pixels and identify what part of the original image is displayed. Start with the same values as in the SVG file and adjust the values to obtain the desired display. Typically, when you increase the numbers, a zoom-out effect is generated, while lower numbers result in a zoom-in behavior.

Calculated fieldsA calculated field is a combination of functions, fields, and constants displayed in a report column. For example, you can calculate the sum of two fields, divide a field by a constant, generate random numbers, convert to ASCII, and so on.

If a certain indicator is missing from your database, it is possible to create different types of calculated fields and display them in reports and dashboards.




Note Calculated fields can be defined only for reports based on data dictionaries of type standard or multi-dictionary.

Define a calculated fieldTo define a calculated field:

1. Open the report for which you want to define a calculated field.

2. Select the Edit button and select the Field Selection tab.

3. Once on the Field Selection tab, click the Calculated Field button .

The Calculated field dialog box displays.

4. Provide values for the following fields:

Field Description

Field name A unique identifier for the field.

Description A user-friendly name for the column. This is the value used to identify the field in the UI. For example, this is the value you see when you add a field to your report on the Design tab.

Field group

The group with which the calculated field is associated. Groups are used to find the fields easily when you design a report. By default, four groups are available: Attribute, Metric, Time axis and Calculated fields. You can define other filed groups in Data management > Field group.

5. Select the Add button to create an expression for the field.

A dialog box displays allowing you to choose the type of expression and its attributes.

6. Select a value from the Operand type drop down.

l Function: Make complex calculations based on several functions. For example, you could choose a function to truncate and aggregate values.

l Constant: Define a constant value with a certain data type.

l Field: Refer to a value from an existing column.

7. Select a data type from the Type drop down.

Data Type Description

String Alphanumeric characters.

Numeric Value

A numeric value that could be numeric, integer, float and double. See below for more detailed information about each type.




Data Type Description

Numeric Functionally equivalent to decimal. A literal representation of a number’s value. It uses decimal precision for rounding. Range is -1038+1 to 1038-1.

Integer Range is -2147483648 to 2147483647.

Float A small (single-precision) floating-point number. An approximate numeric type, meaning that it represents an exponential format for a given value. It uses binary precision when rounding. Range is 1.17549x10-38 to 3.40282x1038.

Double A large (double-precision) floating-point number. An approximate numeric type that uses binary precision. 2.22507x10-308 to 1.79769x10308.

Temporal Value

A date, a time, a timestamp, or an interval of time.

Date Describes a date using the fields YEAR, MONTH and DAY in the format YYYY-MM-DD.

Time Describes a time in an unspecified day using the fields HOUR, MINUTE and SECOND in the format HH:MM:SS.

TimeStamp Describes both a date and time using the fields YEAR, MONTH, DAY, HOUR, MINUTE and SECOND in the format YYYY-MM-DD HH:MM:SS.

8. Specify a value for the Value field. Depending on the data type you choose in the Type field, you either select a value from the Value drop down or enter a value in the Value field.

9. Select OK.

Your new calculated field is displayed at the bottom of the Calculated field dialog box.

10. Optionally, select the Add button to add another expression to this calculated field.

Examples of calculated fieldsThis section contains several examples of implementing calculated fields with all three operand types: Function, Constant and Field.

Use functionsAs functions provide the greatest number of options amongst the operand types, this section provides several examples of their use.

Calculate the sum of two fieldsYou can create a column that will sum the values from two or more fields.




1. Create a calculated field.

a. In the Operand Type field, select Function.

b. In the Type field, select Numeric.

c. In the Value field, select Addition.

Two branches are displayed by default in order to specify which two columns to sum. If you click on the plus button next to the Addition function, you can add as many columns as you like.

2. To sum two fields, for each branch specify the Operand type as Field, the Type as Numeric and the Value as the column that you want to include in the sum.

Case Any ThenThe Case Any Then function is similar to an SQL CASE expression with the following pattern:

CASE value_to_evaluate

WHEN value_to_evaluate=value_case_1 THEN result1

...

ELSE default_result

The following illustration shows how you can specify the different values and result.:

The SQL statements above relate to the illustration as follows:

l value_to_evaluate as indicated by A.

l value_case_1 as indicated by D.

l result1 as indicated by B.

l default_result as indicated by C.

In addition, you can use the Add button indicated by E to create additional WHEN branches in your CASE expression.

Example

Consider a situation where you need a new column named State_Code containing the values 0, 1 and 2 depending on the values of the existing column State. For the State Succeed you want to display 1, for Failed you want to display 0 and for any other state you want to display 2.




To achieve this, choose the Operand type as Function, the Type as String and the Value as Conditional Function > Case Any Then.

By default three branches are displayed. In this example we need one more branch. To add a new branch click on the plus button next to the Case Any Then function:

The values in the following table refer to the illustration above. Use these values to create the several branches in this calculated field:

Callout Operand Type Type Value

A Field String State

B Constant String Succeed

C Constant Numeric 1

D Constant String Failed

E Constant Numeric 0

F Constant Numeric 2

When Condition ThenYou can combine conditions with Boolean operators.

Consider a situation where you need to find out which products from your catalog have expired. You need to compare the expiration date with the current date. If the current date is greater than the expiration date, you display the value, Expired. Otherwise, you display the value, Valid.

In this situation, the Operand type is Function, the Type is String and the Value is When Condition Then. When you select this function two branches are displayed by default.




The values in the table below refer to the illustration above. Use these values to create the scenario illustrated.


A Constant Date 01/01/14 (or you can use {s:today})

B Field Date ExpDate

C Constant String Expired

D Constant String Valid

E Function Boolean Greater strict

Divide a field by a constantYou can divide the values from a numeric column by a constant.

The Operand type is Function, the Type is numeric and the Value is Division.

The following illustration is an example of a calculated field that divides the values in the column, Total_Amount by 2.

The values in the following table refer to the illustration above. Use these values to create the scenario illustrated:


A Field Numeric Total_Amount

B Constant Numeric 2




Concatenate two string columnsYou can concatenate the values of two or more columns. For example, if you need to display the Name and Surname in the same columns, you can use the Function Concatenate String. Two branches will be displayed and for each one, you specify the Fields to be concatenated : Name and Surname.

Conditional countYou can use the Division function to divide the values obtain by the usage of two functions. In this example the Conditional Count and Count functions are used.

This calculated field may be useful to determine for example the event error rate.

For this scenario you have to choose the Operand type - Function, the Type - Numeric and the Value - Division. When selecting this function two branches are displayed by default:

The values in the following table refer to the illustration above. Use these values to create the scenario illustrated:


A Function Numeric Conditional Count

B Field String State

C Constant String FAILED

D Function Numeric Count

E Field Numeric EventId

Obtain event timestampThe function eventTimeToMillis takes the EventTime field of the respective row and returns a numeric value representing that time in milliseconds.

In the image below you can see an application of this function in a calculated field, where the combination with the addMillis function leads to obtaining a timestamp for each event. This




calculated field can be further used, for instance, for comparing timestamps.

The function eventTimeToMillis was introduced in 4.2.0 Service Pack 7.

Use a constantWhen you define a calculated field with the Operand type of Constant, you should decide on a data type (for example, string, integer, date, and time) and the value that will be displayed when executing the report. If you do not add any condition, the same value will be displayed in all rows.

This type of calculated field is especially useful in combination with conditional functions described above.

Use a fieldYou can define a calculated filed that contains an existing column. This is useful if you want to add an aggregation on a certain column without modifying the existing column.

FormsYou can set up forms where you can enter, change, and view the data in a database.

Forms are made up of controls, such as text boxes, buttons and drop-down lists, grouped in a way that makes them easy to use and helps you get work done.

After defining a Form object, you can either access it directly from My documents folder, include it in a Dashboard (see Create a Web Dashboard on page 90) or you can use it in a Dynamic link (see Dynamic links on page 146) to navigate from a Report to Form.

Create a form 1. On the Main menu, click Dashboard design > Form to access the list of existing forms.

2. Click the New document button to create a new Form.


3. Specify values for the following fields:




Field Description

Name A unique identifier for the form object.

Description A user-friendly label for your form to be used throughout the UI. You can internationalize the description.

Entity Owning entity (see User access managment on page 102).This value will impact the access rights for this form. Depending on the entity, the form designer will be able to select one data dictionary accessible from this entity. Also, only users that have access to this entity will be able to use the form.

Query The data dictionary used to access the data. Only standard data dictionaries can be used to define forms. The selected data dictionary should use a world (database connection) that allows table content modification (no “read-only” option) and user access with appropriate DB privileges.

Table A table from the selected data dictionary on which the form will be based. The table should have a primary key.

Allow insert

Allows users to insert data in the form. This would allow the user to add a line in the table selected above.

Allow update

Allows users to modify data in the form. This would allow the user to update a line in the table selected above.

Allow delete

Allows users to delete data from the from. This would allow the user to delete a line in the table selected above.

4. On the Design tab, define and configure the columns to be used in the form:

a. Add columns from the Available fields section in the Used fields sections if you want use them in the form.

b. Delete columns in the Used fields section if you do not want to display them in the form. Several properties of each column can be configured by clicking on the columns in the Used fields section:




Field Description

Prompt type

Two prompt types are available:

l Simple value prompt type: allows the user to manually enter a value in the input box when adding new lines in the form.

l Simple select: allows the user to select a value from a list when adding new lines in the form. This type of prompt is available when joining a dependent table to your table to fulfill the form value list. For example you could display a ClientID value list if your table has a foreign key that will be joined with the client table.

Description Set the label of the column to be displayed in the form.

Comment Add a comment to the column. The comment will be available on the prompt used by dynamic links.

Display type

Two display types are available:

l Visible: if this option is unselected the column won't be displayed when visualizing the form.

l Updatable: if this option is unselected the values in the column cannot be modified.

Field name The name of the column as it is in the database. This field cannot be modified.

Default value

The default value of the column. This will be the value added by default when you add a new row to the form.

Min value The minimum value that can be inserted in the column. You are not allowed to insert smaller values in this column.

Max value The maximum value that can be inserted in the column. You are not allowed to insert grater values in this column.

In SQL insert statements

New values can be inserted in the data base.

In SQL update statements

Existing values can be modified in the database.

Nullable Shows if the column support null values or not.




Field Description

Usable in links

The column can be used when defining dynamic links. For more details see Dynamic links on page 146.

Required When you a new line in a form, you must insert values in the columns marked as required. This option is mandatory for the primary key fields and all the fields with the nullable option disabled.

Visualize FormsYou can visualize forms by accessing them directly from the My documents folder, by including them in a Dashboard or by using them in a Dynamic link allowing navigation from a Report to Form.

When you visualize a form, you see a spreadsheet where you can update, add, or remove rows. Alternatively, if you use dynamic links and the pop-up options, you can update fields related to the source you selected in a prompt window.

After modifying the form, you can save the changes. If you do so, these changes will also be reflected at database level. Attention! After the last value you update in the form, make sure that you press the Enter key or change the focus from that cell to another cell on the form. Otherwise the value you last entered may be lost.

You can also refresh the page in order to bring new data from the database or you can go to edit the form at design level.

System valuesYou use system values in various Web Dashboard objects to represent values calculated from data extracted from the database.

You can use system values for the following activities:

l Set default filter for a dashboard.

l Filter the results of a search or report.

l Set up a value for a conditional formatting for a report.

l Set up a constant in a Calculated fields formula for a report.

l Configure the result file name in case you export reports and dashboards using tasks.

l Configure threshold and/or a message in a control.

l Set up a context field in data dictionaries of standard type.

l Set up data dictionaries of type SQL, in the query.

l Set up filters in External components.

l Set the default value for a field in a form.

There are three families of system values:




l Date extraction on page 166

l Relative date on page 168

l User session on page 169

Date extractionUse date extraction system values to calculate a numerical value based on the current date. These system values use the ISO week date:

System Value

Syntax Returned Information

Examples

Year {s:year[+|-]n} Returns the current year, offset by n years.

{s:year} - current year {s:year-1} - previous year{s:year+1} - next year

Month {s:month[+|-]n}

Returns the number of the month in the current year, offset by n months.

{s:month} - the number of the current month {s:month-1} - the number of the previous month {s:month+1} - the number of the next month

Week of month {s:weekofmonth[+|-]n}

Returns the number of the week in the current month, offset by n weeks.

{s:weekofmonth} is 1 if today is first Thursday of the month {s:weekofmonth} is 5 if today is last day of the month

Week of year {s:weekofyear[+|-]n}

Returns the number of the week in the current year, offset by n weeks.

{s:weekofyear} is 1 if today is 4th of January (as per ISO standard) {s:weekofyear} is 52 or 53 if today if last week of the year




System Value


Examples

Day of year {s:dayofyear[+|-]n}

Returns the number representing the day of the year, offset by n days

{s:dayofyear} - the current day of the year (ex. 262){s:dayofyear-2} - 2 days before the current day of the year (ex. 260) {s:dayofyear+3} - 3 days after the current day of the year(ex. 265)

Day of month {s:dayofmonth[+|-]n}

Returns the day of the current month, offset by n days.

{s:dayofmonth} - the current day of the month {s:dayofmonth-1} - the previous day of the month {s:dayofmonth+1} - the next day of the month

Day of week {s:dayofweek[+|-]n}

Returns the day of the week, offset by n days. A week starts with Sunday which has day number 1. Each day correspond to a day number.

{s:dayofweek} - 3 (Day number 3 correspond with Tuesday) {s:dayofweek-2} - 1 (Day number 1 correspond with Sunday) {s:dayofweek+3} - 6 (Day number 6 correspond with Friday)

Hour in day {s:hour[+|-]n} Returns the hour in the current day, offset by n hours.

{s:hour} - the current hour of the day {s:hour-1} - the previous hour of the day{s:hour+1} - the next hour of the day

Minute {s:minute[+|-]n}

Returns the minute in the current hour, offset by n minutes.

{s:minute} - the current minute of the current hour {s:minute-1} - the previous minute of the current hour {s:minute+1} - the next minute of the current hour




System Value


Examples

Second {s:second[+|-]n}

Returns the second in the current minute, offset by n seconds.

{s:second} - the current second of the current minute{s:second-1} - the previous second of the current minute{s:second+1} - the next second of the current minute

Millisecond {s:millisecond[+|-]n}

Returns the millisecond in the current second, offset by n milliseconds.

{s:millisecond} - the current millisecond of the current second {s:millisecond-1} - the previous millisecond of the current second {s:millisecond+1} - the next millisecond of the current second

Relative dateYou use relative date system values to calculate future or past dates based on the current date.

System Value


Now {s:now[[+|-]n[d|w|m|y|h]]}

Returns the current date and time offset by n days/weeks/months/years/hours.

Current hour {s:currenthour[[+|-]n[d|w|m|y|h]]}

Returns the current date and time truncated to hours and offset by n days/weeks/months/years/hours.

Today {s:today[[+|-]n[d|w|m|y|h]]}

Returns the current date offset by n days/weeks/months/years/hours.

First day in week {s:firstdayinweek[[+|-]n[d|w|m|y|h]]}

Returns the first day in the current week offset by n days/weeks/months/years/hours.

First day in month

{s:firstdayinmonth[[+|-]n[d|w|m|y|h]]}

Returns the first day in the current month offset by n days/weeks/months/years/hours.

First day in year {s:firstdayinyear[[+|-]n[d|w|m|y|h]]}

Returns the first day in the current year offset by n days/weeks/months/years/hours.




User sessionYou use the user session system values to represent data related to the current user session. These values can vary depending on the user connected.

System Value


Session identifier

{s:usersessionguid}

Returns the unique identifier of the current session. When a user cannot be identified (as in the case of a metric task, for example), a null value is returned.

User name {s:username} Returns the user name of the connected user. When a user cannot be identified (as in the case of a metric task, for example), a null value is returned.

User login {s:userlogin} Returns the user login of the connected user. When a user cannot be identified (as in the case of a metric task, for example), a null value is returned.

User's entity name

{s:entityname} Returns the name of the connected user's entity.

User workspace name

{s:workspacename}

Returns the name of the connected user's workspace. When a user cannot be identified (as in the case of a metric task, for example), a null value is returned.

User language {s:language} Returns the ISO-639-1 code representing the connected user's language. This code is specified in the language setup screen. When a user cannot be identified (as in the case of a metric task, for example), a null value is returned.

User language name

{s:languagename} Returns the language name representing the connected user's language. This name is specified in the language setup screen. When a user cannot be identified (as in the case of a metric task, for example), a null value is returned.

User profile {s:profile} Returns the connected user's profile.0: Public user profile 1: User profile 2: Administrator profile 3: Super-administrator profile When a user cannot be identified (as in the case of a metric task, for example), a null value is returned.




Formatted text messagesYou can create formatted text to use as a design element in dashboards. Text messages cannot be edited from the dashboard. You create formatted text using HTML tags. It can be translated in one of the active language from the Internationalized tab.

You can enter and format your text using HTML tags. Text messages support standard HTML element, including:

l paragraphs

l bullets

l images

l various styles, such as bold, italic, and underline.

Create formatted text messagesTo create formatted text messages:

1. Go to Dashboard Design > Text.

2. Select the Add button .

3. Enter values for the Name, Description, and Entity fields.

4. Optionally, go to the Internationalization tab and provide values.

5. Go to the Text tab and enter the content of your text message, then select Save.

Note As you edit the text message, it is displayed as HTML code. It is not WYSIWYG. You can use HTML code to format your text (see HTML tags) or you can use the buttons in the toolbar when you create your text message. It is recommended that you enter all the text, select pieces text you want to format, and then click the toolbar button for the format you want to apply. This will enclose the selected text between correctly coded tags.

HTML tags for text messagesThe following table provides some guidance for using HTML tags in your text message.

Using any other tags will generate an error and you will not be able to save the object.

HTML tag example Results/Comments

<b>my text</b> my text

<u>my text</u> my text

<i>my text</i> my text




HTML tag example Results/Comments

</br> Inserts a line break

<p>my text</p> Creates a paragraph by inserting a line break before and after the text

<ul><li>my text</li></ul> Creates a bulleted list with one item: "my text"

<img

src="/SentinelWebDashboard/folder/ImgPath/myimage.png"

title="this is my picture" alt="this is my alternative

text" />

Inserts an image in the message text

l src=" ": Specifies the URL of the image

l title=" ": Specifies the tool-tip for the image

l alt=" ": Specifies alternative text for the image in case it is not shown.

The user should have permission to access the folder where the image is placed. Image types supported:

l jpg

l png

l gif

l svg

l ico See the following examples.

The following are examples of code you can use in your text message.




URL format when the default folder for images is used

<img src="folder/ImgPath/myimage.png" title="test1" alt="test" />

<img src="/SentinelWebDashboard/folder/ImgPath/myimage.jpg"

title="test2" alt="test" />

<img src="http://<server host>:<Web server

port>/SentinelWebDashboard/folder/ImgPath/myimage.gif/">

URL format when a folder other than the default is used

<img src="img2/axway-arrow.png" title="test2" alt="test" />

<img src="/SentinelWebDashboard/img2/radial-gradient.svg" title="test2"

alt="test" />

<img src="http://<Sentinel server host>:<Web server

port>/SentinelWebDashboard/img2/spinner-24.gif" title="test3" alt="test"

/>

URL format when the image is available in another places

<img src="favicon.ico" title="image from SentinelWebDashboard folder"

alt="test" />

<img src="img/radial-gradient.svg" title="image from

SentinelWebDashboard sub-folder" alt="test" />

<img src="themes/Axway/-/logo" title="image from Axway theme" alt="test"

/>

<img src="/SentinelMonitoring/SentinelMonitoring/axfavicon.ico"

title="image displayed from another web application" alt="test" />

<img src="http://www.axway.com/sites/default/files/vertical_tile_

images/vertical-thumb-financial.png" title="image from another server"

alt="test" />

CommandsIt is possible to trigger execution of an external script (.sh, .bat, .exe, etc.) or even Java class on Web Dashboard search results. This is a very powerful extension of searches and it is used to act in the context of search results. As an example, if a search report is used to monitor transfers, users can launch a restart command from within the Web Dashboard GUI or can cancel transfers that are hanging.




To run external executable files or Java classes from within Web Dashboard, define and deploy Sentinel Command objects. These objects are traditionally defined in Composer and can be used with Sentinel Web Monitoring Requests. Web Dashboard automatically recognizes Commands deployed in the system.

Define Sentinel commands for Web DashboardNote If intended to be employed in Sentinel Monitoring, it is recommended to define the

Commands within Composer.

The following information assumes that Sentinel Commands are used in Web Dashboard only. In this case, it is possible to have a minimalist XML definition that can be easily created manually.

Important Command objects defined this way will not be available in Sentinel Monitoring.

The following is a sample XML definition of a Sentinel Command:

This sample defines a Sentinel Command that displays in the Web Dashboard GUI under the name Dump traces. Upon execution, it triggers the execution of the my_command.bat file, and transmits the values of two fields: CycleId and EventId. Sentinel looks for the my_command.bat locally.

Transmitting parametersTransmitting contextual information to scripts (.bat, .sh, .exe, etc.) is configured in the command definition XML as follows. In Java classes, all fields available in the data dictionary, calculated fields and the context parameters, are automatically passed to the command without configuring these in the command definition XML. Passing user input to Java classes must be configured in the same way as in case of scripts.

Report fieldsYou can transmit the value of any column available in the data dictionary, including the values of calculated fields. The following example displays how to configure the transmission of the fields PositionNumber and EVENTID, assuming they exist in the data dictionary.




Tip For efficiency reasons, database tables exposed through standard dictionaries must have a primary key or at least a column named EVENTID that uniquely identifies every row in your search results. If none of these conditions are fulfilled, only displayed fields will be transmitted to the command. For SQL dictionaries there is no constraint.

User inputBy referring nonexistent fields in the command definition, Web Dashboard prompts the user for input. In the following example, Web Dashboard prompts the user for input for the parameter voucher:

Starting with Service Pack 2, the set of characters allowed by the user input can be configured by setting the property webdashboard.command.regex=<your regular expression> in server.properties file. The value of the property should be a valid regular expression.

Example: When allowing a 5 character long user input comprised of 1 small caps alphanumeric character, 1 numeric character, 1 underscore, 1 space, 1 large caps alphanumeric character ordered in this exact sequence, the property should be as follows:

webdashboard.command.regex=[a-z0-9_\\sA-Z]

Notice, the backslash (\) must be doubled, similar to any property that is using this character (like paths).

If the regular expression is not valid or the property is not set, the default regex is used, which is allowing only alphanumeric characters.

Context parametersUsername and PassPort domain (if it is the case) are transmitted to commands by using the syntax in the following example:

Remote execution on Sentinel Event RouterTo configure a Command so its execution is forwarded to a Sentinel Event Router the <target> tag must be completed properly, as shown in the following example:




Correspondingly, Event Router must be properly configured to match the authorization details from the Command definition, as shown in the following matching target.xml for Event Router example:

For Sentinel to correctly identify the Event Router host and port, the fields AgentIpAddr and AgentIpPort must be available in your search as dictionary fields or as calculated fields.

Deploy Sentinel commands for Web DashboardIf the definition of the Command objects Composer was used, it is recommended to deploy the objects with Composer. Otherwise, there are two options to deploy a Command object:

l Option 1: Use the Sentinel REST API. Sentinel server, restart is not necessary. The Sentinel REST API is requires basic use and does not require code development. There are free applications that can be used to consume REST services. For example, Postman for Chrome browser or REST Easy add-on for Firefox. For more details, see the Axway Sentinel API Developer Guide.

l Option 2: Manually copy the file into Sentinel/broadcast/commit/Command and restart Sentinel.

Activate command execution on SearchesAll Command objects deployed in Sentinel are listed in the Search report design view, in the Command tab. By default no Command object is enabled on any Search report. To enable it, select the check box beside the displayed command.

Note Commands are enabled only on reports of type Search.

Enable and disable commands depending on search resultsUse complex criteria for control if a command is enabled or disabled depending on search results. Criteria can be defined in the Search report design view, in the Command tab.

Important The mentioned criteria is for the GUI only and it is not validated on server side. For proper security, the necessary validations must be implemented inside the script or Java class referred in the Command object.

Referring columns in criteriaRefer any field available in the data dictionary and use its name:




l When the field name contains spaces, the back-quote separator (`) should be used when defining a criteria, for example ̀ My column`.

l If the columns in a search are formatted (see Column properties > Data format), the values used in the criteria should not be formatted. Otherwise the criteria is not valid.

Tip For embedding advanced logic in your criteria, consider creating calculated fields. These can be referred to by its name (similar to other fields).

Comparison operators allowed in criteriaThe following comparison operators can be used when defining a criteria: =, <, >, <=, >=, <>, IS NULL, IS NOT NULL.

Hierarchical criteriaThe following examples describe how to build complex hierarchical criteria by using parentheses for grouping conditions and the operators AND and OR:

Example 1A criteria enabling commands if the selected row in a search has the string value CFT in the Product Name column, and has one of the three states: CANCELED, INTERRUPTED or SUSPENDED.

`Product Name`='CFT' AND (State='CANCELED' OR State='INTERRUPTED' OR State='SUSPENDED')

Example 2A criteria that enables commands if the selected row contains numerical value 111 for column ProductId and one of the states (string values): TO_EXECUTE, AVAILABLE, RECEIVING, SENDING, or PRE_PROC.

ProductId=111 AND (State='TO_EXECUTE' OR State='AVAILABLE' OR State='RECEIVING' OR State='SENDING' OR State='PRE_PROC')

Example 3A criteria enabling commands for rows that have the string value CFT in the Product Name column, the Date column has dates greater than 2000/05/03 and the Id column has a numeric value 111.

`Product Name`='CFT' AND Date>'2000/05/03' AND Id=111

Data typesThe following data types should be used:




l For string and date type values, use delimited single quotes ('). For example: State='In progress' or Date='2014/10/16 17:50:00'.

l For date values, use the following format: yyyy/MM/dd HH:mm:ss.

l For numeric values that contain decimals, use the (.) separator. For example: 3.1415926

Access ManagementAccess to commands in Web Dashboard are managed using:

l Traditional resources

l Actions when using PassPort

l Rights when using Sentinel Administration or custom user exit implementation

PassPort l If granted the privilege on the action EXECUTE_COMMAND on the Sentinel resource Request, users can execute commands on both Sentinel Web Monitoring Requests and Sentinel Web Dashboard Search reports. Conditional privileges are constructed using the resource property name that is matched against Sentinel Web Monitoring Request names and Sentinel Web Dashboard report names.

l If granted the privilege to execute the action VIEW on the Sentinel resource Command, users can view commands both in Sentinel Web Monitoring and in Sentinel Web Dashboard. Conditional privileges are constructed using the resource property name that is matched against command names.

Sentinel Administration and custom user exit implementationThe right named Execute Commands controls access of users to commands. This corresponds to the following constant in a custom user exit:

com.axway.sentinel.common.server.user.Rights.RIGHT_TRACKINGCOMMANDEXECUTE

SearchThe Search is a type of Web Dashboard report dedicated to searching. At the Report design level, you choose a specific chart type named Search.

Reports containing charts of type Search behave exactly as the current table reports in all aspects, including creation, modification, execution, filtering, customizing, export, import, employment in controls, embedding in dashboards, and so on.

For more details about how to set up and visualize reports, see thee following sections:




l Set up reports on page 45

l Visualize reports on page 86

Field groupsField groups are categories that help you more easily identify more the columns you want to add when defining a report.

There are four predefined field groups:

l Attribute

l Metric

l Time axis

l Calculated fields

When you create a data dictionary, each column is automatically associated with one of the filed groups as follows:

l Attribute for string characters

l Metric for numeric type of columns

l Time axis for date and time columns

The field group associated to each column can be modified, including with new field groups that you define. In the next paragraph it is presented how to create new field groups.

At report design level, in the Field selection tab, all the columns related to the data dictionary you have selected, will be grouped by field groups.

The Calculated fields group can be used when defining calculated fields. This way it will be easier to identify which of the columns are calculated and which ones come directly from the data base.

Create field groupsTo create field groups:

1. On the Main menu, click Data management > Field group.

A list of existing field groups displays.

2. Select the New document button to create a new field group. A new document opens and the




Description tab displays. Provide values for the following fields:

Field Description

Name A unique identifier for the field group object. This field is mandatory.

Description A user-friendly label for your field group to be displayed across the GUI. See Build a data dictionary on page 33 and Set up reports on page 45. The description can be internationalized (translated into the language defined for each user) using Internationalization tab. This field is mandatory.

Entity Owning entity. See User access managment on page 102. This will impact the access rights for this field group.When you assign a field group to a sub-entity, admin users in the root-entity cannot edit data dictionaries or reports of the sub-entity if the data dictionary or report use the new field group.

3. Click Save.

Driver managementA JDBC driver allows the administrator user to access different types of databases. As soon as a database driver is added, the admin user can configure the database connection using the world objects. You can add the new driver from Data management.

In the Description tab, provide values for the following fields regarding details about the driver:

Field Description

Name Unique identifier for the driver

Description A label for the driver. This label is displayed across the GUI. The description can be internationalized (translated into the language defined for each user) using the Internationalization tab

Default URL

The driver URL used to connect on the database. The URL is different depending on the database type like: Oracle, MySQL, and so on.

Class name The driver class

Catalog separator

The separator used for the tables, views and internal database management.

Identifier quote string

The identifier used for the string interpretation.




Field Description

Join Style The style of join affects the SQL query generated based on the specified data structure:

l ANSI: table1 T1 [inner|left|right|full] join (table T2 on T1.field1=T2.field1)

l Basic: table1 T1, table T2 WHERE T1.field1=T2.field1

l Oracle: table1 T1, table T2 WHERE T1.field1(+)=T2.field1

In addition, you can specify database options, including the following:

l Supports catalog

l Supports schema

l Supports INNER JOIN

l Supports LEFT JOIN

l Supports RIGHT JOIN

l Supports FULL JOIN

You use the Functions tab to define the mapping between functions and their proper implementations.

Refer to the database management system's documentation for information relating to the implementation of each function.

To use the database driver, you must save it to the lib folder for your web server.

Metrics and strategic mapsWeb Dashboard functionality to analyze strategic goals pursued by an organization. To perform this kind of analysis, you use several objects from Web Dashboard: Metric, Perspective, Strategic objective and Strategic map.

A strategic map is a diagram that you can use to display various performance measures in an organization. The strategic map uses shapes in a diagram to show the relationships between the objectives and metrics (or KPIs). It uses colors to highlight how each objective or metric is performing.

Strategic maps have their roots in the Balanced Scorecard framework, which defines organizational performance by using four perspectives described in the following table:

Perspective Description

Financial The financial perspective usually includes metrics such as revenue, cost, and profit.




Perspective Description

Customer The customer perspective, which is also referred to as the customer satisfaction perspective, includes metrics such as customer counts, market share, and number of complaints.

Internal process

The internal process perspective, which is also referred to as the operations perspective, typically includes metrics such as time to market for new products, service error rates, and quality control measures.

Learning and growth

The learning and growth perspective, which is also referred to as the human resources perspective, includes metrics such as employee turnover rates, the number of new employees, and hiring data.

Although many organizations find the Balanced Scorecard framework useful, you do not have to follow it when you create your strategy map. You can create your strategy map using any combination of metrics and objectives.

In order to visualize a strategic map you should create several objects in Web Dashboard in the order presented below:

1. Define a Perspective.

2. Define a Strategic objective.

3. Create a Metric.

About PerspectivesA Perspective is a category that helps you group and analyze your strategic objectives. For example, you can define perspectives like Finance, Customer, Internal processes, Learning and innovation, and so on.

The Strategic objectives (see About Strategic objectives on page 182) can be organized to form a strategic axis, named Perspective, which is displayed in the Strategic map (see Web Dashboard functionality to analyze strategic goals pursued by an organization. To perform this kind of analysis, you use several objects from Web Dashboard: Metric, Perspective, Strategic objective and Strategic map. on page 180).

Create a perspectiveTo create a perspective:

1. On the Main menu, click Dashboard design > Perspective to access the list of existing perspectives.

2. Click the New document button to create a new Perspective. A new document opens and the Description tab displays. A perspective is configured with the following properties:




Field Description

Name A unique identifier for the perspective object.

Description A user-friendly label for your Perspective to be displayed in the Strategy map. The description can be internationalized (translated into the language defined for each user) using Internationalization tab.

Caption font

This parameter configures the style (background color, size, font, and so on) of the perspective object to be displayed in the Strategic map. The style is also reflected in the PDF export of the Strategic map.

Sort order This parameter specifies the order in which perspectives blocks are displayed in the Strategy map. The style is also reflected in the PDF export of the Strategic map.

About Strategic objectivesA Strategic objective is an element represented on the Strategy map as a bubble containing one or many Metrics (see About Metrics on page 183.) It groups metrics together in a coherent manner. A Strategic objective belongs to a single Perspective, in the same way that a Metric belongs to only one Strategic objective.

One or more Strategic objectives can be defined in each Perspective. This is useful, for example, to reflect the areas of development of your company. Strategic objectives can be: Maintain growth, Increase profitability, Product quality, Customer acquisition, and so on.

Create a strategic objectiveTo create a strategic objective:

1. On the Main menu, click Dashboard design > Strategic objective to access the list of existing objectives.

2. Click the New document button to create a new Strategic objective. A new document opens and the Description tab displays. A Strategic objective has the following properties:

Field Description

Name A unique identifier for the strategic objective object.

Description A friendly label of your strategic objective that will be displayed on the strategy map. The description can be internationalized (translated into the language defined for each user) using Internationalization tab.

Perspective Link the strategic objective to the selected perspective.




Field Description

Strategic Objective

This is the related strategic objective. It is an optional property that will be represented in the strategy map as an arrow to indicate a cause-and-effect relationship between the current strategic objective and another one that has already been configured.

Caption font

This parameter configures the style (background color, size, font, etc.) of the strategic objective displayed in the strategic map.

Metrics font

This parameter configures the style (background color, size, font, etc.) of the metrics displayed in the strategic map.

Comment Add a comment to your strategic objective.

About MetricsYou can use a metric to monitor a value representing the result or status of a process over a certain period of time. For each metric, the application extracts and aggregates the data at specified intervals and calculates the trend.

This process scans a specified number of lines in a report and determines a value, known as a metric, by applying a particular rule (for example, sum, average, minimum, maximum, and so on) to the data in one of the report's columns.

This metric is then recorded in a history log. A certain trend can be observed as this value changes over time.

Metrics are calculated globally for all or selected entities.

The result of the process can be represented in two ways:

l As a tree, accessible from Dashboard design > Metric.

l As a graphic displayed on Dashboard design > Strategic map, showing cause-and-effect relationships.

Create a metricTo create a metric:

1. On the Main menu, click Strategy map > Metric. A list of existing metric displays.

2. Click the New document button to create a new Metric. A new document opens and the Description tab displays.





Field Description

Name A unique identifier for the metric object. This field is mandatory.

Description A user-friendly label for your metric to be displayed across the GUI. The description can be internationalized (translated into the language defined for each user) using Internationalization tab. This field is mandatory.

Entity Owning entity (see User access managment on page 102). This will impact the access rights for this Metric.

Strategic Objective

The strategic objective to which the metric is related. In the strategic map, the metric will be included in the strategic objective selected at this step.

Report The report on which to monitor the values of a certain column. The email is sent based on these values. Only reports with interactive execution mode can be used (not snapshot mode).

Field name The name of the column in the report used as the condition to trigger the email. This must be a numeric field.

Calculation mode

The metric is determined by applying a calculation mode (sum, average, minimum or maximum) to the data in one of the report's columns.

Number of lines

The number of line to be scanned to obtain the metric.

Target The value of the desired target. In the strategic map or in the metric panel, the target will be compared with the metric value generated by applying the calculation mode.

Color This color is applied when the metric is displayed in the strategic map.

Format The format of values from the column to be analyzed.

Storage duration

The storage duration of calculated values of the metric. This values are used to build the historic graph of the metric that can be accessed in the strategic map.

Time unit The unit of measure for the Storage duration. One of the following time units can be associated to the frequency: day, hour, minute, month, week.

Trend calculation

The period of calculation of the trend (comparison between the actual value and the old one). The trend is the arrow displayed beside the metric in the metric panel.




Field Description

Time unit The unit of measure for the execution of Trend calculation. One of the following time units can be associated to the frequency: day, hour, minute, month, week

Analysis report

This report can be attached to the mail in PDF or Excel format to highlight the calculated value of the metric.

Comment Add a comment to your metric.

Version Version number of the object. Sentinel increments this number when the object is saved. Sentinel increments the correction number when the object is saved. This version number is used during XML export and import. See Import Excel files on page 198.

4. On the Schedule tab, specify whether the task associated with the metric execution is a Master task or a Child task.

l Master task - Has an execution defined (CRON or frequency).

l Child task - The execution of a Child task depends on another task. In the task manager, the Child task is displayed under the Master task.

5. For a Child task, two fields must be completed:

l Parent task: The reference task.

l Run when: Use the selection list to choose the execution condition from the following:

o Parent Task OK

o Parent Task Ok/Warning

o Parent Task Ok/Warning/Error

o Parent Task Warning

o Parent Task Warning/Error

o Parent Task Error.

6. Fill in the fields to establish a schedule for when the metric is executed:

Field Description

Task group

Chose a task group for this metric object. If you don't have any, you can create one in the Task group section in Main menu > Task.

Cron expression

You can use a standard cron expression to specify the schedule for this metric. Cron is an operating system utility used to execute commands at scheduled times. For example, the cron expression can be 0 30 1 * * ? and it means launch at 1h30 every day. Available for a master task only.




Field Description

Time zone Choose the timezone for the Start date and End date fields.

Start date The date and hour when a master task will start.

End date The date and hour when a master task will end.

Frequency The periodicity of metric execution. This is an alternative to the Cron expression. Available for a master task only.

Time unit The unit of measure for the execution of this metric. One of the following time units can be associated with the frequency: day, hour, minute, month, week.

7. Click the Message tab and compose the message to be sent and specify the users to receive the message. Specify values for the following fields:

Field Description

Send to users with access to this control

Only the users with access to this metric will receive the message

Send to additional users

Define message recipients other than those who have access to this metric object.

Subject The text you enter here will appear as the subject of your email or sms.

Message The body of the email or sms. This information can be contextualized.

Attachment The Report selected in Description tab can be attached as PDF or Excel file.

Message sending policy

Use this matrix to set the conditions under which your message will be sent. If you select a check box, your message will be sent if that condition is met. Each condition evaluates both the initial and the final state of the report. If you do not select any check boxes, no message will be sent. If you select all the check boxes, a message will be sent each time the metric is executed.

Execute MetricsIn order to be able to send and receive messages, there are several more items you must configure:

l Add the metric to the desired workspace (User management > Workspace > Metric tab).

l Create a Message type in the Administration folder to specify the message provider: email or sms.




l In User management > User, check the option, Allow messaging access, and complete the Message type you have created with an email address or phone number (for sms) of the destination user.

l Execute the Metric in the Task manager.

The workspace Metric tab allows you specify the access level for each metric.Metrics can have the following access levels:

l None: The metric will never be calculated for users in this workspace.

l Read only: The metric will be calculated but will not be customizable by users in this workspace.

l Total: The metric will be calculated and will be customizable by users in this workspace.

Visualize metricsYou can visualize metric by including them in dashboards (for more details about dashboard see the section Setup Dashboards).

In a dashboard, the metric is shown as a counter. The border around the metric is shown in red, yellow and green, representing the thresholds specified in the setup. The black arrow represents the target value and the red arrow shows the actual value. Clicking the arrows will display the exact value.

To view the history, you must click on the Metric history.

Metric PanelThe metrics panel allows you to visualize the alert levels of all the metrics, arranged in preset groups. It also shows how they have changed since the last time the dashboard was executed.

A summary of the alert levels of the metrics is displayed for the various metric groups.

Double-clicking on a metric name opens a popup. The metric detail window displays the alert level and the threshold values for the metric.

When clicking on a metric, many icons in the toolbar become enabled:

l Metric history- a link to the metric history

l Report – a link to the analysis report used in the task

l Customize – displays the _Customize this metric _window. Change values for thresholds and click OK.

l Delete customization – deletes the last customization.




Strategic mapLike the Metric panel, the Strategy map shows all the metrics that you can access, organized by Perspective and by Strategic objective. The Strategy map also shows the cause-and-effect links between objectives.

The Strategic map can be visualized on the main menu on Dashboard design > Strategic map.

Clicking on the name of a metric opens the a popup with the following options:

Button Description

Refresh Reloads the strategic map.

Customize Use the Customization dialog box to setup a New Goal and a Threshold for the selected metric object.

Delete customization

Deletes the customization already applied. This button is enabled only if the metric has already been customized.

PDF export Generates a PDF file with the strategic map that you can either save or open directly.

Report It displays the analysis report on which the metric is based. See Set up reports on page 45.

Metric history The metric history is available when displaying the metric.

Visualize requests and graphic objects from Sentinel Monitoring

You can use an external component to display Web Monitoring requests inside Web Dashboard, with the possibility to apply filter and dynamic link functions to it.

You can insert the Web Monitoring screen directly in a Dashboard or use it as a Dynamic link (see Dynamic links on page 146) to drill down from a report in Web Dashboard to a Request or Cycle Graph in Web Monitoring.

You can access Web Monitoring from Web Dashboard in two cases:

l Using SSO (Single Sign-On), if access management is done via PassPort

l Using authentication parameters (user, password, PassPort domain). This will work in both cases, when access management is done via Sentinel Administration or PassPort.

When defining the external component you use specific variables in the URL, depending on the request in Web Monitoring. The text of an URL varies depending on the value of the associated variables.




Access requests and graphic objects from Sentinel Monitoring Before you can access requests and graphic objects from Sentinel Monitoring, you must create an external component.

1. On the Main menu, go to Dashboard design > External component.

2. Specify the URL to Sentinel Monitoring. The parameters described above (for example, showCycleGraph) can be inserted directly in the URL or they can be added as filters:

Field Description

Name Name of the POST or GET parameter

Description Used when displaying the filter for users or the dynamic link

Default value

Default value of the parameter

Value list It is possible to select an SQL query that offers a list of options for the parameter's value, rather than an unrestricted user input

Mandatory Specifies whether or not the parameter is systematically applied

Active Specifies whether or not the parameter is applied

Dynamic link

Specifies whether or not the parameter can be used in a dynamic link

Visible Specifies whether or not the parameter can be entered directly by the user

After defining the External component you could either include it directly in a Dashboard (see Create a Web Dashboard on page 90) or you could use it in a Dynamic link (see Dynamic links on page 146) to be able to navigate from a report in Web Dashboard to a related Request or Cycle Graph in Web Monitoring.

The syntax to define URLs is explained in the section below.

Define Sentinel Monitoring URLsUsing a specific syntax you can define URLs to display and execute Requests and Cycle Graphs in Sentinel Monitoring directly from Web Dashboard.

This section provides some examples of URLs showing requests and graphs from Sentinel Monitoring with different access management applications.




URL examples for requests and graphs

Simple searchWhen accessing this URL, the specified request will be displayed. The request has no parameters.

http://mywebserver:8080/SentinelMonitoring/SentinelMonitoring/?actions=search&user=MyUserName&passwd=MySecretPassword&request=Company.Sentinel.SampleRequest

Search with a parameterWhen using this URL, the executed request is displayed and it contains also parameters.

http://mywebserver:8080/SentinelMonitoring/SentinelMonitoring/?actions=search&login=MyUserName&pw=MySecretPassword&request=Company.Sentinel.SampleRequestWithParams&CycleId?=CycleId

Cycle graphA specific cycle graph is displayed when accessing this URL.

http://mywebserver:8080/SentinelMonitoring/SentinelMonitoring/?actions=search&user=MyUserName&passwd=MySecretPassword&request=Company.Sentinel.Graph&showCycleGraph=true&objectId=ObjectId&cycleId=CycleId

URL examples for different access management applications

PassPort AM with SSO:In this case the URL should contain the PassPort SSO port (the default value is 6900) and the product instance whose default value is "default". In this case the access is made by auto login, without the need of introducing the user and password in the URL.

https://passportserver:6900/axway/Sentinel/4.0.1/default/SentinelMonitoring/SentinelMonitoring/?actions=search&request=Company.Sentinel.SampleRequest

Sentinel Administration with login:In this case the URL contains the user and password so that no login is required when displaying a request from Sentinel Monitoring. If the URL does not contain user and password the login page of Web Monitoring is displayed.




http://mywebserver:8080/SentinelMonitoring/SentinelMonitoring/?actions=search&user=MyUserName&passwd=MySecretPassword&request=Company.Sentinel.SampleRequest

Passort AM with login:The URL should contain a user and passport defined in PassPort and the associated domain.

http://localhost:8080/SentinelMonitoring/SentinelMonitoring/?actions=login&user=MyUserName&passwd=MySecretPassword&domain=DomainName

In order to define this URL a specific syntax is required:

Parameter Description

actions This parameter can have two values:

l search: a request is executed

l login: user is logged in automatically with the credentials provided by the login/user and pw/passwd parameters

domain (for PassPort AM 4.3)

For PassPort AM 4.3, there are a number of possible options for user login depending on how the domain is defined in the URL:

l If no domain is defined in the link and the user is in the default domain, the default domain is used and the user is logged in. For example: http://localhost:8080/SentinelMonitoring/

SentinelMonitoring/ ?actions=login&user=

MyUserName&passwd=MySecretPassword

l If no domain is defined in the link and the user is not in the default domain, the connection is refused.

l If the domain which is not the default domain is defined in the link and user is in this domain, the user is logged in. For example: http://localhost:8080/SentinelMonitoring/

SentinelMonitoring/?actions=login&user=

MyUserName&passwd=MySecretPassword&domain=DomainName

l If the domain which is not the default domain is defined in the link and user is not in this domain, the connection is refused.

domain (for PassPort AM 4.4)

For PassPort AM 4.4 the domain is mandatory and the user must be defined in this domain: http://localhost:8080/SentinelMonitoring/ SentinelMonitoring/?actions=login&user=

MyUserName&passwd=MySecretPassword&domain= DomainName

login Parameter to specify the username for login. (login and user are both used for the same purpose to ensure compatibility between the Monitoring interface and Sentinel Monitoring)





user Same as login.

pw Parameter to specify the password for login (pw and passwd are both used for the same purpose to ensure compatibility between the Monitoring interface and Sentinel Monitoring)

passwd Same as pw.

request The complete name of the request to be executed

showCycleGraph true: display cycle graph view.false: display search result.

objectId The ObjectId parameter used when displaying a Cycle Graph

cycleId The CycleId parameter used when displaying a Cycle Graph

External componentWeb Dashboard enables you to include external components, such as a website or some other HTML page, in your dashboard. In addition, you can apply filters and dynamic links to external components.

Using an external component, you can also display Web Monitoring requests. See Visualize requests and graphic objects from Sentinel Monitoring on page 188.

After defining an external component, you can either include it directly in a Dashboard (see Create a Web Dashboard on page 90) or you can use it in a Dynamic link (see Dynamic links on page 146) to be able to navigate from a Report to an External component.

Create an external componentTo create an external component:

1. On the Main menu, click Dashboard design > External component. A list of existing external components displays.

2. Select the New document button to create a new External component. A new document opens and the Description tab displays.

3. Provide information about the external component. On the Description tab, enter values for the following fields:




Field Description

Name A unique identifier for the external component object. This is a mandatory field

Description A user-friendly label for your external component to be displayed across the GUI. The description can be internationalized (translated into the language defined for each user) using Internationalization tab. This is a mandatory field.

URL The URL of the web page or the corresponding JavaScript file. This URL is the same as the one displayed in your browser's address bar.

Plugin mode

A check box that indicates whether the external component's URL points to a JavaScript file.

Class to be loaded

The name of the JavaScript class.

4. Optionally, define filters. You specify parameters that are treated as filters and are similar to report-level filters in terms of both their definition and their usage.

Field Description

Name The name of the POST or GET parameter.

Description Used when displaying the filter for users or the dynamic link.

Default value

The default value of the parameter. You can also add a personalized field from the drop-down list.

Value list It is possible to select an SQL query that offers a list of options for the parameter's value, rather than an unrestricted user input.

Require If this option is checked, when executing the external component the filter cannot be disabled (unchecked). The filter will be systematically applied.

Dynamic link

Specifies whether or not the parameter can be used in a dynamic link.

Visible If this option is checked the parameter will be displayed on the filters pop-up when the external component is executed. If it is unchecked the parameter won't be displayed but if the option Dynamic ink is checked, the parameters will be available when defining a dynamic link

Active Specifies whether or not the parameter is applied




In order to be able to use an external component in Dashboards, you must first add the component to the user's workspace. See User access managment on page 102.

If you want to use the external component in a dynamic link, it is sufficient to include the object, Hidden session-group.

Examples of external components

Google mapsThe following is an example of filters you can define when creating an external component for Google maps. These parameters will be reflected when displaying the external component.

The URL is: https://maps.google.com

Name Description Default Value

Additional Information

q location query

New York, NY

If you use a default value, it is used when displaying the Google map. In this case, when you display the Google map, you will see a map of New York, NY.If you do not use a default value, you can specify a location when displaying the external component by clicking the Filters button.

output output format

embed This displays the Google map inside the Web Dashboard.

t map type m The following values are available for this parameter:

l m - map

l k - satellite

l h - hybrid

l p - terrain

l e - GoogleEarth

z zoom level 12 Values for zoom level range from 1 to 20.

Visualize requests and graphic objects from Sentinel MonitoringThe following is an example of using PassPort with SSO as an access management application. A specific cycle graph is displayed when accessing this external component.




If you choose to use filters to define the parameters from the url, you should use a relative URL, like this:

https://passportserver:6900/axway/Sentinel/4.0.1/default/SentinelMonitoring/SentinelMonitoring/

For more detail, see Visualize requests and graphic objects from Sentinel Monitoring on page 188.

Name Description Default Value Additional Information

actions actions search The request is executed through this parameter.

request request full name

Company.Sentinel.Graph This is the complete name of the request to be executed.

showCycleGraph cycle graph true Controls whether the external component displays the cycle graph or the search results.true: the cycle graph view is displayedfalse: search results are displayed

objectId objectId 123 The ObjectId parameter used when displaying a Cycle Graph.

cycleId cycleId 456 The CycleId parameter used when displaying a Cycle Graph

If you do not use filters, the URL should contain all the parameters, like this:

https://passportserver:6900/axway/Sentinel/4.0.1/default/SentinelMonitoring/SentinelMonitoring/?actions=search&request=Company.Sentinel.Graph&showCycleGraph=true&objectId=ObjectId&cycleId=CycleId

HTML home pageYou can define an external component to be used as an HTML home page for Web Dashboard. To do this, you create an external component as shown below and include it in a dashboard.

To see this page directly after login, choose this dashboard as the user's Home under User management > User > Description tab.

Before defining your external component, create a folder under Administration > Folder, for example, in the directory /pub/home. Also, create the "home" folder on the server side under webdashboard/pub. In this location on the server side, you put the JavaScript file (see the example attached). Please see more details about folders in the section Server side resources and folder management.




Field Example of field value

Additional Information

URL folder/Home/my_

home_page.jsHome is the folder created on the server side. my_home_page.js is the JavaScript file used to display the home page.

Plugin mode

checked This option is checked because the external component's URL points to a JavaScript file

Class to be loaded

ldb.plugin.home

The name of the JavaScript class used in the JavaScript file.

In the JavaScript sample below, you can modify the two objects, ldb.plugin.Home and ldbInit2 in order to change the content of your HTML page. This sample contains a title "Hello world", a subtitle "This is a sample Javascript code to be employed in Web Dashboard" and an image.

if (ldb.plugin == null) ldb.plugin = {};

ldb.plugin.Home = function () {

this.div = null;

this.name = null;

this._container = null;

this._scrollPane = null;

this._l10nMap = null;

this._data = null;

this._i18nMap = {

en: {

home: 'Hello world',

welcome: 'This is a sample Javascript code to be employed in Web

Dashboard'

}

};

};

ldb.plugin.Home.prototype = {

constructor: ldb.plugin.Home,

destroy: function() {

if (this._scrollPane) {

this._scrollPane.destroy();

}




this._scrollPane = null;

},

ldbInit2: function (name, container) {

var builder,

table,

tbody,

tr,

td,

ul,

li,

h2,

a,

href,

items,

i,

j,

node,

node2;

this._container = container;

this.name = name;

switch (this._container.application.userLanguage) {

case 'fr':

this._l10nMap = this._i18nMap.fr;

break;

default:

this._l10nMap = this._i18nMap.en;

};

this.div = this._container.getDocDiv();

ldb.o.setStyle(this.div, {

backgroundColor:'#f6f6f6',

backgroundRepeat:'no-repeat',

borderRadius: '4px' });

this._scrollPane = new ldb.framework.ScrollPane(this._container,

this.div);

builder = this._container.factory.getBuilderInstance(); node = builder.createElement(this._scrollPane.div, 'H1');




ldb.o.setStyle(node, { background: '#f6f6f6', margin: '0', borderRadius:

'4px', textAlign: 'center', lineHeight: '32px' });

builder.text(node, this._l10nMap.home, false);

node = builder.createElement(this._scrollPane.div, 'H2');

ldb.o.setStyle(node, { textAlign: 'center', lineHeight: '32px' });

builder.text(node, this._l10nMap.welcome, false);

node = builder.createElement(this._scrollPane.div, 'DIV');

ldb.o.setStyle(node, {textAlign:'center'});

node2 = builder.image(node, this._container.application.contextPath +

'/folder/home/web-dashboard.png', 'AXWAY');

ldb.o.setStyle(node2, {margin:'1em'});

},

getCommands: function () {

return this._container.application2.createCommandsArray();

},

getInfos: function () {

return null;

},

execute: function(action) {

if (!action) return;

switch (action) {

default:

this._container.application.displayErrorMessage({ message:

this._container.application.getL10nMap().notImplementedError },

'Finance');

};

},

resize: function() {

this._scrollPane.resize(this.div.offsetWidth, this.div.offsetHeight);

}

}; ldb.js.registerUrl('folder/Home/home2.js');

Import Excel filesWeb Dashboard allows you to import data from Excel files into different databases managed by Web Dashboard. The Excel sheets should contain tabular data disposed in one area only.

The file to be imported can be located on a local directory or on server side inside any folder defined in Web Dashboard in Administration > Folder.




The information you provide in order to import the Excel file is saved as a template. This allows you to re-import the file in the future.

A three-step wizard helps you insert the data from an Excel file into a database managed by Web Dashboard. The wizard analyzes the file, scanning the first 15 lines to determine the type of data in each column.

1. On the Main menu, click Data management > Excel Import.

A list of previously created import sessions is displayed.

2. Click the New document button to create a new Excel import.


3. On the Description tab, you specify information about the import. Enter information in the following fields:

Field Description

Name A unique identifier for the Excel import session. The name is a mandatory field.

Description A user friendly label of your Excel import session to be displayed across the GUI. The description is a mandatory field.

Entity Owning entity (see Set up access management). This will impact the access rights for this object.

World The World pointing to the database into which the data from the Excel file will be imported.

Source location

Use these buttons to specify the source of the import. Select either the local directory or the on server folder radio button. The file can be located on a local directory or on server side inside any folder defined in Web Dashboard in Administration > Folder. After you select the type of location, choose the file to import data from. For files located on server site, click the folder icon to open a file chooser popup. The file chooser popup lists all the Folders defined in Web Dashboard.

4. After you select a file, click on the green arrow on the right to go to the next step, on the Source tab.

The file is analyzed, a preview and some basic options are displayed.

If the Excel file contains more that one sheet with tabular data, each sheet can be individually handled. Uncheck Import worksheet to ignore the current sheet.

If the first row in the Excel file is the header of the table, select the option, First row is label.

5. Click More details to further modify the import settings. You can then choose the data type of each column and which part of the sheet to import. If you set the End row to zero, the whole sheet is imported.

6. Click the green arrow on the right to go to the next step on the Destination tab.




7. Data will be imported in a table. If the table doesn't exist, it will be created. By default, a table name will be generated, and the table will be created in the previously selected World (see Create a world on page 29). By checking the option Create data dictionary the application will generate a new data dictionary (see Build a data dictionary on page 33) representing the data from the Excel file. Therefore, after the import is finished, data is ready for building reports.

8. Click More details to configure how to insert data in the database.

9. On the Destination tab, enter values for the following fields:

Field Description

Create data dictionary

Check this option to create a new standard data dictionary based on the table defined.

Import type

Choose from the following:

l Carbon Copy — data added replaces data contains in the table, if any

l History — data is added to the existing table without delete the old data.

Table The name of the table to be populated with the source data.

Catalog The name of the database catalog.

Schema The name of the database schema.

Create table if needed

The table is created if it does not exist. Otherwise, you can use an existing table.

Delete type

When you use the Carbon copy import type, use this field to select the Delete type:

l Delete — Deletes all the rows from the table, but does not free the space containing the table.

l Truncate — Deletes all rows from the table and frees the space containing the table. You cannot use this option when the table is referenced by a Foreign Key.

Commit Type

Choose from the following:

l Line by line — Commits after each line is written.

l Global commit — Commits once after all lines are written.

l Number of lines before a commit — Commits after a number of lines you specify.




Field Description

Batch execution

Batch execution allows you to group related SQL statements and into a batch and submit them with one call to the database.

l Deactivated — Batch execution is unavailable.

l Global batch — Groups all SQL statements into a single batch. This mode of batch execution improves performance as there is only one call made to the database.

l Number of lines in a batch — Split SQL statements into multiple batches. This mode of batch execution generates multiple calls to the database.

10. Click the green arrow button on the right side of the screen to import your Excel data.

When lines are inserted into the table during import, the result of the transaction is displayed as a message.

11. Click the Save button.

Your settings are saved allowing you to perform the same import later. The reference to the Excel file, itself, is not saved. This means each time you want to reuse these settings, you must select an Excel file again.

Internationalize Web DashboardYou can internationalize Web Dashboard to display field labels translated into the language specified for the user. This allows users to have access to the application in their assigned or preferred language. For a language to be associated with a user, you must activate it from the Language menu.

The steps for internationalization include:

1. Make languages available

2. Provide translations on the Internationalization tab for each object you want to internationalize.

3. Specify a language for the user

Note When you specify a language, the menu labels, report and dashboard titles and all the descriptions are translated into that language.

Make languages availableFor a language to be available for internationalization, it must exist on the Language tab. See Languages in Web Dashboard on page 204.

In addition, you must make a language active for it to be available. If you change the active status of a language, you must restart the web server to make the change effective. By default, English and French are active.




Provide internationalization valuesYou provide internationalization values (translations) for Web Dashboard field labels using the Internationalization tab. Primarily, these will be descriptions that users see when they use Web Dashboard. There are, however, other fields for some Web Dashboard object that you can internationalize. See Additional fields for internationalization on page 202.

The Internationalization tab will display a set of fields for each language that you have activated. It is here that you provide translations to be displayed in the user's language.

Note Internationalized labels can contain special characters supported by UTF-8 encoding.

1. Go to the tab for the object for which you want to internationalize text, for example, Data management > Data dictionary, and click the Internationalization tab.

For each active language, the Internationalization tab displays a list of fields for which you can specify translations.

2. Enter values for the fields you want to display as translated.

3. Click Save.

Additional fields for internationalizationThe following table lists some additional labels specific to certain Web Dashboard objects that can be internationalized:

Web Dashboard Object Internationalization fields

Data dictionary Description CommentTable nameFields name

Dashboard DescriptionFiltersTemplate description

External component DescriptionDescription parameters (Filters)

Form Description of the formDescription of the fields used




Web Dashboard Object Internationalization fields

Report Description of the reportCommentFiltersFields (columns) displayed in the reportLabel of calculus line cells

Text Description of the text object and the body text

Control Description of the control objectComment (Thresholds)Message Subject and Body

Metric Description of the metric objectMessage Subject and Body

Task Description of the task objectCommentMessage

Select a user languageYou can either assign languages on a per-user basis or the user can specify a language in his Preferences options. When a user selects a language, all descriptions in reports, dashboards, and other objects are immediately displayed in the selected language. However, menu labels are displayed in the new selected language only if user refreshes the page manually in the web browser, or logs out and logs in again.

To select a user language, do the following:

1. Go to User management > User and select the user for which you want to assign a language.

2. Select a value from the Language field.

3. Click Save.

Best practice for language managementYou should consider adding languages in the early stages of Web Dashboard configuration and development to avoid having to repeat internationalization procedures unnecessarily.

Before you design reports and dashboards, consider the following activities.




1. Add and activate all necessary language.

2. Create data dictionaries and complete internationalization for every selected field. Column fields translation will be automatically used in reports.

3. Create a first report:

l For every calculated field and every filter, complete the internationalization.

l For every column name you change, change the translation too.

4. Duplicate reports. If you use same columns, filters, and calculated fields, you will not have to rewrite translations.

5. Create your dashboards and other objects based on reports. Complete internationalization for each object.

Languages in Web DashboardUse the Language item in Web Dashboard to activate or deactivate an existing language or to add new languages.

When you activate a language, it becomes available in the Internationalization tab and can be used for translating labels.

When you select the Language item from the Administration folder, a list of the languages supported by Web Dashboard is displayed.

The default language is English. You can change the default by updating the faces-config.xml file located here: <Web server>\webapps\SentinelWebDashboard\WEB-INF>

By default, English and French are activated.

Add a new languageTo add a new language, follow these steps.

1. Go to Administration > Language.

2. Click the Add button .

The Description tab is displayed.

3. Provide values for the following fields:

Field Description

Name A unique identifier for the language

Description A label associated with your language to be displayed across the GUI. The description can be internationalized (translated into the language defined for each user) using Internationalization tab.




Field Description

Language The ISO-639-1 code for the language. For example, the code for Romanian is ro. This is a mandatory field.

Date field pattern, Date and time field pattern, Time field pattern

The format for the Date, Date and time, and Time.

4. Select the Active check box to make your language active and available to be used for internationalization.

If you decide not to use a language, deselect the Active check box. The language will no longer be available for internationalization.

5. Go to the Internationalization tab and add a description in each of the other active languages available on the tab.

6. Click the Save button .

Data formats used in Web DashboardYou use data formatting in Web Dashboard to change the appearance of values to be displayed throughout the application, for example, in reports and dashboards.

Valid data types are as follows:

l numeric

l date, time, date&time

l interval

l image

l choice

Specify a data formatYou specify a data format for a report on a column-by-column basis. To specify a report format:

1. Open a report and go to the Design tab.

2. Right click the column in the report for which you want to adjust the data format and select Column properties from the drop-down list.

3. In the Data format field, enter the format you want to use. See the table below for valid formats for all data types.




Alternatively, click the button next to the Data format field to display a separate dialog box where you can enter information about the column. The options available in this dialog box will depend on the column's data type.

Valid data formatsThis section provides information about how to specify a particular data format for a given data type.

Numeric format To define how to format numeric data, you can create a custom numeric format string consisting of one or more custom numeric specifiers shown in the table below.

Symbol Description

0 Replaces the zero with the corresponding digit if one is present. Otherwise, zero appears in the result string.

# Replaces the "#" symbol with the corresponding digit if one is present. Otherwise, no digit appears in the result string.

. Determines the location of the decimal separator in the result string.

- Minus sign.

, Inserts a localized group separator character between each group.

E Separates mantissa and exponent in scientific notation.

; Defines sections with separate format strings for positive, negative, and zero numbers.

% Multiplies a number by 100 and inserts a localized percentage symbol in the result string.

\u2030 Multiplies by 1000 and show as per mile.

' Used to quote special characters in a prefix or suffix.




Examples

Format Value Country Result

{0,number,#,##0.00} 1234.5678 EN 1,234.57

FR 1.234,57

1234.0000 EN 1,234.00

FR 1.234,00

{0,number, 0.00} 1234.5678 EN/FR 1234.57

1234 EN/FR 1234.00

{0,number,0.##} 1234.5678 EN 1234.57

1234.5000 EN 1234.5

1234.0000 EN 1234

{0,number, 0.00%} 0.253 EN 25.30%

{0,number,0.00} L 1234.5678 EN 1234.57 L

US$ {0,number,0.00} 1234.5678 EN US$ 1234.57

{0,number,0.00} [euro] 1234.5678 EN 1234.57€

{0,number,-#.00} 1234.5678 EN -1234.57

{0, number,#0.0#;(#0.0#)} 1234.5678 EN 1234.57

-1234.5678 EN (1234.57)

Date formatUse this format for date or numeric data. When dates are expressed as numeric data, it is in milliseconds since 1 January 1970.

Symbol Description

G Represents the period or era, such as A.D.




Symbol Description

y "y": The year, from 0 to 99. "yy": The year, from 00 to 99. "yyy": The year, with a minimum of three digits. "yyyy": The year as a four-digit number.

M "M": The month, from 1 through 12. "MM": The month, from 01 through 12. "MMM": The abbreviated name of the month. "MMMM": The full name of the month.

w Week in year

W Week in month

D Day in year

d Day in month

F Day of week in month

E Abbreviated name of the day in the week in local language (Mon, Tue, and so on)

EEEE Full name of the day in week in local language (Monday, Tuesday, and so on)

Examples


{0} 2010-12-24T08:49:45

EN 12/24/10 8:49 AM

FR 24/12/10 08:49

{0,date} 2010-12-24T08:49:45

EN Dec 24, 2010

FR 24 déc. 2010

{0,date,short} 2010-12-24T08:49:45

EN 12/24/10

FR 24/12/10

{0,date,medium} 2010-12-24T08:49:45

EN Dec 24, 2010

FR 24 déc. 2010





{0,date,long} 2010-12-24T08:49:45

EN December 24, 2010

FR 24 décembre 2010

{0,date,full} 2010-12-24T08:49:45

EN Friday, December 24, 2010

FR vendredi 24 décembre 2010

{0,date,yyyy-MM-dd HH:mm}

2010-12-24T08:49:45

EN 2010-12-24 08:49

FR 2010-12-24 08:49

{0,date,yy-DDD} 2010-12-24T08:49:45

EN 10-358

FR 10-358

{0,date,’<’w’> ’E} 2010-12-24T08:49:45

EN <51> Fri

FR <51> Ven

Time formatUse this format on date or numeric data. When time is expressed as numeric data, it is in milliseconds since 1 January 1970.

Symbol Description

a AM/PM

H Hour (0-23)

k Hour (1-24)

K Hour am/pm (0-11)

h Hour am/pm (1-12)

m Minute

s Second

S Millisecond




Symbol Description

z Time zone

Z RFC822 Time zone

Examples


{0,time} 2010-12-24T08:49:45 EN 8:49:45 AM

FR 08:49:45

{0,time,HH:mm:ss} 2010-12-24T14:49:45 EN/FR 14:49:45

{0,time,H:mm} 2010-12-24T08:49:45 EN/FR 8:49

{0,time,h:mm:ss a} 2010-12-24T08:49:45 EN/FR 8:49:45 AM

{0,time,H'h 'm'min 's's 'S'ms'} 2010-12-24T08:49:45 EN/FR 8h 49min 45s 0ms

Interval formatUse this format on numeric data. When an interval is expressed as numeric data, it is in milliseconds since 1 January 1970.

Symbol Description

d h:m 'Days' 'Hours':'Minutes'

d h 'Days' 'Hours'

d Days

h:m:s 'Hours':'Minutes':'Seconds'

m:s 'Minutes':'Seconds'

s Seconds

h:m 'Hours':'Minutes'

h Hours am/pm (1-12)

m Minutes




Examples

Format Value Result

{0,interval,h:m:s} 5,270,924 1:27:50

{0,interval,m:s} 5,270,924 87:50

{0,interval,d h:m:s} 5,270,924 0 1:27:50

Choice formatThis format is applied to numeric data only. It allows you to attach a format to a range of numbers.

The values should be in a list separated by |. List items should be specified in ascending order. The separator between the value and the label is # for values to be included, and < for values to be excluded ("x#" is less than or equal to x and "x<" is strictly greater than x).

Example:

{0,choice,-1#is negative|0#is zero or fraction|1#is one|1<more than one}

l if x<=-1, "is negative"

l if -1<x<=0, "is zero or fraction"

l if 0<x<=1, "is one"

l if x>1, "more than one"

Image formatThe following items describe how to use the image format:

l To insert an image in a report, set the format of a column to “[image]”.

l To display this image, first upload the image in the user’s Theme. For example, name it “uk” and attach a low DPI image to it (uk.png) like a 16x13 px PNG representing the flag of United Kingdom.

l Create a table report (see Set up reports on page 45) into which you have at least one column which has at least one cell with the text “uk”. Using the Column properties, set the format of the column to “[image]”.

l In the table report, on the specially formatted column, wherever the cell contains exactly the text “uk”, it is replaced by the image uploaded in the theme.

l In order to visualize the image when executing a report you should restart the server and clear the browser cache after adding or updating the image in the user’s Theme.




Publicly accessible Web Dashboard objectsIn Sentinel Web Dashboard, you can access different types of objects (for example, reports or dashboards) without authentication. Of course, for security reasons, the access level offered is minimal, you are basically granted only visualization rights.

Public objects can be accessed with the following url: SentinelWebDashboard/public/webdashboard/<doctype>/<docname>

where:

l <docname> is the name of the object

l <doctype> is the type of the object

Use values from the table below when specifying a doctype.

doctype value Object type

report Report document

dashboard Dashboard document

external External session

To make a document publicly available, associate it with the predefined entity object Public and the predefined workspace Public. By default, Public workspace is empty.

See User access managment on page 102 for information about entities and workspaces.

Once you've accessed a public object in a browser, you are considered logged into Web Dashboard with a generic user called webdashboard, with no option of switching to another user or logging out.

Note As long as the generic user's session is still valid, you cannot be logged into Web Dashboard with a different user in that same instance of the browser. This means that, for logging into Web Dashboard with a regular user after having accessed public documents, you need first to empty the browser's cache.

Integrate dashboard into third-party softwareYou can integrate Sentinel Web Dashboard objects into third-party HTML pages, for example, portals. To do this, the HTML pages must conform to W3C standards for HTML. If you do not need authentication, the objects must be public. See Publicly accessible Web Dashboard objects on page 212. Otherwise, the user will be presented with the Web Dashboard login page.

When you have your HTML ready, you must deploy it on a web server. If Web Dashboard is accessible via HTTPS, the SSL certificate must be trusted by the browser where the third-party HTML is displayed.




Important! For Security reasons, if the third party software has a different host name than the Sentinel's web server, accessing the Web Dashboard objects won't work without having the external host name or IP specified in the referer.hosts.accepted property, in server.properties. This functionality was introduced in Service Pack 13.

The following is an example of an HTML file deployed on the same web server as Web Dashboard. This example uses a public dashboard and features the following elements:

l a meta tag to prevent Microsoft Internet Explorer from switching to compatibility mode.

l a div tag that acts as a container for a Web Dashboard report.

l two script elements to provide the logic necessary to display the report with the name "MyReport."

Note Do not use Internet Explorer quirks modes.

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html>

<meta http-equiv="X-UA-Compatible" content="IE=edge"></meta>

<meta http-equiv="Content-Type" content="text/html;charset=utf-

8"></meta>

<body>

<script type="text/javascript"

src="/SentinelWebDashboard/js2/libs/ext/jquery.min.js" charset="UTF-

8"></script>

<script type="text/javascript"

src="/SentinelWebDashboard/js2/document.min.js" charset="UTF-

8"></script>

<script>

ldb.e.observe(window, 'load', function() {

var container = new ldb.document.Container();

container.bootstrap({

id:'XXX',

sessionType:'DOCUMENT',

name:'MyReport',

publicUser:'webdashboard',

contextPath:'/SentinelWebDashboard',

embedded:true,

noFinder:true,

noPostit:true,

noBookmark:true,

noSettings:true,

noLogout:true

});

});




</script>

<h1>Hello world!</h1>

<p>Here I am</p>

<div id="XXX" class="ldb" role="application"

style="position:absolute; left:10%; width:80%; height:400px; border: 1px

solid #999;"></div>

</body>

</html>

The parameters supported in the script are:


id Div id in which the document is to be inserted (mandatory)

contextPath Context where Sentinel Web Dashboard is deployed (mandatory). This context must be either of the following: • a relative path. It must start with '/' (for example: /SentinelWebDashboard). • a complete URL, beginning with http:// or https://. In this case, the HTML page and Sentinel Web Dashboard come from different origins. The CORS parameter is needed. Note CORS mode is not supported by older browsers, for example Internet Explorer 6, 7 or 8.

clientId This parameter is applicable only if the "embedded" parameter has the value "true". The client id is mandatory when embedding objects from multiple Web Dashboard instances in the same HTML page. See sample code provided below.

cors Parameter for Cross-Origin Resource Sharing (http://www.w3.org/TR/cors/). Default value is false. For more details, see the description of contextPath parameter.

sessionType The type of the document to display (mandatory). Specify one of the following: • DOCUMENT: Report • DASHBOARD: Dashboard • EXTERN: External session • CONTROL: Control • METRIC: Metric • METRIC_HISTORY: Metric history • CONTROL_PANEL: Control panel • METRIC_PANEL: Metric panel • STRATEGY_MAP: Strategy map


http://www.w3.org/TR/cors/




name The name of the document to display. Mandatory when "sessionType" is any of the following: • DOCUMENT: Report • DASHBOARD: Dashboard • EXTERN: External session • CONTROL: Control • METRIC: Metric • METRIC_HISTORY: Metric history

filters Filters to apply to the report or dashboard. • name: filter name • use: true to apply the filter or false to not apply the filter • datatype: the data type of the filter: • GENERIC_NUMERIC: numeric • GENERIC_DATE: date • GENERIC_CHAR: string • values: String array for filter values

publicUser Always has the value webdashboard. Indicates that the object to display is public and does not require authentication.

noFinder If true, hides the menu icon from the right side of the toolbar.

noPostit Used to hide post-its. For public objects, true is considered independently of the configured value.

noBookmark Used to hide bookmarks. For public objects, true is considered independently of the configured value.

noSettings Used to hide user settings. For public objects, true is considered independently of the configured value.

noLogout Used to hide the logout button from the toolbar. For public objects, true is considered independently of the configured value.

Examples

Code snippet for using filters for a dashboard objectThe dashboard's dashboardName is filtered on the field, year.

...





id:'XXX',

sessionType:'DASHBOARD',

name:'MyDashboard',


embedded:true,

filters:[{name:'year', use:true, datatype:'GENERIC_NUMERIC', values:

['2012','2013']},

]});

...

CORS mode - remote Sentinel Web DashboardIn this case, the src and the contextPath attributes must specify a complete URL. Here, a code snippet for embedding MyReport from a remote Web Dashboard (foo.com).

... <script type="text/javascript"

src="http://foo.com:18080/SentinelWebDashboard/js2/document.min.js"

charset="UTF-8"></script>

<script>


var container = new ldb.document.Container();


id:'XXX',


name:'MyReport',


contextPath:'http://foo.com:18080/SentinelWebDashboard',

embedded:'true',

cors:'true' ,

});

</script>

...

Note To use CORS mode, uncomment the filters and related mapping in the web.xml file of Sentinel Web Dashboard. To find the filters and mappings, search for cors.

Web Dashboard objects from multiple Web Dashboard instancesYou can integrate several objects from different Sentinel Web Dashboard installations into a single HTML page. To do this, define your HTML page with several div elements with the unique identifiers, XXX, YYY, and ZZZ.




...


var container = new ldb.document.Container(), callback;

callback = function()

{

var container2 = new ldb.document.Container();

var container3 = new ldb.document.Container();

container2.bootstrap({

id:'ldb2',

clientId:'YYY',


name:'MyReport1',



cors:false,

embedded:true,

});

container3.bootstrap({

id:'ldb3',

clientId:'ZZZ',

sessionType:'DASHBOARD',

name:'MyDashboard1',



cors:false,

embedded:true,

});

};


id:'ldb1',

clientId:'XXX',


name:'MyReport2',


publicUser:'webdashboard', cors:false,

embedded:true

},

callback);




});

...

If you want to use the multiple integration with CORS mode, modify it to specify an absolute URL for the contextPath parameter and to set the parameter cors to true.



6 Web Dashboard logs and troubleshooting

By default, Web Dashboard log entries are written into the Tomcat console or the catalina.<date>.log file (for example, catalina.2014-01-10.log) available in <WEB_SERVER_HOME>/logs directory, where <WEB_SERVER_HOME> represents the absolute path to the home directory of your web server. Logs are managed using log4j and by default only messages with the following levels are logged: INFO, WARN, ERROR and FATAL.

To troubleshoot the application, create a file named log4j.xml and place it in the <WEB_SERVER_HOME>/webapps/SentinelWebDashboard/WEB-INF/classes directory. Restart Tomcat or reload the Sentinel Web Dashboard Web Dashboard web application via the Tomcat Application Manager to ensure this file is considered.

In the example below, logging is redirected to a dedicated file called SentinelWebDashboard.log and log level is adjusted to DEBUG. To use this example, you must replace <WEB_SERVER_HOME> with the absolute path to your web server's home directory, for example, C:/Axway/Sentinel/Tools/apache-tomcat.

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/"

debug="false">

<appender name="FILE" class="org.apache.log4j.RollingFileAppender">

<param name="File" value="<WEB_SERVER_

HOME>/logs/SentinelWebDashboard.log"/>

<layout class="org.apache.log4j.PatternLayout">

<param name="ConversionPattern" value="%d %-5p \[%t\] %C{2} (%F:%L) -

%m%n"/>

</layout>

</appender>

<root>

<priority value="DEBUG"/>

<appender-ref ref="FILE"/>

</root>

</log4j:configuration>

For information about how to create your custom log, visit http://logging.apache.org/log4j/1.2/.


http://logging.apache.org/log4j/1.2/


Date post:	17-Apr-2020
Category:	Documents
Upload:	others
View:	10 times
Download:	0 times