Address

The accelerator is published under URL that will be referred as baseURL. Access to each of its instance is possible through baseURL/instanceURL. Some instances provide anonymous access; in order to access other a user needs to authenticate.

Usage of user's data

The accelerator uses cookies to store user's credentials. The website asks for users physical position in order to display that on a map on a login screen.

Logging in

Each time a user wants to access a page they do not have access to they will be asked to log in. A screen similar to this will be displayed:
login1.PNG

A user should enter their credential. It possible to mark if the system should remember the user.
If a user provides invalid credential an appropriate message will be displayed:
login2.PNG

While in the application a user can see their username and a name of an instance to which they are logged in.
login3.PNG

If a user is not logged in a prompt to log in will be displayed.
login4.PNG

A user can log off using a log off link under their login information.
login5.PNG

Languages

A user can change a language of the application by selecting a link next to user info. All static texts in the application will be displayed in a selected language. Indicators name, if available, will be displayed in it too.
login5.PNG

Viewing cities

Anonymous user (if available) and viewer users can access Cities page. It is a default page after logging in. Users can access it entering address baseURL/instanceURL/Cities/ManageCities or by clicking Cities link in a header.
login4.PNG

A user is presented with a list of cities; the cities are displayed on a map. By each city their is a piece of information representing a number of KPI's available in the latest active load for this city. By clicking on View Dashboard user will be redirected to this city's dashboard.

IDB:
viewcities.PNG

GCIF:
viewcities4.PNG

AfDB:
viewcities5.PNG

After clicking on city's name or its pushpin the map will be centred on the city and an infobox will be displayed. A number of KPI's and a date of the latest active load will be displayed.
viewcities2.PNG

It is possible to find a particular city by typing its name in Select cities textbox.
viewcities3.PNG

Managing cities

Admin users instead of seeing Cities page will see Manage Cities. They will be presented with a similar page but with more options:
mngcities1.PNG

Admin users can delete all the inactive sets for a particular city, change city's name or upload a new set (described later). After clicking on Active/Inactive indicator an admin user is able to see each data set information for a particular city:
mngcities2.PNG

Each set information consists of:
  • number of valid KPI's in this set
  • set's relevance date
  • upload information
  • if this set is active; if it is not it will be present in the system but not displayed
  • if this set is publicly available; it it is anonymous users will be able to access it, otherwise only authorized users (viewers and admins) will see this set; this option is unavailable if the entire instance was given no public access (described later)
  • download summary to download a report on this particular set (in a txt format); the report shows all the details including all the errors on importing KPI's - each error shows a line of file in which the error occurred and a brief description of problems
  • delete set button - this is active only for inactive sets - in order to delete an active set a user needs to mark is an active; this action cannot be undone

Adding new city

After clicking on Add new city (in a header) there will be an overlay displayed:
addcity1.PNG

The user enters name of a city they want to add. The system will use Bing Maps resources to find an appropriate city. If there is more than one result the user will be presented with a list of them:
addcity2.PNG

Clicking on a list position will cause the map beneath to move to a selected location and an infobox will be selected. After selecting a valid location the user can adjust a name under which the city will be stored in a system.

City Dashboard

City dashboard is accessible from various places in the system by links. A user can access it directly by entering an address baseURL/instanceURL/Cities/CityDashboard?id=cityID. After entering a particular city dashboard a screen similar to this:
dashb1.PNG

A user is presented with a city's name and a number of KPI's in the latest active load. A user can change active city by selecting another one from a drop down list in a top right corner. In the centre of the screen the user is presented with a chart of a selected indicator. There is its name, unit and description displayed. Below the chart there are three colour boxes (green, amber, red) displaying conditions for the ranges. The chart is displayed using various colours - the colours change when the line crosses any threshold. To displays thresholds explicitly a user can check 'Show thresholds' check box.

Chart

User can hover over any marked point on the chart; in this case detailed information will be displayed. User can select the entire range - by clicking in one point of the chart, holding a mouse button and moving mouse to a desired end position; please note that this works only horizontally. After selecting a range detailed info for all the points within this range will be displayed.
dashb2.PNG

