Intro
The Charge Station Importer allows for to batch Import Charge Station and Locations as well as batch Update Charge Stations based on a CSV file.
This could be useful to update e.g. tariff codes or deploy states
High level process
The importer has six main steps as outlined below:
Additional information on steps:
- Selecting the Culture, this determines the acceptable formats e.g. for dates and decimal numbers. More info on the field section
- Notes can be added for internal reference when looking at the importer history
Import Actions
There are different actions that can be taken.
- Batch importing Charge Stations + Charge Locations
- Batch creating Charge Stations into existing Locations
- Batch updating Charge Stations
- Batch move Charge Stations to an existing Location - NOT APPLICABLE - use instead Move Charge Stations (greenflux.com).
All Imports require an Import file that has the same format, but slightly different required fields depending on the operations.
File requirements
Action | File |
1) Create a new charge station and a new location | All minimum required fields for a CS and Location must be supplied.A location is identified based on a combination of name, address & Zip Code. |
2) Create a new charge station into an existing location | All minimum required fields for a CS and Location must be supplied.The exact location details of the target location need to be added. It is not possible to identify a target location by location ID. |
3) Update one or many charge station | Update multiple fields for an existing Charge Station.Required fields do not have to be supplied, and cannot be cleared |
CSV import file
The Import needs to be in a .csv format. An example file can be downloaded in step 3 of the import process.
Per Action, the minimum requirements for the csv file below are outlined.
1) Batch importing Charge Stations + Charge Locations
This action can be best used when you want to create both new charge stations and locations.
Minimum required fields to create both new Charge Stations and Locations:
Field name | Required | Example |
ChargeStationID | yes | GFX0002022 |
ChargeStationTemplateID | yes | ABB-wallbox |
TariffCode | yes | A0 |
LocationName | yes | University of Amsterdam |
HouseNumber | yes | 306 |
Street | yes | Science Park |
ZipCode | yes | 1098 XH |
City | yes | Amsterdam |
CountryCode3 | yes | NLD |
ChargerType | yes | Home |
2) Batch importing Charge Stations to existing Charge Locations
This action can be best used when the target Location already exists and new charge stations need to be added. The required fields are the same as the previous action.
Attention: When performing this Use Case, extremely important to use the exact same data for the existing location where you are trying to map the chargers. When the House Number, Street, Zip Code, City and Country code are not an exact match (character by character, including spacing), then the procedure will be creating new locations for the new chargers, instead of mapping them in the desired existing location.
Minimum required fields to create new Charge Station(s) into existing Location(s):
Field name | Required | Example |
ChargeStationID | yes | GFX0002022 |
ChargeStationTemplateID | yes | ABB-wallbox |
TariffCode | yes | A0 |
LocationName | yes | University of Amsterdam |
HouseNumber | yes | 306 |
Street | yes | Science Park |
ZipCode | yes | 1098 XH |
City | yes | Amsterdam |
CountryCode3 | yes | NLD |
ChargerType | yes | Home |
3) Batch Update Charge Stations
It is possible to update one or more Charge Stations by just providing the ChargeStationID and then any number of optional fields that should be updated for those Charge Stations.
We strongly recommend not to use any Location fields as this operation is intended for batch updating Charge Stations only.
Minimum required fields to update existing Charge stations:
Field name | Required | Example |
ChargeStationID | yes | GFX0002022 |
Sub Use Case: Batch Update Charge Station Tariffs - check details in this dedicated article.
4) Move Charge Stations
For this use case, do not use this tool, but rely instead on the Batch Move Charge Station functionality, which is reflected in this KH article: Move Charge Stations (greenflux.com). This tools is way more robust for performing that specific need.
General notes on import file
- Empty values - Any columns that has empty values, or any columns not supplied in the file, will not make any changes to the charge station or its location.for example: not setting or not adding any value for 'InstallationDate' will not change the existing value.To be clear, it is not necessary to include every optional field in the import file
- Replace and update - Fields that have lists as input 'replace and update'. E.g. Facilities or Auth list. it is not possible to add one additional token or facility, the entire list + any new additions need to be updated
- Changelog Changes made in the EV portal can be viewed in the update log and on the record itself and it is possible to see which values have been updated.
Updates made via the Importer will currently not share the level of detail. It will show that a record has been updated, but not the changes themselves.
- Import format - Excel sometimes automatically changes the field formats, creating issues. This can be the case for for dates, currency amounts or lat/longs. Please select the 'text' cell format or use another program in case this issue persists.
Sync issues between EV portal and CPO database
GreenFlux has two main databases for Charge Station data, one underlying the EV Portal and the other the core Charge Station data. Both should be in sync with each other.
However, it can be possible that there are some sync issues. Using the CS Importer will trigger a sync and it could lead to these sync issues coming to the surface.
Charge station import fields
List of fields with description and validation for Charge station fields.
Field Name | Required for new Charge station | Description | Validation and examples |
ChargeStationID | Yes | 'External charge station ID' in EV PortalCan never be changed afterwards. | Max length 39 characters.For example EVB-P1851371. |
ChargeStationTemplateID | Yes | Creates EVSEs and Connectors based on Hardware template. Is always mandatory for creating new Charge Stations | Valid template ID (see EV Portal --> Manage Hardware templates --> TemplateID). See below for further info where to find it. |
TariffCode | Yes | 'Default Tariff' in EV PortalMust already exist in the EV Portal for the required CPO Network. | Unique ID, Max length 36 characters.Example is A1. |
ReimbursementTariffCode | 'Default reimb tariff' in EV PortalMust already exist in the EV Portal for the required CPO Network. | Unique ID, Max length 36 characters.Example is A1. | |
ChargeStationName | 'Custom Name' in EV Portal | Free Text. Max length 255 characters. | |
Floor | Part of Directions to the specific Charge Station | Free text. Max 4 characters | |
ChargeStationDirections | 'Directions to Charge Station' in EV Portal. | Free text, directions from location to charger. Language will always be set to EN (English). Max length is 512 characters | |
DeployState | 'State' in EV Portal.Specifies the deploy state of the Charge Station. | Accepted values:StockProductionDeprecatedDEfault is Production | |
InstallationDate | The date and time of when this Charge Station was installed. Must be a valid date and time. | This field is culture specific. Requires date and time input.Example input:2021-10-28T08:45:11Z (Z = UTC timezone) | |
ContactlessType | Sets the type of contactless terminal used by this charge station. | Accepted values arePayterNayax. | |
ContactlessTerminalSerialNumber | 'Payment Terminal ID'Used to determine the contactless payment terminal for this Charge Station. | Unique string. | |
ContactlessTerminalAuthAmount | 'Pre-authorization amount' in EV PortalThe amount that will be charged to the customer for using the contactless payment terminal. Must be a decimal number. This field is culture specific. | ||
ChargeStationAuthList | Sets the Authorizaton for the charge station. Entries will replace and update existing field. To update tokens, use the specific import tool in the portal. | To import Customers use: CustomerExternalId:CustomerNameFor tokens use:ClosedGroups:GB-GFX-CEAMPLEAUTHFor multiple values separte with a pipe '| 'CustomerExternalId:CustomerName| CustomerExternalId:CustomerName| ClosedGroups:GB-GFX-CEAMPLEAUTH| | |
TapToStop | Only for Payment terminals. Whether Drivers can stop a transaction using the same card that started the transaction. | Value should be true or false. The default value is false. | |
StopOnParking | BETA, do not yet use | Value should be true or false. The default value is false. | |
MaintenanceInfo | 'Maintenance Information' in EV Portal | Free Test | |
Remarks | 'Notes' in EV Portal | Free Text | |
Charger Type | Yes | Internal administriative field to classify a Charge Station | Accepted Values:HomeBusinessPublic |
The ChargeStationTemplateID can be found by navigating to:ChargeStation List --> Manage Hardware templates --> Template ID in the Ev Portal.If the column is not visible, add it using the menu in the top right corner.
A valid ChargeStationTemplateID must be supplied to create a new charge station.
Location Import fields
Below is an overview of all acceptable Field names and their description for the Location object.
Field Name | Required for new Location | Description | Validation Examples |
LocationName | yes | 'Location Name' in EV Portal. | Free Text. Max length 255 characters. |
HouseNumber | House Number of the address | Max length 20 characters. | |
Street | yes | Max length 255 characters. See below for details of location address validation. | Max length 255 characters. See below for details of location address validation. |
ZipCode | yes | 'Postal Code' in EV Portal | Valid ZipCode. Max length 10 characters. |
City | yes | City | Max length 58 characters. |
CountryCode3 | yes | A valid 3 letter country code, Example NLD. Must be 3 characters, and must be a valid ISO 3 character country code. See below for details of location address validation.https://www.iban.com/country-codes | Common examples:NLDGBRBELGERFRAPRTESPGRCITA |
AddressLine2 | This field is not used to determine the location used by the charge station. | Max length 255 characters. | |
Facilities | Set the related Facilities for the Location. | Accepted values: HotelRestaurantCafeMallSupermarketSportRecreationAreaNatureMuseumBusStopTaxiStandTrainStationAirportCarpoolParkingFuelStationWifiFor multiple values separte with a pipe character ' | 'Museum|Cafeor: Airport|Hotel|TrainStation | |
Latitude | Calculated based on address if not provided. Latitude of the location can be optionally provided. | Must be a valid Latitude value between -90 and 90. Field is culture specific | |
Longitude | Calculated based on address. Longitude of the location can be optionally provide. | Must be a valid Latitude value between -180 and 180. Field is culture specific | |
TimeZone | Time Zone of the location. Calculated based on address. | Must be a valid Windows time zone name according to https://support.microsoft.com/en-ie/help/973627/microsoft-time-zone-index-values .Examples:GMT Standard TimeCentral Europe Standard TimeGTB Standard Time | |
IsPublic | 'Published' field in EV Portal.This field determines if the location will be published externally to roaming partners through OCPI and Hubject. Value should be true or false. The default value is false. | True or FalseDefault: False | |
IsRestricted | 'Restricted Access' in EV Portal.Sets the OCPI restricted accces, to indicate that this Location may not be available to the general public. | True or FalseDefault: False | |
LocationDirections | 'Directions to location' in EV Portal | Language will always be set to EN (English) . Max length is 512 characters | |
AuthList | Sets the 'Authorization' at the Location level.Entries will replace and update existing field. To update tokens, use the specific import tool in the portal. | To import Customers use: CustomerExternalId:CustomerNameFor tokens use:ClosedGroups:GB-GFX-CEAMPLEAUTHFor multiple values separte with a pipe '| 'CustomerExternalId:CustomerName| CustomerExternalId:CustomerName| ClosedGroups:GB-GFX-CEAMPLEAUTH| | |
EnergyMixProfileId | 'Energy Mix Profile' in EV Portal.The ID of the energy mix profile that the location should use. The energy mix profile must already exist in the EV Portal. | 86ae001d-c6df-43f6-9364-ef5e426dba0c | |
LocationType | 'Location Type' in EV Portal.The LocationType of a Location as outlined by OCPI: | One of the following values: OnStreetParkingGarageUndergroundGarageParkingLotOtherUnknown | |
PaymentProvider | The PaymentProvider is the external payment providert that can be used to authorize at charge stations in this location. | The accepted values are:Lemonway. | |
WalletId | The WalletId to be used by the payment provider for this location. | ||
CustomisedFIelds | Pipe separated string with Type and Value (type:value|type:value) | Example: 'LocationMobieVoltage:BTN|LocationMobieCpe:PT0002123116495528CW'LocationMobieVoltage can be one of the following options: BTN, BTE or MT (In Portuguese: BTE - Baixa Tensão Especial; BTN - Baixa Tensão Normal; MT - Média Tensão)LocationMobieCpe means in Portuguese: CPE = Código de Ponto de Entrega |
Location Address
The location of the charge station will be determined by the following fields:
- HouseNumber
- Street
- ZipCode
- City
- CountryCode3
The address of a location must be unique for a CPO. Only one location with the specified address can exist for a CPO.
If a location inside the CPO exists with an address matching the above fields, then the charge station will be added to this location.
If the location does not exist, then it will be created, and the charge station will be added to this newly created location.
AddressLine2 is an optional location field, and will not be used to determine if the location already exists.
Updating Location Name or Location Address Fields.
It is not possible to update the address fields of a Location. Doing so would create a new Locaton and move any existing Charge Stations to this newly created Location.
Please note that this will not change the address of a location. It is not possible to modify the address of a location with the charge station importer. It is only possible to change the location to which the charge station belongs.
Related actions
Batch moving Locations
Moving Locations across a CPO is currently an action that can only be performed by GreenFlux Support. Please create a support ticket for batch actions.