This documentation supports the 25.1 version of BMC Helix Digital Workplace Basic and BMC Helix Digital Workplace Advanced. Icons distinguish capabilities available only for the Advanced and External license levels. For more information, see License types and features.To view an earlier version, select the version from the Product version menu.

Reviewing active users

Although BMC Helix Digital Workplace does not check for license usage, as an administrator, you can view the number of named users, active users and self-registered users in your system. Use these reports to analyze the unused or idle licenses, decide whether you need to purchase additional capacity, or export the data to add to your compliance and audit report. 


Related topics

License-types-and-features

FAQ

Use the following methods to view the number of users logging in toBMC Helix Digital Workplace:

Report name

Report viewed from 

Description

Scenario

Named users count from the CTM:People form

BMC Helix ITSM

A search query result from the CTM:People form in BMC Helix ITSM that displays the number of named users. 
Users are considered in the report is they are issued a unique ID regardless of whether they are actively using BMC Helix Digital Workplace at any given time.

Important: To get the exact usage count, make sure that you exclude the following accounts: 


    • User accounts that are disabled, deleted, or are inactive
    • Non-user type (technical) accounts set up in the system 
    • Ex-employee accounts

As an administrator, Allen wants to review how many users in his organization are set up in BMC Helix ITSM Foundation data. Allen logs in to BMC Helix ITSM as an administrator. He visits the CTM:People form and searches for users with valid Login IDs. A list of all the users matching this criteria is displayed. The list has 5000 named users. However, his organization has only 4500 users. Allen understands that he needs to change the status of ex-employees to "offline" and remove their login IDs.  He exports the report to a CSV format and uses it to show an overconsumption of the named license. 

Named users count who have the Named user license with self-registered users add-on license

BMC Helix ITSM

A search query result from the CTM:People form in BMC Helix ITSM that displays the number of named users excluding self-registered users.

Users are considered in the report is they are issued a unique ID regardless of whether they are actively using BMC Helix Digital Workplace at any given time.


Important: To get the exact usage count, make sure that you exclude the following accounts: 


    • User accounts belonging to external company
    • User accounts that are disabled, deleted, or are inactive
    • Non-user type (technical) accounts set up in the system 
    • Ex-employee accounts

As an administrator, Allen wants to review how many users in his organization are set up in BMC Helix ITSM Foundation data. Allen logs in to BMC Helix ITSM as an administrator. He visits the CTM:People form and searches for users with valid Login IDs and those that do not belong to the external company. A list of all the users matching this criteria is displayed. The list has 3000 named users with self-registered users add-on licenses. However, his organization has only 2500 users. Allen understands that he needs to change the status of ex-employees to "offline" and remove their login IDs.  He exports the report to a CSV format and uses it to show an overconsumption of the named license. 

Active User report

BMC Helix Digital Workplace Admin console

A web report that displays the number of active end users.
Users are considered active when they log in or access the product via APIs at least once during a given calendar month.

As an administrator, Allen wants to review how many users in his organization are actively using BMC Helix Digital Workplace. Allen uses the Active User report and specifies a date range for last six months to generate the report. The report shows the total active users on all types of devices are 1900. He knows that his organization has 2000 licenses. With this information, Allen concludes that in the past six months, 100 licenses were unused. Allen exports the report to a CSV format and uses it as a compliance and audit report.

Self-registered user report

BMC Helix Digital Workplace Admin console

A web report that displays the number of external end users who self-registered to use the subscription services.
User are considered in the report when they log in to subscription services or access the services via APIs at least once during a given calendar month.

Apex, a BMC Helix Digital Workplace subtenant, purchased 5000 external user licenses one year ago. Six months later, there were 3000 self-registered users of Apex. As an administrator, Allen wants to see how many more self-registered users for Apex are using BMC Helix Digital Workplace. Allen has the external administrator permissions so he logs in to the BMC Helix Digital Workplace Admin console from the external portal to access the Active User report. He specifies a date range for the past six months to generate the report. The report shows the total active users are 4000. With this information, Allen concludes that 1000 licenses are still unused. 

REST API call

REST API response

A report generated by opening the API endpoint while authenticated as a BMC Helix Digital Workplace administrator. To use a REST API call, you must have MyIT Super Admin permissions.

Not applicable


Overview of the BMC Helix Digital Workplace User reports

BMC Helix Digital Workplace provides licenses on a per user basis. Use these reports to find out how many users in your organization are actively using BMC Helix Digital Workplace and derive the number of unused or idle licenses.

The following table provides an overview of the user reports in BMC Helix Digital Workplace Admin console :


Before you begin

  • Ensure that you are a member of the MyIT Admin or MyIT Super Admin permission group. 
    • The reports are available by default and you do not need to do any additional configurations to view the report.
    • You can view the data only for your own tenant.
    • In a multitenant environment, you can view the data only for the current tenant.
  • Ensure that the BMC Helix Digital Workplace Admin console is accessible.
  • If you want to view the self-registered users reports, make sure you have external administrator permissions. 


To view the Named User license consumption

  1. As an administrator, log in to BMC Helix ITSM. 
  2. Select Administration Console > Application Administration Console.
  3. From the Configuration for Company list, select the company for which you want to generated the named user report. 
    For example, Petramco
  4. Click View Next to People. 
  5. On the CTM:People form, click New Search. 
  6. Click Advanced Search. 
  7. In the Advanced search field, type 'Login ID' != NULL and Status="Enabled".
  1. Click Search. 
    A list of people with login ID for the Petramco company is displayed, as shown in the following image:

named user report_example.png

  1. Export this report to a CSV file. 


To view the Named Users license consumption without self-registered users

  1. As an administrator, log in to BMC Helix ITSM. 
  2. Select Administration Console > Application Administration Console.
  3. From the Configuration for Company list, select the company for which you want to generated the named user report. 
    For example, Petramco
  4. Click View Next to People. 
  5. On the CTM:People form, click New Search. 
  6. Click Advanced Search. 
  7. In the Advanced search field, type 'Login ID' != NULL and 'Company*+'!=<External company name>.
    A list of all users who have access to the system with a Login ID and who do not belong to the external company is displayed. 
  8. Click Search. 
  9. Export this report to a CSV file. 


To view the Active User report

  1. Log in to the Admin console. 
  2. Click the Reports tab. 
  3. To view active user report for a defined period of time, specify the date range and select Filter. 

  4. (Optional) Click Export to CSV to access the report locally in your machine. 

    Important

    To avoid CSV injection, in the Active User reports CSV file, if the User Name, Email, User Id columns contain data that start with special characters—equal to (=), plus (+}, minus (-), or at the rate (@) then a string is prefixed with single quotation mark (').

The following image is an example of the Active User report:

Reports_19.11.png


To view the Self-Registered User report

  1. As an external administrator, log in to the external portal. 
  2. Navigate to the Admin console. 
  3. Click the Reports tab. 
  4. Specify a date range for a defined period of time and select Filter.
  1. (Optional) Click Export to CSV to access the report locally in your machine. 

The following image is an example of a Self-registered User report filtered over six months:

Self-registered users report.png


 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*