[Index]

Model: data/LicenseAuditSettings

Licensing

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

Note

This topic only covers the Admin Portal interface available for licensing export. For further details and for licensing export using platform CLI commands, refer to the Licensing and Subscriber Data Export Guide.

VOSS Automate provides the means to collect the audit data to track VOSS license usage in the system each month. This is required to ensure the billing is aligned with the license usage in the system according to our contract.

A schedule is configured to collect the data and save the output to the platform filesystem at 3AM UTC on the first day of the month, but the platform CLI also has commands to run the data collection manually. For details, refer to the Licensing and Subscriber Data Export Guide.

Configure License Delivery

System administrators with the required permissions (default is sysadmin) have the option from the Licensing menu to configure the delivery of the audit data by means of one or more of the following delivery methods and combine them into one or more File Transfer Destinations. These destinations can then be used to transfer the audit data.

The delivery method configuration can be accessed from the menus:

When the required methods have been configured, the scheduled audit data collection can also deliver the data files by these methods.

Workflow steps:

  1. Set up one or more delivery method destinations listed above.

  2. Combine configured delivery method destinations into one or more file transfer destinations (File Transfer Destinations menu).

  3. On the Settings menu:

  4. At the scheduled collection date of the system or when the command is run manually on the platform CLI, the files are then:

Settings for the VOSS-4-UC License Audit file extract and transfer.

Model Details: data/LicenseAuditSettings

Title Description Details
Name Default: Global
  • Field Name: name
  • Type: String
  • Default: Global
Destinations File Transfer Destinations to which the audit file will be sent.
  • Field Name: destinations.[n]
  • Type: Array
  • Cardinality: [1..n]
Destination * Destination
  • Field Name: destinations.[n].destination
  • Type: String
  • Target: data/FileTransferDestination
  • Format: uri
File format * Format of the file to be sent to this destination. Anonymous files do not contain the provider/reseller/customer names, whereas detailed files do. ZIP files include a hash which can be used to identify tampering.
  • Field Name: destinations.[n].format
  • Type: String
  • Choices: ["Anonymous CSV", "Anonymous ZIP", "Detailed CSV"]