Skip to main content
Version: 10.2

Enterprise Architect License Manager

Introduction​

Open iT supports Enterprise Architect 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 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:

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 Enterprise Architect 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-ea.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 Enterprise Architect log files, run the command:

    Command Syntax
    openit_confinit -c "logfilecollector-ea.logfilecollector.source.dir=<ea_log_dir>"

    where <ea_log_dir> is the location of the Enterprise Architect log files.

    Example
    openit_confinit -c "logfilecollector-ea.logfilecollector.source.dir=C:\Program Files\Sparx Systems\Keystore\Service\Logs"
    Sample Log File Content
    2012-01-15 01:09:51 [INFO]: ###################################################
    2012-01-15 01:09:51 [INFO]: #        Sparx Systems Keystore Service           #
    2012-01-15 01:09:51 [INFO]: ###################################################
    2012-01-15 01:09:51 [INFO]: # Protocol Version: 1.0                                                    #
    2012-01-15 01:09:51 [INFO]: # Start Time: 2012-01-15 01:09:51                                          #
    2012-01-15 01:09:51 [INFO]: # Operating System: Windows 5.02 Service Pack 2                            #
    2012-01-15 01:09:51 [INFO]: #                                                                          #
    2012-01-15 01:09:51 [INFO]: # Service Path: C:\Program Files\Sparx Systems\Keystore\Service            #
    2012-01-15 01:09:51 [INFO]: # Logging Dir: C:\Program Files\Sparx Systems\Keystore\Service\Logs        #
    2012-01-15 01:09:51 [INFO]: ###################################################
    2012-01-15 01:09:51 [INFO]: ** Starting up!
    2012-01-15 01:09:51 [INFO]: ** Now listening for connections
    2012-01-16 07:51:20 [INFO]: CHECKIN SUCCESS, z99ca8a, Sparx Systems Enterprise Architect build 864, PKL3-OZSA-4JKT-F7GY, EA Systems Engineering Edition
    2012-01-16 09:36:18 [INFO]: CHECKOUT SUCCESS, Z99B79P, Sparx Systems Enterprise Architect build 863, PKL3-OZSA-4JKT-F7GY, EA Systems Engineering Edition, Y88724328\Z99B79P, 2012-01-17 09:36:18
    2012-01-16 09:38:18 [INFO]: CHECKIN SUCCESS, Z99B79P, Sparx Systems Enterprise Architect build 863, PKL3-OZSA-4JKT-F7GY, EA Systems Engineering Edition
    2012-01-16 10:30:53 [INFO]: CHECKOUT SUCCESS, Z99M6AS, Sparx Systems Enterprise Architect build 864, H6S2-HYGL-PYLE-G29U, EA Systems Engineering Edition, Y11717206\Z99M6AS, 2012-01-17 10:30:53
    2012-01-16 10:17:27 [INFO]: [AUDIT] Start
    2012-01-16 10:17:27 [REPORT]: [AUDIT] EA Corporate Edition                               | Available:   2 | Expired:   0 | Checked Out:   1 | Checkouts:   2 | Reasserts:   0 | Failures:   0 |
    2012-01-16 10:17:27 [REPORT]: [AUDIT] MDG Technology for SysML                           | Available:   3 | Expired:   0 | Checked Out:   0 | Checkouts:   0 | Reasserts:   0 | Failures:   0 |
    2012-01-16 10:17:27 [REPORT]: [AUDIT] EA Systems Engineering Edition                     | Available:   5 | Expired:   0 | Checked Out:   0 | Checkouts:   0 | Reasserts:   0 | Failures:   0 |
    2012-01-16 10:17:27 [INFO]: [AUDIT] End
    2011-01-12 09:21:51 [INFO]: CHECKOUT SUCCESS, Z99OATY, Sparx Systems Enterprise Architect build 910, 3DH2-MBHE-SI3M-5CW1, EA Corporate Edition, Y88727278\Z99OATY, 2012-01-16 09:21:51
    2012-01-16 10:32:53 [INFO]: CHECKIN SUCCESS, Z99M6AS, Sparx Systems Enterprise Architect build 864, H6S2-HYGL-PYLE-G29U, EA Systems Engineering Edition
    2012-01-16 07:49:20 [INFO]: CHECKOUT SUCCESS, z99ca8a, Sparx Systems Enterprise Architect build 864, PKL3-OZSA-4JKT-F7GY, EA Systems Engineering Edition, Y88725108\z99ca8a, 2012-01-17 07:40:32
    2011-01-12 09:23:51 [INFO]: CHECKIN SUCCESS, Z99OATY, Sparx Systems Enterprise Architect build 910, 3DH2-MBHE-SI3M-5CW1, EA Corporate Edition

  5. Update the configuration file, run the command:

    Command Syntax
    openit_confbuilder --client

    Make sure no errors are encountered.

Advanced Configuration

Refer to the Enterprise Architect Log File Collection Configuration table to learn more about Enterprise Architect configuration in logfilecollector-ea.xml.

Object NameAccepted ValueDescription
source.dirDirName (e.g., C:\Program Files (x86)\Sparx Systems\Keystore\Service\Logs)Location of the Enterprise Architect log files.
source.patternString (i.e., *.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., ea)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.
Enterprise Architect Log File Collection Configuration

Activating Log Data Collection​

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

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

The collection runs every 5 minutes by default, which triggers the data collection process. To configure the intervals, locate the instances attribute under collect_ea_licenselogs, preprocess_ea_licenselogs-records, or transfer_ea_licenselogs in the same file and configure the attributes.

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

Attribute NameAccepted ValueDescription
max-instancesUint (e.g., 5, 8, 9)The number of instances allowed to run 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.
Enterprise Architect 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-ea.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?​

Vendor License Renaming
Feature Renaming
Create and Add Report
License Monitor