# Dassault Systemes License Server (DSLS)

# Introduction

Open iT supports DSLS usage reporting through the autoconfigurator by detecting configurations used to set the license manager data collection automatically. On the other hand, if you need to configure its behavior manually, the following sections will guide you on the required configuration for license manager utility polling and log file parsing.

# Configuring License Manager Utility Polling

Open iT polls the license servers at regular intervals to get the current status of its license use and availability.

An Open iT client is installed on your license server for this collection. The data collector/preprocessor gathers the current license usage information from the license manager every hour using a 5-minute sample interval, triggering the data collection process. It also processes the gathered license usage. Once the data is preprocessed, it is transmitted to the Core Server, according to the client's timezone, for further storage, completing the license usage data collection and processing.

License Manager Utility Polling Workflow

License Manager Utility Polling Workflow

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

The following sections will guide you in setting up the necessary configuration to collect and send the required data to the server.

# Requirements

# Getting the License Status Utility Binary Location

This configuration requires the path to the license status utility binary, DSLicSrv, to obtain the license status information. Get this by following these steps:

Through the Interface

  1. Open the Task Manager.
  2. Go to the Details tab.
  3. Locate DSLicSrv.
  4. Right-click and choose Open file location.
    The path of the binary will be displayed.

Through the Command Line

  1. Open a command prompt with Administrator level privileges.

  2. Run the following command to locate the binary:

    Command Syntax
     where /r <installation_drive> DSLicSrv

    where <installation_drive> is the drive where the license manager is installed.

    Example
     where /r C:\ DSLicSrv

    The path of the binary will be displayed.

After verifying the path of the polling program, make sure that it is running.
Open a command prompt in the directory of the license server executable or the polling program and run the following command:

Command Syntax
DSLicSrv -admin

Make sure no errors are encountered.

Run the following command to locate the binary:

Command Syntax
find . | grep DSLicSrv

The path of the binary will be displayed.

# Configuring Data Collection

These are required steps to activate and configure collection of DSLS usage data.

  1. Go to the Components directory, which is by default in C:\Program Files\OpeniT\Core\Configuration\Components, and back up the licpoll.xml configuration file.

  2. Open a command prompt with Administrator level privileges.

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

  4. Once in the directory, activate the collection of DSLS data, run the command:

    Command Syntax
     openit_confinit -c "licpoll.license-types.dsls-sample.active=true"

  5. Set the license server name and port used by the DSLS License Server, run the command:

    Command Syntax
     openit_confinit -c "licpoll.license-types.dsls-sample.license-server=<hostname:portnumber>"
    Example
     openit_confinit -c "licpoll.license-types.dsls-sample.license-server=osl120win:27000"

  6. Set the path to the binary used by DSLS, run the command:

    Command Syntax
     openit_confinit -c "licpoll.license-types.dsls-sample.status-command=<binary_path>"

    where <binary_path> is the obtained path in Getting the License Status Utility Binary Path.

    Example
     openit_confinit -c "licpoll.license-types.dsls-sample.status-command=C:\dsls\bin\DSLicSrv"

  7. Update the configuration file, run the command:

    Command Syntax
     openit_confbuilder --client

    Make sure no errors are encountered.

  1. Go to the Components directory, which is by default in /var/opt/openit/etc/Components, and back up the licpoll.xml configuration file.

  2. Go to the bin directory, which is by default in /opt/openit/bin, run the command:

    Command Syntax
     cd $BIN_DIR
    Example
     cd /opt/openit/bin

  3. Once in the directory, activate the collection of DSLS data, run the command:

    Command Syntax
     ./openit_confinit -r /var/opt/openit/ -d /var/opt/openit/etc/ -c "licpoll.license-types.dsls-sample.active=true"

  4. Set the license server name and port used by the DSLS License Server, run the command:

    Command Syntax
     ./openit_confinit -r /var/opt/openit/ -d /var/opt/openit/etc/ -c "licpoll.license-types.dsls-sample.license-server=<hostname:portnumber>"
    Example
     ./openit_confinit -r /var/opt/openit/ -d /var/opt/openit/etc/ -c "licpoll.license-types.dsls-sample.license-server=osl120win:27000"

  5. Set the path to the binary used by DSLS, run the command:

    Command Syntax
     ./openit_confinit -r /var/opt/openit/ -d /var/opt/openit/etc/ -c "licpoll.license-types.dsls-sample.status-command=<binary_path>"

    where <binary_path> is the obtained path in Getting the License Status Utility Binary Path.

    Example
     ./openit_confinit -r /var/opt/openit/ -d /var/opt/openit/etc/ -c "licpoll.license-types.dsls-sample.status-command=/var/dsls/DSLicSrv"

  6. Update the configuration file, run the command:

    Command Syntax
     ./openit_confbuilder --client

    Make sure no errors are encountered.

