VLA - PPU Usage and Billing Statement

Report Name: Viewer License Agreement - Billing Report (example 1, example 2)

File Name: Earthsoft.Reports.Library.73174.dll

Report Dependencies: N/A

Software: EQuIS Professional and EQuIS Enterprise

Source: EarthSoft Community Center Downloads Dashboard under Products > Additional Resources > v7.0 for each organization's EarthSoft Primary Point of Contact (POC)

Language: English

Output Type: Excel1

Description: Generate usage information for invoicing purposes. This report is only required for usage-based Viewer License Agreements (VLA). This report documents the monthly number of concurrent users that are identified as VLA users.

Installation Instructions: Download the VLA - PPU Usage and Billing Statement report from the EarthSoft Community Center. Starting in 7.24.3, the report is packaged together with other standard-by-request reports, i.e., "EQuIS_By_Request_Reports_All_7.24.3.zip".

Unblock the *.zip file, and extract the DLL to the EQuIS Professional installation folder. For standard installations, this directory is C:\Program Files\EarthSoft\EQuIS; for per-user installations, this directory is %localappdata%\Programs\EarthSoft\EQuIS by default. After the user reopens Professional or refreshes the Open window, the report will appear in the Reports list.

Note: Prior to EQuIS 7.23.3, the report ran using 3-month intervals, rather than a year, and may need to be run multiple times to cover the expected reporting period. If the database does not contain the ST_USAGE table, the report will use data from ST_RECENT instead.

Overview:

To flag an EQuIS Enterprise EZView user as participating in a VLA, set the value of ST_USER.CLIENT_CODE to some value other than DBNull. Users with ST_USER.CLIENT_CODE equal to DBNull will not be counted in VLA usage accounting. VLA users that do not log in to EQuIS during a given month are not charged for that month. Note that if a VLA user is "impersonated" using the impersonate feature, the login usage will show up on the VLA Usage Report and would be chargeable.

The ST_USER.CLIENT_CODE field is used to identify external (pay-per-user) users. If CLIENT_CODE is null, the user is considered an internal user and is excluded from the report. If CLIENT_CODE is non-null, the user is considered an external user and is included in the report. Before running this report, you must identify which users are external users (as defined by the VLA). Add a record to ST_CLIENT with a CLIENT_CODE value of your choosing, then use that CLIENT_CODE value in the ST_USER.CLIENT_CODE field for the appropriate users. If desired, you may have different CLIENT_CODE values; the report will include all users where CLIENT_CODE is not null.

Input Parameters

Reporting Date	Select a date.
Billing Months Prior to Reporting Date	Enter an integer between 1 and 12. Defaults to the last 12 months prior to the reporting date. For example, when Reporting Date is July 2023, the billing period is July 2022 to June 2023 for the default last 12 months.
Hosting Environment	Single Selection Client Hosted EQuIS Online
Client Name	Text. Enter the name of the VLA client. This value appears on the usage report and is intended for use by the EarthSoft client submitting this report.

1Excel report output requires a valid license of Microsoft Excel to view the output.