ChargeBox
Frequently Asked Questions
How do I download statistics data?
- From the stats page, use the search tool or click on table contents (e.g. the station's serial number) so that 12 stations or fewer are selected.
- Use the buttons (see below) at the top right of the main stats table to open the download dialog for either the daily stats or interactions data.
Note: You may not have the permission to view these buttons - You can further narrow your range of csv data by using the date fields in the dialog. By default, the range covers a month prior to the current day.
- Interactions - Information about every interaction with a station e.g. locker/cable used, charge given, duration
- Daily Stats - Daily totals for usage and vending currency data, essentially a table view of the usage graph
Sparta doesn't work in IE
Many of the packages and libraries used to make Sparta what it is are incompatible with Internet Explorer (especially older versions). It is recommended that Sparta is operated within Chrome, Firefox or Safari
What data is collected when I log into ChargeBox systems?
Your email, userid, and password are all that is required to log in to our systems. We also store the name of all users. The password is encrypted and is stored using one-way encryption, meaning nobody can ever retrieve your password. We will send you information to the email address you have associated with your account on any password reset.
Statistics Help
What Stats?
Sparta provides a number of statistics for every Internet enabled ChargeBox+ station. The following usage data is collected for each ChargeBox interaction:
- The station serial number and locker number
- The date, time and duration of the interaction
- The total cash/tokens inserted for an interaction (if vending)
- The outcome of the interaction - whether the charge was completed
- The total charge delivered during the interaction
- The device USB enumeration data identifying the make and model of device and device serial number (where provided)
- The times of all key events, including when the locker door is closed and opened.
Understanding The Graph
The column chart on the home (stats) page is a graphical representation of the filtered statistics data shown in the table below. The "x" axis represents the date over a range for which data is present (up to 3 months), and the "y" axis (by default) represents the total number of successful charges split by the following criteria:
- Light Blue: Charged Short (<= 30 minutes)
- Blue: Charged Complete (> 30 minutes, <= 2 hours)
- Dark Blue: Charged Overdue (> 2 hours)
Users with the permissions to view cash statistics data for vending ChargeBox units are able to view the daily totals for cash and token intake as part of the stats page breakdown. Each currency (including tokens) will appear in the radio selector above the graph, and the checkboxes above the main table, which will display the respective currency totals when clicked
Stations Help
The Stations Tree
On the stations page, individual stations are grouped into a hierarchy for ease of navigation and managing various levels of scope. This hierarchy consists of the following levels:
- Partner - represents the different ChargeBox regional partners
- Account - represents a particular client
- Site - a specific geographical site
- Location - a location within a site where at least one station is placed
Unknown vs Unplaced
On the stations management page, you may notice the 'unknown stations' and 'unplaced stations' sections.
- Unknown stations are those that have no serial number attached to them - This could mean that the station is either new or incorrectly configured.
- Unplaced stations are those without an assigned location - This means that the station is reporting with the correct serial but without a set location.
When an unknown station is updated with a new serial number, it will move into unplaced stations. A station will move to it's expected reporting location when both the serial number and location ID have been set.
If a station has been correctly configured and a duplicate station remains in the unknown or unplaced sections, there is the option to 'hide' the station within the edit dialog. Hidden stations can be displayed by pressing the 'Show Hidden' button at the top of the stations tree.
Managing Reports
Located to the right of each tree item is a report summary of all stations attached to the selected level of scope. The icon corresponds to the total number of stations under the associated tree node, whereas the and icons illustrate the distribution of reporting vs non-reporting stations that form this number.
Also note the color to the left of each tree node:
- Grey Bar The station* does not have any reporting data or is currently uploading its data.
- Orange Bar The station* has not reported for over 1 hour.
- Green Bar The station* is currently reporting.
* 'station' here also refers to any station attached to the specific tree node
Add/Edit Station Tree Items
A number of other items are also visible on the right hand side of each tree item. The available functions for each of the icons will vary depending on the current level of scope:
- (Partners, Accounts, Sites) - Adds a new instance of the selected tree item. input name and tags (text)
- Metadata (Accounts, Sites) - Check
Edit App's Metadata.
- (All Scopes) - Opens the Edit dialog. input name and tags (text)
- Note - the Edit dialog for individual stations allows new locations and serials to be set. input name, actual serial (text) and location (scope selector tree)
- Similar Configurations - Editing some stations may reveal a list of similar stations. Depending on the similarities between the configurations, users can choose to merge the stations or identify them as being entirely separate.
- Ignore Station - The edit dialog for some stations may also include a button to 'ignore' the selected station. Pressing this will set the station's status to 'hidden'. This is typically used to hide stations that have been incorrectly configured
- Metadata (Sites, Locations, Stations) - Check
Edit App's Metadata.
- (Stations) - Opens the Report dialog for the selected station, the date/timestamp for the last 5 station reports are displayed.
Edit App's Metadata
ChargeBox App needs some information about Sites, Locations and Stations from Sparta. If the required information is not available the App does not show the site. Please ensure that all required information is available in Sparta.
- Site's Metadata
- Display Name - Is shown throughout the App and should reflect the name of the client’s site.
- Address
- Name - Should be the name of the place if it is not the same as the ‘Display Name’.
- Number - Street number.
- Street - Street name.
- City - Write City in full in English.
- Code - Zip or Postcode, please make sure this is formatted as required for addresses and as you wish it to be displayed in the App.
- Country - Please write Country in full in English.
- Geo coordinates - Must provide accurate positioning of a site at street level. Two options are avaible to set up the geo coordinates: using the input boxes or clicking in the map.
- Status - The status of a site determines whether or not it is displayed in the App. Please select 'visible' or 'hidden'.
- Opening Times - Please insert the site's opening times. If all days have empty values the site will display no opening hour information. For a given day the available options are: closed, open 24 hours and one or more time ranges.
- Opening Time Exceptions - Are to display seasonal or bank holiday differences to the normal opening hours, these display during the week that they occur. Please select a date and the opening times for the given day. The available options are: closed, open 24 hours and one or more time ranges.
- Additional information - For any specific access restrictions for a site, e.g. for a casino: ‘You must be over 18 to enter this site’.
- Location's Metadata
- Display Name - Is shown throughout the Site information and should reflect the name of the location at the client’s site.
- Level - Level information should reflect the name of the level at the client’s site, e.g. -1, 0, 1, 2, 3. If however the location uses ‘Lower Ground’, ‘Ground’, ‘Upper Ground’, then an abbreviated version should be entered in the field i.e. LG, G, UG.
- Geo coordinates - Must provide accurate positioning of a location within a building. Two options are avaible to set up the geo coordinates: using the input boxes or clicking in the map.
- Status - The status of a location determines whether or not it is displayed in the App. Please select 'visible' or 'hidden'.
- Additional information - For any specific access restrictions for a location.
- Station's Metadata
- Type - Please select the station's type.
- Number of Lockers - Select the number of lockers.
Roles & Users Help
The User Tree
Much like on the stations page, users and roles are grouped within a hierarchic tree. The level on which a user, or user role sits defines it's level of scope and available permissions. The levels of scope are:
- Sparta Super Administrator
- Sparta Administrator
- Partner Administrator
- Account Viewer
- Site Viewer
A user attached to a particular role will inherit the default permissions attached to the selected scope. Users can be attached to multiple roles of different scopes, whereas roles may only exist as single nodes in the tree structure. A user can be assigned roles that branch outside the scope of the default role.
Add/Edit User Tree Items
- The icon will open a dialog prompting the user to add a new User or Role
- User: Dialog to enter the new user's email, password, first name and last name into the required fields, followed by the permissions to be allocated to that user
- Role: Dialog to enter the role name and permissions set for users attached to this role type
- The icon opens the Edit dialog, allowing the user to edit the above mentioned fields.
Software Help
Files and software deployed on stations can be changed here. This option is only available to administrators.
Further information and guidance is shown in the corresponding manual. Please ask your preferred point of contact inside the company for the file.
- Stations - The settings control the update category of stations
- Manual - stations will not receive updates
- Test - Units in highly controlled environments being test stations for new or untested software
- Staging - Controlled in-field units to receive first wave of updates for risk mitigation
- Production - Units in the field to receive software over-the-air, largest part of fleet
Classification is done by searching for stations and putting them in the lower table. By default, stations are categorised as “manual” to avoid mistakes.
Assign - here, packages are deployed to stations.
It can be selected which software should be deployed to which units. Deployments can be made for your whole user, an account, site or even for single stations.
An assignment can be easily changed. Instead of creating new assignments it is always worth to see if altering an existing one could give the same results
What's New?
Version 4.7.8
This version includes the following changes and improvements:
- Humber stations are added to daily reports.
- Added "Duration (Seconds)" column for daily stats.
The following bugs were fixed for this version:
- Fixed some blocking process issues.
- Various interface issue fixes.
Version 4.7.7
This version includes the following changes and improvements:
- Added xlsx support for each daily reports.
- Added date filtering for each graph.
The following bugs were fixed for this version:
- Fixed daily stats exporter issues.
Version 4.7.6
This version includes the following changes and improvements:
- Incomplete Interaction - the process by which we build interaction information in the database
The following bugs were fixed for this version:
- Sparta stats site - "stations" summary shown seems suspect
- Software management hanging in stations tab
Version 4.7.5
This version includes the following changes and improvements:
- Network report - daily network report per station
The following bugs were fixed for this version:
- Station vs Machine - 'machine' is renamed as 'station' or 'serial'
- Locked over alert email - Locked over alert email should be sent only when locked_over
- Login page clears email address when password entered is incorrect
- network connection information can't be opened on sparta website for humber station
- XLSX downloads appear to have dates as string cells
Version 4.7.2
This version includes the following changes and improvements:
- Filter results - clearing the filter results in the stats page keeps the previous organisation
The following bugs were fixed for this version:
- Daily report - the daily report had a too narrow date range selector
- Interactions report - column amount in XSLX files was formated as text instead of number
- Hash encoding - last Firefox version is using a URL encoding for the hash. It was affecting to the role selector
- Station management page showing duplicate Stations when filter used
Version 4.7.1
This version includes the following changes and improvements:
- Money box report - extra column Period has been added to the money box reports
- Financial report - extra columns Period Days, Counted Days and Uncounted Days have been added to the money box reports
The following bugs were fixed for this version:
- Missing start_time in last report info from stations connected to the network server
- Sparta was allowing across partners linking
- Daily report - under certain circumstances there were missing rows in the daily stats report
Version 4.7
This version includes the following changes and improvements:
- Sparta R4.7 is faster - several optimisations make this release faster than previous releases
- Notification email - the email notification template has been updated
- Interactions report - the protocol has been improved to increase the number of selected stations
The following bugs were fixed for this version:
- Sparta was allowing across partners linking
- Daily report - under certain circumstances there were missing rows in the daily stats report
- Notification email - Sparta was sending false positives locked-over notifications
Version 4.6.5
This version includes the following changes and improvements:
- Cash box - currency is preselected in the cash box count and the box id is displayed on the tables
The following bugs were fixed for this version:
- Notification email - missing logo in the notification emails
Version 4.6.4
The following bug was fixed for this version:
- Notification email - missing logo in the notification emails
Version 4.6.3
This version includes the following changes and improvements:
- OTA - over the air updates system has been implemented
The following bug was fixed for this version:
- Minor style fixes
Version 4.6.2
This version includes the following changes and improvements:
- Interactions report - extra column have been added to the interactions report: Charging Duration, Current Average, Lock Delay, Unplugging Delay and Locker Events
The following bugs were fixed for this version:
- Notification email - the notification protocol has been improved to avoid no permanent coin jam notifications
- Notification email - new locked-over notification
Version 4.5.1 - 4.6.1
These versions includes the following changes and improvements:
- Minor UI changes - Small tweaks to management UI
Version 4.5
This version includes the following changes and improvements:
- Money box reports - Three new reports related to money boxes have been implemented: Counted boxes report, Collected boxes report and Open boxes report
- Number of sequences - Sequences are available in the last reports dialog. It is useful for the people that is uploading journal files. Now the last received sequence for a given station is known, then journal files must be uploaded using that sequence.
- App's metadata - We have worked in the App's metadata, in this new release Sparta allows to update the information about stations, locations and sites from the web.
The following bugs were fixed for this version:
- A bug in the App's request has been fixed - The bug was affecting to unlinked and relocated stations, it means that in some sites, the App's is showing more available lockers than actually are.
Version 4.4
This version includes the following changes and improvements:
- Sparta R4.4 is faster - Fewer sever requests and other optimisations make this release faster than previous releases
- Removed date range from open cash boxes - Users can now see all open cash boxes without having to enter a specific date range
- The user's current role is now printed below of the user's name in the menu
- Users can now set their default role (role they log in with) in their account settings
- The 12 stations limit in the daily stats report csv download has been removed
- Distinction between free/vending stations in the stations tree
- View station configurations in an all new dialog
- New stations graph on stats page to show number of stations reporting
- Days/times with missing data are visible on stats page graphs
- Improved responsive design - better formatting on smaller screens
- Sorted stations tree - Stations in Management > Stations are now sorted by their reporting status (if they are green, orange or grey), then by serial number. This makes it easier to find stations, especially in long lists such as in Unknown/Unplaced.
- Page Navigation - We no longer have to wait for a page to load fully before navigating to a new page. When clicking away from the current page, all requests that are currently in process are aborted. This also reduces the risk for clash of page data.
The following bugs were fixed for this version:
- Bug in the money boxes date selector - minimum date now updates for end date
- Missing money information in interaction reports
- Daily reports now are sorted by station serial and date
- Fix for password reset dialog for when new users log in
- Major fix for Internet Explorer - workaround for cryptography dependancy
- Smart Search fix - Smart search now filters stations based on station IDs rather than serial numbers, this will resolve issues where unexpected stations will appear in the stats table after searching
Version 4.3
This version includes the following changes and improvements:
- Smart search - A global search feature to more accurately filter the list of stations shown
- Encrypted CSV downloads - A system for downloading encrypted data (when present) as part of the interactions CSV download dialog
- Daily stats CSV - An option to download the daily usage/cash totals in CSV format. Essentially a table view of the data forming the stats page bar graph/s
The following bugs were fixed for this version:
- Missing stations bug - A number of unplaced stations were previously not showing in the stations management tree view
Version 4.2.1
This version includes the following changes and improvements:
- Closed box coin empty - a feature to split coin box objects that have already been closed/emptied
The following bugs were fixed for this version:
- Cash menu UI bug - Duplicate menu items appended when performing a manual close on a coin box
- Role name update - Error when attempting to edit the 'name' field for any role
- Edit location bug - Error when attempting to assign a new location to a station
Version 4.2
This version includes the following changes and improvements:
- Cash management system - A feature for managing the coin boxes for the vending ChargeBox units
- Improved station management - A system for streamlining station configurations and removing duplicate station objects
- Improved auth protocol - A more secure approach to user authentication regarding logging in, session validity and password changes
Version 4.1
This version includes the following changes and improvements:
- Revised CSV downloads - Cross browser support
- Alerts - New alerts skin replacing default browser alerts
- Minor UI changes - Small tweaks to management UI
The following bugs were fixed for this version:
- Cash addition bug - Stats objects containing more than one station object would incorrectly compile currency totals
- Misc. management bugs - A number of bugs involving updating users/roles in the management section have been resolved
Version 4.0
This version includes the following changes and improvements:
- Cash and tokens statistics - This version introduces cash and tokens data to the front page, enabling users to view the daily intake for stations with the vending service
- Hide unknown stations - Stations that don't have a location or serial number set can now be manually configured to 'hidden'. Hidden stations can be viewed by pressing the 'Show Hidden' toggle, and then manually reset to 'visible'
- Responsive design - Previously problematic page elements now conform to responsive design principles and are supported on phones and tablets. On smaller screens, all stats page elements are set to the full width and are vertically stacked, as well as the graph and main table reformatting to fit the new page width.
- Interactions downloads - It is now possible to select 12 stations at once for csv downloads (the previous limit was 2). Users can also specify the date range for the stats download with 'From' and 'To' date fields.
The following bugs were fixed for this version:
- Latest reporting station bug - Previously, the station with the most recent reports was incorrectly identified as being 'unknown' as a more recent (and incorrect) configuration was in it's place. This issue has been resolved.
- Search timeout - The search feature on the stats page is now only executed after the user is finished typing.
Version 3.1
This version includes the following changes and improvements:
- New 'Help' section - Various help topics outlining Sparta functionality as well as version history.
- Spinner graphic for page loads - Visual feedback for slow loading information. Displayed only when http requests are in progress.
- User interface adjustments - Some minor layout adjustments to improve user experience as well as a redesign of the tree navigation forming the 'Stations' and 'Roles/Users' pages
- Table sorts - The main data table on the stats page can now be sorted according to a specified column in ascending or descending order.
- Auto refresh with countdown - The latest station reports dialog now automatically refreshes every 30 seconds (still with the option to manually refresh)
The following bugs were fixed for this version:
- Timezone issue fix - Previously, station reporting dates/times were inconsistent with the viewer's timezone.
- Station location differentiation - Statistics for the same station attached to different locations are now correctly differentiated in the stats page into different rows.
- Config/Locations bug - Users are now blocked (and an alert is displayed) when attempting to assign new locations for previous station configurations
- Non-reporting colour - Stations without any report data ('n/a') are now identified with a grey strip, rather than the previous green/reporting colour
Version 3.0
This version includes the following changes and improvements:
- New permissions model
This release introduces tools to create and edit user roles. Each user can have several roles (with one default role). The role model follows a tree structure so each role could have a number of child roles. If a role has management permissions, users of this role can update other users linked to it and also those linked to its children roles.
- Management section
- Station Management Screen - A new section to create and edit accounts, sites and locations and to assign stations.
- Role/User Management Screen - A new section to create and edit users and roles.
- Station reporting status (+ unknown)
Enables users to view the reporting status of a station (or group of stations) and the date/time of the last 5 station reports. Unknown stations refer to those stations that are not currently linked to a specific location.
- Interaction exports
This is a new tool to extract data in csv format from Sparta:
- Serial Number
- Date
- Time
- Charging Outcome
- Charging Duration
- Charge delivered
- USB Ports used
- Search shortcut clicks
This is a mechanism to filter statistics by one click. Clicking an element in the table is equivalent to writing that same element in the search field at the top of the screen.