The Report Log

The Report log must be set up to obtain server statistics. The Report log can have any name and can be located anywhere on the server machine; however, its folder must be created ahead of time. The type of log can be set to detailed, standard (std), or small; if no type is specified, a standard log is created. Standard type lists typical client license information. Small type includes only minimal license connection information, while the detailed type includes the client's OS, the date, and other details. To use the log with the Log File Converter for further data analysis, select std or detailed.

Report Log Setup

To set up the Report log:

  1. Create a folder for the Report log on the server machine, perhaps within the Vectorworks Site Protection folder. The folder must already exist for it to be specified by the command.

    2. If no file path is specified for the Report log, the file is created in the RLM installation folder.

  2. Click Status from the main Server Administration screen. From there, click vektorwrx from the OPTIONS column.

    3. The Edit ISV Options window opens.

    SiteProtection00015.png 

  3. Enter the following command into the ISV Options field.

    4. Command
    Description
    Syntax

    REPORTLOG

    Sets up the location, file name, format, and type of Report log (small, std, or detailed). The file path can be specified as a relative or absolute path. If using a relative path, the current folder is the Vectorworks Site Protection Server installation folder.

    REPORTLOG file_path_file_name output_type

    Windows example: REPORTLOG Log\Reportlog.txt detailed 

    Mac example: REPORTLOG Log/Reportlog.txt std 

  4. Click Update Options.

  5. A message states that “vektorwrx options file written.” Click Back to Status to return to the Status screen.

  6. Click Reread/Restart Servers to restart the ISV server. The log file will be created in the specified location when the ISV server restarts.

If the RLM server is restarted, the existing log file is overwritten. Create a backup of the log file before restarting the RLM server.

You can control whether license check ins, check outs, and denials are recorded in the Report log, by setting an option in the RLM options. See Controlling RLM Options.

Switching to a Different Report Log File

You can switch from using the current Report log and specify a different log file. A Report log must already exist to be able to switch to a new one.

  1. Click Switch Reportlog from the main Server Administration screen.

    2. The Switch Reportlog For License Server screen opens.

    SiteProtection00016.png 

  2. Select vektorwrx from the ISV list.

  3. In File, enter the file path where the log is located, including the filename.

  4. Click SWITCH REPORT LOG.

The Report log switches to the other file.

Creating a New Report Log

You can save the current Report log file with a different name, and continue using the original file for logging. This is convenient for creating backup files.

The ROTATE command automatically creates backup log files. Depending on the operating circumstances, the log files can become very large; backing up regularly prevents the files from becoming too big. For more information, see Specifying Server Options.

  1. Click New Reportlog from the main Server Administration screen.

    2. The New Reportlog For License Server screen opens.

    SiteProtection00017.png 

  2. Select vektorwrx from the ISV list.

  3. In File, enter the file path where the backup log should be located, including the filename.

  4. Click MOVE DATA TO NEW LOGFILE.

The contents of the current Report log file are saved to the specified backup log. Logging continues in the current Report log file.

Using the Report log Information for Statistical Analysis

The Report log is created as a text file, but it can be converted into Excel® format by using a special file converter utility, the Log File Converter. The Log File Converter is located in the Vectorworks Site Protection Server folder.

After a log file has been converted, you can verify the number of licenses for each product that is running within the allotted time period or perform other calculations on the server statistics. This information is useful baseline data for an administrator.

To convert the Report log:

  1. Navigate to the Vectorworks Site Protection Server folder.

  2. Double-click on the Log File Converter.app (Mac) or LogFileConverter.exe (Windows).

    3. The Log File Converter utility opens.

  3. Click Select log file to open the RLM log file dialog box. Specify the Report log file.

  4. Click Save excel file to open the Excel file dialog box. Specify the location and the filename to use for saving the converted file.

  5. Click Convert to convert the text file into a file that can be used in a typical spreadsheet program like Excel.

  6. When the conversion is complete, click the Quit button to close the Log File Converter.

The resulting Excel file can be opened and used for graphing or any type of analysis.

convertSheet.png 

The converted spreadsheet file contains the following information:

Parameter
Description

Date

The date that the statistics were generated

Version

The Vectorworks version

Product

The name of the Vectorworks module

Seats

The number of licenses available per module

Time intervals

Shows the number of licenses used during each time period.When a client launches, the number of licenses in use increases, and when a client shuts down, the number decreases. If a module is used for several hours in a row, the count stays at the increased number while the module is being used.

The count shows the number of launches for each module. If a client restarts and shuts down repeatedly during the time period, the number in use increases, up to the number of available licenses.

If a license was renewed in the middle of the day, and a specific module was unusable, the unusable time period is indicated by an asterisk (*). The next day, it will not appear in the statistics.

If the number of licenses changes in the middle of the day, the new value will be reflected at the end of the day (when the date changes).

Borrow

Indicates the number of borrowed licenses at the end of the day (when the date changes)

The Visual C++ 2012 Redistributable Package is necessary to run this utility. This is installed by the Vectorworks Site Protection Server. If the dll is necessary for running the converter on a different machine, then you must install it separately. The Redistributable Package is available at microsoft.com/en-us/download/details.aspx?id=30679 

~~~~~~~~~~~~~~~~~~~~~~~~~

Server Operating Status Logs

 

vectorworks.net