User can narrow down the main chart using a smaller one below. User can change starting and ending dates for the main chart by moving ends of an orange bar of the smaller chart:
dashb3.PNG

After narrowing it down user can move the orange bar to adjust the main chart range.

There are three chart types available in the application:
  • Line chart
  • Scatter chart
  • Bar chart
User can switch between these types using buttons below the chart. The fourth button switches on or off threshold lines.

KPI's list

Below the chart there is a list of all the indicators available for the city. Each of the indicators is displayed with its name, current (latest) value, unit, and a small chart. Additionally the entire tile is displayed with a colour (red, amber, green) corresponding with the latest value's range. Please note that if the value does not fall into range the tile (and the entire chart) will be displayed in black. On each tile there is a thumbnail of a chart for this value too.
dashb4.PNG

After clicking on a tile the main chart will be replaced with a new one for a selected indicator.

Hovering over a blue 'i' icon on a tile will show an infobox containing this indicator description. Hovering over 'message' icon on a tile will show comments or links for the indicator. These icons are not available if there are is no description or comments and links.

Users can search for particular indicators. In order to do that they have to click on 'KPI Search' button and begin to enter indicator's name:
dashb5.PNG

After doing that the list below will be narrowed down to selected indicators only.

Users can organize tiles in various ways:
  • by various levels of categorization
dashb6.PNG
  • by various levels of alphabetical order and colour schemes
dashb7.PNG

After selecting any of these user can also define sorting order:
dashb9.PNG

A set of available options depends on previous choices.

This screenshot shows a sample organisation by status:
dashba.PNG

Comparing cities

User can access this screen by clicking on 'Compare cross-city KPI' button on a tile on City Dashboard screen. Another possibility is to enter address directly: baseURL/instanceURL/Cities/CompareCities/cityID?indicatorId=indicatorID.

comp1.PNG

A user is presented with a screen with a selected city's name and a relevance date for the latest active set for it. Then there is a colour box displaying a value of a selected indicator and showing its range. User can change the active city by selecting another one from a drop down list in the top right corner.

User can examine the selected indicator and change it by using another drop down list.

User is presented with a chart similar in behaviour with a chart described earlier in City Dashboard section. A main difference is that the chart is not coloured.

Below the chart there is a list of all the cities defined for the instance of an application. Some cities have check boxes (ticks); these which do not do not have this particular indicator defined.

User can select one or more cities to be included in a comparison:
comp2.PNG

In this case the chart will display more than one line. Each line will have its own colour and there will be a label on a right end of a line indicating a corresponding city.

Select city button works similarly as one described in View City page - it allows to narrow down the list of cities.

Map comparison

By clicking Map button user can hide a chart and display a map.
comp3.PNG

User will be presented with a map with pushpins for all the selected cities. Each pushpin is displayed using a corresponding colour. Clicking city's name or its pushpin will reveal more detailed information:
comp4.PNG

Matrix comparison

Matrix comparison is available after clicking 'Compare' link in the header or by entering address baseURL/instanceURL/Cities/Compare. The user is presented with a view similar to the following:
matrix1.PNG

There is a map containing all the cities that have active sets. Below there is a matrix: in each row there is a city, in each city - an indicator. User can narrow down cities list by clicking 'Select city' button and entering desired cities names.

User can select up to 5 (in desktop version) indicators using drop down lists.
matrix2.PNG

After doing that each cell of a matrix will contain data related to the selected indicator for a particular city. The cell contains current value of this indicator, its unit, and a simplified chart; the entire tile is coloured accordingly to a current range. Please note that if there is no indicator defined for a city an empty cell will be displayed.

User can click on one of the cells. In this case the entire column will be highlighted and triangle indicators will be added. Values in the triangles will be differences between the selected city's value and a particular one's. Arrows will show a direction of the difference.
matrix3.PNG

Please note that this will colour all the pushpins on the map accordingly to the selected indicator.

User can star a city - all starred cities will be displayed at the beginning of cities list.
matrix4.PNG

