ACI API 24.1

# Setting Up Licensing

All ACI communication actions sent to IDOL components in an OEM-licensed environment must be ACI encrypted. IDOL components access the `licensekey.dat` file to determine the encryption keys required to decode encrypted action.

NOTE: You must not use the `CommsEncryptionType` and `CommsEncryptionTEAKeys` (deprecated) configuration parameters to encrypt ACI communications because the key would be publicly available.

IDOL components also require a `versionkey.dat` file, which determines the versions of the component that the license can run.

To set up licensing in an OEM environment

- Encrypt ACI communications between IDOL components and the front-end application by making the appropriate API call in your application and passing in the OEM encryption keys that were provided to you. For example:

  In the C API, you could make the following call:

      const char* szKeys = "MjR8CJCUGcb4RbRdNDKbK9RXX3pEswAiZ";
      aciInitEncryption(TRUE, "TEA", szKeys);

  where the value of `szKeys` is the encryption key provided with the license.

  In the Java API, you could make the following call:

      BteaEncryptionCodec encryptionCodec = new BteaEncryptionCodec(
          "MjR8CJCUGcb4RbRdNDKbK9RXX3pEswAiZ");
      aciServerDetails.setEncryptionCodec(encryptionCodec);

- Redistribute the `licensekey.dat` and `versionkey.dat` files with your application by copying them to the working directory of each IDOL component. The IDOL components then read the license from the `licensekey.dat` instead of the `[License]` section of the component’s configuration file.

  The `licensekey.dat` file is generated by OpenText and provided to you along with your license.

  You can download `versionkey.dat` from the Software Licenses and Downloads portal (SLD), in the License Server package or as a standalone download package. You must download a new `versionkey.dat` when you upgrade your IDOL components.

- Unlike standard ACI encryption, the ACI responses from the IDOL component are not encrypted by default. You can optionally encrypt the response returned by an IDOL component by setting the `EncryptResponse` action parameter to `True` in the ACI action you run. However, in most cases OpenText recommends that you use SSL/TLS for secure communications.

Copyright 2023 Open Text
Version 24.1 | Last updated December 2023

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL ACI API 24.1

Topic Title: Setting Up Licensing