SmartPlant License Manager

Reporting User's Guide

September 2016

Copyright
Copyright 1991-2016 Intergraph Corporation. All Rights Reserved. Intergraph is part of Hexagon.
Including software, file formats, and audiovisual displays; may be used pursuant to applicable software license agreement; contains
confidential and proprietary information of Intergraph and/or third parties which is protected by copyright law, trade secret law, and
international treaty, and may not be provided or otherwise made available without proper authorization from Intergraph Corporation.

U.S. Government Restricted Rights Legend

Use, duplication, or disclosure by the government is subject to restrictions as set forth below. For civilian agencies: This was
developed at private expense and is "restricted computer software" submitted with restricted rights in accordance with
subparagraphs (a) through (d) of the Commercial Computer Software - Restricted Rights clause at 52.227-19 of the Federal
Acquisition Regulations ("FAR") and its successors, and is unpublished and all rights are reserved under the copyright laws of the
United States. For units of the Department of Defense ("DoD"): This is "commercial computer software" as defined at DFARS
252.227-7014 and the rights of the Government are as specified at DFARS 227.7202-3.
Unpublished - rights reserved under the copyright laws of the United States.
Intergraph Corporation
305 Intergraph Way
Madison, AL 35758

Documentation
Documentation shall mean, whether in electronic or printed form, User's Guides, Installation Guides, Reference Guides,
Administrator's Guides, Customization Guides, Programmer's Guides, Configuration Guides and Help Guides delivered with a
particular software product.

Other Documentation
Other Documentation shall mean, whether in electronic or printed form and delivered with software or on Intergraph Smart Support,
SharePoint, or box.net, any documentation related to work processes, workflows, and best practices that is provided by Intergraph
as guidance for using a software product.

Terms of Use
a.

Use of a software product and Documentation is subject to the End User License Agreement ("EULA") delivered with the
software product unless the Licensee has a valid signed license for this software product with Intergraph Corporation. If the
Licensee has a valid signed license for this software product with Intergraph Corporation, the valid signed license shall take
precedence and govern the use of this software product and Documentation. Subject to the terms contained within the
applicable license agreement, Intergraph Corporation gives Licensee permission to print a reasonable number of copies of the
Documentation as defined in the applicable license agreement and delivered with the software product for Licensee's internal,
non-commercial use. The Documentation may not be printed for resale or redistribution.

b.

For use of Documentation or Other Documentation where end user does not receive a EULA or does not have a valid license
agreement with Intergraph, Intergraph grants the Licensee a non-exclusive license to use the Documentation or Other
Documentation for Licensees internal non-commercial use. Intergraph Corporation gives Licensee permission to print a
reasonable number of copies of Other Documentation for Licensees internal, non-commercial use. The Other Documentation
may not be printed for resale or redistribution. This license contained in this subsection b) may be terminated at any time and
for any reason by Intergraph Corporation by giving written notice to Licensee.

Disclaimer of Warranties
Except for any express warranties as may be stated in the EULA or separate license or separate terms and conditions, Intergraph
Corporation disclaims any and all express or implied warranties including, but not limited to the implied warranties of merchantability
and fitness for a particular purpose and nothing stated in, or implied by, this document or its contents shall be considered or deemed
a modification or amendment of such disclaimer. Intergraph believes the information in this publication is accurate as of its
publication date.
The information and the software discussed in this document are subject to change without notice and are subject to applicable
technical product descriptions. Intergraph Corporation is not responsible for any error that may appear in this document.
The software, Documentation and Other Documentation discussed in this document are furnished under a license and may be used
or copied only in accordance with the terms of this license. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL
EVALUATION AS TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.
Intergraph is not responsible for the accuracy of delivered data including, but not limited to, catalog, reference and symbol data.
Users should verify for themselves that the data is accurate and suitable for their project work.

SmartPlant License Manager Reporting User's Guide

