# EPLAN License Manager

# Introduction

Open iT supports EPLAN 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.

# 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 license usage data from the EPLAN license manager.

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

2. Locate and set root.scheduler.jobs.run_elmmonitor.general.active to true to activate raw data collection.

   collect_license_eplan-raw.oconf

    15|	}
    16|	general
    17|	{
    18|		active
    19|		{
    20|			type=bool
    21|			value=true

3. Locate root.scheduler.jobs.run_elmmonitor.operations.arguments.

   collect_license_eplan-raw.oconf

    40|	}
    41|	arguments
    42|	{
    43|		type=string
    44|		value=--elmmonitor_path "%ELMMONITORPATH%" --servername %SERVERNAME% --xmlfile "${OpeniT.directories.conf}/eplan-report.xml" --outputdir "${OpeniT.directories.temp}/Raw.EPLAN.Report"
    45|	}

   Set the full path to the ELM monitor application %ELMMONITORPATH% and the EPLAN license server name %SERVERNAME%.

   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: collect_license_eplan-raw.oconf

    40|	}
    41|	arguments
    42|	{
    43|		type=string
    44|		value=--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"
    45|	}

4. Save the changes.

# EPLAN Events Log File Collection Configuration

# Activating Event Log Data Collection

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

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

2. Locate and set root.scheduler.jobs.collect_eplan_licenselogs.general.active to true to activate the collection of EPLAN event log data.

   collect_license_eplan-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_eplan_licenselogs, preprocess_eplan_licenselogs-events, or transfer_eplan_licenselogs in the same file and configure the attributes.

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

EPLAN Event Log Job Scheduler Instances Configuration

# Modifying Feature Name and Bundle Number Separator for Event Log Data

These are the required steps to modify the feature name and bundle number separator for event log data if you don't want to use the default, ().

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

2. Locate the data-process11 node under the post-processing node and change [ and ].

   matchobjects-event-eplan.oconf

    141|		data-process11
    142|		{
    143|			description=Presentation of feature name. Configurable. Prohibited character:"|"
    144|			type=string
    145|			value=feature=(feature!="" && bundle!="") ? feature + "[" + bundle + "]":feature
    146|		}

   Sample Output

    EPLAN Electric P8. Professional[4]

   You can use any character except |.

   Example: matchobjects-event-eplan.oconf

    141|		data-process11
    142|		{
    143|			description=Presentation of feature name. Configurable. Prohibited character:"|"
    144|			type=string
    145|			value=feature=(feature!="" && bundle!="") ? feature + "<" + bundle + ">":feature
    146|		}

   Sample Output

    EPLAN Electric P8. Professional<4>

3. 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:

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_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

# Activating Record Log Data Collection

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

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

2. Locate and set root.scheduler.jobs.collect_eplan_licenselogs-records.general.active to true to activate the collection of EPLAN record log data.

   collect_license_eplan-record-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_eplan_licenselogs-records, preprocess_eplan_licenselogs-records, or transfer_eplan_licenselogs-records in the same file and configure the attributes.

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

EPLAN Record Log Job Scheduler Instances Configuration

# Modifying Feature Name and Bundle Number Separator for Record Log Data

These are the required steps to modify the feature name and bundle number separator for record log data if you don't want to use the default, ().

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

2. Locate the data-process2 node under the post-processing node and change [ and ].

   matchobjects-record-eplan.oconf

    134|		data-process2
    135|		{
    136|			description=Presentation of feature name. Configurable. Prohibited character:"|"
    137|			type=string
    138|			value=feature=(feature!="" && bundle!="") ? feature + "[" + bundle + "]":feature
    139|		}

   Sample Output

    EPLAN Electric P8. Professional[4]

   You can use any character except |.

   Example: matchobjects-record-eplan.oconf

    134|		data-process2
    135|		{
    136|			description=Presentation of feature name. Configurable. Prohibited character:"|"
    137|			type=string
    138|			value=feature=(feature!="" && bundle!="") ? feature + "<" + bundle + ">":feature
    139|		}

   Sample Output

    EPLAN Electric P8. Professional <4>

3. 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:

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_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.

# Next Steps?

   Renaming Vendor License    Renaming Features    Create and Add Report    License Monitor