#
OLicense Server
#
Introduction
Open iT supports Olicense 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 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
#
Specifying Olicense Log File Path
These are the required steps to specify the path to the Olicense log files.
Go to the Components directory, which is by default in
C:\Program Files\OpeniT\Core\Configuration\Components
, and openlogfilecollector-olicense.xml
.Locate object node
dir
and set its value to the location of the Olicense log files.logfilecollector-olicense.xml14| <Object> 15| <Name>dir</Name> 16| <Description>Directory containing the log files</Description> 17| <Value type="DirName">%OLICENSELOGDIR%</Value> 18| </Object>
Example: logfilecollector-olicense.xml14| <Object> 15| <Name>dir</Name> 16| <Description>Directory containing the log files</Description> 17| <Value type="DirName">C:\Users\Administrator\Desktop\olicense</Value> 18| </Object>
Save the changes.
Open a command prompt with Administrator level privileges.
Go to the 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
Update the configuration file, run the command:
Command Syntaxopenit_confbuilder --client
Make sure that there are no errors encountered.
Refer to the Olicense Log File Collection Configuration table to learn more about Olicense configuration in logfilecollector-olicense.xml
.
Go to the Components directory, which is by default in
/var/opt/openit/etc/Components
, and openlogfilecollector-olicense.xml
.Locate object node
dir
and set its value to the location of the Olicense log files.logfilecollector-olicense.xml14| <Object> 15| <Name>dir</Name> 16| <Description>Directory containing the log files</Description> 17| <Value type="DirName">%OLICENSELOGDIR%</Value> 18| </Object>
Example: logfilecollector-olicense.xml14| <Object> 15| <Name>dir</Name> 16| <Description>Directory containing the log files</Description> 17| <Value type="DirName">/var/opt/olicense</Value> 18| </Object>
Save the changes.
Go to the bin directory, which is by default in
/opt/openit/bin
, run the command:Command Syntaxcd $BIN_DIR
Examplecd /opt/openit/bin
Update the configuration file, run the command:
Command Syntax./openit_confbuilder --client
Make sure that there are no errors encountered.
Refer to the Olicense Log File Collection Configuration table to learn more about Olicense configuration in logfilecollector-olicense.xml
.
#
Olicense Events Log File Collection Configuration
#
Activating Event Log Data Collection
These are the required steps to activate collection of the Olicense log file for events.
Go to the scheduler directory, which is by default in
C:\Program Files\OpeniT\Core\Configuration\scheduler
, and opencollect_license_olicense-logs.oconf
.Locate and set
root.scheduler.jobs.collect_olicense_licenselogs.general.active
to true to activate log file collectioncollect_license_olicense-logs.oconf13| } 14| general 15| { 16| active 17| { 18| type=bool 19| value=true
Save the changes.
Go to the scheduler directory, which is by default in
/var/opt/openit/etc/scheduler
, and opencollect_license_olicense-logs.oconf
.Locate and set
root.scheduler.jobs.collect_olicense_licenselogs.general.active
to true to activate log file collection.collect_license_olicense-logs.oconf13| } 14| general 15| { 16| active 17| { 18| type=bool 19| value=true
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_olicense_licenselogs
, preprocess_olicense_licenselogs-events
, or transfer_olicense_licenselogs
in the same file and configure the attributes.
Refer to the Olicense Log Job Scheduler Instances Configuration table to learn the attributes used to configure Olicense data collection and transfer.
#
Changing the Vendor License Name for License Events
These are the required steps to change the vendor license names for Olicense license events monitoring and reporting:
Go to the Configuration directory, which is by default in
C:\Program Files\OpeniT\Core\Configuration
, and openmatchobjects-event-olicense.oconf
.Locate the
data-process1
node under thepost-processing
node and set the vendor license name.matchobjects-event-olicense.oconf106| data-process1 107| { 108| type=string 109| value=product="MNL473WIN_OLICENSE" 110| }
Save the changes.
Go to the Configuration directory, which is by default in
/var/opt/openit/etc
, and openmatchobjects-event-olicense.oconf
.Locate the
data-process1
node under thepost-processing
node and set the vendor license name.matchobjects-event-olicense.oconf106| data-process1 107| { 108| type=string 109| value=product="MNL473WIN_OLICENSE" 110| }
Save the changes.
#
Verifying Event Log Data Collection
After configuration, 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 the 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_olicense-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
.
Go to the bin directory, which is by default in
/opt/openit/bin
, run the command:Command Syntaxcd $BIN_DIR
Examplecd /opt/openit/bin
Run the command:
Command Syntax./openit_executor -r collect_license_olicense-logs
Verify that there are
archiver*.in
files created in the incoming directory in your defined data_dir($ROOT_DATA_DIR)
upon Open iT server installation.
#
Olicense Records Log File Collection Configuration
#
Activating Record Log Data Collection
These are the required steps to activate collection of the Olicense log file for records.
Go to the scheduler directory, which is by default in
C:\Program Files\OpeniT\Core\Configuration\scheduler
, and opencollect_license_olicense-record-logs.oconf
.Locate and set
root.scheduler.jobs.collect_olicense_licenselogs-records.general.active
to true to activate log file collection.collect_license_olicense-record-logs.oconf13| } 14| general 15| { 16| active 17| { 18| type=bool 19| value=true
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_olicense_licenselogs-records
, preprocess_olicense_licenselogs-records
, or transfer_olicense_licenselogs-records
in the same file and configure the attributes.
Refer to the Olicense Log Job Scheduler Instances Configuration table to learn the attributes used to configure Olicense data collection and transfer.
Go to the scheduler directory, which is by default in
/var/opt/openit/etc/scheduler
, and opencollect_license_olicense-record-logs.oconf
.Locate and set
root.scheduler.jobs.collect_olicense_licenselogs-records.general.active
to true to activate log file collection.collect_license_olicense-record-logs.oconf13| } 14| general 15| { 16| active 17| { 18| type=bool 19| value=true
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_olicense_licenselogs-records
, preprocess_olicense_licenselogs-records
, or transfer_olicense_licenselogs-records
in the same file and configure the attributes.
Refer to the Olicense Log Job Scheduler Instances Configuration table to learn the attributes used to configure Olicense data collection and transfer.
#
Changing the Vendor License Name for License Records
These are the required steps to change the vendor license names for Olicense license records monitoring and reporting:
Go to the Configuration directory, which is by default in
C:\Program Files\OpeniT\Core\Configuration
, and openmatchobjects-record-olicense.oconf
.Locate the
data-process1
node under thepost-processing
node and set the vendor license name.matchobjects-record-olicense.oconf111| data-process1 112| { 113| description=Product Name 114| type=string 115| value=product="MNL473WIN_OLICENSE" 116| }
Save the changes.
Go to the Configuration directory, which is by default in
/var/opt/openit/etc
, and openmatchobjects-record-olicense.oconf
.Locate the
data-process1
node under thepost-processing
node and set the vendor license name.matchobjects-record-olicense.oconf111| data-process1 112| { 113| description=Product Name 114| type=string 115| value=product="MNL473WIN_OLICENSE" 116| }
Save the changes.
#
Setting Max Available Licenses
The raw log file does not include information on the max available licenses. Set this manually by following these steps:
Go to the Configuration directory, which is by default in
C:\Program Files\OpeniT\Core\Configuration
, and openmatchobjects-record-olicense.oconf
.Locate the
data-process3
node under thepost-processing
node and set it to the number of max available licenses.matchobjects-record-olicense.oconf122| data-process3 123| { 124| description=Max available license. Set manually. 125| type=string 126| value=licenses=100 127| }
Save the changes.
Go to the Configuration directory, which is by default in
/var/opt/openit/etc
, and openmatchobjects-record-olicense.oconf
.Locate the
data-process3
node under thepost-processing
node and set it to the number of max available licenses.matchobjects-record-olicense.oconf122| data-process3 123| { 124| description=Max available license. Set manually. 125| type=string 126| value=licenses=100 127| }
Save the changes.
#
Verifying Record Log Data Collection
After configuration, 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 the 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_olicense-record-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
.
Go to the bin directory, which is by default in
/opt/openit/bin
, run the command:Command Syntaxcd $BIN_DIR
Examplecd /opt/openit/bin
Run the command:
Command Syntax./openit_executor -r collect_license_olicense-record-logs
Verify that there are
archiver*.in
files created in the incoming directory in your defined data_dir($ROOT_DATA_DIR)
upon Open iT server installation.
#
Sample Reports
#
Historical Reports
#
Real-time Reports
#
Troubleshooting
#
Max in Use is Greater than Max Available Licenses
#
Problem
This issue may be encountered when the license check outs were processed even though there weren't license check ins.
#
Resolution
A new command line option --autooff
is added so you can configure the duration before checked out licenses are automatically checked in.
These are the required steps to configure:
- Open
collect_license_olicense-record-logs.oconf
in the scheduler directory, which is by default inC:\Program Files\OpeniT\Core\Configuration\scheduler
. - Locate the
--autooff
argument inroot.scheduler.jobs.preprocess_olicense_licenselogsrecords.operations.arguments
and set its value to the desired duration before automatically checking in checked out licenses.collect_license_olicense-record-logs.oconf151| arguments 152| { 153| type=string 154| value=--srcdir "${OpeniT.directories.temp}/Raw.Olicense.Record" --srcpattern raw-olicense-license-LogFileCollector*.data --srcfilehandling delete --trgdir "${OpeniT.directories.temp}/LogParserOlicense" --module license --datatype record --resolution PT1H --matchobjects "${OpeniT.directories.conf}/matchobjects-record-olicense.oconf" --type record --autooff PT5M 155| }
- Save the changes.
- Open
collect_license_olicense-record-logs.oconf
in the scheduler directory, which is by default in/var/opt/openit/etc/scheduler
. - Locate the
--autooff
argument inroot.scheduler.jobs.preprocess_olicense_licenselogsrecords.operations.arguments
and set its value to the desired duration before automatically checking in checked out licenses.collect_license_olicense-record-logs.oconf151| arguments 152| { 153| type=string 154| value=--srcdir "${OpeniT.directories.temp}/Raw.Olicense.Record" --srcpattern raw-olicense-license-LogFileCollector*.data --srcfilehandling delete --trgdir "${OpeniT.directories.temp}/LogParserOlicense" --module license --datatype record --resolution PT1H --matchobjects "${OpeniT.directories.conf}/matchobjects-record-olicense.oconf" --type record --autooff PT5M 155| }
- Save the changes.
#
Next Steps?
Renaming Vendor License Renaming Features Create and Add Report License Monitor