#
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:
- (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.
Apply the configurations shown in the Open iT client.
#
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.
Go to the scheduler directory, which is by default in
C:\Program Files\OpeniT\Core\Configuration\scheduler
, and opencollect_license_alm-logs.oconf
.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.oconf13| } 14| general 15| { 16| active 17| { 18| type=bool 19| value=true
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 inC:\ProgramData\Siemens\Automation\Automation License Manager\logging
.collect_license_alm-logs.oconf48| } 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| }
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.
#
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.
#
Verifying Log Data Collection
After activation, you can verify that the data is collected and sent to the server by following these steps:
Open a command prompt with Administrator level privileges.
Go to bin directory, which is by default in
C:\Program Files\OpeniT\Core\bin
, run the command:Command Syntaxcd $BIN_DIR
Examplecd C:\Program Files\OpeniT\Core\bin
Run the command:
Command Syntaxopenit_executor -r collect_license_alm-logs
Verify that there are
archiver*.in
files created in the server in the archiver directory, which is by default inC:\ProgramData\OpeniT\Data\incoming\archiver
.
Next Steps? Renaming Vendor License Renaming Features Create and Add Report License Monitor