Uploading data set

User can enter upload file screen by clicking 'Upload new set' button from Manage Cities screen. A similar view will be displayed:
upload1.PNG

The user has to select a type of a spreadsheet: IDB, GCIF, or AfDB.

User has to select a city from a drop down list and choose relevance date for this upload. This can be done using three text boxes (day, month, year) or by clicking on a calendar icon. It applies to IDB file only.
upload2.PNG

Please note that if user chooses to enter a date manually they must take care of entering a valid date:
upload3.PNG

After user clicks on 'Choose file' button a standard file choosing window will be opened. User should choose a CSV file with valid data (more on files below). After choosing a file user will be presented with files details and will be able to choose another file (replaces existing one):
upload4.PNG

User is presented with a preview of a file.
upload5.PNG

User should select where a header row is. After changing this selection the preview will reload and will be showing the file starting with a selected row. Another thing to do is to select first row of data.

User needs to assign column that will be imported to columns in the file. In order to do that they should select a value from a drop down list for each important column.
upload6.PNG

There is a several options; not every option has to match a column. These values have to be assigned:
  • name
  • description (IDB only)
  • unit
  • red (IBD only, AfDB optional)
  • amber (IBD only, AfDB optional)
  • green (IBD only, AfDB optional)
  • threshold 1 (GCIF only)
  • threshold 2 (GCIF only)
  • value
  • year (GCIF only)
  • quarter, week, or day (GCIF only)
Remaining are not necessary.
Please note that there may be only one matching for each value. If user chooses a value for a second time the first matching will disappeared.

After matching all the values user should click on 'Upload' button. After a successful upload Manage Cities page will be displayed and the user will be able to see an upload report and to adjust the load's settings.

Files

Files that are uploaded have to be valid CSV (comma separated value) files with semicolons (;) as delimiters. Files may have headers; there may be only one indicator value per row. Each kind of value has its own rules that must be followed.

There are two supported file formats: IDB and GCIF.

Fields description

Name (all)

Name has to be a valid string. Please note that there may be more than one name column. If there are columns for names in different languages their names must follow the rules: assume that name's column is IndicatorName. In this case a column containing names in Spanish must be named IndicatorName_ES.

When matching a value to existing indicators this value has to be exactly the same.

Description (IDB and AfDB only)

Description has to be a valid string.

When matching a value to existing indicators this value has to be exactly the same.

Unit (IDB only)

Unit has to be a valid string.

When matching a value to existing indicators this value has to be exactly the same.

Red, Amber, Green (IDB only)

These fields have to fit into following rules:

While importing spreadsheets into the application there will be some restrictions put on ranges. Each range column (for green, yellow, and red range) will have to satisfy the following conditions:
Number values
It is enabled to use units in range definitions. Units have to be included after a number (‘60-120 hab/ha’); they cannot occur before a number (‘$60000-$120000’).
Floating point values
Floating point values must be in format 123.45. It is allowed to add either + or - sign in front of it. It is possible to omit the fractional part (123). A separator has to be a dot (.).
Ratio values
Ratio values must be in format 123.45:1. For the first number (123.45) the same rules as for floating point values. The second number has to be set to 1.
Range definitions
Inequality ranges
Inequality range has to be in format {operator} {number}. Operator has to be one of the following: <, >, <=, >=. No spaces within the operators are allowed. Number has to follow the rules for numbers. All additional characters (like units) will be omitted.
Equality ranges
Equality range has to be in format {number} or = {number}. Number has to follow the rules for numbers. All additional characters (like units) will be omitted.
Range
  • Format 1
Range may be presented in format {number} {keyword} {number}. Numbers have to follow the rules for numbers (see). Keyword is one of the following – or a. The list is not closed – it may be extended through web.config file edition. All additional characters (like units) will be omitted. Numbers have to be in one format (either floating point or ratio).
  • Format 2
