How to configure EPLAN log file Collection

EPLAN License Manager #

Introduction #

Open iT supports EPLAN usage reporting by collecting log files and converting them to Open iT format.

An Open iT client is installed on your license server, and the license server does not create license usage history logs for this collection. The data collector initiates the raw data collector to request license usage history logs from the license manager every hour, triggering the data collection process. Once the logs are received, the raw data collector passes them to the data collector. The collected data is then sent to a data preprocessor for processing. After preprocessing, the final preprocessed data is sent and stored in the Core Server.

Requirements #

• EPLAN License Manager Version 2022.0.3.339
• License server name
• Full path to the ELM Monitor application, elmmonitor.exe
• Full path to the debug log file
• An Open iT Client connected to an Open iT Server or a coexistent Open iT setup

Configuring Raw Data Collection #

These are the required steps to obtain raw data from the EPLAN license manager.

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:
   • cd C:\Program Files\OpeniT\Core\bin
3. Once in the directory, activate the collection of raw EPLAN data, run the command:
   • openit_oconfinit -u “collect_license_eplan-raw.root.scheduler.jobs.run_elmmonitor.general.active=true”
4. Set the full path to the ELM monitor application and the EPLAN license server name.
   Run the command:
   
   Command Syntax:
   • openit_oconfinit -u “collect_license_eplan-raw.root.scheduler.jobs.run_elmmonitor.operations.arguments=–elmmonitor_path \”<elm_monitor_path>\” –servername <server_name> –xmlfile \”${OpeniT.directories.conf}/eplan-report.xml\” –outputdir \”${OpeniT.directories.temp}/Raw.EPLAN.Report\””
     where:
     • <elm_monitor_path> – path to the ELM monitor application
     • <server_name> – EPLAN license server name
        
       Example:
       openit_oconfinit -u “collect_license_eplan-raw.root.scheduler.jobs.run_elmmonitor.operations.arguments=–elmmonitor_path \”C:/Program Files/EPLAN/ELM/ElmMonitor.exe\” –servername hou105win –xmlfile \”${OpeniT.directories.conf}/eplan-report.xml\” –outputdir \”${OpeniT.directories.temp}/Raw.EPLAN.Report\””

You can also include the date range of the data you want to collect following the format –from “DD-MM-YYYY” –to “DD-MM-YYYY” (e.g., –from “01.01.2023” –to “26.09.2023”).
               Example:

• openit_oconfinit -u “collect_license_eplan-raw.root.scheduler.jobs.run_elmmonitor.operations.arguments=–elmmonitor_path \”C:/Program Files/EPLAN/ELM/ElmMonitor.exe\” –servername hou105win –xmlfile \”${OpeniT.directories.conf}/eplan-report.xml\” –outputdir \”${OpeniT.directories.temp}/Raw.EPLAN.Report\” –from \”01.01.2023\” –to \”26.09.2023\”

The collection runs hourly by default. To configure, run the command:

Command Syntax:

• openit_oconfinit -u “collect_license_eplan-raw.root.scheduler.jobs.run_elmmonitor.scheduling.start-triggers.trigger#1.period=<time_span>

where <time_span> is the ELM monitor application run frequency in the ISO-8601 duration format PnDTnHnMn.nS.

Example:

• openit_oconfinit -u “collect_license_eplan-raw.root.scheduler.jobs.run_elmmonitor.scheduling.start-triggers.trigger#1.period=P1D

 

EPLAN Events Log File Collection Configuration #

This will produce the following aggregated data types used for historical reporting:

• (104) License Logfile Events v2.0
• (107) Denied License Use Licenseevents

Activating Event Log Data Collection #

These are the required steps to activate event log data collection.

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:
   Example:
   • cd C:\Program Files\OpeniT\Core\bin
3. Once in the directory, activate the collection of EPLAN event log data, run the command:
   Command Syntax:
   • openit_oconfinit -u “collect_license_eplan-logs.root.scheduler.jobs.collect_eplan_licenselogs.general.active=true”

Verifying Event 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:
   • cd C:\Program Files\OpeniT\Core\bin
3. Run the command:
   • openit_executor -r collect_license_eplan-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.

 

EPLAN Records Log File Collection Configuration #

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

Activating Record Log Data Collection #

These are the required steps to activate record log data collection.

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:
   • cd C:\Program Files\OpeniT\Core\bin
3. Once in the directory, activate the collection of EPLAN record log data, run the command:
   • openit_oconfinit -u “collect_license_eplan-record-logs.root.scheduler.jobs.collect_eplan_licenselogs-records.general.active=true”

Verifying Record 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:
   • cd C:\Program Files\OpeniT\Core\bin
3. Run the command:
   • openit_executor -r collect_license_eplan-record-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.

For assistance or further configuration support, please contact your Open iT support team.

For additional references, you may visit our Documentation page.