# FlexNet Embedded license client setup
# FlexNet Embedded license client setup
#### Subtopics
1. [Installing the FNE license client](https://lhc.advantest.com/books/flexnet-embedded-licensing/page/installing-the-fne-license-client "Installing a FlexNet Embedded license client used to provide the activated licenses to a SmarTest installation on a system controller workstation requires two steps: the installation of the license client software itself on the SmarTest host system, and configuration of the license server configuration file to prioritized the order of server access.")
2. [Uninstalling the FNE license client](https://lhc.advantest.com/books/flexnet-embedded-licensing/page/uninstalling-the-fne-license-client "Uninstalling the FNE license client is done manually using yum.")
3. [Enabling license logging](https://lhc.advantest.com/books/flexnet-embedded-licensing/page/enabling-license-logging "Detailed information about license consumption and optimize license usage can be identified by License usage logging.")
The FlexNet Embedded license client is required to run on the system controller (installed as default).
The FlexNet Embedded license client is installed as the default license client.
Information required to install, configure and administer FlexNet Embedded license clients is divided into the following areas:
- License client installation - Installation of the license client software to manage the licensing of a SmarTest software installation.
- Switching the client between FlexNet Embedded and FlexNet Publisher servers.
- License client administration - Advantest FlexNet Embedded (FNE) license client tools and their usage.
### **System controller prerequisites**
- SmarTest 8.x
- The system controller fully-qualified hostname
### **Checking the connection to a customer-hosted FNE License Server**
After installing the FNE license server, check that the FNE license server is contactable from the SmarTest workstation before you start the installation of the FNE client subsystem on the SmarTest workstation.
`href="http://:7070/api/1.0/health `
Complete the following procedure to check the connection to the FNE license server:
1. Open a browser.
2. Enter the URL appropriate for your FNE server arrangement:
- `href="http://:7070/api/1.0/health `
``represents the hostname of the *FNE license server* to which you are testing the connection.
- **`href="http://:7070/api/1.0/health
` **represents the hostname of the *failover FNE* license server to which you are testing the connection.
If the FNE license server is contactable (port 7070 is open), the following type of output is displayed:
[](https://lhc.advantest.com/uploads/images/gallery/2025-10/scaled-1680-/L4R11-png.png)
3. **If port 7070 is not open**, you a page with a not available message is displayed. In this case, get in contact with your administrators (customer IT) and request that port 7070 is opened for the SmarTest client workstation.
# Installing the FNE license client
Installing a FlexNet Embedded license client used to provide the activated licenses to a SmarTest installation on a system controller workstation requires two steps: the installation of the license client software itself on the SmarTest host system, and configuration of the license server configuration file to prioritized the order of server access.
### About this task
Installing the FNE license client (installed as default license client) also installs the FNE Server Viewer. For more details, see [Monitoring license servers using the FNE Server Viewer](https://lhc.advantest.com/books/flexnet-embedded-licensing/page/monitoring-license-servers-using-the-fne-server-viewer "The FNE Server Viewer is a web-based application that can be used to monitor Advantest license servers.").
The following procedure explains how to install the FlexNet client.
### **Before you begin**
The license client is the SmarTest software. The FlexNet license server communicates with SmarTest using the FNE client.
The license client install package can be downloaded from the FNE section of the Advantest Software Center:
[https://softwarecenter.advantest.com/download/othersw/builds/licensing](https://softwarecenter.advantest.com/download/othersw/builds/licensing)
The following procedure is applicable to installation, upgrades and updates.
Note: During upgrading and updating, the installation script can be called without any option. All installed packages are detected automatically and updated if applicable.
`sudo sh install-fne-date-version.sh`
**Port 7070** must be open to the customer FNE license server and if needed to the cloud license server.
To check connection to your license servers, use the command:
If you are using the Advantest cloud license servers, check the connections by opening the following URLs:
- http://<license-server>:7070/ping
- https://<Device Owner FNE license server>.advantest.cloud:7070/ping
- https://<Device Owner FNE license server>-fo.advantest.cloud:7070/ping
If port 7070 is open, the following type of output is displayed:
[](https://lhc.advantest.com/uploads/images/gallery/2025-10/scaled-1680-/jtO44-png.png)
### **Procedure**
1. Open the Advantest Software Center in a browser: [https://softwarecenter.advantest.com/](https://softwarecenter.advantest.com/)
Login with your credentials.
2. To get the list of all available Licensing products, from the left menu select: ****[](https://lhc.advantest.com/uploads/images/gallery/2025-10/scaled-1680-/9IE55-png.png)
3. Scroll to and select the license type FNE and the version you want to install and expand to display the details.
4. Create an empty installation directory. For example: `/tmp/smartest_pakages`
5. Download the archive package by clicking the [](https://lhc.advantest.com/uploads/images/gallery/2025-10/scaled-1680-/WoC9-png.png) icon.
The selected license (`tar.gz`) package is downloaded to your browser's download folder.
Example FNE packages include:
`fne_2024.01.0.0-24043_rhel9.tar.gz`
6. Move the downloaded archive packages to the installation directory: `/tmp/smartest_pakages`
7. Unpack the archive with the command:
`tar xvzf package-name.tar.gz`
For example:
**`tar xvzf fne_2024.01.0.0-24043_rhel9.tar.gz`**
**The installation script is extracted**, for example:
**`install-fne-2024.01.0.0-24043-rhel9.sh`
**
8. Check the downloaded archive package for integrity:
`bash install-fne-date-version.sh test`
9. Shut down the **SmarTest Work Center**.
For details see [Shutting down SmarTest](https://tdc.advantest.com/help/topic/com.verigy.itee.help.smartest.ui.8.7.6/248729.htm "This task describes the procedure of shutting down SmarTest.").
10. Install the client package: `sudo sh install-fne-date-version.sh client`
For example:
`sudo sh install-fne-2024.01.0.0-24043-rhel9.sh client`
Note: During upgrading and updating, the installation script can be called without any option. All installed packages are detected automatically and updated if applicable.
11. **Optional:** Remove the installation directory. For example:
`rm -rf /tmp/smartest_packages `
12. After the installation has completed, configure the license server configuration file where the list of FlexNet Embedded license servers are listed in a prioritized order.
Open the **configuration file** in an editor: **`/etc/fne/client.conf`
**
Syntax of the **client.conf** file:
- **Local license server**
```
#Configuration of FNE servers to be used
# primary FNE server
server
{
name = "FNE on localhost"
url = "localhost"
}
```
- **Remote license server**
```
#Configuration of FNE servers to be used
# primary FNE server
server
{
name = "FNE central server"
url = "hostNameLicenseServer.domain"
}
#secondary FNE server
server
{
name = "FNE remote server"
url = "socbu158.advantest.com"
}
```
---
Keywords for the **
client.conf** file:
- **include**
- Used to include another configuration file. **include** can be used multiple times in a file.
- **server { }**
- Used to specify a server description with brackets enclosing each description. **server { }** can be used multiple times in a file.
- **name**
- Free text used to add a description for a server.
- **selector**
- The client must comply with all listed selector conditions before the client can attempt to contact the server.
**selector** can be used multiple times in a file.
- **url/primaryUrl**
- **url** used to address for the server if only one server is configured. Use **primaryUrl** instead for the primary server when more than one server is configured.
- **failoverUrl**
- Used to address the failover servers.
- **mute**
- Used to suppresses connection-related error messages for the corresponding server.
Other error messages are displayed.
Some FNE servers listed in **client.conf** files may be unavailable by intent, for example, emergency servers or temporary servers. If these servers are not running or disconnected, associated error messages are normally displayed at each checkout request, which can be unhelpful if it is an expected situation.
Note: The mute keyword is not supported by older FNE subsystems and is ignored if specified. For FNE subsystem versions that do not support the mute keyword, a syntax warning might be displayed and can be ignored.
13. Enter the names and URLs for all FlexNet Embedded license servers that you want to use in their order of priority.
14. To verify the installation and license server configuration enter the command:
`/usr/local/bin/fne-list-licenses`
The tool iterates through the FlexNet Embedded servers defined in **`/etc/fne/client.conf`** and lists all licenses (used and available).
It also provides detailed information about the available licenses including:
- Content of the AssetScale tokens
- Locking of licenses
- Expiry information
Note: The fne-list-licenses tool does not show details from cloud license servers.
For details, see [fne-list-licenses](https://lhc.advantest.com/books/flexnet-embedded-licensing/page/advantest-flexnet-embedded-license-client-tools).
### **Results**
You have installed the license client software and configured the list of FlexNet Embedded license servers in a prioritized order.
The order in which clients attempt to check out licenses is the same order in which the licenses are referenced in the **client.conf** file.
### **Example**
#### Example of a client.conf file:
```
#Configuration of FNE servers to be used
# Emergency Server
include "/etc/fne/emergency.conf"
server
{
name = "Local cloud space"
url = "localcloud.company.com"
}
server
{
name = "My cloud"
selector = "DeviceOwner:MyCompany"
url = "https://MyCompany.advantest.cloud:7070"
}
server
{
name = "Local license server"
primaryUrl = "fne1.company.com"
failoverUrl = "fne2.company.com"
}
```
Minimum client.conf file configuration:
```
server
{
url = "localhost"
}
```
# Uninstalling the FNE license client
Uninstalling the FNE license client is done manually using yum.
### About this task
There are two options for uninstalling the FNE license client:
- Remove the FNE client only, which results in automatically switching back to using the FNP license client and FNP licensing.
- Completely remove the FNE client installation, which removes the license client, the FNE Server Viewer, and the `test_license_checkout` tool.
#### Uninstalling the FNE license client only
To remove the FNE client only, enter the command:
`yum remove v93000-fne-client`
### **Completely uninstalling the FNE license client and tools**
To completely remove the FNE client installation, enter the command:
`yum remove v93000-fne-client advantest-fne-server-viewer advantest-test_license_checkout`
### **Results**
FNE license client is no longer installed on the SmarTest system controller.
# Enabling license logging
##### **Subtopics**
- [**Reading log file data**](https://lhc.advantest.com/link/73#bkmrk-reading-log-file-dat-1)
- [**Example logfile parser**](https://lhc.advantest.com/link/73#bkmrk-example-logfile-pars)
Detailed information about license consumption and optimize license usage can be identified by License usage logging.
### **About this task**
To be able to get detailed information about license consumption and optimize license usage, it is necessary to analyze the licensing requirements for memory and speed for each measurement within a test program. From this information, it is then possible to isolate the main license requirements.
License usage logging (incremental over measurements and per measurement logging) provides the information required to establish the licensing dependencies. If the watermark increases in proportion to the measurement data, the test is independent, otherwise it shares data with other tests.
Log data is written to:
`/opt/hp93000/soc/system/log/licenseUsage_.log `
To read in the data you need to generate a parser based on protobuf library using the grammar in:
`/opt/hp93000/soc/system/include/xoc/profiling/licenseUsage.proto `
An existing file is not overwritten - only new data is appended to the existing content.
The most valuable data collected by license logging is when you have not previously executed an initial bind before executing the profile configuration. After an initial bind, only dynamic changes are recorded.
### **Before you begin**
Make sure the test program has been loaded.
License logging can only be enabled using a Profile launch configuration.
### **Procedure**
1. Select a test program or test flow in the **Package Explorer** view for which you want to enable license logging.
License logging is not available for encrypted testflows or test programs containing encrypted testflows.
2. Open the **Profile Configurations** dialog from the context menu:
****
3. Select **Test Program** from the objects pane on the left.
4. Click the New Launch Configuration [](https://lhc.advantest.com/uploads/images/gallery/2025-10/scaled-1680-/10-png.png) button.
5. Enter a name for the new profile configuration in the configuration pane on the right.
6. In the **Main** tab (default selection), select **Enable license logging**.
[](https://lhc.advantest.com/uploads/images/gallery/2025-10/scaled-1680-/kAy66-png.png)
7. Specify any other required configurations. For details, see [Creating a run configuration for running test programs or testflows](https://tdc.advantest.com/help/topic/com.verigy.itee.help.smartest.ui.8.7.6/256920.htm "You can specify, save and reuse customized configurations for starting test programs or testflows in execute or debug mode.").
8. Click **Apply** to save the profile configuration.
9. Click **Profile** to profile the test flow or **Close** to close the **Profile Configurations** dialog box.
##### **Results**
License logging is enabled.
Log data is written to `/opt/hp93000/soc/system/log/licenseUsage_.log.`
A license usage log file contains the memory contribution (in Bytes) for each signal for each measurement.
Note: License logging can also be enabled and disabled using the Test Cell API. For example:
`TestProgramConfig config;`
`config.enableLicenseLogging = true;`
`testProgram.loadWithConfig(config);`
For details about TestProgramConfig, see **[TestProgramConfig](https://tdc.advantest.com/help/topic/com.verigy.itee.help.smartest.ui.8.7.6/structxoc_1_1tcapi_1_1_test_program_config.html).**
##### **What to do next**
The generated log file is user-readable and it is possible to manually extract the licensing requirements for memory and speed for each measurement within a test program. It is not essential to parse this file.
However, for further processing, it can be beneficial to parse the file to arrange its content into a more readable format.
To read in the data you can generate a parser based on the **protobuf** library using the grammar in:
`/opt/hp93000/soc/system/include/xoc/profiling/licenseUsage.proto`
---
# Reading log file data
1) Log file data contains information, such as memory usage.
##### **About this task**
If license logging is enabled, the license log data is written to:
**`/opt/hp93000/soc/system/log/licenseUsage_.log.`**
The following log example shows the used memory (Pattern or PA = 1032 bytes) for the signal D04. The total accumulated value (`accDoubleValue`) is 3096 bytes which the total memory used by the complete program.
##### **LicenseUsage.log file example:**
```
measurementName: "Main.GlobalPAPattern.measurement"
measurementTimestamp: "Mon, 01 Jul 2019 15:30:08 -0700"
licensedFeatureLog {
featurePerSignal {
signalList: "D00 + D01 + D02 + D03 + D04"
feature {
feature: "speed"
accDoubleValue: 10000000
unit: "bps"
}
}
featurePerSignal {
signalList: "D04"
feature {
feature: "memory"
accDoubleValue: 3096
doubleValue: 1032
unit: "B"
}
feature {
feature: "sharedMemory"
doubleValue: 60352
unit: "B"
}
}
}
```
A license usage log file contains the memory contribution (in Bytes) for each signal for each measurement. The accumulated memory value is also recorded. In the example above:
| **Measurement** | Main.GlobalPAPattern.measurement |
| **Signal names** | signal\_list: "D00 + D01 + D02 + D03 + D04" |
| **Signal requirement type** | feature: speed (all signals)
feature: memory (signal D04)
feature: sharedMemory (signal D04)
|
| **Accumulated speed value** | accDoubleValue: 10000000 bps (all signals) |
| **Accumulated memory value** | acc\_double\_value: 3096 B (signal D04) |
| **Memory value** | doubleValue: 1032 B (signal D04) |
| **Shared memory value** | doubleValue: 60352 B (signal D04) |
Note: If you only require the values for a specific measurement, you can read this from the ASCII text manually.
```
TestProgramConfig config;
config.enableLicenseLogging = true;
testProgram.loadWithConfig(config);
```
The protocol buffer compiler is installed under `/usr/bin/protoc`The protoc version can be found with the command:`/usr/bin/protoc --version`
Output example: **libprotoc 2.5.0**
To structure information, protocol buffer message types are defined in .proto files. The following protobuf file is used for license logging, which can be compiled with the protocol buffer compiler to Java, Python, Objective-C, or C++.
---
- ### **Before you begin**
- Make sure that license logging is enabled. For details, see [Enabling license logging](https://lhc.advantest.com/books/flexnet-embedded-licensing/page/enabling-license-logging "Detailed information about license consumption and optimize license usage can be identified by License usage logging.").
### **Procedure**
1. Create a parser file, for an example, see [Example logfile parser](https://lhc.advantest.com/link/73#bkmrk-example-logfile-pars)**.**
2. For example, to compile to C++ with the protocol buffer compiler, run the following commands or a **make.sh** script containing the commands:
`protoc -I=/opt/hp93000/soc/system/include/xoc/profiling/ --cpp_out=.`
` /opt/hp93000/soc/system/include/xoc/ profiling/licenseUsage.proto`
`c++ -std=c++11 -g -L/usr/local/lib -lprotobuf -o licenseLogger licenseUsage.pb.cc main.cpp`
The generated C++ class is used to simplify the parser implementation.
```
./licenseLogger licenseUsage.log memory D04
Analysing: licenseUsage.log memory D04
Top 20 measurement runs for feature "memory" at signal "D04"
Measurement Run | Value |Watermark Value
----------------------------------+----------+-----------------------
Main.GlobalPAPattern2.measurement | 1032.000 | 3096.000
```
### **Results**
After the above **protoc** call or **make.sh** script is run, the following files are created:
- **licenseLogger**
- Generated Parser Executable To execute the licenseLogger, use the command: `./licenseLogger `
For example:
`./licenseLogger licenseUsage.log memory D01`
- **measurementLicense.pb.cc**
- Generated after running protobuf compiler
- **measurementLicense.pb.h**
- Generated after running protobuf compiler
---
## Example logfile parser
1) The following code is an example parser for reading license log files and printing the top 10 measurement executions contributing to the specified feature and signal.
#### **Example parser (SmarTest ≥ 8.2.0)**
```
#include
#include
#include
#include
#include
#include