# Altium License Manager

# Introduction

Open iT supports Altium usage reporting by collecting log files and converting them to Open iT format. This will produce the following aggregated data types used for historical reporting:

• (89) Total License Use Licenseevents
  
• (90) Individual License Use Licenseevents
  
• (91) Usergroup License Use Licenseevents
  
• (108) Host License Use Licenseevents
  
• (109) Hostgroup License Use Licenseevents
  
• (104) License Logfile Events v2.0
  
• (107) Denied License Use Licenseevents

The following sections will guide you in setting up the necessary configuration to collect and send the required data to the server.

# Requirements

• An Open iT Client connected to an Open iT Server or a coexistent Open iT setup
• License server administrative rights
• Full path to the debug log file

# Configuring Log File Collection

These are the required steps to configure collection of Altium log files.

1. Go to the Components directory, which is by default in C:\Program Files\OpeniT\Core\Configuration\Components, and open logfilecollector-altium.xml.

2. Locate object node dir and set its value to the location of the Altium log files.

   logfilecollector-altium.xml

    14|	<Object>
    15|		<Name>dir</Name>
    16|		<Description>Directory containing the log files</Description>
    17|		<Value type="DirName">%ALTIUM%</Value>
    18|	</Object>

   Example: logfilecollector-altium.xml

    14|	<Object>
    15|		<Name>dir</Name>
    16|		<Description>Directory containing the log files</Description>
    17|		<Value type="DirName">C:\Users\Administrator\Desktop\altium</Value>
    18|	</Object>

3. Save the changes.

4. Open a command prompt with Administrator level privileges.

5. Go to the bin directory, which is by default in C:\Program Files\OpeniT\Core\bin, run the command:

   Command Syntax

    cd $BIN_DIR

   Example

    cd C:\Program Files\OpeniT\Core\bin

6. Update the configuration file, run the command:

   Command Syntax

    openit_confbuilder --client

   Make sure that there are no errors encountered.

Refer to the Altium Log File Collection Configuration table to learn more about Altium configuration in logfilecollector-altium.xml.

Object Name	Accepted Value	Description
source.dir	DirName (e.g., C:\Users\Administrator\Desktop\altium)	Location of the Altium log files.
source.pattern	String (i.e., *.log)	The glob pattern identifying source files in the source directory.
source.seen	String (collect, ignore, or tail)	Seen files are source files collected from before. Specify collect to collect from the start every time, specify ignore to never collect from the same file again, or specify tail to continue collection from the end of the file last time (i.e., collect the ones added since last time).
source.cmplines	Integer (e.g., 6, 10, 20)	This is required if the value of source.seen is tail. This is the number of lines compared to source files collected before to determine where to start the collection. Note: If this number is too low, you can end up with an incorrect position, and duplicate data may be in the log files. Usually, it is better to have a few lines more than strictly necessary than even a single line too little.
target.dir	DirName (i.e., ${OpeniT.directories.temp}/LogFileCollector)	This is the location of the directory containing the collected log data.
target.module	String (i.e., license)	The target type of module (in general).
target.datatype	String (i.e., altium)	The specific type of target data.
target.interval	Timespan (e.g., P30S, P5M, P1D)	The span of time between collector runs.
target.rotation-size	Integer (e.g., 6, 10, 20)	The log file rotates if it goes beyond the number (in mb) defined.
target.rotation-glob	String (e.g., *)	The glob pattern to match before the log file rotates.

Altium Log File Collection Configuration

# Activating Log Data Collection

These are the required steps to activate collection of Altium log data.

1. Go to the scheduler directory, which is by default in C:\Program Files\OpeniT\Core\Configuration\scheduler, and open collect_license_altium-logs.oconf.

2. Locate and set root.scheduler.jobs.collect_altium_licenselogs.general.active to true to activate the collection of Altium log data.

   collect_license_altium-logs.oconf

    13|	}
    14|		general
    15|		{
    16|			active
    17|			{
    18|				type=bool
    19|				value=true

3. Save the changes.

The collection runs hourly using a 5-minute sample interval by default. The primary data is then transferred to the server every night according to the client timezone for processing. To configure the intervals, locate the instances attribute under collect_altium_licenselogs, preprocess_altium_licenselogs-events, preprocess_altium_licenselogs-records, or transfer_altium_licenselogs in the same file and configure the attributes.

Refer to the Altium Log Job Scheduler Instances Configuration table to learn the attributes used to configure Altium data collection and transfer.

Attribute Name	Accepted Value	Description
max-instances	Uint (e.g., 5, 8, 9)	The number of instances allowed to run at the same time.
max-handling	String (end-oldest, end-all-old, or end-new)	The action done upon reaching the maximum number of instances. Specify end-oldest to stop/kill the oldest instance and then start the new, specify end-all-old to stop/kill all running instances and then start the new, or specify end-new to not start the new instance.
end-timeout	Timespan (e.g., P30S, P5M, P1H)	The maximum waiting time before terminating a running instance.
quarantine	Timespan (e.g., P30S, P5M, P1H)	The waiting time before starting a new instance after a previous one.

Altium Log Job Scheduler Instances Configuration

# Verifying Log Data Collection

After configuration, you can verify that the data is collected and sent to the server by following these steps:

1. Open a command prompt with Administrator level privileges.

2. Go to the bin directory, which is by default in C:\Program Files\OpeniT\Core\bin, run the command:

   Command Syntax

    cd $BIN_DIR

   Example

    cd C:\Program Files\OpeniT\Core\bin

3. Run the command:

   Command Syntax

    openit_executor -r collect_license_altium-logs

4. Verify that there are archiver*.in files created in the server in the archiver directory, which is by default in C:\ProgramData\OpeniT\Data\incoming\archiver.
   

Next Steps?    Renaming Vendor License    Renaming Features    Create and Add Report    License Monitor