Migrate Custom Protocols with Import and Export

Custom Protocols are not Community specific and can be migrated before the Sterling File Gateway Community. The Custom Protocol should not be added to the Community Resource Tag. Because Custom Protocols are custom configurations within the system, the migration steps and the resources migrated will vary between different implementations. Custom Protocol migration is a two-step process because some of the migration is done through the user interface and some is done outside of the user interface.

Guidelines and Requirements

Guidelines and requirements for Custom Protocol migration include:
  • Custom Protocols are not Community specific, instead they are system specific; they are available to all Communities on the system.
  • Custom Protocol resources and files (or entries within the files) that you want to migrate should be migrated and copied to the target system before migrating the Sterling File Gateway Community.
  • Custom Protocol resources should not be added to the Community Resource Tag
  • The resources that define a Custom Protocol can vary from system to system, so the specific resources to be migrated will vary between different implementations. Therefore, all customized resources that are used by the Custom Protocol must be migrated. This includes any all custom BP's and Services used by the Custom Protocol.
  • Because some of the configuration is managed outside of the user interface, Custom Protocol Migration is a two step process.
  • If the target system already contains the AFTExtensionsCustomer.xml and/or the AFTExtensionsCustomer.properties file, then the entries from these files on the source system will need to be added to these files on the target system. Only completely new Customer Protocol entries should be added. Adding modified (different) versions of previously existing Custom Protocol entries or updating previously existing Custom Protocol entries in these files may lead to unexpected behavior.

Resource Manager

Custom Protocols used by, or available to, the Sterling File Gateway Community must be migrated to the target system before the Community is migrated. All of the custom resources that are required for the Custom Protocol to work, must be exported from the source system via the Resource File from the Sterling B2B Integrator Resource Manager (for example, custom BPs or custom Services). These custom resources can be added to a Resource Tag (non-Community Resource Tag) or exported ad-hoc. These custom resource components are not subject to the same constraints as the resources within an Sterling File Gateway Community.

AFTExtensionCustomer Files

After the resources used by the Custom Protocol have been migrated to the target system through the Resource Manager, both files, located within the Sterling B2B Integrator installation directory, must be copied and moved from the file path specified below on the source system to the same file path on the target system:
AFTExtensionsCustomer.xml
The AFTExtensionsCustomer.xml is located in the following directory within the Sterling B2B Integrator installation directory: 
<installation directory>/container/Applications/aft/WEB-INF/classes/
resources/xml
AFTExtensionsCustomer.properties
The AFTExtensionsCustomer.properties is located in the following directory within the Sterling B2B Integrator installation directory: 
<installation directory>/container/Applications/aft/WEB-INF/classes/
resources/

If these files contain any Custom Protocol configurations that are not intended to be migrated, then both files must be updated with the removal of the unwanted configurations. If the target system already contains the AFTExtensionsCustomer.xml and/or the AFTExtensionsCustomer.properties file, then the entries within these files on the source system will need to be added to these files on the target system. Only completely new Customer Protocol entries should be added to these files. Adding modified (different) versions of previously existing Custom Protocol entries or updating previously existing Custom Protocol entries in these files may lead to unexpected behavior.

After both AFTExtensionCustomer files have been moved to the appropriate directory on the target system, the system must be stopped, and restarted after running setupfiles and deployer.