FME Form: 2024.1

Working with Transformer Versions, Upgrades, and Change Logs

To the right of the toolbar, the Version drop-down displays the version of the transformer that is currently active for editing.

To start a new version

  1. On the toolbar, click Version, or from the Edit menu, select New Version.
    Note  If the current version has unsaved changes, you are prompted to save or discard the changes before proceeding.
  2. In the New Version dialog, enter Change Log notes indicating the differences between the new and prior version, and click OK. These notes display in the Detailed Version Changes window when an FME Workbench end user is in the process of Upgrading Transformer Versions. You can always update this log later (see Working with Version Information, below).
  3. The Version drop-down updates to the newly-created version (Latest version), which becomes active for editing.

Upgrading a Transformer Version

The Upgrade Properties window allows you to specify how a transformer version is upgraded to the most recent version. This window allows the option of deprecating the transformer entirely and replacing it with another transformer.

To open the Upgrade Properties window, click the Upgrade Properties tab (bottom right).

Configure the following Upgrade Properties:

  • Replaced By: Check to specify that the current transformer is deprecated and should be replaced by another transformer with a different name. When configured, and an end user of FME Workbench is in the process of upgrading the transformer, they are presented with a Replace window, rather than an Upgrade window, to complete the upgrade. Expand and specify:
    • Transformer Name: The name of the transformer that replaces the current transformer.
    • Version: The version of Transformer Name that replaces the current transformer.
  • Port Mapping: Specify how each port of the current transformer (Current Port) maps to each port of the transformer specified in Transformer Name (New Port), and the Direction of the New Port, either Input (In) or Output (Out).

Working with Version Information

The Version Information window allows you to view and update useful text about the transformer version that is currently active for editing.

To open the Version Information window, click the Version Information tab (bottom right), or select Version Information from the View menu.

You can perform the following in the Version Information window:

  • Update the Change Log for whichever transformer version is currently active for editing. The notes under What Changed display in the Detailed Version Changes window when an FME Workbench end user is in the process of Upgrading Transformer Versions.

  • Add or update an Upgrade Warning. This text displays to the end user in a separate Warning dialog before the user decides to upgrade.

  • Add version-specific Developer Comments for internal reference.

    Note  Developer comments that do not pertain to a specific version of the transformer can be added separately when Configuring a Transformer.