Working with Preference File (JSON) for SAP ECC to SAP S/4HANA migration

When you want to migrate a project from TIBCO ActiveMatrix BusinessWorks™ Plug-in for SAP Solutions to TIBCO ActiveMatrix BusinessWorks™ Plug-in for SAP S/4HANA and use the feature of preferences then you must add a sapecc2saps4hana.json in the root folder of the project before migration.

This converts the Invoke RFC BAPI in SAP activity of the TIBCO ActiveMatrix BusinessWorks™ Plug-in for SAP Solutions to the Consume OData Service activity of the TIBCO ActiveMatrix BusinessWorks™ Plug-in for SAP S/4HANA.

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

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

You can use the JSON preference file to:
  • To provide the properties related to the new Consume OData Service activity. The schema required for the Consume OData Service activity can be fetched using the SAP S/4HANA Cloud Connection Resource. To create the new SAP S/4HANA Cloud Connection Resource, you need to specify its configuration details manually in the JSON preference file.
  • To provide the input field mappings of the Invoke RFC/BAPI in SAP activity that are mapped to the input fields of the Consume OData Service activity.
    Two types of mappings are supported; Field and Literal mapping.
    • Field mapping- The fields from Invoke RFC/BAPI in SAP activity are mapped to fields from the Consume OData Service activity in the following manner from the JSON preference file, <field in Invoke RC/BAPI in Activity>:<field in Consume OData Service activity>. If the field is part of a hierarchy, the elements are separated by a slash (/).
      For example, <parent1/parent2/child3>:<parent1/child4>
      Note: The type of mapping is preserved as of the original activity.
    • Literal mapping- The mapping supports literal values in the format, <value>:<name of field in Consume OData Service activity> .
    Note: Only string field data type is supported for literal mapping in the JSON preference file. For values, the values can only be literals and all the password types must be obfuscated passwords.

The JSON preference file contains a mapping section which maps the input field of the Invoke RFC/BAPI in SAP activity to the Consume OData Service activity. The mappings can contain multiple levels. The value types is preserved in the JSON preferences file. It is not possible to change the value or its type in the JSON preference file.
Note:
  • You must use the JSON preference file template provided in the tools folder for reference only. Copy the template file from the tools folder and paste in the root directory of the project as sapecc2saps4hana.json. Then edit the preference file and provide the necessary properties and their corresponding values.
  • The JSON preference file contains a field service which is given in the format: <apiName>/<serviceName>/<operation>. The migration is based on the combination of these schema name, service name, and process. All the activities referred to the same schema will have the same mapping instructions.
  • After migration, the date data type is changed from "YYMMDD" to "YYYY-MM-DDTHH:MM:SS".
  • If the authentication type is OAuth 2.0 for On-Premise/Private Cloud environment, you will have to populate parameter "sysPassword" to download the schemas for the SAP S/4HANA Cloud Connection Resource in the JSON preference file.
  • When refactoring is performed on the same project a multiple number of times, you should use the same s4hanaConnection parameters defined in the sapecc2saps4hana.json preference file, and you need to delete the RefactoringReport.log file to receive the latest log for the refactoring report.

Note the following points prior to using the JSON preference file for TIBCO ActiveMatrix BusinessWorks™ Plug-in for SAP Solutions project:

Note:
  • The location and filename of the sapecc2saps4hana.json preference file is not configurable.
  • The password used in the JSON preference file should be obfuscated. The bwobfuscator utility in the <TIBCO_HOME>/bw/version/bin folder should be used to obfuscate the password. Any other password obfuscators will not work. For more information about how to use the bwobfuscator, see TIBCO ActiveMatrix™ BusinessWorks Application Developement guide.
  • The JSON preference file is case sensitive.
  • While migrating any projects, any open processes are closed and reopened after migration.
  • During migration a RefactoringReport.log file is created for the project. This log file contains the name of the process, activity, and steps of migration. Any errors that are generated are logged in this file. The RefactoringReport.log file is not appended. To receive new log file, you need to delete the existing RefactoringReport.log file.