Bizzdesign Integration app for ServiceNow - Support (2023)

You can use the Bizzdesign Integration app for ServiceNow^® to ensure automated integration and configuration between ServiceNow and the Bizzdesign Horizzon platform. The integration allows you to analyze and dynamically visualize your IT service and delivery infrastructures in the context of your enterprise architecture, from business to technology. You can set up your integration and automate the import of ServiceNow data into Bizzdesign Horizzon. Mapping between the ServiceNow CSDM (Common Service Data Model) and ArchiMate allows for easy integration of content.

Key features of the app are:

• Retrieve all the collections (external data) and model packages in ServiceNow.

• Publish CMDB (Common Service Data Model) data alongside the CI relations to Horizzon.

• Publish any non-CMDB table data to Horizzon.

For additional information, see also the blog about mapping between ServiceNow's CSDM and ArchiMate.

On this page:

Creating an API client in Horizzon

For the communication between Horizzon and ServiceNow an API client is needed consisting of a client ID and client secret. An API client can be created in Horizzon. Once you have created the API client you will need its client ID and client secret to configure the Bizzdesign Integration App.

Configuring the Bizzdesign Integration App on ServiceNow

1. Install the Bizzdesign Integration application on your instance and open it.

2. Set Bizzdesign Integration as the Application Scope.

3. Add your Horizzon endpoint to the REST Message:

   (Video) CMDB Service Graph Connector, IH-ETL. Multisource walkthrough under 10 minutes

   1. In the menu, go to System Web Services > Outbound > Rest Message.

   2. In the REST Messages list, select Horizzon Integration.

   3. Under Related , add your endpoint to the following HTTP methods. Double-click an endpoint, change the URL, and save it.

      retrieveLayers
      retrieveObjects
      retrieveModels
      retrieveModelPackages
      retrieveAttributes
      deleteEntity

4. Configure the Application Registry (OAuth):

   1. In the menu, go to System OAuth > Application Registry.

   2. In the Application Registries list, select Bizzdesign Client Token.

   3. Fill in the following fields:

      Client ID: Your Horizzon client ID (for more information about the client ID, please refer to Creating a named API client)
      

      (Video) Whats New in the Tokyo CMDB, CSDM and Service Graph Connectors
      Client Secret: Your Horizzon client Secret
      Token URL: https://YOURHORIZZONINSTANCE.horizzon.cloud/oauth/token
Redirect URL: https://YOURINSTANCENAME.service-now.com/oauth_redirect.do
   4. Click Update.
5. Add a credential:
   1. In the menu, go to IntegrationHub >Connections & Credentials > Credentials.
   2. Click New.
   3. Select OAuth 2.0 Credentials.
   4. Fill in the following fields:Name: e.g., Bizzdesign
OAuth Entity Profile: Select/search for: Bizzdesign Client Token default_profile
   5. Click Submit.
   6. To check if the credentials are working click:Get OAuth Token
      
      
6. Add a connection to Horizzon:
   1. In the menu, go to IntegrationHub >Connections & Credentials > Connection.
   2. Click New.
   3. Select HTTP(s) Connection.
   4. Fill in the following fields:
      
      Name: e.g., Bizzdesign Horizzon
Credential: Select/search for the name you used in step 5
      Connection alias: x_bzzbv_bizzdesign.Horizzon
Connection URL: https://YOURHORIZZONINSTANCE.horizzon.cloud/api/1.0
   5. Click Submit.

All content from all the pages in the app will be automatically updated every hour. This is an automatically scheduled job. So if you, for instance, store a new model package on Horizzon it will be displayed in the app automatically within an hour. There's also the option to manually perform an import or export in between the scheduled jobs:

• Model Packages, Collections: Click the Retrieve Model packages and Collections button on the list page to perform a manual import.
  

• Entity Types: Click the Populate All Entities and Links now button on the list page to perform a manual export.

In addition, you can activate a scheduled job that runs every 4 hours to re-run the active inbound configurations. This scheduled job needs to be activated at the system properties in the app. If you do not want a configuration to be included in the scheduled job, clear the Active option on the Configuration page (menu Bizzdesign Integration > Inbound > Configurations, open a configuration).

