This documentation supports the 21.05 version of BMC Helix ITSM: Asset Management. To view an earlier version, select the version from the product version menu.

Creating custom license types

By default, several license types, such as Enterprise, Site are available. The default license types use default behavior for connection criteria and compliance criteria to relate CIs to the license certificates and check their compliance. For more information, see .Configuring license types. If you want to add more connection criteria or compliance criteria, you can create custom license types.  

The following figure shows the process that you follow to create a custom license type:

Basic and advanced mode license types

You can use the following modes when creating custom license types:

  • Basic — Create connection questions and map these based on the answers entered for the questions to a license certificate. In addition to configuring connection information, you can also create compliance questions and actions to determine if your license certificates and CIs are compliant with your licensing agreements. For example, you can use compliance questions and action to verify if you you have deployed more licenses than you have purchased.
  • Advanced — Use template forms and add your own fields. Then map these fields by using the license type wizard. This mode allows more flexibility to create a custom license type.

Fields in the Create License Type page wizard

Tip

You can click Manage Locales to enter license type and description in different languages.


Field

Description

Company

Select the company that can use this license type. If this license type can be used by all companies, select -Global-.

License Type

Enter the name of the license type.

Status

The status has a default value of Draft. You cannot change this value. After the license type has been created, you must activate it as described in Managing license types and related license certificates.

Description

(Optional) Provide a description of the license type being created.

Groupable

Specify whether certificates of this type are to be grouped under a master certificate based on license type and product categorization. 

Groupable licenses are typically used for client software where users expect to make multiple separate purchases of the software.

If you select Yes, you later use the summable and distributable options for compliance questions.

License Type Mode

Select Basic or Advanced. The License Type mode defines the forms you fill in when you create a license certificate.

In the Basic mode, you use the standard connection and compliance forms. It uses a wizard to guide you through creating the license type.

In the Advanced mode, you use custom connection and compliance form.

Overview of creating a license type

Task No.Task
1.

To create a license type by using the basic mode

To create a license type by using advanced mode
2.To customize your connection and compliance forms
To create a calculate compliance action
To create a compare compliance action

To create an update compliance action


