Exporting an Application Profile

An application profile can be exported from the application. After an application is configured with a profile, it becomes part of the application archive.

Do the following to export an application profile as a substvar and properties file:

  1. Click the project.application, expand Package Unit folder and double-click Properties to open the Properties page.
  2. In the Properties view, select the profile, and click the Export Profile button. The Export Profile wizard opens.
  3. Select the properties to be exported and use the Browse button to browse to a location where you want to download the profile file as a substvar or properties file.
    1. To export as substvar file, select the checkbox Export as substvar file and browse the location to export the substvar file.

      A <ProfileName>.substvar file is created in the location specified. You can now import this profile file into another application.

    2. To export as a properties file, select the checkbox Export as properties file and browse the location to export the properties file. The properties that are selected while exporting the profile are generated as key-value pairs in the <ApplicationName.application>-<ProfileName>.properties file. The keys in the Properties file is generated using the names of the properties that are exported. For example, //<ApplicationName>//<PropertyName>=<value>.
      Note: In the properties view, the values of the properties in the profile can be anything, when the profile is exported as a properties file it changes to #//<ApplicationName>//<PropertyName>#
    3. To export the application properties file with property names separated by a dot (.), select the Use dot ('.') as a separator checkbox. This checkbox is enabled only when the Export as properties file checkbox is selected. The properties that are selected while exporting the profile are generated as key-value pairs in the <ApplicationName.application>-<ProfileName>.properties file. The keys in the Properties file is generated using the names of the properties that are exported. For example, <ApplicationName>.<PropertyName>=<value>
      Note:
      • In the Properties view, the values of the properties in the profile can be anything, when the profile is exported as a properties file it changes to #<ApplicationName>.<PropertyName>#
      • TIBCO recommends to use the dot (.) separator for exporting properties file while configuring the Kubernetes Configmap with TIBCO BusinessWorks™ Container Edition.
    4. To export the application properties file with property names separated by a underscore (_), select the Use underscore ('_') as a separator checkbox. This checkbox is enabled only when the Export as properties file checkbox is selected. The properties that are selected while exporting the profile are generated as key-value pairs in the <ApplicationName.application>-<ProfileName>.properties file. The keys in the Properties file is generated using the names of the properties that are exported. For example, <ApplicationName>_<PropertyName>=<value>
      Note:
      • The Use underscore ('_') as a separator and Use dot ('.') as a separator checkboxes cannot be used together. It is a best practice to use only one checkbox at a time.
      • In the Properties view, the values of the properties in the profile can be anything, when the profile is exported as a properties file it changes to #<ApplicationName>_<PropertyName>#
    5. To use custom encryption key to export to Consul, select the Use custom encryption key checkbox. To view the custom encryption key in a plain text format, select the View Key checbox. The custom encryption key is only applicable to password type module properties.

      Note:
      • While running the application, use the CUSTOM_ENCRYPTION_KEY environment variable. The value of this environment variable must be the custom key used while exporting the profile to Consul.
      • It is recommended to update or rotate custom key on a regular basis following the ideal security standards.

  4. Click Finish.

The following table lists the values of five different types of properties if the default values are not provided for all the properties and exported as properties file.

Data Type Property Name Values Before Export Values After Export Values After Export in properties file
  DefaultDefault  
String newProperty5   #//test//newProperty5# newProperty5
Password newProperty4   #//test//newProperty4# <encrypted value of the password>
Integer newProperty3 0 #//test//newProperty3# 0
Long newProperty2 0 #//test//newProperty2# 0
Boolean newProperty1 false #//test//newProperty1# false

The following table lists the values of five different types of properties if the default values are provided for all the properties and exported as properties file.
Data Type Property Name Values Before Export Values After export Values After Export in properties file
  DefaultDefault  
String newProperty5 TIBCO #//test//newProperty5# TIBCO
Password newProperty4 *** #//test//newProperty4# <encrypted value of the password>
Integer newProperty3 1 #//test//newProperty3# 1
Long newProperty2 12345 #//test//newProperty2# 12345
Boolean newProperty1 true #//test//newProperty1# true

Note: For String type property in group, the values after export in properties file is //test///newGroup/newGroup1/newProperty5=TIBCO

The following table lists the values of five different types of properties if the default values are provided for all the properties and exported as properties file using (.) dot as a separator.
Data Type Property Name Values Before Export Values After Export Values After Export in properties file
  DefaultDefault  
String newProperty5 TIBCO #test.newProperty5# TIBCO
Password newProperty4 *** #test.newProperty4# <encrypted value of the password>
Integer newProperty3 1 #test.newProperty3# 1
Long newProperty2 12345 #test.newProperty2# 12345
Boolean newProperty1 true #test.newProperty1# true

Note: For String type property in group, the values after export in properties file is test.newGroup.newGroup1.Property5=TIBCO