Moving to the Helix Service Management Suite license model by using the Suite Licensing Opt-in Utility

The Suite Licensing Opt-in Utility is applicable only for on-premises deployments.

Use the Suite Licensing Opt-in Utility to convert your existing classic licenses to the Helix Service Management Suite licensing model and share an .xls report with the administrator. As an administrator, you can review this report to determine which users' license needs to be converted to the new Helix Service Management Suite licensing model.

Use the Suite Licensing Opt-in Utility in the following deployment scenarios: 

ScenariosDetails
Installing BMC Helix IT Service Management version 25.3.00

Run the Suite Licensing Opt-in Utility based on the following scenarios:

  • run the Suite Licensing Opt-in Utility in activate mode before onboarding and then onboard the users
  • run the Suite Licensing Opt-in Utility process after onboarding
Upgrading from BMC Helix Service Management version 21.02.xx to version 25.3.00

During the upgrade, run the Suite Licensing Opt-in Utility after the upgrade pipeline.

Upgrading from BMC Helix Service Management version earlier than 21.02.xx to version 25.3.00Run the Suite Licensing Opt-in Utility after completing the migration.

To download the Suite Licensing Opt-in Utility

  1. On the BMC Electronic Product Distribution (EPD) site, from Products, select BMC Helix Innovation Suite OnPrem.

  2. Select the latest version.
    The following screenshot shows the version.
    Opt-in EPD.png
  3. From the Product tab, select Suite Licensing Opt-in Utility SHA Checksum Version <version> and Suite Licensing Opt-in Utility Version <version>.
    The following screenshot shows the Suite Licensing Opt-in Utility:
    Opt-in utility.png
  4. Click Download.
  5. Save the utility in a folder on your computer.

Modes for running the Suite Licensing Opt-in Utility

You can win the Suite Licensing Opt-in Utility in the following three modes:

1751448067659-511.png

ModesDescription
Report

Generates a report that provides details about users who are impacted by the conversion, such as the login ID, full name, email ID, current user license, new license types, new licenses, and service accounts.

The report also includes the functional roles for BMC Helix Business Workflows, BMC Helix Digital Workplace Catalog, and BMC Helix Multi-Cloud Broker.

As an administrator, you can use this report to analyze and determine which users' license needs to be converted.

ApplyModifies the user licenses and performs the updates on the server. It will replace only the BMC Helix licenses, and all custom licenses assigned to the users will be retained. 
Activate

Activates the licensing model for all new and updated users. 

To run the Suite Licensing Opt-in Utility

  1. Access the Suite Licensing Opt-in Utility Version <version> that you downloaded from the Electronic Product Distribution site.
  2. Run the following command on the command line:
    java -jar enablesmartapplicense-<version>-SNAPSHOT.jar
    The following table shows the details about the parameters used in the command:
    ParameterDescription
    -h <arg>Specifies the server host name.
    -t <arg>Specifies the server port number.
    -u <arg>Specifies the user name.
    -p <arg>Specifies the user password.
    -sku <arg>

    (Optional) Specifies the SKU license of the customer, for example, Standard or Advanced.

    • Standard—Assigns standard or advanced licenses based on existing license or functional roles.
    • Advanced—Assigns advance license to all users even if the users need only standard entitlement.
    -m <arg>

    (Optional) Specifies the execution mode. We recommend to run the utility in the following order of execution modes:

    report > apply > activate

    1. (Default) report—Generates a report of current user licenses and saves them in the AR System Upgrade Tracker form.
    2. apply—Applies the licenses to the users after reviewing and approving the details from the report. 
    3. activate—Applies the new licensing model and performs all the updates to initiate the licensing model.

    After you run the utility, the report is available on the AR System Upgrade Tracker form. 

To validate and download the Suite Licensing Opt-in Utility report

  1. Log in to Mid Tier, open the AR System Upgrade Tracker form.
  2. Search for the report. 
  3. If the utility runs successfully, the componentStatus field is updated with the Completed status.
  4. Select your report, and click Save. 
    AR System Upgrade Tracker report.png
    The downloaded .xls report provides a detailed report of users with their existing licenses and the new licenses after running the Suite Licensing Opt-in Utility. 
  5. If the utility fails, the componentStatus field is updated with the Failure status. To troubleshoot the issue, perform the following steps:
    1. Check the logs from the enablesmartapplicense.log file. 
      The failure could be because the user could not be converted to the new licensing model.
    2. Navigate to the Person data form and update the user information.
    3. Run the utility again. 

Data generated in the Suite Licensing Opt-in Utility report

The downloaded .xls file includes three tabs—RAW DATA, VALIDATION, and FunctionalRoles. 

  • The RAW DATA tab displays details such as the login ID, full name, email ID, current user license, and recommended license.

Suite licensing model - Raw data tab.png

  • The VALIDATION tab displays a summary of licenses and compliance. It counts the number of configured licenses and picks data from the RAW DATA tab in the report.

    The Validation tab of the report shows all values as zero. You must enter the values manually.Suite licensing model - Validation tab.png

    The VALIDATION tab includes the following details:
    RowDescription
    TOTAL USERS CONFIGURED

    Shows the total number of users configured in your environment.

    Important: When you add users after running the utility, the next time you run the utility, the report will only display details for the newly added users, not for all users.

    PURCHASEDShows the number of BMC Helix ITSM licenses you have purchased. 
    REQUIREDShows the number of licenses required.
    If you enter the purchased quantity and evaluate the sheet, you will get the value for the required number of licenses to make the status is compliant. 
    STATUS

    Shows the compliance of the license usage. 
    If the purchased quantity is compliant, the value for the STATUS is added as COMPLIANT or otherwise, it is evaluated as NOT COMPLIANT.

    • The status is COMPLIANT when the total number of users configured is less than the number of licenses purchased. 

    • The status is NON-COMPLIANT when the total number of users configured are more than the number of licenses purchased.

  • The FunctionalRoles tab includes a list of all the functional roles for every application participating in the Helix Service Management Suite licensing model.

Suite Licensing Opt-in Utility report license mappings

All users with Fixed licenses will be given the Named User licenses, and users with Floating licenses will be given the Concurrent User licenses. 

The following table lists the base rules for conversion :

Current Platform and Application License Type

BMC Helix ITSM License

BMC Helix Business Workflows or BMC Helix Digital Workplace Catalog Functional roles

BMC Helix Multi-Cloud Broker Functional roles

No Application License

Platform FixedBMC Helix Service Management Standard - Named User BMC Helix Service Management Standard - Named User BMC Helix Service Management Advanced - Named UserNo change
Platform FloatingBMC Helix Service Management Standard - Concurrent UserBMC Helix Service Management Standard - Concurrent UserBMC Helix Service Management Advanced - Concurrent UserNo change

 

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