Usage Reporting Guide

Prev Next

The OneSpan Authentication Server Storage Utility (dpdbreport) is a standalone binary executable to generate usage reports. It is available from OneSpan on request and can safely be deployed and run on existing OneSpan Authentication Server installations (in the binary subfolder).

The dpdbreport runreporting command connects to the OAS database, executes predefined SQL queries against the audit and user tables, and generates a signed plain-text report. It is designed for unattended, scheduled execution (e.g., via cron) so that monthly usage data can be collected without human interaction.

Generated reports

The tool runs four pre-defined database queries:

  1. Number of users with at least 1 transaction per month. Counts distinct users who had authentication or signature events in each closed month.

  2. Number of authentication and signature validation transactions per month. Total authentication/signature event count per closed month.

  3. Report on existing users. Current total number of users, administrator accounts, and the number of disabled user accounts.

  4. Report on users with authenticators. Number of users with at least one authenticator assigned.

Syntax

dpdbreport runreporting [OPTION]...

Command-line options

Option

Parameter

Description

-c, -config

config_file

Optional. Read the database connection parameters from the OneSpan Authentication Server configuration file, specified by config_file. In this case, -d, -p, and -u are not required.

-d, -dsn

dsn

Required. ODBC data source name (DSN), e.g., "IAS embedded database". Not required if you use -c.

-h, -help

Show help and usage information.

-l, --log

log_file

Write output to log_file.

-m, -months

month

Analysis time window in months for time-based reports (Default: 3).

-p, -password

dbpassword

Optional. Password of the database administrator. Not required if you use -c. Can be omitted if the database administrator account has a blank password.

-q, -quiet

Quiet mode. Suppress progress output to the console.

-u, -user

dbusername

Optional. User name of a database administrator (if required). Not required if you use -c.

-v, -verbose

Print verbose output. Can be specified twice to be more verbose.

Instead of providing -d, -u, and -p explicitly, you can use -c to read the connection parameters from an existing configuration file.

Exit codes

Exit code

Description

0

The command completed successfully.

3

The specified parameters are invalid.

5

The database authentication failed.

Examples

Explicit credentials

The following example runs the command with explicit database credentials:

dpdbreport runreporting -d iasdb -u digipass -p digipassword

Using a configuration file

The following example runs the command by using an existing OAS configuration file and creates an output log file:

dpdbreport runreporting -c /opt/vasco/etc/identikeyconfig.xml -l /var/log/reporting.log

Custom analysis time window

The following example runs the command with a custom analysis time windows to include the last 12 months:

dpdbreport runreporting -c /opt/vasco/etc/identikeyconfig.xml -m 12

Scheduled execution

To generate a report automatically on the first day of each month at 2:00, add the following entry to your crontab configuration (Linux):

# Run on the 1st of every month at 02:00
0 2 1 * * /opt/vasco/bin/dpdbreport runreporting -c /opt/vasco/etc/identikeyconfig.xml -q -l /var/log/oas-reporting-$(date +\%Y\%m).log

Example output

OAS Storage Utility (dpdbreport) 3.29.1
Copyright (C) 2026 OneSpan North America Inc. All rights reserved.

Connecting to data store 'iasdb'

Title: Number of users with at least 1 transaction per month (last 3 months)
Result:
eventmonth: 2026-03, usercount: 3295
eventmonth: 2026-04, usercount: 3290
eventmonth: 2026-05, usercount: 3934

Title: Number of transactions (authUser, authSignature) per month (last 3 months)
Result:
eventmonth: 2026-03, authcount: 4965
eventmonth: 2026-04, authcount: 4914
eventmonth: 2026-05, authcount: 7124

Title: Report on existing users - return the number of created users and administrators.
Result:
date: 2026-06-29 10:48:38, total: 10001, admin: 1, disabled: 0

Title: Report on users with DP - returns the number of users with at least 1 DP assigned
Result:
date: 2026-06-29 10:48:38, total: 9950

Additional considerations

  • Only completed months are considered in the reports. For example, running the report on June 17 will include data up to May, excluding any data from June.

  • The default analysis time period is 3 full past months. You can override this with the -m option. Note that the report can include fewer months than specified if the (audit) database contains less historical audit data for the requested period.

  • Depending on the DBMS, table names may be case sensitive. Ensure that the DSN and database name use the correct casing as created during the schema setup.

  • The report generation can take some time, especially if you run the command on databases that contain a lot of audit data.

  1. Schedule to run dpdbreport runreporting on the first of each month, for example, using a cron job on Linux or a scheduled task with the Task Scheduler on Windows.

  2. Use -l to write output to a log file marked with a specific date.

  3. Archive the log file for delivery to your OneSpan sales representative or technical account manager.