To create a license type by using the basic mode

  1. From the Application Administration Console, click the Custom Configuration tab.

  2. From the Application Settings list, select Asset Management > Advanced Options > Configure License Type, and then click Open.
    The Configure Licenses form lists the current license types.
  3. Click Create.
    The Create License Type Page of the license type wizard appears.
  4. Complete the fields as described in Fields for Create License Type page wizard.
  5. Specify the connection questions.
    The answers to the connection questions return a list of CIs. For each connection question, perform the following steps:
    1. In the Question field, type a question.
      The connection questions define the criteria by which CIs are connected to certificates. In the next stage of the license wizard, you map this question to an attribute in the BMC Helix ITSM: Asset Management. The user's answer to the question is used by the license engine in a query to  BMC Helix ITSM: Asset Management.
    2. Select a field type of either Char or Int.
      The field type determines whether the user enters a character or integer answer to the question.
    3. Select the CI grouping:
      • Software — Indicates that the software being licensed.
      • Component — Indicates that the question is about a component on the computer on which the software is installed.
      • Computer System — Indicates that the question is about the computer on which the software is installed.
        Depending on the option you select from the CI grouping list, the CI type list is populated. For example, if the CI grouping question is set as Software, then you can only map attributes belonging to the software classes. 
    4. Select the sequence in which the question is asked and click Add.

      Tip

      To delete a question, highlight it in the list and click Delete. If you want to modify a question, you must delete it and add a new question.

    5. (Optional) To enter questions in other languages, select a question and click Manage Locales.
      The Manage Locales form displays the selected question. You can add translations of the question for other locales.
    6. When you have finished adding questions, click Next.
      The Map Connection Attributes page of the license type wizard for basic mode is displayed.

  6. Specify how to map the questions to CIs in BMC Helix CMDB.
    For any CI Type that you select, the Attribute field lists the Database names used in BMC Helix CMDB forms.
    For each connection question, select the CI Type and Attribute and click Map Attribute. You must use the same CI Type for each connection question. The query to connect to the appropriate CI uses a logical AND between attributes.

    Tip

    To delete a mapped attribute, select it from the list at the bottom of the Build Connection Mapping list and click Delete.

  7. Click Next.
  8. Specify the compliance questions as follows:
    1. In the Question field, type a question.
      The answers to the questions are used by the license engine in a query to BMC Helix ITSM: Asset Management.
    2. Select a field type of either Char or Int.
      The field type determines whether the user enters a character or integer answer to the question.
    3. If you specified Groupable on the Create License Type page of the license type wizard and Int as the field type here, select one of the following values in the Integer Question Type field:
      • None — Indicates that the field accepts an integer value that operates according to actions specified in the Build Compliance Actions page of the license type wizard.
      • Summable — Indicates that the field that you specify as summable gets summed up from all the children to the master certificate.
      • Distributable — Uses the summable amount and distributes the licenses to the children based on the sequence of the children and the value for each.

        Example

        On three separate occasions, 10 licenses, 5 licenses, and 20 licenses were purchased. When their certificates are grouped at the master level, 35 licenses are displayed in the Summable field. The Distributable field value shows the value for each certificate. If a total of 45 CIs are connected to the certificate, 10 licenses are assigned to the first child certificate, 5 to the second, and the remaining 30 licenses to the last. Because the last certificate gets assigned 30 while it had only purchased 20, it is marked as not compliant. The master certificate is also marked as not compliant.

    4. If you selected Distributable in the preceding step, specify values for the following fields:
      • Summable Field List — Select the summable field based on which the value in the Distributable field can be divided amongst the child certificates.
      • Set Compliance Alarm — Select whether to set a compliance alarm. If set to Yes, this distributable field triggers compliance on the child certificates.
    5. Specify whether the question uses a computed value.
      You can specify rules on the next page of the license type wizard to compute values.
    6. Select the field visibility:
      • Visible Read / Write — Identifies fields that are updatable from the certificate
      • Visible Read Only — Categorizes fields that do not need to be updated from the certificate, such as those retrieved for a compare or computation action. For example, this value can be used for the results of CMDB queries.
        Selecting this value results in a dimmed, uneditable field when you use the basic license type to create a license certificate from the Software Asset Management (SAM) Console.
      • Hidden —Categorizes fields that are used in an operation but do not need to be seen in the certificate
    7. Select the sequence in which the question is asked.
    8. To enter questions in other languages, select a question and click Manage Locales.
      The Manage Locales form displays the selected question. You can add translations of the question for other locales.
    9. Click Add.

      Tip

      To delete compliance questions, select them from the list at the bottom and click Delete.

    10. When you have finished adding all of the compliance questions, click Next.
      The Compliance Actions page of the license type wizard for basic mode is displayed.
  9. Specify compliance actions.
    Based on the run-time data from the license engine and based on the compliance questions, select and create the following compliance actions:
    • Get — Retrieves a list of values or a count of the matching records from the specified form. For more information, see To create a get compliance action..
    • Calculate — Computes an expression. For more information, see procedure To create a Calculate Compliance Action.
    • Compare — Performs a comparison defined in an expression. For more information, see procedure To create a Compare Compliance Action.
    • Update — Updates a list of values on a specified form. For more information, see procedure To create an Update Compliance Action.
    • Start loop — Enables you to process a set of actions before moving on to the next action. The Start Loop action is used to start a loop to return a list of values from a Get action. A Start Loop action must be created before the Get Action is created. Actions that use the Get action's results list are created after the Get action.
    • End Loop — Ends the loop before moving to the actions outside the loop. When you select End Loop, a dialog box appears prompting you to select the Start Loop action for which the End Loop action is to be created. 

      End Loop being created for a Get action list

  10. When you have finished specifying compliance actions, click Done.

