ServiceNow Integration
Fundamentals of the SAP LeanIX integration with ServiceNow (CMDB).
Overview
The integration between SAP LeanIX and ServiceNow is a powerful way to enable the transparent flow of data between the two systems. This documentation covers key information to help you understand the Integration more deeply:
- Communication with ServiceNow.
- The core concepts used to integrate.
- The default supported configuration and best practices.
Prerequisites
The ServiceNow integration is only available for the SAP LeanIX Technology Risk and Compliance product. Before you start the configuration process, please make sure you or a colleague/consultant working with you has the fundamental knowledge about ServiceNow CMDB, CSDM, and the ability to do the following within your instance:
- Manage installation and configuration plugins from the ServiceNow store
- Manage users, tables and ACLs in the CMDB
Communication with ServiceNow
The communication between the SAP LeanIX integration running on SAP LeanIX servers and the ServiceNow system depends on the configuration specified in ServiceNow URL.
In case the ServiceNow URL is configured with an https
schema, the communication is done through TLS encryption. Furthermore, all client credentials are stored as part of the configuration encrypted using theAES-256
.
Additionally, the Integration User created can utilize both Basic Auth
or oAuth 2.0
for authentication between the two systems.
Communication method when using HTTPS Instance URL
The TLS version and cipher suites used for communication between SAP LeanIX and ServiceNow depends on the negotiation to the ServiceNow HTTPS server. In general,
TLS v1.2
andTLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
is used for any HTTPS connection to ServiceNow.
The ServiceNow URL mentioned above and the other integration user details are configured in the Integration credentials tab. For more information, see Credential Configuration.
Important!
When the sync between SAP LeanIX and ServiceNow is in the running phase, it is not possible to stop or interrupt this process.
Core Concepts
For synchronization purposes, every mapping between tables in both systems defines the following:
Parameter | Description |
---|---|
Fact Sheet Type | SAP LeanIX Fact Sheet Type - e.g. Application, IT Component (Software), etc. |
Direction/ Source | Defined Direction and Source of Truth - e.g. SAP LeanIX or ServiceNow |
ServiceNow Table | Name of the table in ServiceNow with its logical table name. For example Business Application - cmdb_ci_business_app |
Sync Mode | Defines how to deal with objects on the target that have no corresponding one the source system. See Sync Mode |
Filter/ Constraints | Whether there are any synchronization constraints, e.g. only synchronizing applications with a specific lifecycle status or only synchronizing software product models which are installed on a server belonging to a managed business application |
Within each mapping type described above, it is possible to configure the field-level mapping between the two systems.
The following parameters are available for field mappings:
- The type of field mapping (Further explained, in the setup in SAP LeanIX documentation).
- The name of the field in SAP LeanIX (if applicable).
- The direction of synchronization.
- The name of the field in ServiceNow (if applicable).
- Whether the attribute is to be synced from the defined source of truth or the opposite of the defined source.
- How values are being mapped.
Both standard and custom attributes are supported by the integration. The integration synchronizes in-scope data from one system to another as specified in the configuration.
Sync Mode
A sync mode for integration configuration can be defined in three ways, depending on the specific requirements of preserving/ deleting the items from the target system.
- Additive Sync: This Sync Mode only creates and updates items and never deletes anything. This is the safest Sync Mode, but it can lead to duplicate data if not used carefully.
- Conservative Sync: This sync mode only deletes items created in the target system and are no longer linked to any source object. This Sync Mode preserves manually created items and items that are linked to sources controlled by other integrations. Items that were created by a different integration (e.g. Collibra) will be preserved as well as part of this sync.
- Overwrite Sync: This Sync Mode deletes any items that are not linked to a source object, or that are linked to a source object that no longer exists. This Sync Mode is the most likely to lead to data loss, but it is also the most likely to ensure that your data is consistent with the source system.
Sync Mode behavior:
Direction | Additive Sync | Conservative Sync | Overwrite Sync |
---|---|---|---|
Foreign → LeanIX (SAP LeanIX is the target) | No deletion will happen | Every Fact Sheet will be deleted that has an externalId of the running configuration but the corresponding item on the source is missing AND no further externalId is specified on the Fact Sheet. | Every Fact Sheet will be deleted, that has NO externalId of the running configuration or this externalId links an object that does not exist. |
LeanIX → Foreign (Foreign is the target) | No deletion will happen | Every Foreign item from the target will be deleted if no Fact Sheet is found that is linked to this item, considering the configuration externalId. This will happen if a previous linked FactSheet is archived or the item in the foreign system is manually created. | Every foreign item from the target will be deleted that has no valid link to a FactSheet when considering the configuration externalId. |
Supported Configurations
The integration between SAP LeanIX and ServiceNow is compatible with CSDM 4.0 guidelines
As of the last update of this documentation, our suggested default configuration below is in alignment with CSDM 4.0. Please feel free to reach out to your CSM for any specific questions.
Before implementing the integration, it is recommended to review the current maturity level of the ServiceNow Instance to be connected. The maturity and availability of modules within the ServiceNow instance will implicate what configurations can be used and not used while connecting with SAP LeanIX.
The following decision table provides suggested configuration workflows.
Maturity State | Modules Required | Flow |
---|---|---|
Ready to sync Applications, Business Capabilities, and their relationships to ServiceNow. | n/a | Default Mapping Note - The IT Component section of the flowchart does not apply. |
Ready to sync IT Components of category Hardware, Software, and their relationships with Applications from ServiceNow. | Software Asset Management (SAM) Discovery Service. The link between the Software Discovery Model and the Software Product Model record required through the model_id reference field. | Default Mapping |
(Same as above) Ready to sync IT Components of category Hardware, Software, and their relationships with Applications from ServiceNow. | Software Asset Management Professional (SAM Pro) Discovery Service. | Default Mapping Default Mapping (SAM Pro) - Recommended for large ServiceNow Instances. |
Applications in SAP LeanIX are connected to Business Applications in ServiceNow. IT components in SAP LeanIX are imported from the ServiceNow table Product Models, which is the inventory of Hardware and Software Models in ServiceNow.
As a best practice for CSDM 4.0 modeling, we recommend including business application and deployment as subtypes for application fact sheets and map them to Business Application and Application Service in ServiceNow respectively. In addition to this, other components related to CSDM can be managed in ServiceNow. For more information, see Optional Application Fact Sheet subtypes.
Default Mapping
The flow chart helps illustrate the relations between ServiceNow tables and data flow conditions when constraints are used within the configuration.
Default Mapping (SAM Pro)
Connecting IT Component Software in SAP LeanIX with the Software Discovery Model table in ServiceNow is recommended in cases where the Software Product Model table does not contain enough information or the ServiceNow Instance connected is too large to perform dynamic link matching as described in Figure 1.
Review record size
One way to ascertain if this case applies is to check if the total number records collectively within the
cmdb_rel_ci
,cmdb_sam_sw_install
andcmdb_sam_sw_discovery_model
table are larger than 1 million records.
In such a case, for customers with ServiceNow SAM Pro, the table of cmdb_sam_sw_discovery_model
(Software Discovery Model) should be linked instead to IT Components Software.
However, to ensure only records relevant within SAP LeanIX come through, it is mandatory to have a filter applied to only pull relevant Discovery Models. An example of such a filter to be applied on the Discovery Model table is as follows -
statusINmanually normalized,normalized,partially normalized^norm_versionISNOTEMPTY^norm_publisherISNOTEMPTY^norm_typeINlicensable,not licensable,unknown
The fields of Product Classification
,Main Category
, and Product Type
within the Software Discovery Model table help in further rationalizing the list of records while setting the filter.
Review the number of records left with the filter applied
As the table can easily store hundreds and thousands of records, it is important to review the filter applied and the records that remain with it. A good estimate is to ensure that the records remaining in the table are less than <20k records.
Legacy Configuration
Legacy Software Management Connection
If in case legacy software management module is in use instead of SAM/SAM Pro and Discovery Service, the Integration can be adapted instead to follow the following flow chart instead -
Custom Configurations
It is possible to sync records between custom tables, fields, and also CMDB tables not part of the figures shown above. However, it is not possible to fully support all use cases in all conditions and has to be reviewed on a case-by-case basis.
Frequently Asked Questions
See answers to some frequently asked questions about the ServiceNow integration in the following table.
Question | Answer |
---|---|
Is it possible to use the integration for a decoupled method involving an integration layer with a middleware used as a source for communicating updates to downstream platforms such as ServiceNow, instead of a point-to-point approach? | No, the out-of-the-box ServiceNow integration is designed to communicate directly with ServiceNow. |
If service management processes generate data that is required in SAP LeanIX, does the integration support receiving updates from ServiceNow or another integration platform linked to a downstream platform? | The integration can fetch data from a ServiceNow CMDB table like cmdb_ci_business_app , including data available directly on the attributes or related attributes using a reference field. For more information, see Dot Walking. Attributes and relationships can be synchronized from ServiceNow to SAP LeanIX. You can synchronize the fields available in a table on the Mappings tab of the integration configuration. |
Should mapping be also done on the ServiceNow side? | You should configure mapping in SAP LeanIX. For more information, see Field Mapping. |
Are there any reporting tools to surface mismatches between attributes in the two systems before you enable the integration? | No, but you can use a cloned sandbox workspace and a non-production ServiceNow instance to test the integration. Additionally, you can set up an integration with Microsoft PowerBI to further extract data and perform analysis. To learn more, see OData Integration. |
At first synchronization, SAP LeanIX captures the ServiceNow sys_id field of existing business applications that match on the name field. What are best practices for cases when both systems are already established with data that may conflict? | It's recommended to maintain consistent naming across both systems to ensure uniformity in enterprise language. If discrepancies exist, adjust the item names. If you’re experiencing problems when changing names, please submit a ticket to SAP LeanIX Support. If you're an SAP customer, submit a request from the SAP for Me portal. |
Is the ServiceNow ID field editable in the UI? | The ServiceNow ID field is marked as read-only because it's only used for mapping between SAP LeanIX and ServiceNow. If you want to modify this field, please submit a ticket to SAP LeanIX Support. If you're an SAP customer, submit a request from the SAP for Me portal. |
How can I link a business process to an application to get an overview of data mastered in SAP LeanIX and ServiceNow? For example, can I view business processes that rely on end-of-life IT components? | The integration can read and model existing relations for an application in SAP LeanIX, so the link is created automatically. You can view this data in the following reports: - Application Landscape Report clustered by processes, using the Obsolescence Aggregated Risk view - Application Matrix Report with Processes on the Y axis, IT components in the drill-down, and the Obsolescence Aggregated Risk view selected |
Do you recommend any best practices for managing specific attributes in ServiceNow and SAP LeanIX? Where can I view the data model and data mapping? | The default mapping available in the configuration is based on best practices. To view the data model and data mapping, see Default Mapping. You can also download the mapping matrix as an Excel file, which includes best practices for mapping additional fields. |
Does the integration also include the relationships ServiceNow may have in Service Mapping? | The relationships available in the cmdb_rel_ci table are used for automatic mapping of applications to IT components. Custom relationship mapping is supported from reference fields and custom tables, including the cmdb_rel_ci table. |
Are there any key ServiceNow components, such as ServiceNow HAM Pro or SAM Pro, that are required to enable proper data transfer to SAP LeanIX? | The integration relies on the data available in the Hardware and Software Model table in ServiceNow. Hence, it doesn’t matter how the data is captured as long as it’s accurate. |
How is lifecycle data sourced for IT components? How often is it refreshed? | Lifecycle data for IT components is sourced using the reference catalog Catalog. Data in the reference catalog is refreshed periodically, with scheduled updates set up for each vendor. For more information, see IT Components in the Reference Catalog. |
How to perform synchronization between SAP LeanIX and ServiceNow and vice versa? What should be the master (source) system? | According to best practices, applications and business capabilities should be mastered in SAP LeanIX. The infrastructure landscape (IT components and tech categories) should be mastered in ServiceNow. ServiceNow has discovery and asset management capabilities. Synchronization between the systems occurs daily. You can also synchronize data manually. Data is updated in case of any modifications. |
How does ServiceNow link IT components to applications? Do I need to map them manually? | To link data in ServiceNow, you can rely on discovery solutions and, if needed, use manual mapping. According to the best practice mapping, IT components (Product model) are not directly linked to Business Applications ( cmdb_ci_business_app ), SAP LeanIX cannot send this relation. You should use a graph rule constraint to fetch relations between applications and IT components from ServiceNow. For more information, see Graph Rule Constraints. |
When I remove a link from a server of an application during synchronization, it doesn't delete the link between the application and IT component. Do you plan to implement link deletion during synchronization? | Deletion is part of the synchronization. A hardware model might be used in multiple ServiceNow instances and hence it should be removed from all instances before it gets unlinked in SAP LeanIX. If the issue persists, please contact SAP LeanIX Support. |
The ServiceNow Relationship view shows direct relationships between Business Applications and Servers. How does this comply with the ServiceNow CSDM model? According to CSDM, Business Applications are connected with Servers indirectly, through Application Services. | This is correct. The demo data also contains the instances where CSDM is not followed, considering CSDM and non-CSDM instances. |
How can I identify which servers are using end-of-life software within SAP LeanIX? | You can use the link available on a specific IT component and navigate to ServiceNow to view servers related to this IT component. This is recommended to have a lean model in SAP LeanIX. |
For IT components lifecycle, what is the most commonly used source of information: the reference catalog or ServiceNow Software Asset Management (SAM)? If we’re not using SAM Pro, is it recommended to use the reference catalog? | Customers who use the integration leverage the reference catalog information available on the SAP LeanIX side. For more information, see IT Components in the Reference Catalog. |
When using the ServiceNow integration, should we create any additional fact sheet types or subtypes for better integration of data? | It depends on your use case and the version of the meta model that you’re using. For more information, see Meta Model. |
Can we add fact sheets, such as IT components, using both methods: by discovering them through the ServiceNow integration and manually creating them in SAP LeanIX? | Yes, you can use both methods to add fact sheets to your inventory. To implement this, choose the appropriate sync mode. To learn more, see Sync Mode. |
When synchronizing data between ServiceNow and SAP LeanIX, where is the tech category fact sheet data typically mastered in line with best practices? We're transitioning to a service-centric IT delivery model and wonder if our ITSM should provide service groupings to populate tech categories. | If you're leveraging the TBM taxonomy, we recommend using tech category data from the reference catalog. For more information, see Tech Categories in the Reference Catalog. |
Our organization doesn’t use ServiceNow. How can we set up a ServiceNow native integration? | You can use SAP LeanIX APIs to build a similar integration. For more information, see SAP LeanIX APIs. |
Updated 10 days ago