This chapter is mainly explained about the information and setup which will be useful for IT Operational Team of your company. The details and setup steps for company, sites, area, devices, can be obtained from the subchapters under this chapter. Complete the setup properly will make sure that your company obtained the information as desired and smoothen the daily routines of the users of the portal in your company.
2.1 Site Settings
Site refers to a store of the company, grouping the devices installed at the respective store and summed the counting data collected from all the devices. For retail chain, one site per one store is required, so that the higher management able to review the overall company performance and individual store performance seperately. Site creation is required before device can be added to the portal. In this section, we will explain about the set up related to sites such as create, edit and remove sites.
2.1.1 New Site Setting
We will brief about the three methods to create new site, which are single creation of site, bulk create site and bulk import site.
2.1.1.1 How to Create New Site
- Click on Settings > Site > +New Site button to access the Site Info page.
- Fill in the relevant information for the required fields and click on Save button.
Item
Description
1. Pairing Code Display the pairing code required for installation.
(Info: Refer to for details steps.)2. Site Name Enter a preferred site name.
(Info: Site name inserted will be applied to features in FootfallCam Analytic Manager V9™.)3. Site Code Enter a preferred site code.
(Info: Site code used to identify site within a geographic region.)
4. Billing Address Enter a billing address.
5. Site Group Select the site group.
(Info: Site group added will be apply to report feature. For more information on setting up site group, refer to Chapter 1.3 Setting Up Site Group.)
6. Country Select the country.
(Info: Country selected will be apply to features in FootfallCam Analytic Manager V9™ for mapping the site coordination.)
7. Time Zone Select the time zone.
(Info: Time zone selected will be apply to report feature.)
2.1.1.2 How to Bulk Create Site
If the company need to create site bulky, the company can contact [email protected] or raise a support ticket for this enquiry. To understand the steps of raising a support ticket in details, you may refer to How To Raise A Support Request.
2.1.1.3 How to Bulk Import Site
If you want to import bulk site, please reference Chapter 3.3 Data Import and Export.
2.1.2 Existing Site Management
2.1.2.1 How to Edit Existing Site
This section is mainly about edit the details of the existing site such as Site Name, Site Code, Country, TimeZone, and Site Group.
-
Click on Settings > Site > Edit button in Action column to access the specific Site page.
-
Update the desired field and click the Save button to save the changes.
2.1.2.2 How to Remove Existing Site
We do not encourage to remove sites, this is because when remove a site, all the historical data related to the site will also be removed. This will bring to a scenario that the data is missing or not tally. If you are sure that all the data related to the site will no longer be required, then you may refer to the steps below to remove a site.
If the data of the site will still be useful to your company, we recommend you to select Store Closure for Site Profile.
-
Click on Settings > Site > Edit button in Action column of the site to be deleted to access the specific Site page.
-
Complete the process by clicking on the Delete Site button at the bottom right corner of the page.
2.1.2.3 How to Modify Operating Hours of Site
Users who would like to update their operating hours in their existing store may do so with an Admin account.
Basic operating hour indicates one operating hour only for a day.
-
Click on Settings > Site > Edit button in Action column to access Sites page.
-
Navigate to the Operating Hours section and amend the operating hours as desired.
-
Complete the process by clicking on Save button on the bottom right of the page.
2.1.2.4 How to Set Up Multiple Operating Hours
Multiple Operating Hour indicates a maximum of two operating hours for a day.
-
Click on Settings > Site > Edit button in Action column to access Sites
-
Navigate to the Operating Hours To create multiple operating hours, users may click on + icon at the end of each row of day.
-
Complete the process by clicking on Save button on the bottom right of the page.
2.1.2.5 How to Set Up Custom Operating Hour
Custom Operating Hour indicates the special operating hours for a date range which will be different from the normal operating hours set for the days. The setup must be preconfigured at least 24 hours earlier for the setting to take place.
For example, on normal Wednesday, the operating hour is 9am to 9pm. But on 01/01/2025, the site will be closed. In this case, the user can set custom operating hours for 01/01/2025.
If you would like to extend the normal operating hour, you need to set the custom operating hour as full hours, for example, if the normal operating hour is 9am to 9pm and for one day you wish to extend the operating hour until 11pm, you need to input the custom operating hour as 9am to 11pm.
-
Click on Settings > Site > Edit button in Action column to access Sites
-
Navigate to the Operating Hours section and click on + New Custom Operating Hour button to trigger the Add Custom Time pop-up.
-
Complete the process by entering all the required fields and clicking on Update button to add the custom operating time for the site. Then, click on Save button on the bottom right of the page to save the changes.
2.1.2.6 How to Remove Custom Operating Hour
To remove the created Custom Operating Hour, select the Custom Time that you wish to delete and click on Delete button to delete it.
2.2 Device Settings
In this section, we will brief through on the set up which are related to device, such as ad device, remove device, device setting, device network specifications and some requirements for using our server.
2.2.1 New Device Basic Setting
There are 2 methods of adding new devices, which are add device during installation and ad device from portal manually. The importance of adding all your device on your company portal is to ease the process of managing all the devices, including daily checking on the status of the devices.
2.2.1.1 How to Add Device During Installation
This section is mainly talk about the procedure of adding new device during the device installation by the installer. Customer would need to share the pairing code, which is unique for all site(s) to the installer when doing device installation. Without doing this, the installed device would not attach to any site and the data collected by the device would not reflect in the site report.
-
Click on Settings > Site > Edit button in the Action column of the newly created site.
-
Copy the pairing code to share with your installer during their installation. (Site detail must be pre-configure before the installation.)
-
The installer is required to insert the pairing code by following the steps in Device Configuration to pair up the device with the site.
2.2.1.2 How to Manually Add Device from Portal
This section will guide you on the steps to add new device on the FootfallCam Analytic Manager manually after the device installation by the installer. The serial number of the device will be required when adding the device and is able to obtain on the back of the device.
-
Click on Settings > Device > + New Device button to access the Add Device page.
-
Complete the process by entering all the required fields and click on Add button.
Item
Description
1. Site Select the site name to add the device. 2. Device Type Select the device type. 3. Serial Enter the device serial or company serial.
(Info: Device serial can be obtained at the back of the devices.)4. Device Name Enter a preferred device name.
2.2.1.3 How to Remove Existing Device
-
Click on Settings > Device > Edit button in the Action column to access the Device page.
-
Click on Delete Device button to remove the device.
2.2.2 Device Setting Configuration
2.2.2.1 Device Info Page
In this section, we will talk about the basic setting of the devices.
-
Click on Settings > Device > Edit button in the Action column of the device to manage to access the Device
-
Update the field to be modified and click Save button to save the changes.
Item
Description
1. Device Name Enter a preferred device name. 2. Serial Display the serial of the device. 3. Model Display the model of the device. 4. Firmware Display the current firmware of the device. 5. Last Allocation Date Display the date and time of the device is being allocated. 6. Warranty Display the expiry date of the device warranty. 7. Active Display the status of the device.
2.2.2.2 Device Network Specifications
FootfallCam™ Devices consumes network bandwidth, allowing servers to collect and process the data into analytical information in FootfallCam™ Analytic Manager V9. Below are the Minimum Bandwidth Usage for FootfallCam™ Devices.
MINIMUM BANDWIDTH USAGE
|
Item |
Data Type |
Approximate Bandwidth Usage |
Frequency |
|
Counting Data |
JSON |
6 KB per counter |
Every Hour |
|
Wi-Fi Data (Hashed) |
JSON |
5 KB per counter |
Every Hour |
|
Client Data |
JSON |
50 KB per 350 detected clients |
Daily |
|
Compressed Counting Video |
ZIP |
10 MB per scheduled video from portal (15 minutes duration) |
Three videos per day until Accuracy Audit is completed |
|
Space Occupancy Data |
JSON |
5KB per counter |
Event Driven (person detection by device considered as an "event". Once device detected person, it will push data to server.) |
MINIMUM BANDWIDTH USAGE (FootfallCam Centroid and FootfallCam Centroid Outdoor only)
|
Item |
Data Type |
Approximate Bandwidth Usage |
Frequency |
|
Counting Data |
JSON |
100 KB per input source* |
Every Hour |
|
Compressed Counting Video |
ZIP |
500 MB** per scheduled video per input source* |
One video per day until Tuning is completed |
* FootfallCam Centroid and Centroid Outdoor supports up to 8 input sources simultaneously.
** Measured with a 30-minute long 1080p 25 FPS recording.
2.2.2.3 Requirements for using FootfallCam™ Cloud Server
This section required attention from the customers that chosen to use our FootfallCam™ Cloud Servers. This is important for them to whitelist those IP Address to ensure that the services provided by FootfallCam™ can work properly.
NETWORK OUTBOUND FIREWALL RULES (ON-SITE):
|
IP Address |
Port Number |
Purpose |
|
198.244.207.93 |
80 (HTTP), |
[Mandatory] To enable counting data upload from on-site devices to FootfallCam™ Cloud Server. |
|
45678 (FTP) |
(Optional) Allow client to establish connection to FootfallCam™ FTP Server, which is used for client to access and manage data for automated import or export jobs. |
|
|
51.195.132.20 |
80 (HTTP), |
[Mandatory] To enable counting data upload from device to FootfallCam™ Cloud Server (failover server) in case of primary server is down. |
|
51.89.155.156 |
80 (HTTP, WS), |
[Mandatory] To enable Space Occupancy / Group Counting / any other special features data upload from on-site devices to server. |
|
54.85.80.97 |
80 (HTTP), |
[Mandatory] VPN server to allow FootfallCam™ Support Team personnel remote access to on-site devices in case of technical support / error diagnosis. The connection will only be initiated from on-site devices and will only be triggered if ticket has been raised and is being processed and authorised by Support Team personnel. The connection will be closed on the next day or the support process has ended, whichever come first. |
NETWORK INBOUND FIREWALL RULES (ON-SITE / CLIENT'S FTP SERVER):
|
IP Address |
Port Number |
Purpose |
|
54.38.212.250 |
(Client to provide FTP port number) |
(Optional) To allow FTP connection established by FootfallCam™ Analytic Manager V9 to client's FTP server to perform scheduled export and import jobs. |
CONSEQUENCES OF BLOCKING TARGET IP ADDRESS, PORT NUMBER AND PROTOCOL:
|
Blocked Target IP Address, port number and protocol |
Consequence(s) |
|
198.244.207.93 port 80 (HTTP) and 443 (HTTPS) |
Counting data from on-site devices will NOT be uploaded to FootfallCam™ Cloud Servers in the event of server failover from Primary Server (145.239.4.218), and the latest counting data will NOT be presented in FootfallCam™ Analytic Manager V9 platform. The latest counting data will NOT be available for scheduled export jobs via FTP, through API, SQL function query, or any mean of data exportation from FootfallCam™ Analytic Manager V9 platform. |
|
51.89.155.156 port 80 (HTTP, WS) and |
Space Occupancy related data will NOT be uploaded to FootfallCam™ Cloud Server, and the Space Occupancy dashboard in FootfallCam™ Analytic Manager V9 platform will NOT be updated to the latest Occupancy count. The latest space occupancy data will NOT be available for scheduled export jobs via FTP, through API, SQL function query, or any mean of data exportation from FootfallCam™ Analytic Manager V9 platform. |
| 54.85.80.97 port 80 (HTTP) 443 (HTTPS) |
VPN connection cannot be established from on-site devices directly to FootfallCam™ Cloud Servers. FootfallCam™ proactive support will be affected and significantly increases the turnaround time of resolving ticket raised from FootfallCam™ Support Portal. |
2.2.3 Counting Lines Configuration
2.2.3.1 In Out Counting (Pro2)
Color Definitions
(Last updated on 16-Aug-2024)
| Counting Line / Zone | Description |
| Tracking Zone | A designated area to detect and monitor the presence and movements of individuals within its boundaries. |
| IN Line | A boundary that detects IN count when people cross it as they enter a specific area. |
| OUT Line | A boundary that detects OUT counts when people cross it as they go out a specific area. |
| Pink Patch | A special covering used to block or hide stationary objects of a certain height that might be mistakenly counted by the sensor, preventing unnecessary noise or incorrect counting. |
| Filter Zone | A special area that helps to make sure only the right objects get counted. For example, in a store or with a swinging door, it can filter out any extra movements that shouldn't be counted as people coming in or going out. It works by only counting people whose path starts or ends inside the filter zone. If both the start and end of the path are either inside or outside the filter zone, the person won't be counted. |
2.2.4 Firmware and Patch Update
2.2.4.1 Firmware update
3D People counting device have different firmware versions like:
- 3.2.2
- 3.2.2a
- 3.4.1
- 4.6.0
- 4.2.0
There are different firmware versions for the device as we have different variant of hardware for the device. In order to know the firmware version of the device, user can access to the device info page and liveview page of the counter, it will be shown as '3.4.1' (just an example).
When and how to perform firmware update?
Firmware update is different from patch update where it requires manually update by FootfallCam technical personnel. Therefore, if the device is having an old firmware version, please contact FootfallCam by raising a support ticket to get the device updated.
Below are the old firmware version that requires update:
- Firmware that starts with '3.2.0', might be followed by i, j, k, etc.
- 3.3.0
- 3.5.0
- 3.8.0
2.2.4.2 Patch update
What is patch update?
A patch is a update revision for a device firmware. The higher the number of the patch version, the later the patch version of the device.
When and how to perform patch update?
When there's a new patch version released, the device has its own mechanism to update on its own by downloading the patch file from server. Hence, user wouldn't need to manually perform update for the device. However, if the device patch is too old, then there's a need to manually update the patch version for the device. In order to know the patch version of the device, user can access to the device info page and liveview page of the counter, it will be shown as '3.4.1_patch_p191' (just an example), the part p191 is the patch number/version of the device. Each firmware version has its own patch version.
If the device is have patch number/version older than below, please contact FootfallCam by raising a support ticket to get the device updated.
- 3.2.2_patch_p158
- 3.2.2a_patch_p145
- 3.4.1_patch_p191
- 4.6.0_patch_p19
2.2.4.3 Summary
Device with outdated firmware or patch version tends to have legacy issue and software bugs that will affect the user experience.
Therefore, it's important to keep the device updated to the latest version to ensure the device working properly.
2.3 Area Settings
The counting data is tied to the area available for the company, thus setting up area is extremely important in order to store the data in the server and display on the dashboards and reports afterward.
Area is a smaller region of focus within a site, and it is one of the traffic analysis methods that normally used in shopping malls, offices and stores with multi-level to understand the distribution of visitors throughout the site. Taking the shopping mall as an example, which applicable to any other industry, the site can be partitioned into different area such as different floors or different shops. Devices are required to cover all entrances and exits for each area in order to obtain the data.
2.3.1 Area Configuration
In this section, we will explain how to create, edit and update area settings.
2.3.1.1 How to Create Area
The site entrance area will be created and included the devices with entrance counting enabled automatically when the site is created. This area is mainly for the footfall of the site. If you wish to create more areas, you may follow the steps below:
Step 1 - Go to Settings > Area to view the existing area list.
Step 2 - Click on the "+ New Area" button and fill up the necessary details in Create New Area pop up shown.
|
Item |
Description |
| 1. Area Name | Enter your preferred name for the area. |
| 2. Area Code | A unique code for the area. |
| 3. Description | Some note to describe the intended use case of the area. |
| 4. Area Type | The area nature type whether it is a site entrance or for queue area or so. Select the best fits type in the list. |
| 5. Area Group | The area can be grouped up as a larger region, which all the metrics are summed up in showing dashboards and reports. |
| 6. Site | The site of the area belongs to, to filter the devices contributing counting data to the area. |
Step 3 - Click on the "Create" button to go into the area settings page, and configure the dataset and operating hours accordingly, then click "Save" button to create the area. For more details on dataset and operating hours, refer to section 2.3.2 Dataset and Operating Hours below.
2.3.1.2 How to Update Area
Over the time there may be having changes to be made on the area configuration, if you wish to update the area settings, you may follow the steps below:
Step 1 - Go to Settings > Area to view the existing area list, click on the pen icon to edit the area details.
Step 2 - Update the details which changes is required, then click on the "Save" button to save the changes.
2.3.1.3 How to Delete Area
We do not suggest deleting the area, as the data will be deleted and not recoverable. If you still decided to delete the data, you may follow the steps below:
Step 1 - Go to Settings > Area to view the existing area list, click on the pen icon to edit the area details.
Step 2 - Click on the "Delete Area" button to remove the area and its data from the server.
2.3.2 Dataset
Dataset in area settings, specified the device contributor onto the data type for the area. There are multiple types of data stores under the area, and each type need to be configured accordingly, to create relationship between the area with the devices for respective the data type.
|
Type |
Description |
| 1. People Counting | Collect footfall metrics including Footfall In and Footfall Out. |
| 2. Dwell Time | With mode MAC Address Dwell Time, the visit duration is calculated from 2 peaks of the WiFi signal strength detected from all devices linked. |
| 3. Queue Counting | Collect queue counting metrics including Queue Serve Time and derive the Queue Waiting Time |
| 4. Others | Collect metrics other than specified above, including occupancy, heat dwell, heatmap and others. |
2.3.2.1 Dataset Configuration - People Counting
 |
If the area has only 1 device, and that device only contribute to 1 area, then in normal circumstances, the IN Count is contributed by the IN Line (green) and the OUT Count is contributed by OUT Line (blue).
|
 |
If the area contains more than 1 device, then all devices should be added during area configuration.
|
 |
If 1 device is contributing to multiple areas, then the 2 areas need to be created with inverted line for the count. For example: For Area A, the IN Count is contributed by IN Line (green) while OUT Count is contributed by OUT Line (blue);
For Area B, the IN Count is contributed by OUT Line (blue) while OUT Count is contributed by IN Line (green).
|
2.3.2.2 Dataset Configuration - Dwell Time
For each area, if visit duration is required, then Dwell Time dataset need to be set up by adding all devices which contribute to the area.
2.3.2.3 Dataset Configuration - Queue Counting
For area which required to have queue solution, the Queue Counting dataset must be set up to collect and store the data in server level, with the specific ROI of the relevant devices.
2.3.2.4 Dataset Configuration - Others
Besides people counting, dwell time for visit duration and queue counting, other metrics fall under this category, including occupancy, heat dwell and heatmap.
2.3.3 Operating Hours
Considering the use case for shopping mall, which every shop may have different operating hours, areas can have its own operating hours which different from the site. This can be set in the operating hour tab. If the store operating hour is the same as site, you may tick at the field "Same with Site Operating Hours".
2.3.4 Area Groups
Area group is referring to the group of areas, which the data is summation of the areas under the group. This area group is mainly used in shopping mall, to group the shops under same category, and review the footfall as a group.
Please be noted that area group is not applicable to occupancy, due to the nature of occupancy cannot be summed.
2.3.4.1 How to Create Area Group
Step 1 - Go to Settings > Area Group to access the area group list.
Step 2 - Click "+ New Area" and fill up the information required.
|
Item |
Description |
| 1. Area Group Name | Enter your preferred name for the area group. |
| 2. Site | The site that the area group belongs to. |
| 3. Area Group Type | The type for the area group. |
Step 3 - Click on "Create" button to go into the area group detail view.
Step 4 - Update the list of areas to be included under this area group.
2.3.4.2 How to Update Area Group
Over the time there may be having changes to be made on the area group configuration such as adding areas or removing areas. Area group configuration can be updated via area settings and area groups settings.
2.3.4.2.1 Update in Area Settings
Step 1 - Go to Settings > Area to view the existing area list, click on the pen icon to edit the area details.
Step 2 - Update the area group tagging, then click on the "Save" button to save the changes.
2.3.4.2.2 How to Update Area Group in Area Settings
Step 1 - Go to Settings > Area Group to view the existing area group list, click on the pen icon to edit the area group details.
Step 2 - Update the linked area(s), then click on the "Save" button to save the changes.
2.3.4.3 How to Delete Area Group
If you wish to remove the area group, you may follow the steps below:
Step 1 - Go to Settings > Area Group to view the existing area group list, click on the pen icon to edit the area group details.
Step 2 - Click on the "Delete Area Group" button to remove the area group from the server.
2.4 Site Group Settings
A retail chain company with multiple sites or multiple stores in different region can have global company views and reports in Analytics Managers. The sites can be group under different categories for the convenient of review by the regional manager. To achieve this, site group configuration is required to categorize the site within the same site group.
2.4.1 Area Group Configuration
2.4.1.1 How to Create Site Group
Step 1 - Go to Settings > Site Group to access the site group list.
Step 2 - Click on the "+ New Site Group" button and update the site group name, then click the create button to create site group.
Step 3 - Update the linked site(s) and click "Save" button to save the changes. Under "Advanced", there are customize site group report settings can be added.
|
Item |
Description |
| 1. Advance Setting Toggle Switch | The toggle to enable or disable the custom site group specific report settings. |
| 2. First Day of Week | The first day of the week, reference for weekly number. |
| 3. Weekend | Weekend for the site group, to provide weekday and weekday & public holiday distribution in dashboard. |
| 4. Date Format | The date format show on dashboards and reports. |
| 5. Start of Financial Week | The starting of financial week. |
| 6. Currency | The currency for the site group. |
| 7. Site Group Specific Public Holiday | To add custom public holidays for the site group |
2.4.1.2 How to Update Site Group
Similarly to area group, the linked sites can be updated in both site settings and site group settings, but advance site group settings can only be updated in site group settings.
2.4.1.2.1 Update Site Settings
Step 1 - Go to Settings > Site to view the existing site list and click on the pen icon to edit the site details.
Step 2 - Update the site group tagging and click on the "Save" button to save the changes.
2.4.1.2.2 Update in Site Group Settings
Step 1 - Go to Settings > Site Group to view the existing site group list, click on the pen icon to edit the site group details.
Step 2 - Update the linked site(s) or advanced settings, then click on the "Save" button to save the changes.
2.4.1.3 How to Delete Site Group
Step 1 - Go to Settings > Site Group to view the existing site group list, click on the pen icon to edit the site group details.
Step 2 - Click on the "Delete Site Group" button to remove the site group from the server.