Generate Usage report

You can manually generate a usage report that provides an overview of the daily usage of SecureTransport. This option is applicable to environments with SecureTransport only (without Transfer CFT or other MFT products).

The report provides daily usage metrics and totals for a selected period or date range:

  • number of active users
  • number of unique transfers based on coreID
  • number of successful inbound and outbound file transfers

Along with these daily metrics, the report contains information regarding your current SecureTransport setup.

The report is in JSON format and is available as a REST API resource.

The Administration Tool provides a simple interface to generate the report as a JSON file.

  1. Select Setup > Server License.
  2. The Server License page is displayed.
  3. In the Usage Report pane, select a reporting period from the drop-down and click Generate.
  4. A dialog box prompts you to open the report or save it to disk as a .json file.
  5. Select your preference, and click OK.

The generated JSON report contains the following parameters:

Element

(type)

Description

 

envId

(string)

Unique custom identifier useful for specifying each cluster instance. Blank by default, this value can be changed using the StatisticsSummaryReport.EnvironmentId server configuration option.

schemaId

(string)

The JSON schema to validate the file against.

Blank by default this value can be changed using the StatisticsSummaryReport.SchemaId server configuration option.

timestamp

(string)

Timestamp when the report is generated.

This value is in ISO 8601 format: {YYYY}-{MM}-{DD}T{hh}:{mm}:{ss}.{SSS}{TZ}.

granularity

(number)

Report interval granularity: 86400000 milliseconds (24 hours)
report

(object)

Collection of daily reports, chronologically ordered by date in the specified reporting period.

  • date

    (object)

The date of the daily report.

This value is in ISO 8601 format: {YYYY}-{MM}-{DD}T{hh}:{mm}:{ss}.{SSS}{TZ}.

The number of daily reports depends on your selection of the reporting period.

    • product
    • (string)
Name of the MFT product, e.g. SecureTransport
    • usage
    • (object)

Collection of daily metrics related to the product. With SecureTransport it contains the active users and information about the file transfers performed within the day.

      • ST.ActiveUsers
      • (number)

Number of active users for the day

      • ST.TransfersCore
      • (number)
Total number of unique transfers (based on coreID) for the day
      • ST.TransfersIn
      • (number)

Number of successful inbound file transfers (with state RECEIVED) for the day. Internal routing (within SecureTransport) via Advanced Router and Standard Router is excluded.

      • ST.TransfersOut
      • (number)

Number of successful outbound file transfers (with state SENT) for the day. Internal routing (within SecureTransport) via Advanced Router and Standard Router is excluded.

      • ST.TransfersMaxInOut
      • (number)
The greater number between ST.TransfersIn and ST.TransfersOut
    • meta
    • (object)
Additional meta information for the daily report

meta

(object)

Additional meta information for the summary report.
  • companyName
    (string)
Company name as specified in the license
  • envName
    (string)

Custom display name of the environment.

Blank by default, this value can be changed using the StatisticsSummaryReport.EnvironmentName server configuration option.

  • productLine
    (string)
Name of the product line: e.g. MFT
  • productName
    (string)
Name of the MFT product: e.g SecureTransport
  • productVersion
    (string)
Base product version: e.g. 5.4 (SecureTransport version)
  • currentPatch
    (string)
Currently installed patch: e.g. PATCH-23
  • isECEnabled
    (boolean)
Specifies if Enterprise Clustering is enabled: can be true or false.
  • isFMEnabled
    (boolean)
Specifies if Flow Management (Central Governance) integration is enabled: can be true or false
  • isADIEnabled
    (boolean)
Specifies if AxwayDecisionInsight (Sentinel) integration is enabled: can be true or false
  • plugins
    (object)

List of installed plug-ins along with their versions

    • authorization
    • (object)
List of installed authorization plug-ins.
    • authentication
    • (object)
List of installed authentication plug-ins
    • site
    • (object)
List of installed transfer site plug-ins
    • customARStep
    • (object)
List of installed Advanced Routing step plug-ins
  • reportTimeframe
  • (object)
The report time frame
    • startDate
    • (string)
Timestamp of the start date of the reporting period
    • endDate
    • (string)
Timestamp of the end date of the reporting period. Note that the end date is not included in the report. For example, to generate a report for May, the start date should be 1 May, the end date should be 1 June.
  • reportSummary
  • (object)

Usage aggregations for the selected period based on daily usage information

      • ST.ActiveUsers
      • (number)
Maximum number of active users for the reporting period
      • ST.TransfersCore
      • (number)
Total number of unique transfers (based on coreID) for the reporting period
      • ST.TransfersIn
      • (number)

Number of successful inbound file transfers (with state RECEIVED) for the reporting period. Internal routing (within SecureTransport) via Advanced Router and Standard Router is excluded.

      • ST.TransfersOut
      • (number)

Number of successful outbound file transfers (with state SENT) for the reporting period. Internal routing (within SecureTransport) via Advanced Router and Standard Router is excluded.

      • ST.TransfersMaxInOut
      • (number)
Total of the ST.TransfersMaxInOut values for the reporting period

Related topics:

Related Links