Product documentation Docs
    • English
    • Deutsch
    • 日本語
    • 한국어
    • Français
  • More Sites
    • Now Community
    • Developer Site
    • Knowledge Base
    • Product Information
    • ServiceNow.com
    • Training
    • Customer Success Center
    • ServiceNow Support Videos
  • Log in

Product documentation

  • Home
How search works:
  • Punctuation and capital letters are ignored
  • Special characters like underscores (_) are removed
  • Known synonyms are applied
  • The most relevant topics (based on weighting and matching to search terms) are listed first in search results
Topics are ranked in search results by how closely they match your search terms
  • A match on the entire phrase you typed
  • A match on part of the phrase you typed
  • A match on ALL of the terms in the phrase you typed
  • A match on ANY of the terms in the phrase you typed

Note: Matches in titles are always highly ranked.

  • Release version
    Table of Contents
    • Now Platform capabilities
Table of Contents
Choose your release version
    Home New York Now Platform Capabilities Now Platform capabilities Configuration Management Database CMDB Identification and Reconciliation CMDB identification rules Create or edit a CI identification rule

    Create or edit a CI identification rule

    • Save as PDF Selected topic Topic & subtopics All topics in contents
    • Unsubscribe Log in to subscribe to topics and get notified when content changes.
    • Share this page

    Create or edit a CI identification rule

    Identification rules are used to uniquely identify CIs in the CMDB, as part of the identification and reconciliation process. Each CMDB class can be associated with a single identification rule.

    Before you begin

    Role required: itil has read access, itil_admin (on top of itil) has full access.

    About this task

    In a CI identification rule, specify a CI identifier, and identifier entries and related entries that uniquely identify the CI. You cannot use the CI Class Manager to create related entries for an identification rule, instead, add related entries directly to the cmdb_identifier table.

    Review the following before creating identification rules:
    • CMDB identification rules
    • Effective usage of CMDB Identification

    Procedure

    1. Navigate to Configuration > CI Class Manager.
    2. Click Hierarchy to display the CI Classes list. Select the class for which to create an identification rule.
    3. In the class navigation bar, expand Class Info and then click Identification Rule.
    4. Click Edit to edit an existing rule, or click Add in the Identification Rule section to create one. Fill out the form, and then click Save.
      Field Description
      Independent/Dependent Designation of whether the CI identifier can identify the CI independently of other CIs, or not.
      Note: To set the rule as Dependent, you must specify dependent relationship rules for the selected class.
      Name Name of CI identifier.
      Description Description of the CI identifier.
    5. In the Identifier Entries section, click an existing identifier entry to edit, or click Add to create one.
    6. In the Identifier Entry dialog box, choose an option and then click Next. Continue with one of the following three steps according to the option you selected.
      Option Description
      Use attributes from main table <table> Lets you select attributes from the currently selected table (regular identifier entry).
      Use attributes from another table (Lookup table) Lets you select attributes from any related table, other than the currently selected table (lookup identifier entry).
      Use attributes from main and another table (Hybrid) Lets you select attributes from both the currently selected table, and from another table (hybrid identifier entry).
    7. Use attributes from main table <table> option: Set the options on the form and then click Save.

      Search On Table is preset to the currently selected table in the CI Classes list.

      Field Description
      Active Check box that specifies the identifier entry is active. At least one identifier entry in an identification rule must be active for the rule to apply.
      Priority Priority of the identifier entry. Identifier entries are applied based on priority. Rules with lower priority numbers are given higher priority. Identifier entries of identical priorities are applied randomly.

      You can keep gaps between the priority numbers, so you can assign the unused priority numbers to new entries without modifying the existing priority order.

      Criterion Attributes Set of attributes that uniquely identify the CI. Attributes can belong to the current class, or to a parent class.

      It is not possible to add reference fields as a criterion attribute. Reference fields store sys_ids that point to a record in another table, and thus is considered a weak criterion attribute (in terms of uniqueness) for the current table.

      Allow null attribute

      When selected, then if at least one criterion attribute is not null, allow to attempt matching with an identifier entry even if there are criterion attributes which are null.

      Otherwise, all criterion attributes must have values to attempt matching with an identifier entry.

      Allow fallback to parent's rules Allows the identification rules of the CI's parent to be used if a match is not found for this identification rule. Applies only for dependent identification rules.
      Note:
      • If criterion attributes have only two attributes and sys_class_name is one of them (for example [name, sys_class_name], [ip_address, sys_class_name]), then the other attribute cannot be NULL, even if Allow null attribute is enabled. This restriction is due to sys_class_name being considered a special system matching attribute.
      • Optional condition is applicable only for lookup or hybrid identifier entries (and not applicable when using attributes from the main table).

        The Optional condition does not apply, although you are able to customize the default Identifier Entry form by adding the Optional condition field. Then navigating to Configuration > Identification/Reconciliation > CI Identifiers to use that customized form (not using the CI Class Manager).

    8. Use attributes from another table (Lookup table) option:
      1. Set Search On Table to a table other than the currently selected table in the CI Classes list. The Search On Table must have a reference field to cmdb_ci, otherwise the identifier entry is considered invalid.
      2. Set the rest of the fields as described in the previous step.
      3. Optionally, click Advanced options and enter the information for a lookup identifier (scroll down if necessary).
        Advanced Option Description
        All of these conditions must be met A filter to narrow the set of records that will be searched for a matching CI.
        Enforce exact count match For lookup identification, match a CI only on exact lookup records count match.
        When enforced, all lookup items for a CI in the payload must have matching records in the lookup table, that reference the same CI:
        1. Only matches CIs that have all the lookup items from the input payload referencing the CI in CMDB.
        2. If there are multiple matches, selects the oldest created CI as the final match.
        When not enforced, one lookup item for a CI in the payload matching a record in the lookup table, is sufficient to consider a match:
        1. Matches any CI that has at least one of the lookup items from the input payload referencing the CI in CMDB.
        2. If there are multiple matches, selects the CIs with the max number of lookup items from the input payload referencing the CI in CMDB.
        3. If there are still multiple matches, selects the oldest created CI as the final match.
      4. Click Save.
    9. Use attributes from main and another table (Hybrid) option:
      1. Set the options on the General Settings tab as described in previous steps, and then click Next.
      2. On the Main Table Settings tab, select the attributes to use from the currently selected table, and then click Next.
        Search On Table is preset to the currently selected table in the CI Classes list.
      3. On the Lookup Table Settings tab, select a Search On Table and then in Criterion Attributes select attributes from the specified table. Search On Table must have a reference field to cmdb_ci, otherwise the identifier entry is considered invalid.
        You can click Advanced options and enter the information for a lookup identifier as described in the previous step (scroll down if necessary).
      4. Click Save.
      Note: The Allow null attribute option in the hybrid option, is set to 'false'. Therefore, all of the selected criterion attributes from both the currently selected table and the lookup table, must have a value.
    10. (Optional) Add related entries to the cmdb_identifier table.
      1. In the main platform navigation bar, navigate to Configuration > Identification/Reconciliation, and click CI Identifiers.
      2. In the Identifiers view, locate and click the identification rule that you have been editing or creating.
      3. Click the Related Entries tab.
      4. In the Related Entries related list, click New or open an existing entry to specify a related entry for matching the related item. Fill out the form, and then click Submit.
        Table 1. Related Entry form
        Field Description
        Identifier The CI identifier for which this related entry belongs to. By default it is set to the identifier you previously selected.
        Related table A related table that references the CI that is being matched.
        Referenced field A referenced field in Related table that should store the referenced CI. This field always references the cmdb_ci table, or a descendent of the cmdb_ci table.
        Criterion attributes The set of attributes to uniquely identify the related item. Attributes can belong to the current class, or to a parent class.

        Click the lock icon to view, add, or remove attributes from the identification rule.

        Optional condition Use the Add Filter Condition and the Add "OR" Clause buttons to construct a filter to narrow the set of records that will be searched for a matching related item.
        Active Check box that specifies that the related entry is active.
        Allow null attribute If at least one criterion attribute in the related table is not null, allow to attempt matching with an identifier entry even if there are criterion attributes which are null.
        Priority Priority of the related entry for the specified Related table. Rules with lower priority numbers are given higher priority while matching a related item for specific related table. Related entries for the specified related table with identical priorities are applied randomly.

        You can keep gaps between the priority numbers, so you can assign the unused priority numbers to new entries without modifying the existing priority order.

        Note: If criterion attributes have only two attributes and sys_class_name is one of them (for example [name, sys_class_name], [ip_address, sys_class_name]), then the other attribute cannot be NULL, even if Allow null attribute is enabled. This restriction is due to sys_class_name being considered a special system matching attribute.

    Example

    For example, the pre-defined Hardware Rule applies to the Hardware [cmdb_ci_hardware] table. It has an identifier entry with the criterion attribute Serial Number, Serial Number Type and its Search on table field is set to Serial Number.

    The following payload snippet adds a CI to the cmdb_ci_linux_server class, that is a child of the Hardware class. It also shows how you can add related items in the payload for which you should create Related Entries on the CI Identifier page for the Hardware [cmdb_ci_hardware] table:

    {
        "items": [
            {
                "className": "cmdb_ci_linux_server",
                "lookup": [
                    {
                        "className": "cmdb_serial_number",
                        "values": {
                            "serial_number": "VMware-42 21 e3 da 44 14 5a a6-56 48 2b 0a 28 53 42 4c",
                            "serial_number_type": "system",
                            "valid": "true"
                        }
                    },
                    {
                        "className": "cmdb_serial_number",
                        "values": {
                            "serial_number": "4221E3DA-4414-5AA6-5648-2B0A2853424C",
                            "serial_number_type": "uuid",
                            "valid": "true"
                        }
                    },                }
                ],
    
        “related": [
                    {
                        "className": "cmdb_ci_ucs_chassis",
                        "values": {
                            “name": “chassis1",
                            “category": “category1",
                            “short_description": “My Chassis 1"
                        }
                    },
                    {
                        "className": "cmdb_ci_ucs_chassis",
                        "values": {
                            “name": "chassis2",
                            "category": "category2",
                            "short_description": "My Chassis 2"
                        }
                    },    }
         ],
    
                "values": {
                    ......
                    "name": "xpolog2.lab3",
                    "os_name": "Linux",
                    "output": "Linux xpolog2.lab3 2.6.32-431.el6.x86_64 #1 SMP Fri Nov 22 03:15:09 UTC 2013 x86_64 x86_64 x86_64 GNU/Linux",
                    "serial_number": "VMware-42 21 e3 da 44 14 5a a6-56 48 2b 0a 28 53 42 4c",
                    "sys_class_name": "cmdb_ci_linux_server"
                }
            }
        ]
    }
                             

    When the Hardware Rule is applied, the Serial Number [cmdb_serial_number] table is searched for a match with the values specified within the lookup key. Unless Enforce exact count match (Lookup) is checked, it is not necessary for every lookup key to return a match, as long as there is at least one match. If all matches reference the same CI, then that CI is considered to be the existing CI record. If no match is found, then the identification search continues to the next rule entry. If after all the rules are exhausted without finding a match, a new CI record is created in the database.

    What to do next

    You can optionally create an inclusion rule to narrow the scope of CIs that are included in identification.
    Related tasks
    • Create an identification inclusion rule

    Tags:

    Feedback
    On this page

    Previous topic

    Next topic

    • Contact Us
    • Careers
    • Terms of Use
    • Privacy Statement
    • Sitemap
    • © ServiceNow. All rights reserved.

    Release version
    Choose your release version

      Create or edit a CI identification rule

      • Save as PDF Selected topic Topic & subtopics All topics in contents
      • Unsubscribe Log in to subscribe to topics and get notified when content changes.
      • Share this page

      Create or edit a CI identification rule

      Identification rules are used to uniquely identify CIs in the CMDB, as part of the identification and reconciliation process. Each CMDB class can be associated with a single identification rule.

      Before you begin

      Role required: itil has read access, itil_admin (on top of itil) has full access.

      About this task

      In a CI identification rule, specify a CI identifier, and identifier entries and related entries that uniquely identify the CI. You cannot use the CI Class Manager to create related entries for an identification rule, instead, add related entries directly to the cmdb_identifier table.

      Review the following before creating identification rules:
      • CMDB identification rules
      • Effective usage of CMDB Identification

      Procedure

      1. Navigate to Configuration > CI Class Manager.
      2. Click Hierarchy to display the CI Classes list. Select the class for which to create an identification rule.
      3. In the class navigation bar, expand Class Info and then click Identification Rule.
      4. Click Edit to edit an existing rule, or click Add in the Identification Rule section to create one. Fill out the form, and then click Save.
        Field Description
        Independent/Dependent Designation of whether the CI identifier can identify the CI independently of other CIs, or not.
        Note: To set the rule as Dependent, you must specify dependent relationship rules for the selected class.
        Name Name of CI identifier.
        Description Description of the CI identifier.
      5. In the Identifier Entries section, click an existing identifier entry to edit, or click Add to create one.
      6. In the Identifier Entry dialog box, choose an option and then click Next. Continue with one of the following three steps according to the option you selected.
        Option Description
        Use attributes from main table <table> Lets you select attributes from the currently selected table (regular identifier entry).
        Use attributes from another table (Lookup table) Lets you select attributes from any related table, other than the currently selected table (lookup identifier entry).
        Use attributes from main and another table (Hybrid) Lets you select attributes from both the currently selected table, and from another table (hybrid identifier entry).
      7. Use attributes from main table <table> option: Set the options on the form and then click Save.

        Search On Table is preset to the currently selected table in the CI Classes list.

        Field Description
        Active Check box that specifies the identifier entry is active. At least one identifier entry in an identification rule must be active for the rule to apply.
        Priority Priority of the identifier entry. Identifier entries are applied based on priority. Rules with lower priority numbers are given higher priority. Identifier entries of identical priorities are applied randomly.

        You can keep gaps between the priority numbers, so you can assign the unused priority numbers to new entries without modifying the existing priority order.

        Criterion Attributes Set of attributes that uniquely identify the CI. Attributes can belong to the current class, or to a parent class.

        It is not possible to add reference fields as a criterion attribute. Reference fields store sys_ids that point to a record in another table, and thus is considered a weak criterion attribute (in terms of uniqueness) for the current table.

        Allow null attribute

        When selected, then if at least one criterion attribute is not null, allow to attempt matching with an identifier entry even if there are criterion attributes which are null.

        Otherwise, all criterion attributes must have values to attempt matching with an identifier entry.

        Allow fallback to parent's rules Allows the identification rules of the CI's parent to be used if a match is not found for this identification rule. Applies only for dependent identification rules.
        Note:
        • If criterion attributes have only two attributes and sys_class_name is one of them (for example [name, sys_class_name], [ip_address, sys_class_name]), then the other attribute cannot be NULL, even if Allow null attribute is enabled. This restriction is due to sys_class_name being considered a special system matching attribute.
        • Optional condition is applicable only for lookup or hybrid identifier entries (and not applicable when using attributes from the main table).

          The Optional condition does not apply, although you are able to customize the default Identifier Entry form by adding the Optional condition field. Then navigating to Configuration > Identification/Reconciliation > CI Identifiers to use that customized form (not using the CI Class Manager).

      8. Use attributes from another table (Lookup table) option:
        1. Set Search On Table to a table other than the currently selected table in the CI Classes list. The Search On Table must have a reference field to cmdb_ci, otherwise the identifier entry is considered invalid.
        2. Set the rest of the fields as described in the previous step.
        3. Optionally, click Advanced options and enter the information for a lookup identifier (scroll down if necessary).
          Advanced Option Description
          All of these conditions must be met A filter to narrow the set of records that will be searched for a matching CI.
          Enforce exact count match For lookup identification, match a CI only on exact lookup records count match.
          When enforced, all lookup items for a CI in the payload must have matching records in the lookup table, that reference the same CI:
          1. Only matches CIs that have all the lookup items from the input payload referencing the CI in CMDB.
          2. If there are multiple matches, selects the oldest created CI as the final match.
          When not enforced, one lookup item for a CI in the payload matching a record in the lookup table, is sufficient to consider a match:
          1. Matches any CI that has at least one of the lookup items from the input payload referencing the CI in CMDB.
          2. If there are multiple matches, selects the CIs with the max number of lookup items from the input payload referencing the CI in CMDB.
          3. If there are still multiple matches, selects the oldest created CI as the final match.
        4. Click Save.
      9. Use attributes from main and another table (Hybrid) option:
        1. Set the options on the General Settings tab as described in previous steps, and then click Next.
        2. On the Main Table Settings tab, select the attributes to use from the currently selected table, and then click Next.
          Search On Table is preset to the currently selected table in the CI Classes list.
        3. On the Lookup Table Settings tab, select a Search On Table and then in Criterion Attributes select attributes from the specified table. Search On Table must have a reference field to cmdb_ci, otherwise the identifier entry is considered invalid.
          You can click Advanced options and enter the information for a lookup identifier as described in the previous step (scroll down if necessary).
        4. Click Save.
        Note: The Allow null attribute option in the hybrid option, is set to 'false'. Therefore, all of the selected criterion attributes from both the currently selected table and the lookup table, must have a value.
      10. (Optional) Add related entries to the cmdb_identifier table.
        1. In the main platform navigation bar, navigate to Configuration > Identification/Reconciliation, and click CI Identifiers.
        2. In the Identifiers view, locate and click the identification rule that you have been editing or creating.
        3. Click the Related Entries tab.
        4. In the Related Entries related list, click New or open an existing entry to specify a related entry for matching the related item. Fill out the form, and then click Submit.
          Table 1. Related Entry form
          Field Description
          Identifier The CI identifier for which this related entry belongs to. By default it is set to the identifier you previously selected.
          Related table A related table that references the CI that is being matched.
          Referenced field A referenced field in Related table that should store the referenced CI. This field always references the cmdb_ci table, or a descendent of the cmdb_ci table.
          Criterion attributes The set of attributes to uniquely identify the related item. Attributes can belong to the current class, or to a parent class.

          Click the lock icon to view, add, or remove attributes from the identification rule.

          Optional condition Use the Add Filter Condition and the Add "OR" Clause buttons to construct a filter to narrow the set of records that will be searched for a matching related item.
          Active Check box that specifies that the related entry is active.
          Allow null attribute If at least one criterion attribute in the related table is not null, allow to attempt matching with an identifier entry even if there are criterion attributes which are null.
          Priority Priority of the related entry for the specified Related table. Rules with lower priority numbers are given higher priority while matching a related item for specific related table. Related entries for the specified related table with identical priorities are applied randomly.

          You can keep gaps between the priority numbers, so you can assign the unused priority numbers to new entries without modifying the existing priority order.

          Note: If criterion attributes have only two attributes and sys_class_name is one of them (for example [name, sys_class_name], [ip_address, sys_class_name]), then the other attribute cannot be NULL, even if Allow null attribute is enabled. This restriction is due to sys_class_name being considered a special system matching attribute.

      Example

      For example, the pre-defined Hardware Rule applies to the Hardware [cmdb_ci_hardware] table. It has an identifier entry with the criterion attribute Serial Number, Serial Number Type and its Search on table field is set to Serial Number.

      The following payload snippet adds a CI to the cmdb_ci_linux_server class, that is a child of the Hardware class. It also shows how you can add related items in the payload for which you should create Related Entries on the CI Identifier page for the Hardware [cmdb_ci_hardware] table:

      {
          "items": [
              {
                  "className": "cmdb_ci_linux_server",
                  "lookup": [
                      {
                          "className": "cmdb_serial_number",
                          "values": {
                              "serial_number": "VMware-42 21 e3 da 44 14 5a a6-56 48 2b 0a 28 53 42 4c",
                              "serial_number_type": "system",
                              "valid": "true"
                          }
                      },
                      {
                          "className": "cmdb_serial_number",
                          "values": {
                              "serial_number": "4221E3DA-4414-5AA6-5648-2B0A2853424C",
                              "serial_number_type": "uuid",
                              "valid": "true"
                          }
                      },                }
                  ],
      
          “related": [
                      {
                          "className": "cmdb_ci_ucs_chassis",
                          "values": {
                              “name": “chassis1",
                              “category": “category1",
                              “short_description": “My Chassis 1"
                          }
                      },
                      {
                          "className": "cmdb_ci_ucs_chassis",
                          "values": {
                              “name": "chassis2",
                              "category": "category2",
                              "short_description": "My Chassis 2"
                          }
                      },    }
           ],
      
                  "values": {
                      ......
                      "name": "xpolog2.lab3",
                      "os_name": "Linux",
                      "output": "Linux xpolog2.lab3 2.6.32-431.el6.x86_64 #1 SMP Fri Nov 22 03:15:09 UTC 2013 x86_64 x86_64 x86_64 GNU/Linux",
                      "serial_number": "VMware-42 21 e3 da 44 14 5a a6-56 48 2b 0a 28 53 42 4c",
                      "sys_class_name": "cmdb_ci_linux_server"
                  }
              }
          ]
      }
                               

      When the Hardware Rule is applied, the Serial Number [cmdb_serial_number] table is searched for a match with the values specified within the lookup key. Unless Enforce exact count match (Lookup) is checked, it is not necessary for every lookup key to return a match, as long as there is at least one match. If all matches reference the same CI, then that CI is considered to be the existing CI record. If no match is found, then the identification search continues to the next rule entry. If after all the rules are exhausted without finding a match, a new CI record is created in the database.

      What to do next

      You can optionally create an inclusion rule to narrow the scope of CIs that are included in identification.
      Related tasks
      • Create an identification inclusion rule

      Tags:

      Feedback

          Share this page

          Got it! Feel free to add a comment
          To share your product suggestions, visit the Idea Portal.
          Please let us know how to improve this content

          Check any that apply

          To share your product suggestions, visit the Idea Portal.
          Confirm

          We were unable to find "Coaching" in Jakarta. Would you like to search instead?

          No Yes
          • Contact Us
          • Careers
          • Terms of Use
          • Privacy Statement
          • Sitemap
          • © ServiceNow. All rights reserved.

          Subscribe Subscribed Unsubscribe Last updated: Tags: January February March April May June July August September October November December No Results Found Versions Search preferences successfully updated My release version successfully updated My release version successfully deleted An error has occurred. Please try again later. You have been unsubscribed from all topics. You are now subscribed to and will receive notifications if any changes are made to this page. You have been unsubscribed from this content Thank you for your feedback. Form temporarily unavailable. Please try again or contact  docfeedback@servicenow.com  to submit your comments. The topic you requested does not exist in the release. You were redirected to a related topic instead. The available release versions for this topic are listed There is no specific version for this documentation. Explore products Click to go to the page. Release notes and upgrades Click to open the dropdown menu. Delete Remove No selected version Reset This field is required You are already subscribed to this topic Attach screenshot The file you uploaded exceeds the allowed file size of 20MB. Please try again with a smaller file. Please complete the reCAPTCHA step to attach a screenshot
          Log in to personalize your search results and subscribe to topics
          No, thanks Login