Call Home entitlement mechanism

The Call Home entitlement mechanism is an online licensing method for
FactoryTalk® Optix™
 Runtime running in Docker containers only.
TIP: For information about Docker entitlements and licensing, see Docker runtime entitlements.
FactoryTalk® Optix™
 Runtime can run in Ubuntu 22.04 Docker containers.
The entitlement serial number is injected into the Docker container as an environment variable named
FTOPTIX_ENTITLEMENT_SERIAL_NUMBER
. This variable triggers the Call Home mechanism.
The entitlement flow occurs as follows:
  1. The Docker container calls specific Entitlement Web APIs to lock the specified entitlement.
  2. If the lock request is successful, the Docker container periodically refreshes the entitlement lock every 30 minutes.
  3. The Docker container unlocks the entitlement upon Runtime termination, to make it available for rehosting.
TIP: If the Docker container does not unlock the entitlement upon termination, proceed with a manual rehost. This scenario might occur whenever Runtime stops unexpectedly.
Diagram showing communication between different components.
If the Docker container rehosts the locked entitlement during runtime, this latter receives a rehost notification after the next entitlement lock refresh.
A seven-day grace period starts only if the connection with the Entitlement Web API is lost after an entitlement lock.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal