Skip to content

Release a configuration version & export a deployable file

Before handing a configuration over to other stakeholders or deploying a configuration productively, we highly recommend you always release a version. In this step, the following happens:

  • The BALCFG file will be "frozen".
    The DRAFT suffix in the file name is replaced by a version number. This helps you distinguish a productively deployed version from a draft version. Changes can now only be made by creating a new version.

  • A deployable file is exported.
    This is the file you need to hand over to your technician. It's end-to-end encrypted and thus protects the sensitive project keys in the configuration during transmission.

Equipment & requirements

  • Any ToolSuite version

  • A reader to encrypt the deployable file during export. We recommend ID-engine ZB Brick or ACCESS200.

    Legacy readers with a firmware ID other than 1100 will not work.

Settings to check

Before releasing, make sure you set the following options in Administrative Information as needed.

  • Support Legacy Firmware Versions
    Enable this option if you want to support readers with legacy firmware. Then you'll get the deployable file in the legacy BEC format instead of the standard BEC2 format (learn more).

  • Package with Specific Firmware Version
    We generally recommend you enable this option (learn more).

    Screenshot: Settings in Administrative Information to check before releasing a configuration in BALTECH ConfigEditor

Release & export the configuration

  1. Open BALTECH ConfigEditor.
    If you haven't installed it yet, you can download it here as part of BALTECH ToolSuite.

  2. Open the BALCFG file of the configuration you want to release.

  3. Connect a reader to your computer. This is where the deployable file will be end-to-end encrypted during export.

    My company uses their own BALTECH customer key.

    If your productive readers are equipped with your own customer key, , the encrypting reader needs to hold that customer key as well. Otherwise, you won't be able to deploy the configuration.

  4. Click Release & Export Configuration.

    Button "Release & Export Configuration" in BALTECH ConfigEditor

  5. If you've packaged the configuration with a firmware, but want to give your technician the option to create a ConfigCard in BALTECH Uploader, enable the checkbox in the Release and export dialog.

    Details

    By default, the exported file will contain both the configuration and the firmware. This file can't be stored on ConfigCards due to space limitations. Enabling the checkbox will export a second file with the configuration only.

    Export a configuration packaged with a firmware without the firmware for ConfigCard creation in BALTECH Uploader

  6. Save. Keep the version number -01 as part of the file name as this helps you identify the version later.

    The header changes to This is a released configuration. This version can no longer be edited. To make further changes, create a new version.

    Use the exported file to deploy the configuration to productive readers.

    Header of a released configuration version in BALTECH ConfigEditor

Will someone else keep working on the configuration?

  • Hand over the BALCFG file
    The exported deployable file can't be edited.
  • Set a password
    It encrypts the BALCFG file and thus protects sensitive information (e.g. encryption keys) during transmission. To set a password, click File > Set Password. Transmit the password via a different channel than the configuration, e.g. via SMS or on the phone.
Title