Refer to the DSLS Data Collection Configuration table to learn more about DSLS configuration in licpoll.xml.

Object Name Accepted Value Description
active Boolean (true or false) Setting this to true activates DSLS usage data collection.
type String (i.e., DSLS) The license manager type.
interval Timespan (e.g., P30S, P5M, P1H) The span of time between each polling round (it is recommended to set a value no less than P1M).
offset Timespan (e.g., P30S, P5M, P1H) The span of time the aligned poll time decided by interval is shifted.
product-name String (e.g., server;daemon) This object is defined if a vendor license name other than the default DSLS=%server%;dsls will be used.
license-server String (e.g., hou105lin:5008) The DSLS name and port.
restricted Boolean (true or false) Setting this to false prevents DSLicSrv from running with administrator access.
status-command FileName (e.g., ${OpeniT.directories.bin}/DSLicSrv) The binary used to obtain status from the license manager.
status-command.language String (EN-JP for English, JP for Japanese) The expected language of the status command output.
status-command.arguments String (i.e., -admin) The arguments used for the status command.
password String The password for DSLicSrv. Specify if required.
DSLS Data Collection Configuration

# Verifying Data Collection

After configuration, you can verify that the data is collected 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_licpoll -# 1

  4. Verify that the temp directory, which is by default in C:\ProgramData\OpeniT\Data\temp, contains a LicPoll directory containing .data and status-*.log files.

  1. Go to the bin directory, which is by default in /opt/openit/bin, run the command:

    Command Syntax
     cd $BIN_DIR
    Example
     cd /opt/openit/bin

  2. Run the command:

    Command Syntax
     ./openit_licpoll -# 1

  3. Verify that the temp directory, which is by default in /var/opt/openit/temp, contains a LicPoll directory containing .data and status-*.log files.

# Configuring Log File Parsing

Open iT collects log files and converts them to Open iT format.

An Open iT client is installed on your license server for this collection. The data collector monitors and gathers the license usage history logs from the license manager every 5 minutes. Once the logs are collected, the data collection process triggers and the logs are passed to the data preprocessor. After the data is preprocessed, it is transferred to the Core Server for further storage, completing the history logs collection and processing.

Log File Parsing Workflow

Log File Parsing Workflow

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

Record Log Data:

Event Log Data:

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 DSLS log files

# Configuring Log File Collection

These are the required steps to configure the collection of DSLS log files.

Log file collection supports log files in the LicenseServerYYYYMMDDHHMMSS.log and TokenUsageYYYYMMDDHHMMSS.log formats.

  1. Go to the Components directory, which is by default in C:\Program Files\OpeniT\Core\Configuration\Components, and back up the logfilecollector-dsls.xml file.

  2. Open a command prompt with Administrator level privileges.

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

  4. Once in the directory, set the location of the DSLS log files, run the command:

    Command Syntax
     openit_confinit -c "logfilecollector-dsls.logfilecollector.source.dir=<dsls_log_dir>"

    where <dsls_log_dir> is the location of the DSLS log files.

    Example
     openit_confinit -c "logfilecollector-dsls.logfilecollector.source.dir=C:\DSLS\logs"

  5. Update the configuration file, run the command:

    Command Syntax
     openit_confbuilder --client

    Make sure no errors are encountered.

Refer to the DSLS Log File Collection Configuration table to learn more about DSLS configuration in logfilecollector-dsls.xml.

Object Name Accepted Value Description
source.dir DirName (e.g., C:\DSLS\logs) Location of the DSLS log files.
source.pattern String (i.e., *.log) The glob pattern identifying source files in the source directory.
source.seen String (collect, ignore, or tail) Seen files are the previously collected source files.
  • collect - Specify this option to collect from the start each time.
  • ignore - Specify this option to skip collecting from the same file again.
  • tail - Specify this option 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., dslsevents) 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.
