Working with Preference File (JSON Format) for Post-migration

When you want to update the schema and use the feature of preferences, then a migrateSchema.json file must be created in the root folder of the TIBCO ActiveMatrix BusinessWorks™ 6.x project.

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

$TIBCO_HOME/bw/palettes/sap/version/tools/migrateSchema.json_template

A preference file (JSON format) can be used in the following manner:
  • To provide mappings required to update adapter schema to plug-in schema.
Note:
  • The JSON preference file template must be only used for reference and should not be modified or used as it is. The preference file must be edited with the necessary properties and their corresponding values.
  • The file created under the root folder of the ActiveMatrix® Adapter for SAP project created on ActiveMatrix BusinessWorks 6.x do not just contain SAP, but also other plug-ins that support adapter migration.

The migrateSchema.json configuration has three sections; RFC, IDOCS, and VARIABLES. Each section has three tuples separated by COLON (:). The first tuple indicates the TIBCO ActiveMatrix BusinessWorks™ 5.x adapter schema element, second tuple indicates schema reference of migrated TIBCO ActiveMatrix BusinessWorks™ 6.x project (this is the relative path of the ActiveMatrix BusinessWorks Plug-in for SAP Solutions plug-in schema), and the third tuple indicates ActiveMatrix BusinessWorks Plug-in for SAP Solutions plug-in schema element type (the ActiveMatrix BusinessWorks Plug-in for SAP Solutions plug-in schema element type with which you want to replace the adapter schema). For example: 

{
"adapter2plugin":
{
	"plugin":
	{
		"bwpluginsap": 
		{
			"mappings":
			{
				"RFC":
				{
				"__caret_request_caret_ZGET__PRICE__RPE_caret_ZGET__PRICE__RPE":"R3AdapterConfigurationActiveConnections/functionModules/ZGET_PRICE_RPE:RequestInputType",
				"__caret_reply_caret_ZGET__PRICE__RPE_caret_ZGET__PRICE__RPE":"R3AdapterConfigurationActiveConnections/functionModules/ZGET_PRICE_RPE:RequestOutputType",
				"__caret_fault_caret_ZGET__PRICE__RPE_caret_ZGET__PRICE__RPE":"R3AdapterConfigurationActiveConnections/functionModules/ZGET_PRICE_RPE:SAPSystemException"
				},
				"IDOCS":
				{
				"DELVRY03-4x":"R3AdapterConfigurationActiveConnections/IDocs/DELVRY03:DELVRY03"
				},
				"VARIABLES":
				{
				"variable1":"R3AdapterConfigurationActiveConnections/IDocs/DELVRY03:E2EDL20003_Type",
				"variable2":"R3AdapterConfigurationActiveConnections/IDocs/DELVRY03:RequestInputType"
				}
			}
		}
	}
}
}
For RFC: 
"RFC":
				{
				"__caret_request_caret_ZGET__PRICE__RPE_caret_ZGET__PRICE__RPE":"R3AdapterConfigurationActiveConnections/functionModules/ZGET_PRICE_RPE:RequestInputType",
				"__caret_reply_caret_ZGET__PRICE__RPE_caret_ZGET__PRICE__RPE":"R3AdapterConfigurationActiveConnections/functionModules/ZGET_PRICE_RPE:RequestOutputType",
				"__caret_fault_caret_ZGET__PRICE__RPE_caret_ZGET__PRICE__RPE":"R3AdapterConfigurationActiveConnections/functionModules/ZGET_PRICE_RPE:SAPSystemException"
				}

Here the SAP adapter element _caret_request_caret_ZGET__PRICE__RPE_caret_ZGET__PRICE__RPE is replaced with RequestInputType. R3AdapterConfigurationActiveConnections is name of SAP connection resource. R3AdapterConfigurationActiveConnections/functionModules/ZGET_PRICE_RPE is the relative path of the ActiveMatrix BusinessWorks Plug-in for SAP Solutions plug-in schema file ZGET_PRICE_RPE.xsd

For IDOCS: 

"IDOCS":
				{
				"DELVRY03-4x":"R3AdapterConfigurationActiveConnections/IDocs/DELVRY03:DELVRY03"
				}

Here, the SAP adapter schema element DELVRY03-4x gets replaced with DELVRY03. R3AdapterConfigurationActiveConnections is name of SAP connection resource. R3AdapterConfigurationActiveConnections/IDocs/DELVRY03 is the relative path of the ActiveMatrix BusinessWorks Plug-in for SAP Solutions plug-in schema file DELVRY03.xsd

For VARIABLES: 

"VARIABLES":
				{
				"variable1":"R3AdapterConfigurationActiveConnections/IDocs/DELVRY03:E2EDL20003_Type",
				"variable2":"R3AdapterConfigurationActiveConnections/IDocs/DELVRY03:RequestInputType"
				}

Here variable1 is name of the variable. R3AdapterConfigurationActiveConnections is name of SAP connection resource. R3AdapterConfigurationActiveConnections/IDocs/DELVRY03 is relative path of the ActiveMatrix BusinessWorks Plug-in for SAP Solutions plug-in schema file DELVRY03.xsd. E2EDL20003_Type is the plug-in schema element type. So variable 1 which is originally referred to adapter schema now refers to E2EDL20003_Type from plug-in schema.

Note: The above variables refer to the process variable in case of assign activity or variables defined on iterate group.
Limitations:

  1. An XSLT out of Sync error occurs in the migrated ActiveMatrix BusinessWorks™ 6.x project. To resolve this issue, right-click the input mapping and select Show Check and Repair.

  2. After the migration, a component out of place error occurs . To resolve this issue, right-click the input mapping and select Show Check and Repair.

  3. If two different activities are using different R3 AdapterConfiguration, but the schema is the same, in this case the ActiveMatrix BusinessWorks™ 5.x schema element name is the same for both (the key in JSON file then all such elements/schemas are replaced)