There is a number of integration parameters that can be set at the system properties in the Bizzdesign Integration App for ServiceNow. You may want to set them before you start working with the app. They are:

• Set mapping field types from Horizzon to ServiceNow.
• Activate a scheduled job to re-run the active inbound configurations.
• Filter the target field, in the configuration page, based on the source field type.
• Set the Horizzon language prefix.
• Set the default batch limit when sending objects (entities).
• Set mapping field types from ServiceNow to Horizzon.
• Remove unused data block definitions.

You can access the system properties via the menu Administration > System Properties.

Working with the Bizzdesign Integration App for ServiceNow is easy. The main pages are the Collections and Entity Types pages. They can be found in the Bizzdesign Integration entry in the menu. A quick demo video and a more detailed description of the different pages can be found here:

Retrieving model packages from Horizzon

The model packages from Horizzon are retrieved in the app automatically during the scheduled automatic update, but manually importing them may be needed if you need them before they have been retrieved.

1. In the menu, go to Bizzdesign Integration > Model Packages.

   

2. The list of all model packages from Horizzon is shown. If no model packages are shown yet, click Retrieve Model Packages and Collections to manually import the model packages from Horizzon.

Creating collections

Using the Bizzdesign Integration app you can create collections within your model packages. These will be used to store the objects you create in the app and export from ServiceNow to Horizzon.

1. In the menu, go to Bizzdesign Integration > Collections.

   

2. Click New and enter the following data:

   

   (Video) Service Mapping | Overview

   Name: Enter the name for the collection.
   

   Model Package: Select the model package this collection needs to be part of by entering the name of the model package, or find a model package and select one using the search control.
3. Click Submit to save the collection.

Creating and exporting objects

On the Entity Types page of the app you can create objects that will be exported from ServiceNow to Horizzon.

1. In the menu, go to Bizzdesign Integration > Entity Types.

   

2. Click New and enter the following data:

   

   Name: The name of the object. This name will be be show on the entity types list page.
   Source Table: Select the source table that will be exported to Horizzon.
   Active: By default, all active objects will be exported to Horizzon. Only clear the option if the object should not be exported.
   Batch Limit: If you are selecting a lot of attributes, you can overwrite the default batch size to use smaller batches. (The default batch size can be set via Bizzdesign Integration > Administration > System Properties.)
   Collection: Select the collection in which the object must be stored in Horizzon.
   Model Package: Is automatically filled based on the selected collection.
   Filter: Filter the table based on the available fields.
   Entity Name Attribute: Select the attribute that must be used for the object's name. Its value will become the name of the object in Horizzon. In most cases "Name" will be pre-filled.

3. In Attributes, click and select the attributes that must be sent from ServiceNow to Horizzon. Some of the attributes that are displayed in green or have a + sign are references to other ServiceNow objects. You can expand these attributes and select a specific attribute or select the "main" attribute and the default listed attribute for the referred object will be used.

   

4. Click Submit to save the object.

Once you have created the objects, population of the objects and relations will take place during the next scheduled app update. To manually start the export, click Populate All Entities and Links Now at the top of the entity types list.

Importing objects from Horizzon

In addition to sending content to Horizzon, you can also retrieve objects from Horizzon and store them in ServiceNow. To do so you need to configure an import in the Bizzdesign Integration app.

1. In the menu, go to Bizzdesign Integration > Inbound > Configure Import.

   If you see a banner appear saying to upload the "Bizzdesign ImportSet Helper" update set, then do this first before continuing. For instructions, click here.

2. On the Configure Import page, enter the following data:

   
   
   Select Table: Select the table you want the objects from Horizzon to end up in. When importing objects from Horizzon the same type mapping will be used that is used to send objects to Horizzon. For example, if you select the table "Business Applications" and use the standard mapping, Application components from Horizzon will be added to the "Business Applications" table.
   Select Package: Select the model package from which the objects need to be retrieved.
   Select Model: Select the model in the package from which the objects need to be retrieved.
   Select Layer Type: Select the layer type from which the objects need to be retrieved.
   Select Layer: Select the layer from which the objects need to be retrieved.

