# Automation License Manager (ALM)

# Introduction

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

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

# Activating Log Data Collection

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

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

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

    collect_license_alm-logs.oconf
     13|	}
     14|		general
     15|		{
     16|			active
     17|			{
     18|				type=bool
     19|				value=true
  3. Locate root.scheduler.jobs.collect_alm_raw_licenselogs.operations.arguments and set the value of --databasefile to the path of the directory that contains the database produced by ALM. This is usually in C:\ProgramData\Siemens\Automation\Automation License Manager\logging.

    collect_license_alm-logs.oconf
     48|	}
     49|	arguments
     50|	{
     51|		type=string
     52|		value=automationlm --databasefile "C:\ProgramData\Siemens\Automation\Automation License Manager\logging" --outputfile "${OpeniT.directories.temp}/SqlCeUtil/ALM/automationlm.csv" --logdir "${OpeniT.directories.log}"
     53|	}		
  4. 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_alm_raw_licenselogs, collect_alm_licenselogs, preprocess_alm_licenselogs-events, preprocess_alm_licenselogs-records, or transfer_alm_licenselogs in the same file and configure the attributes.

Refer to the ALM Log Job Scheduler Instances Configuration table to learn the attributes used to configure ALM 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.
ALM Log Job Scheduler Instances Configuration

# Configuring Log File Collection

The ALM log file configuration file, logfilecollector-alm.xml, is found in the Components directory, which is by default in C:\Program Files\OpeniT\Core\Configuration\Components. You don't need to update this, but if you want to learn more about its behavior, refer to the ALM Log Parser Configuration table.

Object Name Accepted Value Description
source.dir DirName (i.e., ${OpeniT.directories.temp}/SqlCeUtil/ALM/) Location of the ALM log files.
source.pattern String (i.e., *.csv) 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., alm) 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.
ALM Log Parser Configuration

# Verifying Log Data Collection

After activation, 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 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_alm-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

We value your feedback!

Please take a few minutes to complete our survey and share your thoughts on your recent experience with our documentation.

Take survey

Close