Limitation of Damages
IN NO EVENT WILL INTERGRAPH CORPORATION BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL INCIDENTAL,
SPECIAL, OR PUNITIVE DAMAGES, INCLUDING BUT NOT LIMITED TO, LOSS OF USE OR PRODUCTION, LOSS OF
REVENUE OR PROFIT, LOSS OF DATA, OR CLAIMS OF THIRD PARTIES, EVEN IF INTERGRAPH CORPORATION HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
UNDER NO CIRCUMSTANCES SHALL INTERGRAPH CORPORATIONS LIABILITY EXCEED THE AMOUNT THAT
INTERGRAPH CORPORATION HAS BEEN PAID BY LICENSEE UNDER THIS AGREEMENT AT THE TIME THE CLAIM IS
MADE. EXCEPT WHERE PROHIBITED BY APPLICABLE LAW, NO CLAIM, REGARDLESS OF FORM, ARISING OUT OF OR IN
CONNECTION WITH THE SUBJECT MATTER OF THIS DOCUMENT MAY BE BROUGHT BY LICENSEE MORE THAN TWO (2)
YEARS AFTER THE EVENT GIVING RISE TO THE CAUSE OF ACTION HAS OCCURRED.
IF UNDER THE LAW RULED APPLICABLE ANY PART OF THIS SECTION IS INVALID, THEN INTERGRAPH LIMITS ITS
LIABILITY TO THE MAXIMUM EXTENT ALLOWED BY SAID LAW.

Export Controls
Intergraph Corporations software products and any third-party Software Products obtained from Intergraph Corporation, its
subsidiaries, or distributors (including any Documentation, Other Documentation or technical data related to these products) are
subject to the export control laws and regulations of the United States. Diversion contrary to U.S. law is prohibited. These Software
Products, and the direct product thereof, must not be exported or re-exported, directly or indirectly (including via remote access)
under the following circumstances:
a.

To Cuba, Iran, North Korea, Sudan, or Syria, or any national of these countries.

b.

To any person or entity listed on any U.S. government denial list, including but not limited to, the U.S. Department of Commerce
Denied Persons, Entities, and Unverified Lists, http://www.bis.doc.gov/complianceandenforcement/liststocheck.htm, the U.S.
Department of Treasury Specially Designated Nationals List, http://www.treas.gov/offices/enforcement/ofac/, and the U.S.
Department of State Debarred List, http://www.pmddtc.state.gov/compliance/debar.html.

c.

To any entity when Licensee knows, or has reason to know, the end use of the Software Product is related to the design,
development, production, or use of missiles, chemical, biological, or nuclear weapons, or other un-safeguarded or sensitive
nuclear uses.

d.

To any entity when Licensee knows, or has reason to know, that an illegal reshipment will take place.

e.

Any questions regarding export or re-export of these Software Products should be addressed to Intergraph Corporations Export
Compliance Department, Huntsville, Alabama 35894, USA.

Trademarks
Intergraph, the Intergraph logo, Intergraph Smart, PDS, SmartPlant, SmartMarine, FrameWorks, I-Sketch, IntelliShip, ISOGEN,
SmartSketch, SPOOLGEN, SupportManager, SupportModeler, Sapphire, and FreeView are trademarks or registered trademarks of
Intergraph Corporation or its subsidiaries in the United States and other countries. Hexagon and the Hexagon logo are registered
trademarks of Hexagon AB or its subsidiaries. Microsoft and Windows are registered trademarks of Microsoft Corporation.
MicroStation is a registered trademark of Bentley Systems, Inc. Other brands and product names are trademarks of their respective
owners.

SmartPlant License Manager Reporting User's Guide

Contents
Preface .......................................................................................................................................................... 5
SmartPlant License Manager Reporting ................................................................................................... 6
Quick Start .............................................................................................................................................. 6
Supported Browsers and Software Prerequisites ................................................................................... 6
Generating Reports from Licensing Data ................................................................................................. 7
Install Collect Journal Files utility ............................................................................................................ 8
Collect journal files .................................................................................................................................. 8
Upload journal files ................................................................................................................................. 9
Request report ........................................................................................................................................ 9
View report ............................................................................................................................................ 10
Explanation of Columns in the EntryPairs Table ................................................................................... 11
Comparison of Features in Collect Journal Files Utility and eLicense ............................................... 14
Index ........................................................................................................................................................... 15

