Configure the Storage for Custom Files Folders

Custom files are used to customize portal profiles, allowing you to change the appearance of the FintechOS Portal instances. They contain resources such as stylesheets, JavaScript files, or images that determine the look-and-feel of the FintechOS Portal.

These resources are grouped into two main folders: custom and custom-on-demand (which is used mainly for the liveness component resources). They are hosted using Azure Blob storage containers. The name of these folders is comprised of custom-[the-type-of-portal]. There is a custom and custom-on-demand folder for each portal on your environment. The default is custom-portal, custom-studio, custom-b2cportal, and the equivalent for custom-on-demand folders. Here, you can have your own custom folders for your own custom portals.

These custom folders mainly contain files for customizing your portal, they could be images, .xml, .json, and other types of files. The folder structure is explained on the Digital Assets page.

A handy trick for troubleshooting allows you can open the files directly in your browser by navigating to a URL like this: https://[your-environment]/portal/platform/custom/your_file. Keep in mind, the exact URL may vary depending on how your custom folders are named:

  • https://[your-environment]/portal/platform/custom/img.jpg

  • https://[your-environment]/portal/platform/custom-on-demand/abs.css

Here both img.jpg and abs.css are the names of custom files uploaded in Azure for that instance of Studio.

Configure Storage in Azure

  1. When the platform is deployed, the custom and custom-on-demand folders are created automatically in Azure. To access them, navigate to your storage account and then click Storage Browser in the left-side menu > Blob containers, and you'll find custom and custom-on-demand folders in a list.

  2. There is a custom and custom-on-demand folder for each portal on your environment.

  3. In the Configuration Manager, edit the following key:
    Key PathKey NameKey Value
    kv/<environment>/<application>/app-settingsCustomFilesStorageSettings
    Copy
    {
      "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey==;EndpointSuffix=core.windows.net",
      "RootContainerName": "custom"
    }

    where:

    • connectionString is the connection string the platform is using to connect to an Azure Blob container;
    • rootContainer is the root container name where the custom files will be stored (by default custom).
    HINT  
    The connection string can be obtained in Azure from the Access Keys section of the storage account.

Edit the key in both FintechOS Studio and Portal Configuration Manager environments. If the key is not found the platform will fallback to a local file storage rooted in <applicationRoot>\custom folder.

Configure the Storage for the Custom-on-Demand Folder

  1. By default, a private container named custom-on-demand should be set up in your Azure storage account. If you don't have one or if you wish to use a different container, create a new container.
  2. In the Configuration Manager, edit the following key:
    Key PathKey NameKey Value
    kv/<environment>/<application>/app-settingsCustomOnDemandFilesStorageSettings
    Copy
    {
      "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey==;EndpointSuffix=core.windows.net",
      "RootContainerName": "custom-on-demand"
    }

    where:

    • connectionString is the connection string the platform is using to connect to an Azure Blob container;
    • rootContainer is the root container name where the custom files will be stored (by default custom-on-demand).
    HINT  
    The connection string can be obtained in Azure from the Access Keys section of the storage account.

Edit the key in both FintechOS Studio and Portal Configuration Manager environments. If the key is not found the platform will fallback to a local file storage rooted in <applicationRoot>\custom-on-demand folder.

Configure for Local Developer Sandbox

When working with the local developer sandbox, the storage locations are:

  • UploadEBS

  • CustomFiles

  • CustomOnDemand

  • ReportFontFiles

These can be accessed through a built-in file browser interface available at https://fintechos.local/filebrowser. The file browser allows you to upload and download files from the above mentioned storage locations.