Manage Usage Reports

You can view, generate, and schedule Usage Reports that provide information about the use of your Tenant accounts. The system uses aggregate data as well as the usage breakdown of the Tenant accounts in the report information, which includes information such as the number of credentials.

Role Requirements

To generate or schedule Usage Report, Service Provider Administrators need a custom Role with at least Export Reports and Scheduled Task Management permissions. To create a custom role, you must have the Super Administrator role or a custom role that allows you to create new roles.

Create a Custom Role

You must be a Super Administrator or have a custom role that allows you to create a custom role to complete this procedure.

1. Go to Main Menu > Members > Roles. The Roles List page opens.
2. Click Add . The Add Role page opens.
3. Enter a name for your custom role in the Name field. For example, Manage Service Provider Reports.
4. Enter a description for the custom role in the Description field.
5. Choose one of the following options:
   • Select Manage All Roles to allow those assigned this role to manage all users.
   • Do not select Manage All Roles and from the Select Roles to Manage list, select the roles that you want the users assigned this role to manage. For example, if you want to create a custom role called Report Manager that allows the role to manage all users assigned the Auditor role, select Auditor from the drop-down list.
     Note: When you select a role, it appears in the Administrator is allowed to manage these roles list. To add more roles, select the next role from the drop-down list.
6. Set the System Entities and permissions, as follows:
   1. For the Export Reports System Entity, click All.
   2. For the Scheduled Task Management System Entity, click All.
   3. Click Add to create the role.

Generate Usage Reports

Refer to the procedures in this section to generate usage reports for tenants.

Generate Usage Report for a Single Tenant

1. Click Main Menu > Service Provider > Tenants. The Tenants List page opens.
2. Click next to the account.
3. Click Generate Usage Report. The Generate Usage Report dialog box opens.
4. Enter a name for the report in the Name field.
5. Enter a description for the report in the Description field.
6. Select a text character to separate entries from the file delimiter list. Options include: Comma (,) or Pipe (|).
7. Select the Period for the report. If you choose Custom, use the calendar to select start and end dates. Note: The End Date cannot be set beyond the current calendar year, but the Start Date may go back to the previous year.
8. (Optional) Select Schedule Report to create a user report on-demand at the schedule period.
9. Click Confirm.

Generate a Report for all Tenants

1. Click Main Menu > Service Provider > Tenants. The Tenants List page opens.
2. Click > Generate Usage Report.
3. Select Generate Usage Report. The Generate Usage Report dialog box opens.
4. Enter a name for the report in the Name field.
5. Enter a description of the report in the Description field.
6. Select a character to separate files in the report from the File Delimiter field. Options include: Comma (,) or Pipe (|) for the CSV file.
7. Select a time period from the Period selector. If you choose Custom, use the calendar to select start and end dates.
8. (Optional) Select Schedule Report to create a user report on-demand at the schedule period.
9. Click Confirm.

Generate a Report from a Filter List

1. Click Main Menu > Service Provider > Tenants. The Tenants List page opens.
2. Click Search to enable filtering. The Filters dialog box opens.
3. Select your filter options and click Apply. Instant ID as a Service filters the results.
4. Select >Generate Usage Report.
5. Select Generate Usage Report. The Generate Usage Report dialog box opens.
6. Enter a name for the report in the Name field.
7. Enter a description of the report in the Description.
8. Select a text character to separate items in the report from the file delimiter list. Options include: Comma (,) or Pipe (|).
9. Select a period of time for the report from the Period selector. If you choose Custom, use the calendar to select start and end dates.
10. (Optional) Select Schedule Report to create a user report on-demand at the schedule period.
11. Click Confirm.

Export Tenant Reports

1. Click Main Menu > Service Provider > Tenants. The Tenants List page opens.
2. Click Download next to the report to export the report or archive to a CSV file.
3. Click Export. The browser downloads the report.

Schedule Usage Reports

1. Select Main Menu > Scheduled Reports. The Scheduled Tasks page opens.
2. Click Add . The Create Scheduled Report dialog box opens.
3. Enter a name for the scheduled task in the Name field.
4. (Optional) Enter a description for the scheduled task in the Description field.
5. In the Email field, enter the email address of the user who will receive the scheduled task report once it has been generated.
6. Select Usage Report from the Task Type list.
7. Select a recurrence from the Recurrence list.
8. Select the Day of the Week for the scheduled task.
9. Select the file delimiter used in the CSV file. 
10. Select Enable the scheduled report.
11. Click Confirm. The scheduled report appears in the Schedule Reports page.

Enable, Disable, and Delete Scheduled Reports

1. Click Main Menu > Scheduled Reports. The Scheduled Reports page opens.
2. Do the following, as required for the Scheduled Report:
   • Click Disable to disable the Scheduled Report and then click Confirm on the prompt.
   • Click Enable Enable to enable the Scheduled Report and then click Confirm on the prompt.
   • Click Delete to delete the Scheduled Report. Click Delete on the prompt.

Edit a Scheduled Report

1. Click Main Menu > Scheduled Reports. The Scheduled Reports page opens.
2. Click the Name of the Scheduled Report. The Edit Scheduled Report dialog box opens.
3. Edit the fields as required. Refer to the procedure in Manage Usage Reports for more information.
4. Click Confirm.

Usage Report Column Meanings

Column Name	Definition
CompanyName	The tenant or MSP's company name.
Count/Consumed	- Total completed prints for the Issuance Entitlement type - Total claimed flash passes for the Mobile Entitlement type - Maximum number of printers used in a specific time period for the Printer Entitlement type - Maximum number of printers onboarded under Managed Service Providers and tenants who have opted in. - Maximum number of ribbons for IIDaaS Ribbon-based tenants and printers.
ConsumedPreviousPeriod	Displays the same number as CountPreviousPeriod column.
ContractNumber	The contract number that was assigned to this tenant.
CountPreviousPeriod	Displays the number of entitlements between a month prior to StartTime and a month prior to EndTime.
CustomerId	The unique ID assigned to this tenant.
Email	The email address of the account user.
EndTime	The time the usage report counts are calculated before (inclusive).
EntitlementId	The unique ID of the entitlement.
EntitlementType	Displays the entitlement that is enabled for this tenant. Entitlements are each given their own row in the report. For MSP’s, there may be multiple entitlement duplicates listed due to different included service bundle types. Possible values are: ISSUANCE, FLASHPASS, FLEETMANAGEMENT, IIDAASENABLEDRIBBON, ISSUEDFLASHPASS, PRINTER.
FirstName	The first name of the account user.
Hostname	The hostname or domain of the tenant.
LastName	The last name of the account user.
Mobile	The mobile number of the account user.
ParentHostname	The hostname or domain, of the tenants parent account.
Phone	The phone number of the account user.
ServiceBundle	The bundle type of the entitlement. Possible values are: ESSENTIALS, ADVANCED, PROFESSIONAL, DEFAULT. MSP’s can have the same entitlement listed more than once with a different service bundle. ESSENTIALS, ADVANCED, PROFESSIONAL bundle types are assigned to the ISSUANCE entitlement. All others are set as DEFAULT.
ServiceProvider	Indicates if the tenant is a service provider. Possible values are: TRUE, FALSE.
StartTime	The time the usage report counts are calculated after (inclusive).
Trial	Indicates if the tenant is a trial or production account. Possible values are: TRUE, FALSE
UserId	The username of the account.

Note: Count, countPreviousPeriod, Consumed, and consumedPreviousPeriod columns will display the same result for all Issuance entitlements.