DSLS Log File Collection Configuration

  1. Go to the Components directory, which is by default in /var/opt/openit/etc/Components, and back up the logfilecollector-dsls.xml file.

  2. Go to the bin directory, which is by default in /opt/openit/bin, run the command:

    Command Syntax
     cd $BIN_DIR
    Example
     cd /opt/openit/bin

  3. Once in the directory, set the location of the DSLS log files, run the command:

    Command Syntax
     ./openit_confinit -r /var/opt/openit/ -d /var/opt/openit/etc/ -c "logfilecollector-dsls.logfilecollector.source.dir=<dsls_log_dir>"

    where <dsls_log_dir> is the location of the DSLS log files.

    Example
     ./openit_confinit -r /var/opt/openit/ -d /var/opt/openit/etc/ -c "logfilecollector-dsls.logfilecollector.source.dir=/root/user1/DSLS/logs"

  4. Update the configuration file, run the command:

    Command Syntax
     ./openit_confbuilder --client

    Make sure no errors are encountered.

Refer to the DSLS Log File Collection Configuration table to learn more about DSLS configuration in logfilecollector-dsls.xml.

Object Name Accepted Value Description
source.dir DirName (e.g., /root/user1/DSLS/logs) Location of the DSLS log files.
source.pattern String (i.e., *.log) The glob pattern identifying source files in the source directory.
source.seen String (collect, ignore, or tail) Seen files are the previously collected source files.
  • collect - Specify this option to collect from the start each time.
  • ignore - Specify this option to skip collecting from the same file again.
  • tail - Specify this option 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 directory location containing the collected log data.
target.module String (i.e., license) The target type of module (in general).
target.datatype String (i.e., dslsevents) 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.
DSLS Log File Collection Configuration

# Activating Log Data Collection

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

  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. Once in the directory, activate the collection of DSLS log data, run the command:

    Command Syntax
     openit_oconfinit -u "collect_license_dsls-logs.root.scheduler.jobs.collect_dsls_licenselogs.general.active=true"

  1. Go to the bin directory, which is by default in /opt/openit/bin, run the command:

    Command Syntax
     cd $BIN_DIR
    Example
     cd /opt/openit/bin

  2. Once in the directory, activate the collection of DSLS log data, run the command:

    Command Syntax
     ./openit_oconfinit -u "collect_license_dsls-logs.root.scheduler.jobs.collect_dsls_licenselogs.general.active=true"

The collection runs every 5 minutes by default, which triggers the data collection process. To configure the intervals, locate the instances attribute under collect_dsls_licenselogs, preprocess_dsls_licenselogs-events, preprocess_dsls_licenselogs-records, or transfer_dsls_licenselogs and configure the attributes.

Refer to the DSLS Log Job Scheduler Instances Configuration table to learn the attributes used to configure DSLS 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:
  • end-oldest - Specify this option to stop/kill the oldest instance and start a new one.
  • end-all-old - Specify this option to stop/kill all running instances before starting the new one.
  • end-new - Specify this option to prevent a new instance from starting.
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.
DSLS Log Job Scheduler Instances Configuration

# Deactivating Record Log Data Collection

