Portal Sync: Zones and Zones Travelled Chart
To make zone management easier and more efficient, the system supports bulk add, update, and removal of zone-related data via the Portal Sync function. This includes defining Zones and configuring their corresponding Zones Travelled Chart, which maps the number of sections travelled between each pair of zones. The following steps outline how to prepare and upload the required data for efficient syncing.
Zones
The first step is to prepare a list of all zones, including their names and optionally their associated organisation. These zones form the foundation for mapping the number of sections between them in the next stage
- Go to the Zones Page
From the main menu, click Zones to open the Zones Detail page.
- Click the Import Button
In the top of the Zones page, click Import.
- Download the File
- Blank File – Use this template if you are adding new zones.
- Zone List – This file contains all active zones in the system. Use it if you plan to review, update, or delete existing zones.
- Blank File – Use this template if you are adding new zones.
- Review the Rules & Prepare Your Data
Before making any changes, refer to the table of rules provided below to ensure your data meets the required format and conditions.
- Upload the File
Once your file is ready and correctly formatted, return to the Import window and upload your file.
- Choose the Desired Action
After uploading, select the action you want to apply:
- ADD – to add new zones
- UPDATE – to modify existing zones
- REMOVE – to delete zones from the system
Field |
TME Field |
Required? |
Format |
Rules |
Description |
---|---|---|---|---|---|
id | ONLY YES for Updating/Removing |
Number | Is prohibited for Adding | Adding: Must NOT be present. It will be auto-generated by the system. Updated or Removing: Must be present. To obtain the Id, select the ZONES LIST button to download the zones. |
|
name | Zone Name | Yes | Text | Must not be greater than 300 characters. |
Each zone should have a unique identifier and name for accurate reference across the system. |
organisation_id | Number | Must be a valid numeric ID | The organisation_id must be a valid number that corresponds to an active organisation. To find the correct organisation_id, go to Users > Organisations, click the Imports button, and download the ORGANISATION LIST. The organisation_id is shown in the first column of the file. |
Zone Travelled Chart
After you've added the zones, you’ll need to fill in the Zones Travelled Chart. It tells the system how many sections are between each pair of zones, which is used to calculate fares and travel distances.
- Go to the Zones Page
- From the main menu, click Zones to open the Zones Detail page.
- Click Zone Travelled Chart button
- Click the Import Button
In the top of the Zone Travelled Chart page, click Import.
- Download the File
- Blank File – Use this template to add new zone-to-zone section data, especially for zones that are new or not yet included.
- Zones Travelled List – This file contains all active zone combinations in the system. Use it to review, update, or delete existing entries.
- Blank File – Use this template to add new zone-to-zone section data, especially for zones that are new or not yet included.
- Review the Rules & Prepare Your Data
Before making any changes, refer to the table of rules provided below to ensure your data meets the required format and conditions.
- Upload the File
Once your file is ready and correctly formatted, return to the Import window and upload your file.
- Choose the Desired Action
After uploading, select the action you want to apply:
- ADD – to add new zone-to-zone section data
- UPDATE – to modify existing zone-to-zone section data
- REMOVE – to delete zone combinations from the system
Field |
TME Field |
Required? |
Format |
Rules |
Description |
---|---|---|---|---|---|
id | ONLY YES for Updating/Removing |
Number | Is prohibited for Adding | Adding: Must NOT be present. It will be auto-generated by the system. Updated or Removing: Must be present. To obtain the Id, select the ZONES TRAVELLED LIST button to download the zones travelled chart. |
|
zone_from | Yes | Number | Must be a valid numeric ID | The ID of the starting zone in the travel combination. This should match the zone_id from your Zones list. | |
zone_to | Number | Must be a valid numeric ID | The ID of the destination zone in the travel combination. This also corresponds to a valid zone_id. |
||
sections | Number | Must be a positive whole number | The number of sections travelled between the zone_from and zone_to. This must be a positive whole number (e.g. 1, 2, 3...), used to calculate the fare. Note: The number of sections between two zones is the same regardless of direction. That means zone_from → zone_to has the same section value as zone_to → zone_from. Example: If Zone A to Zone B = 3 sections, then Zone B to Zone A is also 3 sections. |