Range may be presented in format {keyword1} {number} {keyword2} {number}. Numbers have to follow the rules for numbers. Keyword1 is one of the following entre or between; keyword2 is one of the following: y or and. The lists are not closed – there may be extended through web.config file edition. All additional characters (like units) will be omitted. Numbers have to be in one format (either floating point or ratio).
Multiple ranges
Ranges described above may be combined. They are in format {range1} {operator} {range2} {operator} …. Ranges must follow range formats described above. Operator is one of the following y, o, or, or and. The list is not closed – it may be extended through web.config file edition. All additional characters (like units) will be omitted. Numbers have to be in one format (either floating point or ratio).
Please note that using multiple ranges with ranges in format 2 is invalid. For example ‘between 0 and 40 and between 100 and 140’ is invalid and should be rewritten to ‘0-40 and 100-140’. Using format 2 while trying to store a multiple range definition may lead to a wrong interpretation.

Please note that Amber range is not obligatory.

When matching a value to existing indicators these value have to be the same. It does not mean they have to be literally equal - they have to define the same range (in a normalised form).

Threshold 1, Threshold 2 (GCIF only)

Threshold values are translated into Red, Amber, Green ranges definition in a following way:
  • Red: <Threshold1
  • Amber: Threshold1-Threshold2
  • Green: >Threshold2

Theshold 1 and Threshold 2 values must comply with number definitions described above.

Value (IDB and GCIF)

Value has to conform number values defined above.

Dimension, Pillar, Topic, Subtopic, Level 5, Level 6 (all)

Levels have to be valid strings. These define hierarchy levels for each indicator.

When matching a value to existing indicators these values have to be exactly the same.

Comment (all)

Comment has to be a valid string. This is displayed in additional information space for indicator.

Links (all)

Links field has to consist of valid strings separated by a pipe (|) sign. Each link has to be in its full form (i.e. with trailing http:// or https://).

Year (GCIF only)

Year for a current row of data.

Quarter, week, or day (GCIF only)

Quarter
Quarter for a current row of data. Needs to be in format Qx where x is a number 1, 2, 3, or 4.
Week
Week for a current row of data. Needs to be a number between 1 and 54.
Day
Day for a current row of data. Needs to be either a number between 1 and 366 or a string of format xx-yy where xx is a day of month and yy is a month.

Years for AfDB

These fields are not assigned explicitly. All the columns having names that are four-digits long valid years will be assumed to be value columns for a particular year.

Templates

Users can use these templates to ramp up on using the solution. Each version of template is available both as an Excel file (.xls/.xlsx) and a CSV file (.csv). User can edit an Excel file and then save it as CSV.

Managing instances

A superadmin user can manage instances of the application. Each instance is a separate site with a different set of users, cities, and loads.

In order to enter instance management page user have to go to address baseURL/admin/Instances. User will be presented with a similar page:
instance1.PNG

There is a list of all the instances defined for the application. User can search them using Site search button and Select sites text box.

Each instance contains information about a number of cities defined in it, creation date, and detailed URL. Admin user can access each site by clicking 'View site' button.

For each instance user can reset passwords for its admin and viewer account. In order to do that they have to click on 'Admin' or 'Viewer' button by 'Password reset for' label. Admin has to type a new password and retype it.
instance2.PNG

Admin user can change public access rules for each instance. If a site is marked as publicly available (public access set to yes) this site's admin will decide on each load whether it should have anonymous access. If public access is set to no the site's admin will not be able to decide on it; all loads' property will be changed to be visible for registered users only.

Another option for admin user is to change site's name. Admin can also choose a logo for a site; the choice is limited to logos that have already been uploaded.

In order to create a new site the admin user should enter a desired name into 'Site name' textbox and click on 'Create' button.
instance3.PNG

A popup with two textboxes will be displayed. Please note the difference between site name and site URL - the former is a user friendly name available everywhere in the system; the latter is the URL required to access sites. There are no restrictions on site name. However site URL must follow valid URL rules - it must not contain space or any special characters (as parenthesis, exclamation mark, colon, etc.).

Last edited Jul 12, 2013 at 10:06 AM by tomaszskucha, version 10

Comments

No comments yet.