To create a license type by using advanced mode

  1. From the Application Administration Console, click the Custom Configuration tab.

  2. From the Application Settings list, select Asset Management > Advanced Options > Configure License Type, and then click Open.
    The Configure Licenses form lists the current license types.
  3. Click Create.
    The Create License Type Page of the license type wizard appears.
  4. Complete the fields as described in Fields for Create License Type page wizard.
    Two additional fields are displayed, which are not displayed for basic mode: Connection Form Name and Compliance Form Name.
  5. In the Connection Form Name field, enter the name of the connection form that you customized from the AST:ConnectionTemplate form to create this license type. 

    Important

    You must spell your form names correctly when you enter them. Otherwise, the license type wizard will not be able to retrieve the fields for selection.

  6. In the Compliance Form Name field, enter the name of the compliance form that you customized from the AST:ComplianceTemplate form to create this license type, and then click Next.
    The Map Connection Attributes page of the license type wizard for advanced mode appears.
  7. From the Customer Fields list, select a field from the connection form that you customized.
  8. Select a field type of either Char or Int.
    The field type determines whether the user enters a character or integer answer to the question.
  9. Select the CI grouping for the license type.
    When you select a CI grouping, the certificates created with this type are grouped under a master certificate, based on the license type and the product categorization you select in the CI Grouping field.
  10. Specify how to map the questions to CIs in BMC Atrium CMDB.
    For each connection question, select the CI Type and Attribute and click Map Attribute.

    Tip

    To delete a mapped attribute, select it from the list at the bottom of the Build Connection Mapping list and click Remove.

  11. Click Next.
    The Compliance Actions page of the license type wizard in advanced mode appears.
  12. Specify compliance actions.
    Based on the run-time data from the rules engine and based on the compliance questions, select and create the following compliance actions:
    • Get — Retrieves a list of values or a count of the matching records from the specified form. For more information, see procedure To create a get compliance action.
    • Calculate — Computes an expression. For more information, see To create a calculate compliance action.
    • Compare — Does a comparison based on an expression. For more information, see To create a compare compliance action.
    • Update — Modifies a list of values on a specified form. For more information, see To create an update compliance action.
    • Start loop — Start loop processes a set of actions before moving on to the next. The Start Loop action is used to start a loop to return a list of values from a Get Action. A Start Loop Action must be created before the Get Action is created. Actions that use the Get action's results list are created after the Get.
    • End loop — End loop ends the loop before moving to the actions outside the loop. When you select End Loop, a pop up appears prompting you to select the Start Loop action for which the End Loop is to be created.
  13. When you have finished specifying compliance actions, click Done.

To customize your connection and compliance forms

You can customize the connection and compliance template forms and map them by using the license type wizard.

  1. Open the AST:ConnectionTemplate or AST:ComplianceTemplate form in Developer Studio.
  2. Save the template form under a new name.
  3. Change the labels and field characteristics.

    Important

    The field id for each field must be a unique value within the range 303000500 -303000900.

  4. (Optional) Add workflows or filters to make data entry easier and to validate the data. For more information, see  Workflow overview Open link .
  5. Save the form.

To create a get compliance action

Use the Get Compliance Action to retrieve information from AR System or CMDB forms.

  1. On the Compliance Actions page of the license type wizard, select Get in the Action field and click Create.
    The Get Action dialog box is displayed.
  2. Enter a name for the Get Compliance action.
  3. Select a source:
    • CMDB — Get information from CMDB forms based on the values of class attributes
    • AR — Get data from any AR System form 

      If you selected CMDB, a list of classes is shown in the CI Type field. (Classes are shown here instead of form names.)
  4. If you selected AR, from the From field, select the form name.
  5. Select the Get action type for which you want to create a query:
    • List — Returns a list of records that matches the criteria specified in the Get action.
    • Count — Sums the number of records that matches the criteria specified in the Get action. 
  6. In the Select field, select from the list of fields displayed for the form or class you selected, and click Add.
    If you selected Count in the preceding step, this field is unavailable.
  7. Build the WHERE qualification by using the controls in the toolbar above the WHERE field.
    As you build the WHERE qualification, it is displayed in the WHERE field.

    Tip

    You can delete the WHERE qualification to make corrections at any time by clicking Clear.

    You can use all or some of the following fields to build your WHERE qualification:

    1. Select the rule:
      • GetCertificates — Specifies the instance ID of the certificate as a value in the WHERE qualification
      • GetQuestions — Specifies the compliance question that you select as a value in the WHERE qualification 

        GetCertificates and GetQuestions are the default rules that appear. As you create actions, they also appear for you to select. Some of the data that is created through connection rules can also be selected here. For example, you can query relationship tables that were populated during a previous connection run.

    2. Select the operator.
    3. Select a field to enter a value in the WHERE qualification.
    4. To specify a free-form value, enter it in the Value field and click Add Value.
  8. Click Save and then click Close.
  9. After you have finished adding all of the compliance actions that you require, click Done to complete the license type wizard.

To create a calculate compliance action

  1. On the Compliance Actions page of the license type wizard, in the Action field, select Calculate and click Create.
    The Calculate Action dialog box is displayed.
  2. In the Name field, type a name for the Calculate Compliance action .
  3. Build the expression by using the controls in the toolbar above the Expression field.
    As you build the expression, it is displayed in the Expression field.

    Tip

    You can delete the WHERE qualification to make corrections at any time by clicking Clear.

    You can use the following fields to build your expression.

    1. Select the rule:
      • GetCertificates — Specifies the instance ID of the certificate as a value in the expression
      • GetQuestions — Specifies the compliance question you select as a value in the expression

    2. Select the operator.
    3. In the Value field, specify a free-form value, and then click Add Value.
  4. Click Save and then click Close.
  5. After you have finished adding all of the compliance actions you require, click Done to complete the license type wizard.

