Managing catalogs in self-hosted ThingPark Enterprise
This task is only available on self-hosted ThingPark Enterprise and only for users with the administrator role. For ThingPark Enterprise SaaS, catalogs are managed by Actility.
Four kinds of catalogs are available on a ThingPark Enterprise platform, described in the following table:
| Catalog | Description |
|---|---|
| Device catalog | Off-the-shelf list of device profiles including model-specific LoRaWAN® technical parameters as well as the associated application payload driver version. The catalog also supports generic profiles (not model-specific) for use in case the specific device model is not yet integrated in ThingPark default catalog. |
| Base station catalog | Off-the-shelf list of base station profiles corresponding to each model supported by ThingPark. The hardware capability of each BS model is defined in the profile, for instance availability of GPS receiver, supported network interfaces (ethernet, cellular, WiFi)... |
| RF region catalog | Off-the-shelf list of regional radio parameters defining the RF channel plan, optimized set of radio parameters allowing best-in-class LoRaWAN® performance between devices and core network in accordance with regulatory rules. Each RF Region available in the RF region catalog provides a set of RF configuration parameters and RF channel plan compatible with the ISM band and the associated regulations of the country in question. To learn more, see RF Regions. |
| Drivers catalog | Off-the-shelf list of payload drivers. Each imported catalog of drivers overrides all system drivers in database. |
As a user with an administrator role on a self-hosted ThingPark Enterprise, catalogs can be updated at any time. The update procedure can be used for the initial loading of catalogs during the first login to ThingPark Enterprise, and later to update these catalogs.
Catalogs can be either updated from the TPE repository or manually uploaded, depending on the TPE configuration. To learn more, see Cockpit configuration for Appliance/VM mode or K8S configuration Kubernetes deployments.
- Catalogs updated from the TPE repository: the four catalogs are retrieved from the TPE repository. The TPE repository may either be online (requires internet access to the central repository) or offline (via the local media). The update of a catalog can be done manually when a newer version is available on the TPE repository. The reload of all catalogs is forced after an upgrade.
- Manual upload of catalogs: the four catalogs are manually uploaded by the platform administrator, through TPE's user interface. A catalog can be uploaded only if its version is not lower than the currently installed version. The reload of all catalogs is not forced after an upgrade.
Catalogs updated from the TPE repository
If the online TPE repository is used, ensure that the ThingPark Enterprise server is connected to the internet. If the offline TPE repository is used, ensure the the local TPE repository is reachable.
Updating a catalog
This task is only illustrated for the base station catalog, but this task applies in the same way to all the catalogs.
-
Select Administration > Settings, and go to BASE STATION MODELS CATALOG.
-
A message indicates that a new version is available, Click UPDATE CATALOG.
-> The catalog is automatically upgraded to the latest version which is displayed on your screen.
Viewing catalog version
This task is only illustrated for the base station catalog, but this task applies in the same way to all the catalogs.
-
Select Administration > Settings, and go to BASE STATION MODELS CATALOG.
-
A message indicates that the catalog is up-to-date. You do not have anything to do.
Manual upload of catalogs
The latest version of each catalog must be first retrieved from the Actility repository:
TPE administrators can use the following RSS feeds to be notified about the latest deliveries of ThingPark catalogs and download them from the ThingPark repository:
- RSS feed for Base Station Profile catalog: https://repository.thingpark.com/rss/bs.xml
- RSS feed for Device Profile catalog: https://repository.thingpark.com/rss/devices.xml
- RSS feed for RF Region catalog: https://repository.thingpark.com/rss/rfreg.xml
- RSS feed for Driver catalog: https://repository.thingpark.com/rss/drivers.xml
To read RSS feeds, you need a RSS feed client. For example, you may use a reader compatible with your internet browser (for instance Google Chrome) or use the RSS feeds feature embedded in Microsoft Outlook.
Updating a catalog
This task is only illustrated for the base station catalog, but this task applies in the same way to all the catalogs.
-
Select Administration > Settings, and go to BASE STATION MODELS CATALOG.
-
Click UPDATE CATALOG. A dialog box opens to upload the catalog from the local computer. Select the file containing the catalog and click UPDATE.
The upload will fail if the version of the uploaded catalog is not higher than the version currently installed.
Viewing catalog version
This task is only illustrated for the base station catalog, but this task applies in the same way to all the catalogs.
-
Select Administration > Settings, and go to BASE STATION MODELS CATALOG.
Because the ThingPark Enterprise platform is not synchronized with the TPE repository, it is not possible to indicate if the installed version is up-to-date or outdated.