ADTF3 Guides - ADTF License Mechanism

Licenser Tool

With the licenser_tool.exe you are able to request, set or show already used license information.

Basically you have to differ between following license types:

Runtime to launch and view ADTF Sessions

Developer to extend the runtime features with creating/editing ADTF Sessions and using the SDK for own adtfplugin implementation

Additional, there can be more license features set, e.g. for using ADTF Toolboxes or 3rd party components.

In ADTF 3.x we differ between following license options:

Node-Locked Offline license for a specified machine (docked to the standard ethernet adapter)

Server Online license from a available license server

Borrow Offline license from a available license server (for a defined duration)

.lic files for ADTF 2.x can only be used within ADTF 2.x, .lic files for ADTF 3.x can only be used with ADTF 3.x. There is no compatibility between these two major versions, like the upgrade from ADTF 1.x to ADTF 2.x.

Command Line usage

First of all let's have a look at the possible options by using the licenser_tool.exe. Just issue the following command: licenser_tool.exe --help

                
licenser_tool

Usage:
        licenser_tool -h
        licenser_tool --info
        licenser_tool --contact
        licenser_tool --load <filename> [--store-for-all-users]
        licenser_tool --list-volumes --host <hostname> --port <port>
        licenser_tool --server --host <hostname> --port <port> --volume <id> [--store-path
                      <filename>] [--store-for-all-users]

        licenser_tool --borrow --host <hostname> --port <port> --volume <id> --days <days>
                      [--store-path <filename>] [--store-for-all-users]

        licenser_tool --request --type (runtime|developer) [--mail]

Options:
        -h, --help  Print the usage info and quit.
        --info      Print license information set on system.
        --contact   Contact data for licensing and support

        Load and store a license file:
          --load    Load command.
          <filename>
                    The path to the license file.

          --store-for-all-users
                    Optional store the license information for all users of the system (default:
                    false)

        List available volumes:
          --list-volumes
                    List volumes command.

          --host <hostname>
                    License server host

          --port <port>
                    License server port

        Setup a server license:
          --server  Server license command.
          --host <hostname>
                    License server host

          --port <port>
                    License server port

          --volume <id>
                    Requested feature scope

          --store-path <filename>
                    Optional path to store received license file from server (default: User Temp
                    directory)

          --store-for-all-users
                    Optional store the license information for all users of the system (default:
                    false)

        Borrow a license from a server:
          --borrow  Borrow server license command.
          --host <hostname>
                    License server host

          --port <port>
                    License server port

          --volume <id>
                    Requested feature scope

          --days <days>
                    Days to borrow

          --store-path <filename>
                    Optional path to store received license file from server (default: User Temp
                    directory)

          --store-for-all-users
                    Optional store the license information for all users of the system (default:
                    false)

        Create a request for a node-locked license:
          --request License request command.
          --type (runtime|developer)
                    License type

          --mail    Open mail client with the generated request


For support issues simply redirect to file, for example:
  licenser_tool --request --type runtime > request.txt
  licenser_tool --info > info.txt

Getting Licensed

Now it's time to get a license for you. If not already done, you have to request a new license by choosing one of the above mentioned license types and options.

Request Node-Locked License

In most cases you will require a node-locked license for your machine. To make it happen, you have to send a request to the support team or create the license request issue in the support platform yourself (see chapter Contact the support team).

In case there are any troubles just follow the instructions given by the tool. In most cases, the tool can not open a mailing program on specific platforms and OS so it has to be done manually (see chapter Generate License Request Manually)

To get a runtime license, just use the following call:

                
licenser_tool.exe --request --type runtime --mail

The difference to developer type:

                
licenser_tool.exe --request --type developer --mail

That's it. If everything works as expected, the request will be generated automatically and will open your mail program (on Windows) with the template (Runtime/Developer type will be set by automatically by using --type <type>).

                
Node-Locked License Request
---------------------------------------------------
Product: ADTF
Version: 3.x.y
---------------------------------------------------
Choose type:
[ ] Runtime (Launch and view sessions)
[ ] Developer (Runtime options + create/edit sessions, using SDK for adtfplugin implementation)
---------------------------------------------------
Additional features:
[x] Device Toolbox
[x] Display Toolbox
[x] Calibration Toolbox
---------------------------------------------------
Company: <REQUIRED>
Department: <REQUIRED>
Responsible person: <REQUIRED>
Additional information: <OPTIONAL>