To create a compare compliance action

  1. On the Compliance Actions page of the license type wizard, select Compare in the Action field and click Create.
    The Compare Action dialog box is displayed.
  2. In the Name field, type a name for the action. 
  3. Build the expression by using the controls in the toolbar above the Expression field. As you build the expression, it is displayed in the Expression field.

    Tip

    As you build the expression, you can delete it to make corrections at any time by clicking Clear.

    You can use the following rules to build your expression:

    1. Select the rule:
      • GetCertificates — Specifies the instance ID of the certificate as a value in the expression
      • GetQuestions — Specifies the compliance question you select as a value in the expression 

    2. Select the operator.
    3. In the Value field, specify a free-form value and click Add Value.
  4. Click Save and then click Close.
  5. After you have finished adding all of the compliance actions you require, click Done to complete the license type wizard.

To create an update compliance action

  1. On the Compliance Actions page of the license type wizard, select Update in the Action field and click Create.
    The Update Action dialog box is displayed.
  2. In the Name field, type a name for the action.
  3. Select a source:
    • AR — Allows an AR form to be selected and fields on that form to be updated
    • Compliance Question — Allows configured compliance questions to be selected. Only those that are set to computed are available for selection. In addition to these questions, the following compliance flags can also be set:
      • Compliance flag  - Set to true (value equal to 1) or false (value equal to 0) to indicate if certificates are in or out of compliance.
      • Breach levels - Indicates that a certificate is approaching or is about to be breach compliance. You can set two breach-level warnings. For example, you can set Breach level 1 to indicate the number of licenses available is 10. Breach level 2 indicates the number of licenses available is 3. Breach level 3 is automatically set by the workflow when the license certificate goes out of compliance.
  4. In the Target field, select a form name that contains the fields that will be updated. AST:Compliance_BasicQuestions is the compliance form for the basic mode and AST:Compliance_AdvancedQuestions is the compliance form for the advanced mode.
  5. In the Set field, select the field to be updated.
  6. In the Set Value From field, select the method to use for the update:
    • Rule — Uses the rule (WHERE qualifier) that you build in the WHERE field. 
    • Constant — Uses the value you specify in the Value field (just below the Set Value From field). If you select Constant, skip to step 8.
  7. If you selected Rule in the preceding step, build the WHERE qualifier by using the controls in the toolbar above the WHERE field. As you build the clause, it is displayed in the WHERE field. 
    If you select Compliance Question for Source, the following default WHERE qualifier is created. You can modify this WHERE qualifier as required.
    "GetCertificates.InstanceId" = 'Certificate_InstanceID'

    Tip

    You can delete the WHERE qualifier to make corrections at any time by clicking Clear.

    You can use the following rules to build your expression.

    1. Select the rule:
      • GetCertificates — Specifies the instance ID of the certificate as a value in the WHERE qualifier
      • GetQuestions — Specifies the compliance question you select as a value in the WHERE qualifier

        GetCertificates and GetQuestions are the default rules that appear. As you create actions, they also appear for you to select. Some of the data created due to connection rules can also be selected here. For example, you can query relationship tables that were populated during a previous connection run.

    2. Select the operator.
    3. Select a field to enter as a value in the WHERE qualifier.
    4. To specify a free-form value, enter it in the Value field and click Add Value.
  8. If you selected Constant in step 6, enter the value in the Value field below the Constant option and click Add.

    Tip

    You can delete values that you have entered by selecting them from the list and clicking Remove.

  9. Select a matching requests value:
    • Do not update, issue an error — Issue an error when the first matching record is encountered and abort the run.
    • Do not update, issue a warning — Issue a warning for each matching record and continue until all records have been processed and the run is completed.
    • Modify all matching records — Update all records that match.
  10. Click Save and then click Close.
  11. After you have finished adding all of the compliance actions you require, click Done to complete the license type wizard.

To add custom license types to the Purchased versus Deployed KPI

  1. When you create the custom license type, use Compliance Question 1 to record the number purchased.
  2. When you create the custom license type, use Compliance Question 2 to record the number deployed.
  3. Use Developer Studio to update the AST:CLR:LicenseType_PurchasedvsDeployed menu on the Software Asset Management console with the custom license type by setting the LicenseTypeGUID_Base field to the custom license type.
Was this page helpful? Yes No Submitting... Thank you

Comments