BI Portal User Guide - Amazon Web Services Vi...BI Portal User Guide BI Portal User Guide 3 January...

BI Portal User Guide


BI Portal User Guide 2 January 2018

Contents

1 Overview ........................................................................................................................ 3

2 Accessing the BI Portal ................................................................................................. 3

3 BI Portal Dashboard ...................................................................................................... 3

3.1 Adding a new widget ............................................................................................................. 4

3.2 Customizing an Existing Widget .......................................................................................... 8

3.3 Additional Widget Operations............................................................................................... 9

4 Widget Gallery ............................................................................................................. 10

5 Generating Reports ..................................................................................................... 11

5.1 Create a New Report ............................................................................................................ 11

5.2 Edit Report ............................................................................................................................ 13

6 Administrator Functions ............................................................................................. 13

6.1 User Management ................................................................................................................ 14

6.1.1 Add new User .............................................................................................................14 6.1.2 Edit User Details .........................................................................................................15 6.1.3 Bulk User operations ..................................................................................................15

6.2 Account Settings .................................................................................................................. 16



1 Overview

Agent Vi’s BI Portal is a Cloud-based reporting tool that allows seamless aggregation, analysis and presentation of data gathered from surveillance systems at multiple locations through a single, web-based interface. With this tool business intelligence (i.e. "BI") can be easily viewed, reformatted, and distributed by authorized users.

Examples of use:

A retail chain manager can compare customer in/out traffic between different days or store or even compare queue behaviors to define staffing policy

A parking lot manager can compare vehicle traffic between different parking lots

Additionally, raw data can be exported or retrieved via API for correlation with PoS data

The BI Portal features the following main capabilities:

Customizable dashboard for viewing BI data graphically (“Widgets”)

View one location or aggregate across multiple locations

Automatically send reports to email recipients

Create reusable BI Widgets that can be shared by multiple users that belong to the same account

View and report data using any Agent Vi’s BI analytic, including: Person/Vehicle Counting; Crow/Occupancy Measurement; Vehicle Speed Analysis

Account administration for creating and managing User

2 Accessing the BI Portal

To be able to access the BI Portal, a user must receive an invitation email that is triggered by the account administrator. Once the invitation is receive:

Click the invitation link within the email body

a screen will prompt the user to set their password

After the password is configured the Dashboard screen should appear (see details below)

Note

User must respond to the BI Portal invitation email within 2 days. If not, the invitation expires and the user will need to ask the account administrator to reissue another invitation.

For subsequent BI Portal sessions the user can point their Web browser to https://biportal.agentvi.com and enter their user name and password

3 BI Portal Dashboard

The BI Portal Dashboard is the day-to-day viewing interface of BI data that could be customized according to specific needs and interests. The dashboard contains multiple “Widgets”, where each widget displays selected BI data with a given format for a given time range. Below is a typical example of a BI Portal dashboard screen:

https://biportal.agentvi.com/



3.1 Adding a new widget

When entering the dashboard for the first time, there are no widgets to display data. Instead, there is a clear label at the center of the screen:

Clicking the Add New Widget button enters the widget editor screen. At the bottom right area, there is a list of BI data types which are applicable for the account, like in the example below:



The options list only shows data types that are configured in the system. For example, a retailer who only has people counting setup will not see Vehicle Count, Speed Analysis, etc. The BI Portal, however, can support multiple analytics if they are configured into the system.

Click the icon of the BI data type to add a new widget to the dashboard. In the example below, the People Count type has been selected:

The main operations to take at this stage are:

Click the time range control:

Choose of the predefined options (like Today, Last 7 days, etc) or select date range using the Custom option (specifying start and end dates).

Click the Add data to widget label:

This will prompt the data selection dialog:



The data select control contains the hierarchy of the entire analytics system:

Systems (e.g., your store locations) Sites (e.g., different floors or different departments) Cameras Rules (different measurements per camera). If we look at the following example:

We can see that we have:

• 2 systems (Mall East and Mall West)

• Mall East has 1 site (Mall Entrance)

• The Mall Entrance site has 2 cameras (Cam 1 and Cam 2)

• Cam 1 has 1 rule (counting of people entering

Use the box control ( ) to select a node in this hierarchy; use the arrow control ( ) to expand a node level in this hierarchy.



Use Group By setting to change the default chart data grouping. By default, all the charts represent the statistics data summarized by selected rules of a savVi system deployment (see section above that describes rule selection). When grouped, the data for People and Vehicle counting rules is aggregated while for all other rules the data is averaged. The data can be grouped by a whole System, a Site within savVi, Camera, or a single Rule (i.e., the data is not grouped).

Example of statistics grouped by System (the legend contains savVi system names):

Example of statistics grouped by Camera (the legend contains camera names):

The Name attribute field gives a meaningful name to the added widget, like in the



example below:

Finally, click the Save button at the bottom of the screen.

Note

Once a Dashboard contains some widgets, a new widget is added by clicking the Plus icon at the bottom right area:

3.2 Customizing an Existing Widget

At any given time the user can customize an existing widget:

Click and modify the Time Range control

To modify the graph type and format, click the Graph Type control:

From here, the following can be modified:

• The graph type (Line; Column; Stacked; Pie)

• The Graph Width (Full; Half)

Rename the widget by double clicking its name label:



3.3 Additional Widget Operations

Click the widget menu for additional operations:

Save to Widget Gallery (see more details about the Widget Gallery in the next section)

Export the statistics data to a CSV file for further analysis and presentation options that are available from Microsoft Excel.

Delete the widget

Further to the above operations, when the Dashboard contains multiple widgets, they can be repositioned: click the mouse over the widget icon:

Once the icon is clicked (marked above) it can be dragged and drop to a new position

within the dashboard.



4 Widget Gallery

The Widget Gallery is a repository of widgets that can be shared by all account members. When adding widgets to the Dashboard one of the options available to the user is to add from the gallery. Following are the main operations that apply to the Widget Gallery and its resources:

To access the Widget Gallery, click the Widget Gallery tab on the left of the main screen:

The process of creating a new widget in the gallery, is identical to the process of

adding a new widget to the Dashboard, as described above.

In addition, a new widget can be added to the gallery by saving an existing widget from the Dashboard – using the Save to Widget Gallery menu option.

An existing widget in the Widget Gallery can be edited by clicking is Edit button:

To delete a widget from the gallery, first enter its Edit screen as described above and then click the Delete Widget button:



5 Generating Reports

5.1 Create a New Report

The BI Portal has the ability to send statistics data via email in CSV format without the need to log in to the website. Additionally, a user can create standard reports and send them to non-portal users through their email address.

To access the Reports, click the Reports tab on the left of the main screen:

To define a new report, click the Plus ‘ ’ button. The following report definition view is displayed:



The data for defining a report is:

• Report Name (will appear in the email subject)

• Report Frequency - The available options are: Daily, Weekly, Every two weeks and Monthly.

• Time of day to receive the report. Note, that the report will be sent using the time zone of the customer that created the report.

• Day of week (relevant in case of Weekly reports).

• Email body text. This is an optional field that contains the email body text that would be embedded within the email.

• Report Recipients. This field allows to add email addresses of the report

recipients. Note that after entering the email address, click the button.

• Report Widgets. The report widgets represent the statistics data to be received

by the report. In order to add widgets to report, click on a yellow button. After clicking on it, all the widget gallery widgets are displayed and can be dragged one by one to a report widget placeholder, as displayed below:



After a widget is placed in the report, the settings can be customized in the same way as dashboard widgets as described in section #3 (BI Portal Dashboard).

Once all steps above are accomplished, the widget can be saved.

5.2 Edit Report

In order to edit report settings after it is already defined, click on a report row. When clicking on an already defined report, it can be tested by clicking ‘Send Report’ button:

6 Administrator Functions

This section covers the BI Portal advanced settings that are available to account users with ‘Administrator’ account role.



6.1 User Management

A user with ‘Administrator’ role is able to add, invite, delete or edit other user details. All this can be done by switching to ‘Users’ view:

6.1.1 Add new User

A new user can be added to an account by clicking the yellow button in the right bottom corner. Fill in all the fields of the view that will be shown:

Once the ‘Save & Invite’ button is clicked, the invitee receives an email invitation with a link to join the account.



6.1.2 Edit User Details

Editing User details is invoked by clicking on a user row in Users table. The following view shows users details:

The following operations can be done using this view:

• Changing user ‘Account Role’. The available options are ‘User’ or ‘Admin’.

• Updating email address

• Changing user name. By clicking on ‘Edit’ button ( )

• Resending an invitation. By clicking on ‘Resend Invitation’ button

• Blocking a user. By using ‘Status’ switch

• Deleting a user. By clicking on ‘Delete User’ button

6.1.3 Bulk User operations

The BI Portal allows performing some user actions on a group of users, using the controls below:

• The users can be filtered by entering text in the Search field

• The users can be blocked, unblocked, deleted or can receive their invitations again, by selecting a group of users and selecting one of the actions



6.2 Account Settings

User with ‘Administrator’ role can view or change account details, as shown below:

This view is allows the ‘Administrator’ user:

• Copy the ‘Account Key’ (relevant when installing the savVi Cloud Uploader)

• View the associated savVi systems (deployments)

• Allow (or disallow) your support team to view account stats data

Notice

Copyright © 2003-2018 by Agent Video Intelligence Ltd.

Agent Video Intelligence Ltd. holds the copyright to this manual. All rights reserved. No part of this publication may be reproduced or transmitted in any form or by any means without prior written consent from Agent Video Intelligence Ltd.

Disclaimer

The information in this manual was accurate and reliable at the time of its release for this specific version. However, Agent Video Intelligence Ltd. reserves the right to change the specifications of the product described in this manual without prior notice at any time.

The customer should note that in the field of video there are a number of patents held by various parties. It is the responsibility of the user to assure that a particular implementation does not infringe on those patents. Agent Video Intelligence Ltd. does not indemnify the user from any patent or intellectual property infringement.

Trademarks

Agent Vi™, Vi™, savVi™, savVi-Analyst™, savVi-Manager™, Vi-Agent™, Vi-Agent Proxy™ and Vi-Server™ are trademarks of Agent Video Intelligence Ltd.

All other proprietary names mentioned in this manual are the trademarks of their respective owners.

www.agentvi.com

[email protected]

http://www.agentvi.com/

mailto:[email protected]

BI Portal User Guide - Amazon Web Services Vi...BI Portal User Guide BI Portal User Guide 3 January...

Documents

Transcript of BI Portal User Guide - Amazon Web Services Vi...BI Portal User Guide BI Portal User Guide 3 January...