---------------------------------------------------
Host Information:

...

Just complete the required information (company, department, responsible) and settings (type, features) and send to receive your license file.

Request Online Server License

Maybe your company has access to a license server instance and you are using kind of floating license, following information are required:

url

port

volume

If you have the complete server address (url:port), then you can search for available volumes, which usually provide specific features like developer vs. runtime or different toolbox features.

                
licenser_tool.exe --list-volumes  --host <myurl> --port <myport>

Chosse a volume and go:

                
licenser_tool.exe --server --host <myurl> --port <myport> --volume <myvolume>

Request Offline Borrow License

Using a server license is very comfortable... but what if you are loosing connection ? For this, just borrow a license from this server and enjoy offline work for the specified duration. So here we need:

url

port

volume

days

                
licenser_tool.exe --borrow --host <myurl> --port <myport> --volume <myvolume> --days <42>

Generate License Request Manually

So, to gather the required information for a license request manually (i.e. to send from another computer, person, no mailing program or whatever), you can use the generate-request option.

This will dump the template (see chapter Request Node-Locked License) to stdout, so it's easy for you to copy or pipe it in a file to send, store or whatever you want to achieve. But please don't forget to complete the required information (company, department, responsible) and settings (type, features) before sending to the support team or for creating a issue (see chapter Contact the support team).

For runtime request:

                
licenser_tool.exe --request --type runtime

For developer request:

                
licenser_tool.exe --request --type developer

You want to have the template in a file ? Just use standard piping mechanism,. e.g.

                
licenser_tool.exe --request --type runtime > myrequest.txt

Load License File

If you have received your requested node-locked license file, then it's time to complete the request and make your license work. To load and also store, just use the open option with path to you license file:

                
licenser_tool.exe --load c:\path\to\my\lic\Mustermann_MustermannMax_V3_11-22-33-44-55-66.lic

And that's it !

Get license information

ADTF is searching your license in following order:

Specified as environment variable ADTF_LICENSE_FILE (absolute or relative to working directory)

User path:

HKCU\Software\Audi Electronics Venture GmbH\ADTF\3\license_file

<home>/.adtf/adtf3.lic

System path

HKLM\Software\Audi Electronics Venture GmbH\ADTF\3\license_file

/etc/adtf3.lic

We recommend using the environment variable ADTF_LICENSE_FILE only temporary, e.g. for testing, processing or scripting setups, especially when relative setups are required (e.g. in Docker).

Maybe you want to check your license, receive some information or issue some troubles by using ADTF and its (licensed) features, you can create a little report by using info option:

                
licenser_tool.exe --info

This will create something like...

                
License for current user is set, used license file 'path/to/adtf3.lic'
Version: ADTF 3.x
User: Max Mustermann
Company: Mustermann GmbH
Type: Offline node-locked license
Host ID: 11-22-33-44-55-66
Valid until: 00:42 04.05.2345
Features:
--- Development
--- Display Toolbox
--- Device Toolbox
--- Calibration Toolbox

This is often very useful to get some hints, especially to send to the support team. Of course you can create a file by using licenser_tool.exe --info > somefile.txt as well.

Contact the support team

Maybe you encounter a problem, have additional questions or just need some contact information, use the contact option

                
licenser_tool.exe --contact

and you will get something like...

                
Digitalwerk GmbH
Support Team

Im Gewerbepark C15
93059 Regensburg

Supportportal: https://support.digitalwerk.net
E-Mail: support@digitalwerk.net
Hotline: +49 941 4662 4311

Service Hours:

Mon - Fri
09:00am - 05:00pm (CET)

excluding:
- German non-business holidays
- Christmas company closing days (Dec 24th - Jan 6th)
- Bridging days

Additonal information regarding license questions

Loading license within your application

If your application depends on licensed plugins and you are not using the ADTF-Launcher, you must set an environment variable. The internal license mechanism is not able to load the corresponding library. ADTF offers for this approach the environment variable ADTF_LICENSER_PLUGIN. This environment variable has to be set to the corresponding license file.

ADTF_LICENSER_PLUGIN = "$(ADTF_DIR)/bin/licenser.dll" The environment variable must not point to you *.lic-file, which contains your specific library. The environment variable points to the plugin (should be in the bin-directory)

Where to go next?

You want to extract or add something to an .adtfdat file ? The ADTF DAT Tool will make it possible.