Portal configuration storage for dynamic and design elements
[]
This article is about the dynamic portal configuration (such as theming) and where it is stored. Dynamic portal configuration is only referred to by the main configuration and also exists in JSON format.
Overview of supported portal configuration storages
Currently, two types of portal configuration storages are supported. Each type has its own property. Properties are evaluated in the order specified below and the first one found is used:
portal-aws
: obsolete please do not use!portal-hcms
: should be used for productionportal-file
: can be used for local development and testing
We recommend not to fill out all properties at once.
portal-aws
: an AWS-hosted DynamoDB as a portal storage
Warning: obsolete, do not use! Still in the code!
portal-hcms
: HCMS instance as a portal storage
In this case, your portal configuration will be stored in the HCMS instance, in a censhare asset. This is currently the default portal storage.
The portal-hcms
property is a JSON object. Inside it, the most important property is portalId
: the portal ID, used to construct the resourceKey
of the entity feature, censhare:resource-key
in the HCMS instance configuration asset. portalId
is optional if the portal
in the system configuration is used and if the latter already contains the id
property.
portal-file
: a local file as a portal storage
In this case, your portal configuration will be stored in a local JSON file. This type of storage is useful for development and testing, but not for production as there is no convenient way to share a local file in a high-availability cluster.
The portal-file
property contains one string as a value which is the path to the file on the local file system. One file can only correspond to one portal, but currently only one portal per application is supported.
How new portal data is added
When you add a new portal, then, upon startup of the application, the middleware will automatically create a new censhare asset with its default configuraiton.