Working with Preference File (JSON) for migration

When a user wants to migrate a TIBCO ActiveMatrix BusinessWorks 5.x project to a ActiveMatrix BusinessWorks 6.x project or TIBCO BusinessWorks™ Container Edition project and if they want to use the feature of preferences, then a adapter2plugin.json file would need to be created in the root folder of ActiveMatrix BusinessWorks 5.x project.

A template of the preference file would be installed in the tools folder of the plug-in in the following location:

$TIBCO_HOME/bw/palettes/peoplesoft/version/tools/adapter2plugin.json_template

A Preference file (JSON format) can be used in the following manner:
  • To override configuration defined in the ActiveMatrix BusinessWorks 5.x project and the adapter services carried over to the plug-in.
  • To provide the configuration available in the plug-in but not available in ActiveMatrix BusinessWorks 5.x project.
Note:
  • The JSON preference file template should be used for reference only and should not be modified or used as it is. The preference file should be edited with the necessary properties and their corresponding values.
  • The file created under the root folder of the ActiveMatrix BusinessWorks 5.x projects will not just contain PeopleSoft but also other plug-ins that supports adapter migration.

In terms of values, the values can either be literals or references to module properties, which would pertain to global variables from ActiveMatrix BusinessWorks 5.x project.

To configure as a Literal Value:

To set the value of reconnectInterval in PeopleSoft Configuration shared resource to 3 in the JSON file, set the values as:

"reconnectInterval" : "3"

To configure as a Module Property:

To use a global variable in JSON file, the user needs to have a same global variable declared with a value in the corresponding ActiveMatrix BusinessWorks 5.x project. Then the user can add the global variable in JSON file.

To set the value of loginName in PeopleSoft Configuration shared resource to PS by using the JSON file as a global variable, add a global variable in ActiveMatrix BusinessWorks 5.x project as loginName and set the value as PS. Now in the JSON file, set the value as

"loginName" : "%%loginName%%"

Below notes must be considered prior to using the JSON preference files for a TIBCO ActiveMatrix™ 5.x project.

Note:
  • The location and filename of the adapter2plugin.json preference file is not configurable.
  • The usage of the preference file does not support the creation of new module properties in migrated projects. For example, we should not specify a module property %%test%% in the preferences if it does not exist in the ActiveMatrix BusinessWorks 5.x project.
  • The usage of preference file is applicable to all adapter configurations in the ActiveMatrix BusinessWorks 5.x project during migration.
  • Since the module properties in ActiveMatrix BusinessWorks 6.x project are case sensitive, the module properties in the preference file should have the same case as the ActiveMatrix BusinessWorks 5.x project.
  • When any value is applied from the preference file, the MigrationReport.log contains logs with key in uppercase and value as is.
  • The password used in the JSON file must be obfuscated. The bwobfuscator utility in the <TIBCO_HOME>/bw/version/bin folder should be used to obfuscate the password. Any other password obfuscators does not work. For more information about how to use the bwobfuscator, see TIBCO ActiveMatrix™ BusinessWorks Application Development guide.