/
External Reference (3.1)

External Reference (3.1)

The External Reference profile allows you to use configuration values in  that originate from property files or exported environment variables from the Platform's startup shell. 

Required Properties

To use this property the mzonline.host and mzonline.port properties need to be added! 

You can use the values provided by External Reference profiles in workflow and agent profile configurations. 

Note!

For instructions on how to define complex parameters such as lists of brokers, refer to Profiles(3.1).

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.

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 AWS S3 Support for External Reference Profile(3.1).
  • Properties File - A file on the Platform host.
  • Environment Variable -  Exported environment variables from the Platform's startup shell.
  • Properties Database - Use the internal database as an External Reference source. To store values in the internal database, use the web interface and enter values for needed Database Keys.
  • Kubernetes Properties - Use Kubernetes ConfigMap as an External Reference source. For more information, refer to Creating External Reference in Helm Chart(3.1).

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.

Use Custom ConfigMap Name 

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

By default the ConfigMap name is constructed from the folder name and profile name.

Select this checkbox to set a custom name for the ConfigMap used to set values. 

Local Key

The name to use when referring to this external reference in the workflow table and profiles which allow the use of external references.

Properties File Key

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

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.

Kubernetes Key

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

The name of the External Reference in the Kubernetes ConfigMap.

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