Skip to main content

Configuration File

Universal Portal has a local configuration file called config.json, which you can use to customize system behavior.

warning

The config file can be accessed by an unauthenticated browser. You must not keep any passwords, secrets, or other confidential information in this file.

config.json must be a syntactically valid JSON file. If there are syntax errors in this file, Universal Portal will not load.

Configuration Keys by Type​

This section lists all keys in config.json. Keys are grouped by type.

Branding​

You can use branding configurations to customize the logos used in Universal Portal.

info

File paths are relative to the directory where config.json is located.

Key Name

Description

Value Type

Default Value

logo

Path to the image file (svg or png) used as the Company Logo in the User Interface.

This image is used as the logo while viewing the Portal in a light color scheme (Daylight Mode or Calm Mode).

string

"images/logo.svg"

logoDark

Path to the image file (svg or png) used as the Company Logo in the User Interface.

This image is used as the logo while viewing the Portal in a dark color scheme (Dark Mode or Evening Mode).

string

"images/logo-dark.svg"

images

An array of images to use as icons in the User Interface. You can define logos for your own Universal Tasks by adding an entry to the images array with the name of the Template. You can also override logos for built-in task types by adding an entry with the name of the Task type.

Each entry in the array is a key-url pair, where the key is the name of the Task/Template, and url is the path to the image file. For example:

images: [  
    {  
        "key": "cron",  
        "url": "vendor/activity.svg"  
    }  
]

Array

Controller Path​

Key Name

Description

Value Type

Default Value

api

The path where Controller is deployed. Change this value to customize the API prefix.

If the Controller was deployed using ROOT.war , then this value needs to be "".

string

"/uc"

Default Locale​

Key Name

Description

Value Type

Default Value

default_locale

The default language used in Universal Portal is English, regardless of the language setting of the user's browser.

If preferred, you can change the default to another supported language.

Options:

  • "en" for English
  • "de" for German
  • "nl" for Dutch
  • "fr" for French
  • "es" for Spanish
  • "it" for Italian
  • "pt" for Portuguese
tip

Users can still change their language setting via User Options. The language setting will persist across logins.

string

"en"

Pooling Settings​

info

These are advanced configurations. Please consult with Support prior to enabling pooling.

Key Name

Description

Value Type

Default Value

taskListPooling

Enables pooling (paralel fetching) for task lists.

boolean

false

fetchLimit

If taskListPooling is true; Defines the number of parallel requests Universal Portal can send to the Controller.

integer

4