SmartPlant License Manager Reporting User's Guide

Preface
This document describes the SmartPlant License Manager journal file reporting process. The
document is intended for administrators who are collecting journal files, uploading the files to
Intergraph, and viewing reports based on the journal data.
Intergraph gives its customers permission to print as many copies of this document as they need
for their non-commercial use. Do not print the document for resale or redistribution.

Customer Support
For the latest support information, use a World Wide Web browser to connect to Intergraph
Support (http://support.intergraph.com). Also, you can submit any documentation comments or
suggestions you might have on the Intergraph support site.

SmartPlant License Manager Reporting User's Guide

SECTION 1

SmartPlant License Manager Reporting

To view your company's software license usage, you can generate reports based on journal files
from a SmartPlant License Manager license machine.

Quick Start
Use these links to get started immediately with SmartPlant License Manager reporting.
Intergraph Smart Support (https://smartsupport.intergraph.com) - Download the latest Collect
Journal Files utility
eLicense (https://ppmapps.intergraph.com/elicensev3) - Visit this web site to request reports and
view the status of requests

See Also
Comparison of Features in Collect Journal Files Utility and eLicense (on page 14)

Supported Browsers and Software Prerequisites

Before beginning the licensing reporting process, verify that your computer meets the following
software requirements.

Supported Browsers
The following browsers are supported for uploading journal files and downloading reports.

Microsoft Internet Explorer 11

Google Chrome

Mozilla Firefox

Software Prerequisites
The following prerequisite applies to the Collect Journal Files utility.

Microsoft .NET Framework 4.5

https://www.microsoft.com/en-us/download/details.aspx?id=30653

The following software is needed to view and manipulate the report output from eLicense.

Microsoft Excel 2013 (32-bit or 64-bit) - required to view the reports

Microsoft Access 2007, 2010, or 2013 (32-bit or 64-bit) - required to manipulate the raw data
output

SmartPlant License Manager Reporting User's Guide

SECTION 2

Generating Reports from Licensing Data

Generating reports from your license data involves several tasks, which include collecting
license journal files, uploading the files to the eLicense web site, and receiving the license
report.
Journal files contain all of the license transaction data. A journal file is created when a license
key is loaded on a license machine. Each time a license key is upgraded, a new journal file is
created, and the previous journal file is archived on the license machine.
The licensing reporting process supports journal files from SmartPlant License
Manager 2008 (version 10) and later.
The following diagram illustrates the process of generating license reports.

What do you want to do?

Collect journal files (on page 8)

Upload journal files (on page 9)

Request report (on page 9)

View report (on page 10)

SmartPlant License Manager Reporting User's Guide

Generating Reports from Licensing Data

Install Collect Journal Files utility

1. Download the latest Collect Journal Files utility from Intergraph Smart Support
(https://smartsupport.intergraph.com).
2. Unzip (extract) the contents into a folder on the license machine.
Intergraph recommends that you create a new folder named CollectJournalFiles in the
default installation path for Windows, like this:
[drive]:\Program Files (x86)\CollectJournalFiles.
To uninstall this utility, delete the CollectJournalFiles folder and its contents.

Collect journal files

There are two ways to collect journal files from your license machine.
The first way is to use the Collect Journal Files utility (CollectJournalFiles.exe), which is
available from Intergraph Smart Support. This utility locates the journal files on the license
machine for you (these files are, by default, hidden system files) and copies them to an output
directory that you specify. You can use Windows Task Scheduler to run this utility on a recurring
basis.
The second way is by collecting the files manually using copy and paste.

Collect journal files using the utility

Before beginning this procedure, install the latest Collect Journal Files utility (on page
8).
1. On the license machine, open a command prompt using the Run as administrator option.
2. In the command prompt window, navigate to the folder containing the Collect Journal Files
utility.
3. Type CollectJournalFiles.exe followed by the appropriate arguments and
parameters. For more information, use -h to view the help.
This utility can collect and upload the journal files in one step, if needed.

Collect journal files manually

1. On the license machine, browse to the journal subfolder in the SmartPlant License Manager
folder (if the defaults were accepted during installation, the journal files will be located in
C:\Win32app\ingr\SPLM\journal).
If you do not see any journal files in this location, check to verify that hidden files
are displayed. In Windows Explorer, click Tools > Folder options, click the View tab, and
select Show hidden files, folders, and drives. Also, clear the Hide protected operating
system files box.
2. Copy the files in the journal folder.
3. Paste the journal files into another folder.
If you will be collecting journal files from multiple license machines, create a shared
folder and copy all journal files into it.

SmartPlant License Manager Reporting User's Guide

Generating Reports from Licensing Data

Upload journal files

There are two ways to upload journal files to eLicense.
The first way is to use the Collect Journal Files utility (CollectJournalFiles.exe). In addition to
collecting journal files, it can also upload the files to eLicense. You can use Windows Task
Scheduler to run this process on a recurring basis.
The second way is by going to the eLicense web site and uploading the files manually.

Upload journal files using the utility

Before beginning this procedure, install the latest Collect Journal Files utility (on page
8).
1. On the license machine, open a command prompt using the Run as administrator option.
2. In the command prompt window, navigate to the folder containing the Collect Journal Files
utility.
3. Type CollectJournalFiles.exe followed by the appropriate arguments and
parameters. For more information, use -h to view the help.
When the upload operation is complete, you will receive an email notification.

Upload journal files manually

1. On eLicense, click SPLM Reporting > Upload Journal File > Upload Only.
2. Browse to specify a journal file.
If you want to upload more than one journal file, zip the files and then browse for the
zip file.
When the upload operation is complete, you will receive an email notification.
You can upload files and request a report at the same time by clicking Upload
Journal File > Upload and Request Report. The report produced in this process includes all of
the records uploaded to date that fall within the specified date range.

Request report
After at least one journal file has been uploaded, you can request a report.

On eLicense, click SPLM Reporting > Request Report.

When the report operation is complete, you will receive an email notification.

You can also request a report as part of the upload process on eLicense. For more
information, see Upload journal files (on page 9).

You can see all previous upload and report requests by going to the View Requests page
on eLicense.

SmartPlant License Manager Reporting User's Guide

Generating Reports from Licensing Data

View report
Once a report has been generated, you will receive an email message from eLicense notifying
you that your report is ready.
The delivered report is intended to provide you with an overview of your
SmartPlant License Manager usage. These results are not certified to be used for billing
purposes. Please contact your Intergraph sales representative to obtain reports for billing
purposes.
1. Click the link in the email message and log in to eLicense.
2. Download the zip file to your local computer.
3. Unzip the file and place the contents in a single folder.
4. To view the delivered results, open the Excel file.
5. Accept the prompt to enable content.
6. On the Data tab, click Refresh All.
During the refresh operation, you will see several prompts about the Microsoft Access file.
Accept all prompts to connect to the local Access file.
Once the link to the Access file is established, you can browse and analyze the journal data
using the pivot tables and pivot charts provided in the Excel file.
You can also create your own views of the data. In this case, open the Access file.

SmartPlant License Manager Reporting User's Guide

10

SECTION 3

Explanation of Columns in the

EntryPairs Table
When customizing views in the Microsoft Access file, it is helpful to know more about the
information in each column in the EntryPairs table.
Column

Description

Customer

The customer group specified in the upload operation on

eLicense.

ServerIP

The IP address of the SmartPlant License Manager server

that recorded the journal file.

ProductTag

The product tag of the license that was obtained.

ClientIp

The IP address of the workstation that obtained the license.

Client

The name of the workstation that obtained the license.

UserID

The user name of the person who obtained the license.

ProcessID

The process identifier on the workstation that obtained the

license.

IsBatch

Whether or not the process that obtained the license was a

batch process.

IsDaily

Whether or not the license was a daily license.

Domain

The domain specified by settings on the client.

Project

The project specified by the client through environment

variables or the licensed application.

Country

The country in which the client workstation was located.

Country is only available when you provide
location information for each client workstation/user
combination in the journal file before the file is uploaded
and processed. Customers must make special
arrangements with Intergraph to use locations.

SmartPlant License Manager Reporting User's Guide

11

Explanation of Columns in the EntryPairs Table

Column

Description

City

The city in which the client workstation was located.

City is only available when you provide location
information for each client workstation/user combination in
the journal file before the file is uploaded and processed.
Customers must make special arrangements with
Intergraph to use locations.

Get_HeaderID

A unique ID created for the journal file when the file was
uploaded on eLicense.

Get_EntryID

A unique ID created for the GET journal record when the

journal file was uploaded. This ID is negative if a GET
could not be found to pair with the RETURN.

Get_SeatIndex

The license index number that was sent to the client by the
GET operation.

Get_OperationCode

The code for the operation when the license was obtained.

1 = Get

31 = Check-out

41 = Counted License

Get_Time

The date and time of the GET operation per the Smart
License Manager server, in CST.

Return_HeaderID

A unique ID created for the journal file when the file was
uploaded on eLicense.

Return_EntryID

A unique ID created for the RETURN journal record when

the journal file was uploaded. This ID is negative if a
RETURN could not be found to pair with the GET.

Return_SeatIndex

The license index number that was used by the client to

return the license.

Return_OperationCode

The code for the operation when the license was returned.

Return_Time

2 = Return

12 = Scavenge

32 = Check-in

The date and time of the RETURN operation per the

SmartPlant License Manager server, in CST.

SmartPlant License Manager Reporting User's Guide

12

Explanation of Columns in the EntryPairs Table

Column

Description

ProductConcurrent

The number of licenses out for the same product across

servers for the customer group at the time of the GET
operation.

ServerConcurrent

The number of licenses out for the same product on the

SmartPlant License Manager server at the time of the GET
operation.

CountryConcurrent

The number of licenses out for the same product in the

same country across servers for the customer group at the
time of the GET operation.
Country is only available when you provide
location information for each client workstation/user
combination in the journal file before the file is uploaded
and processed. Customers must make special
arrangements with Intergraph to use locations.

CityConcurrent

The number of licenses out for the same product in the

same country/city across servers for the customer group at
the time of the GET operation.
City is only available when you provide location
information for each client workstation/user combination in
the journal file before the file is uploaded and processed.
Customers must make special arrangements with
Intergraph to use locations.

UserConcurrent

The number of licenses out for the same product for the
same client workstation/user at the time of the GET
operation.

UserConcurrentBatch

The number of batch licenses out for the same product for
the same client workstation/user at the time of the GET
operation.

UserConcurrentInteractive

The number of interactive (non-batch) licenses out for the

same product for the same client workstation/user at the
time of the GET operation.

SmartPlant License Manager Reporting User's Guide

13

APPENDIX A

Comparison of Features in Collect

Journal Files Utility and eLicense
The following table shows the features available in the Collect Journal Files utility and the
eLicense web site.
Feature

Collect Journal Files

eLicense

Collect journal files

Yes

No

Upload journal files

Yes

Yes

Upload files and request

report

No

Yes

Request report

No

Yes

View status

No

Yes

See Also
Quick Start (on page 6)

SmartPlant License Manager Reporting User's Guide

14

Index
C
Collect journal files 8
Comparison of Features in Collect Journal
Files Utility and eLicense 14

E
Explanation of Columns in the EntryPairs
Table 11

G
Generating Reports from Licensing Data 7

I
Install Collect Journal Files utility 8

P
Preface 5

Q
Quick Start 6

R
Request report 9

S
SmartPlant License Manager Reporting 6
Supported Browsers and Software
Prerequisites 6

U
Upload journal files 9

V
View report 10

SmartPlant License Manager Reporting User's Guide

15