3. Click Retrieve Datablock Definitions. Data block definitions are now imported from Horizzon and added to the table on the page.
4. Map the data block fields to a column (Target Field) from the selected table. Two standard fields are offered: object.object_idandobject.object_name. For some use cases it can be useful to add a custom field (column) to the target table that could be used to store the object.object_id.

   

   Primary key: Set a primary key for the field(s) that need to be used for identification of the object.
   Advanced field (optional): If you select this option, the app will not try to set the values coming from the source field (Horizzon) to the target field (ServiceNow). In that case, a custom mapping has to be created in the Transform map later on.

5. Click Generate and Save Configurations.If your mappings for the import are OK, you are done now. To run the configuration, go to the Configurations page, open the newly created configuration and click Run Configurations at the top of the page. Alternatively, if the option Active is selected in the configuration and in the transform map (which is by default), you can wait for the next scheduled job to run all active inbound configurations. Make sure that the system property for this has been activated.

   If your mappings need any adjustments before the import of objects, continue with the next step.

6. Click Open Transform Map at the bottom of the table to make the necessary changes. The map opens in a new browser tab.

   

   Select Run script. A script field will appear that can be used to customize the mapping, e.g., to add a discovery source or to map values from Horizzon to their corresponding ServiceNow values. Example:
   

   (Video) CSDM V3 Framework Mapping: Archimate V3

   (function transformRow(source, target, map, log, isUpdate) { // Add your code here target.discovery_source = 'Horizzon'; var dateTimeNow = new GlideDateTime().getDisplayValue(); target.last_discovered = dateTimeNow;})(source, target, map, log, action==="update");

7. When you are ready, click Update. A configurations overview page appears, showing the newly created configuration.

   

8. If you want to directly process the changes, click the Created field to open the new configuration and then click Run Configurations at the top of the page.Alternatively, if the option Active is selected in the transform map (which is by default), you can wait for the next scheduled job to run all active inbound configurations. Make sure that scheduled job is activated at the system properties.

Overview of import configurations

An overview of all configured imports can be found via the menu Bizzdesign Integration > Inbound > Configurations. For only your own configured imports, choose My Configurations. The overviews can be used to update the mappings, if needed.

Batch tracking

The Batches page provides an overview of the batches that are being processed and have been processed. There are separate pages for the inbound and outbound batches. You can select a batch in the list to see its details, e.g., if there is an error, this page will contain more information about the error.

In the menu, go to Bizzdesign Integration > Outbound > Batches Tracking, or Inbound > Batches Tracking.

Adding type mappings

If you are missing a source table that you would like to export to Horizzon, it is most likely because there is no out-of-the-box mapping for the ServiceNow object in that table to an ArchiMate type. On the Type Mappings page you can add and update the out-of-the-box mappings. If you want to update an existing type mapping, click the mapping in the list you want to update, make the changes and click Update to save the changes.

1. In the menu, go to Bizzdesign Integration >Type Mappings.

   

2. Click New and enter the following data:

   

   Type: Set the type of the mapping: Entity Type (object) or Link Type (relation).
   

   Horizzon: Enter the Horizzon object or relation type the class needs to be mapped to.
   ServiceNow: Enter the name for the ServiceNow class.
3. Click Submit to save the type mapping.

If you see the following banner when configuring an import, please upload the "Bizzdesign ImportSet Helper" update set. This update set prevents staging tables (needed for the Bizzdesign Integration App) to be deleted every 7 days. If you do not use this update set, staging tables will be deleted every 7 days and with that any customization you may have done for import mappings.

1. Download the update set.
2. In the Bizzdesign Integration app menu, go to System Update Sets > Update Sets to Commit.
3. Click Import Update Set from XML.
4. Click Choose File, select the Bizzdesign ImportSet Helper (sys_remote_update_set.xml), and click Upload.
5. In the update sets list, click the uploaded update set to open it.
6. Click Preview Update Set Batch in the upper right corner. In case of conflicts, select Accept remote changes.
7. Click Commit Update Set Batch.