Turning on log data collection automatically aggregates record and event log data. If you want to collect event log data only, follow 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. Once in the directory, deactivate the collection of record log data, run the command:

    Command Syntax
     openit_oconfinit -u "collect_license_dsls-logs.root.scheduler.jobs.preprocess_dsls_licenselogs-records.general.active=false"

  4. Change the handling of event logs, run the command:

    Command Syntax
     openit_oconfinit -u "collect_license_dsls-logs.root.scheduler.jobs.preprocess_dsls_licenselogs-events.operations.arguments=--srcdir \"${OpeniT.directories.temp}/LogFileCollector\" --srcpattern raw-dslsevents-license-LogFileCollector*.data --srcfilehandling rename --trgdir \"${OpeniT.directories.temp}/LogParserDSLS\" --module license --datatype event --resolution PT1H --matchobjects \"${OpeniT.directories.conf}/matchobjects-event-dsls.oconf\" --type event"

  5. Change the data transfer schedule, run the command:

    Command Syntax
     openit_oconfinit -u "collect_license_dsls-logs.root.scheduler.jobs.transfer_dsls_licenselogs.scheduling.start-triggers.trigger#1.job-name=preprocess_dsls_licenselogs-events"

  1. Go to the bin directory, which is by default in /opt/openit/bin, run the command:

    Command Syntax
     cd $BIN_DIR
    Example
     cd /opt/openit/bin

  2. Once in the directory, deactivate the collection of record log data, run the command:

    Command Syntax
     ./openit_oconfinit -u "collect_license_dsls-logs.root.scheduler.jobs.preprocess_dsls_licenselogs-records.general.active=false"

  3. Change the handling of event logs, run the command:

    Command Syntax
     ./openit_oconfinit -u "collect_license_dsls-logs.root.scheduler.jobs.preprocess_dsls_licenselogs-events.operations.arguments=--srcdir \"${OpeniT.directories.temp}/LogFileCollector\" --srcpattern raw-dslsevents-license-LogFileCollector*.data --srcfilehandling rename --trgdir \"${OpeniT.directories.temp}/LogParserDSLS\" --module license --datatype event --resolution PT1H --matchobjects \"${OpeniT.directories.conf}/matchobjects-event-dsls.oconf\" --type event"

  4. Change the data transfer schedule, run the command:

    Command Syntax
     ./openit_oconfinit -u "collect_license_dsls-logs.root.scheduler.jobs.transfer_dsls_licenselogs.scheduling.start-triggers.trigger#1.job-name=preprocess_dsls_licenselogs-events"

# Verifying Log Data Collection

After configuration, you can verify that the data is collected 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_logfilecollector -c "C:\Program Files\OpeniT\Core\Configuration\logfilecollector-dsls.conf"

  4. Verify that there are *.data files created in the LogFileCollector directory, which is by default in C:\Program Files\OpeniT\Core\Log\temp\LogFileCollector.

  1. Go to the bin directory, which is by default in /opt/openit/bin, run the command:

    Command Syntax
     cd $BIN_DIR
    Example
     cd /opt/openit/bin

  2. Run the command:

    Command Syntax
     ./openit_logfilecollector -c "/var/opt/openit/etc/logfilecollector-dsls.conf"

  3. Verify that there are *.data files created in the LogFileCollector directory, which is by default in C:\Program Files\OpeniT\Core\Log\temp\LogFileCollector.

# Troubleshooting

# API Controller Cannot Upload Parsed Log Data

# Problem

This issue may be encountered when the total size of parsed DSLS data per sending is greater than 2 GB. The large parsed DSLS data cannot to be sent to the server, showing the error, ApiController: : postUploadData Failed to upload x files in the debug logs.

# Resolution

Compress object nodes for the upload_dsls_logs tasks is added so you can enable compression of the target data before sending them to the server.

These are the required steps to activate compression of parsed DSLS data before uploading them to the server.

  1. Go to the Components directory, which is by default in C:\Program Files\OpeniT\Core\Configuration\Components, and open apicontroller.xml.

  2. Locate the object node compress under the object node upload_dsls_logs and set its value to true.

    apicontroller.xml
     937|	<Object>
 938|		<Name>compress</Name>
 939|		<Description>Compress upload files before upload</Description>
 940|		<Value type="Bool">true</Value>
 941|	</Object>

  3. Save the changes.

  4. Open a command prompt with Administrator level privileges.

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

  6. Update the configuration file, run the command:

    Command Syntax
     openit_confbuilder --client

    Make sure no errors are encountered.

  1. Go to the Components directory, which is by default in /var/opt/openit/etc/Components, and open apicontroller.xml.

  2. Locate the object node compress under the object node upload_dsls_logs and set its value to true.

    apicontroller.xml
     937|	<Object>
 938|		<Name>compress</Name>
 939|		<Description>Compress upload files before upload</Description>
 940|		<Value type="Bool">true</Value>
 941|	</Object>

  3. Save the changes.

  4. In the terminal, go to the bin directory, which is by default in /opt/openit/bin, run the command:

    Command Syntax
     cd $BIN_DIR
    Example
     cd /opt/openit/bin

  5. Update the configuration file, run the command:

    Command Syntax
     ./openit_confbuilder --client

    Make sure no errors are encountered.

# Next Steps?

   Renaming Vendor License    Renaming Features    Create and Add Report    License Monitor

Powered by Open iT ® Open iT Docs All rights reserved.