8.11.2 External Reference Profile Configuration

Owned by Jenni Wallin
Last updated: May 08, 2023 by Former user (Deleted)
3 min read

To create a new External Reference Profile configuration, click the New Configuration button in the upper left part of the Desktop window, and then select External Reference Profile from the menu.

The contents of the menus in the menu bar may change depending on which configuration type that has been opened. The External Reference profile uses the standard menu items and buttons that are visible for all configurations, and these are described in 2.1 Menus and Buttons.

External Reference profile dialog

SettingDescription

External Reference Type

From the drop-down list select the External Reference source type.

The following types are available:

  • S3 Properties File - A file on an Amazon Web Service S3 bucket. For more information, refer to 8.11.6 AWS S3 Support for External Reference Profile
  • Properties File - A file on the Platform Container host
  • Environment Variable -  Exported environment variables from the Platform's startup shell
  • Properties Database - Use the internal database as External Reference source. To store values in the internal database.

Properties File

This field is available when you have selected Properties File in External Reference Type.

Enter the path and the name of the properties file.

Local Key

The name of the External Reference in .

Properties File Key

The name of the External Reference in the properties file or environment variable.

Database Key

This field is available when you have selected Properties Database in External Reference Type.

The name of the External Reference in the Database.

Value Type

The following types are available:

  • String - The value is stored as string
  • List - The value consist of a list of values
  • Map - The value consist of a map of key/values pair
Value

The current value of the External Reference. To update the value from the Properties file, use the Refresh button. If values are not displayed, make sure that a properties file is available in the specified path or that the environment variables are set.

In the External Reference profile, you may specify Properties Database as the External Reference source type, then the value is set in the profile itself.
To set a value of an External Reference key, double-click on the value column for the specific row.

Note!

The value will be saved to the database directly after pushing Save on the Value Dialog shown below.

String Value Type

When Value Type is set to String the value dialog shows a single field to enter the value.

List Value Type

When Value Type is set to List the value dialog shows a table to enter values.

Map Value Type

When Value Type is set to Map the value dialog shows a table to enter Key and Value pairs.

External Reference Applications

With External Reference Profile and External Reference Values, you can set different type of permissions for saving External Reference Profile keys and values. To know more about these applications, see 6.1 Access Controller.

Note!

Applicable only if you select Properties Database from External Reference Type. 

For example, the following screenshot shows an access group with the name as 'Values' and different permission that you can assign to that access group for External Reference Values application.

Access Controller - Applications List

The following permissions are available: 

  • Write -  In order to create a new External Reference profile you must have Write access to the External Reference Profile application, however to be able to edit or set Value, you must have Write access to the External Reference Values application. 

    Note!

    If you try to set or edit Value of an External Reference Profile for which you do not have the write permission a dialog window appears stating that you need the correct permission. 


  • Execute -  You cannot make any changes to the External Reference Values permission if you have only Execute access. 


Note!

To be able to open an existing External Reference Profile, you must have the Read access for that particular External Reference Profile. Read 6.2 Configuration Browser to know more about the different permission groups pertaining to a configuration.