Skip to main content
Version: 10.2

OrcaFlex License Manager

Introduction​

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

An Open iT Core 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 midnight. 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:

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

warning

Apply the configurations shown in the Open iT Core Client.

Requirements​

  • An Open iT Core Client connected to an Open iT Core Server or a coexistent Open iT Core setup
  • License server administrative rights
  • Full path to the debug log file

Configuring Log File Collection​

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

  1. Go to the Components directory, which is by default in C:\Program Files\OpeniT\Core\Configuration\Components, and back up the logfilecollector-orcaflex.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 OrcaFlex log files, run the command:

    Command Syntax
    openit_confinit -c "logfilecollector-orcaflex.logfilecollector.source.dir=<orcaflex_log_dir>"

    where <orcaflex_log_dir> is the location of the OrcaFlex log files.

    Example
    openit_confinit -c "logfilecollector-orcaflex.logfilecollector.source.dir=C:\ProgramData\OrcaFlex"
    Sample Log File Content
    3635794431905	3/18/2015 12:31:44 PM	3/18/2015 12:32:05 PM	Disconnected	21	wli	N709	C:\Program Files (x86)\Orcina\OrcaFlex\9.7\OrcaFlex64.exe	OrcaFlex	9.7d	US1WDBPWRHS1	US1WDBPWRHS1.tp.tpnet.intra	10.113.106.181	Network
    3635794431906	3/18/2015 12:32:46 PM	3/18/2015 12:32:55 PM	Disconnected	8	wli	N709	C:\Program Files\Microsoft Office 15\Root\Office15\EXCEL.EXE	OrcaFlex	9.7d	US1WDBPWRHS1	US1WDBPWRHS1.tp.tpnet.intra	10.113.106.181	Netwo
    3635794431907	3/18/2015 12:34:19 PM	3/18/2015 12:34:23 PM	Disconnected	3	wli	N709	C:\Program Files (x86)\Orcina\OrcaFlex\9.7\OrcaFlex64.exe	OrcaFlex	9.7d	US1WDBPWRHS1	US1WDBPWRHS1.tp.tpnet.intra	10.113.106.181	Network
    3635794431908	3/18/2015 12:34:32 PM	3/18/2015 12:35:36 PM	Disconnected	64	wli	N709	C:\Program Files (x86)\Orcina\OrcaFlex\9.7\OrcaFlex64.exe	OrcaFlex	9.7d	US1WDBPWRHS1	US1WDBPWRHS1.tp.tpnet.intra	10.113.106.181	Network
    3635794431909	3/18/2015 12:36:50 PM	3/18/2015 12:43:43 PM	Disconnected	412	wli	N709	C:\Program Files\Microsoft Office 15\Root\Office15\EXCEL.EXE	OrcaFlex	9.7d	US1WDBPWRHS1	US1WDBPWRHS1.tp.tpnet.intra	10.113.106.181	Netwo
    3635794431911	3/18/2015 12:43:02 PM	3/18/2015 12:46:46 PM	Disconnected	224	ymu	N709	C:\Program Files (x86)\Orcina\OrcaFlex\9.6\OrcaFlex64.exe	OrcaFlex	9.6c	US1WD902CTW1	US1WD902CTW1.tp.tpnet.intra	10.3.205.34	Network
    3635794431915	3/18/2015 12:53:43 PM	3/18/2015 12:54:49 PM	Disconnected	66	wli	N709	C:\Program Files\Microsoft Office 15\Root\Office15\EXCEL.EXE	OrcaFlex	9.7d	US1WDBPWRHS1	US1WDBPWRHS1.tp.tpnet.intra	10.113.106.181	Netwo
    3635794431914	3/18/2015 12:53:13 PM	3/18/2015 12:56:22 PM	Disconnected	188	ccox	N1128	C:\Program Files (x86)\Orcina\OrcaFlex\9.7\OrcaFlex64.exe	OrcaFlex	9.7d	US1WDBJ8Q8Z1	US1WDBJ8Q8Z1.tp.tpnet.intra	10.113.106.194	Local
    3635794431916	3/18/2015 12:57:11 PM	3/18/2015 12:58:08 PM	Disconnected	56	wli	N709	C:\Program Files (x86)\Orcina\OrcaFlex\9.7\OrcaFlex64.exe	OrcaFlex	9.7d	US1WDBPWRHS1	US1WDBPWRHS1.tp.tpnet.intra	10.113.106.181	Network

  5. Update the configuration file, run the command:

    Command Syntax
    openit_confbuilder --client

    Make sure no errors are encountered.

Advanced Configuration

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

Object NameAccepted ValueDescription
source.dirDirName (e.g., C:\ProgramData\OrcaFlex)Location of the OrcaFlex log files.
source.patternString (i.e., OLM Licence Use*.log)The glob pattern identifying source files in the source directory.
source.seenString (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.cmplinesInteger (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.dirDirName (i,e., ${OpeniT.directories.temp}/LogFileCollector)This is the location of the directory containing the collected log data.
target.moduleString (i.e., license)The target type of module (in general).
target.datatypeString (i.e., orcaflex)The specific type of target data.
target.intervalTimespan (e.g., P30S, P5M, P1D)The span of time between collector runs
target.rotation-sizeInteger (e.g., 6, 10, 20)The log file rotates if it goes beyond the number (in mb) defined.
target.rotation-globString (e.g., *)The glob pattern to match before the log file rotates.
OrcaFlex Log File Collection Configuration

Activating Log Data Collection​

These are the required steps to activate collection of OrcaFlex 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 OrcaFlex log data, run the command:

    Command Syntax
    openit_oconfinit -u "collect_license_orcaflex-logs.root.scheduler.jobs.collect_orcaflex_licenselogs.general.active=true"
Advanced Configuration

The collection runs every midnight by default. To configure the intervals, locate the instances attribute under collect_orcaflex_licenselogs, preprocess_orcaflex_licenselogs-records, or transfer_orcaflex_licenselogs in the same file and configure the attributes.

Refer to the OrcaFlex Log Job Scheduler Instances Configuration table to learn the attributes used to configure OrcaFlex data collection and transfer.

Attribute NameAccepted ValueDescription
max-instancesUint (e.g., 5, 8, 9)The number of instances allowed to run the at the same time.
max-handlingString (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-timeoutTimespan (e.g., P30S, P5M, P1H)The maximum waiting time before terminating a running instance.
quarantineTimespan (e.g., P30S, P5M, P1H)The waiting time before starting a new instance after a previous one.
OrcaFlex Log Job Scheduler Instances Configuration

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

Next Steps?​

Renaming Vendor License
Renaming Features
Create and Add Report
License Monitor