LogoLogo
  • Welcome!
    • Previous Releases Release Notes
    • ASM Version 10.0 Release Notes
    • ASM Version 10.1 Release Notes
    • ASM Version 10.2 Release Notes
    • ASM Version 10.3 Release Notes
    • vFire Core Version 9
  • Use ASM
    • About the Alemba Service Manager Family
      • URLs and Access Parameters
        • System Access URLs
        • ASM Self Service Portal URLs
        • Pre-Populating Search Fields
      • Product Videos
    • Using the Self Service Portal
      • Logging on to Self Service Portal
        • Forgotten User ID and Password (Self Service Portal)
        • Password Expiry
      • Self Service Portal Home Page
      • Self Administration in Self Service Portal
        • Updating Your Contact Details
        • Changing Your Password
        • Delegating Work
      • Logging and Reviewing Tickets and Tasks/Approvals
        • Using the Logging Forms in Self Service Portal
        • Suggested Knowledge in the Self Service Portal
        • Reviewing Your Tickets in the Self Service Portal
          • Cloning Tickets in Portal
        • Off-Line Conversations with Support
      • Self Diagnosis from Self Service Portal
      • Searching the Knowledge Bank in Self Service Portal
      • Chat
        • Alembot - Chatbot
      • Service Request Catalog
    • Using Nano
      • Nano Feature List
      • NANO Video Tutorial - Quick Start
      • Nano Application
        • Viewing Your Workload in NANO
        • Viewing Bulletins
        • Nano Matching Panel
        • Using the Call, Request, and Task Details window
        • Working with Entities in Nano
        • Using Resource Manager in NANO
        • Viewing Your Outstanding Tasks
    • Using ASM Core
      • Getting Started
        • The ASM Core Window
          • The Information Panel
          • The View Option
          • The New Option
          • Configuring search results
        • Changing your Password
        • Generating an ASM statistics report
        • Printable Reports from within Core
        • Searching for Items
          • Outstanding Item Searches
          • Saved searches
          • Viewing Search Results in Graphs
        • Indicators - Icons
      • Managing Your Tickets - Calls and IPK
        • Working with Calls
          • About the Call Details Window
          • Cloning Option
          • Log New Request from Call
          • Watch Call
          • Change a Call from an Incident to a Problem, Known Error, Major Incident, or Service Request
          • About the Service Window
          • About the Call Information Panel
          • About the Matching Panel
          • Add Notes - Updating Your Tickets
            • Notes: Offline Conversations with the User
        • Call Details Explorer Options
          • Call Activities Explorer Option
          • Linking Explorer Option
          • Forum Analysts Explorer Option
          • AI Ops Explorer Option
          • Viewing Event Transactions from a Call or Request
        • Overview of CTI in Alemba Service Manager
          • Storing Telephone Numbers for CTI
        • Logging a Call
        • Using Quick Forms in ASM Core
        • Deferring a Call
        • Reassigning/Forwarding a Call(s) Internally
        • Forwarding a Call Externally
        • Creating an Outage from a Call
        • Closing a Call
      • Requests and Tasks
        • Viewing your Request Workload
          • Viewing Outstanding Requests
          • Searching for Requests
        • Submit a New Request
        • Searching for Tasks
        • Suspending a Task
        • Completing a Task
        • Sending email from a task
        • Forwarding a Task Internally - Reassignment
        • Completing an Approval
        • Managing Change Calendars
        • Managing Resources
          • Preparing to Use Resource Manager
          • Using Resource Manager
          • Allocating Tasks in Resource Manager
      • Ordering Service Actions within ASM Core
      • Adding Attachments
      • Managing your CMDB
        • Managing CMDB Items
          • Cloning CMDB Items
          • Completing CMDB Item Details
          • CMDB Linking Diagram
          • Freezing CMDB Items
          • Linking CMDB Items
        • Managing Your Assets
          • Managing Inventory Items
          • Managing Software Products
          • Thresholds Explorer Option
          • Managing Transactions
            • Purchasing Items
            • Reserving Items
            • Allocating Items
            • Transferring Ownership of Items
            • Retiring Items
            • Changing Availability Status of Items
            • Adding an order from a search field
          • Specifying Usage Criteria
        • Managing your Service Portfolio
          • Managing Services
          • Managing Service Actions
            • Defining the Outcome of Selecting a Service Action
          • Managing Service Bundles
        • Managing Organizations
        • Managing Locations
        • Managing Cost Centers
        • Managing Jurisdictions
        • Managing Subscriber Groups
        • Managing Stakeholders
        • Options in the CMDB Items Explorer Pane
        • Allocating Change Windows to CMDB Items
        • Managing People
        • Managing Contracts
        • Managing Availability
          • Managing Outages
          • Impact Criteria
          • Displaying Outages
        • Managing Agreements
          • Defining Agreement Thresholds
          • Linking Service Items to an Agreement
          • Attaching Selection Criteria to Agreements
          • Agreement Measurements
      • Configuring AI Ops
        • Using the AI Ops Wizard
        • Managing AI Ops Rules
      • Knowledge Management
        • Managing Knowledge Entries
        • The Knowledge Bank Explorer
        • Viewing Knowledge Entries
        • Knowledge Administration
      • Configuring Reminders
      • Using IPK Workflow Rules
        • Part 1 - Building the Workflows
        • Part 2 - Defining Workflow Criteria Rules
          • Defining Call Fields for IPK Rules
        • Part 3 - Assigning Workflows to Rules
        • Configuring Call Auto Close Rules
        • Running Multiple Workflow Types on a Call
      • The Bulletin Board
        • Viewing Bulletins
        • Managing Bulletins
      • Using Timesheets
      • Scheduling Calls and Requests
      • Quick Forms Quick Start Guide
      • Instant Messaging/Internal Messages
      • Sending an Email
        • Finding Recipients
      • Delegation Setup
    • Dashboards and Reporting
      • Dashboard Configuration and User Learning Guide
      • Descriptions of Default Reports and Dashboards (SDI Classifications)
        • 8.3 Number of Incidents and Service Requests
        • 8.4 Average Time to Respond
        • 8.6 Average time to resolve incidents or fulfill service requests
        • 8.7 First Contact Incident Resolution and Request Fulfilment Rate
        • 8.8 First Level Incident Resolution and Request Fulfillment Rate
        • 8.9 Reopned Incident Rate
        • 8.10 Backlog Management
        • 8.11 Percentage of hierarchic escalations
        • 8.21 Percentage of Functional Escalations copy
        • 8.23 Average incident resolution time by priority
        • 8.24 Average request fulfilment time by priority
        • 8.25 Average resolution time by incident category
        • 8.26 Average fulfilment time by service request type
        • 8.27 Comparison of service level targets to performance
        • 8.28 Service Desk Knowledge Usage
        • 8.29 Customer Facing Knowledge Usage
        • 8.30 Service Desk Knowledge Quality and effectiveness
        • 8.31 Customer facing knowledge quality and effectiveness
        • 8.33 Monitoring Incidents caused by changes measured against target
        • 8.34 Total cost of service delivery
        • 8.35 Average cost per incident by channel
        • 8.36 Average cost per service request by channel
        • 8.43 Problem records created through proactive problem management
        • 8.44 Incident reduction through problem management
      • Install SDI Reporting Pack
      • Dashboards and Reports (.sydx Files)
      • Connecting to Power BI/Other Data Sources
      • Sample SQL Queries
      • Migrating your Syncfusion Dashboards to a New Server
  • SetUp & Configure ASM
    • Licensing
      • Licensing model
      • ASM Person Licenses
    • Installation and Upgrade
      • Alemba Service Manager On-Premise Architecture
      • HERMES Installation Guide
        • HERMES Prerequisites
        • Upgrading/Installing ASM to HERMES Step by Step Guide
      • EOS Installation Guide
        • Upgrading/Installing ASM to EOS Step by Step Guide
        • EOS Prerequisites
        • EOS Known Issues
      • GAIA Installation Guide
        • Upgrading/Installing ASM to GAIA Step by Step Guide
        • GAIA Prerequisites
      • Installation PowerShell Parameters
        • Administration Using PowerShell Scripts
      • Installation Guide for Syncfusion Dashboards
        • Part 1-Syncfusion Dashboard Server Installation
        • Part 2-Syncfusion Server Check HTTPS Binding has been Configured
        • Part 3-Syncfusion Server User Management Server (UMS) Configuration
        • Part 4-Syncfusion Server Configure the Dashboard Server
        • Part 5-Syncfusion Server Patching the Scheduler Service
      • Upgrading from vFire 9.2 or Below
      • Installing and upgrading on Multiple Web Servers
      • About Installing or Patching to ASM 10.1
      • Upgrading where downloading files is not possible
      • On Premise Architecture Diagrams
      • Configuring external network access to ASM
      • About the Polling Services
      • Configuration or Customization
      • Uninstalling ASM Core
    • Setting Up your System
      • Logging in as Administrator
      • Configuring an existing system
      • Configuring Nano
        • Configuring Nano
        • Request Phases
      • Setup Email
        • Setting Up Incoming and Outgoing Email
          • Email Server Configuration
          • Methods of Authentication for Mail Servers
          • About - Incoming Email
            • Recognized Incoming Email Subject Headings
          • Incoming POP3, IMAP, and MAPI Email Server Settings
            • Configuring MAPI
          • Incoming Email via API
          • How the Logging Analyst is Determined on an Incoming Email
          • Outgoing SMTP and MAPI Email Server Settings
          • Outgoing Email via Web Hooks
          • Configure Azure MS Graph API
          • Configuring Exchange Web Services (EWS)
            • Prerequisites
            • EWS - Configure Outgoing Email
            • EWS - Configure Incoming Email
            • EWS - Authorize the Connection
            • EWS - Troubleshooting
        • Mail Message Access (MMA)
      • Setup IM (Internal Messaging)
      • System Administration Settings
        • Custom Global Profile Fields
        • System Settings Menu
          • Your Organization
          • Partitioning
            • Configuring Partitions
            • Partition Settings
          • System Settings
          • Security Profiles
          • Server Time Zone
            • Storing Time Zone Information
            • Time Zone Settings
          • Defining Working Hours
          • Defining public holidays
          • Reset References
          • System Source Titles
          • Browse Limits
          • Messaging
          • Message Types
            • Message Type Definitions
          • Pager Settings
          • Pager Types
          • Activity Log
          • Stored Procedures
          • System Titles
          • Quick Launch
          • Quick Notes
          • Auditing
            • Administration Audit Trail
          • User and Analyst Search Field Settings
        • Security
          • Security Settings
          • Security Settings (Partitioned)
          • IPK Groups
          • Workflow Management Groups
          • Controlling log in
        • Security Roles
          • General Access Security Role
            • Admin Tab
            • Timesheets Tab
          • IPK Management Security Roles
            • IPK Management Role: Options Tab
            • IPK Management Security Role: Groups Tab
            • IPK Management Security Role: IPK Streams Tab
            • IPK Management Security Role: IPK Statuses Tab
            • IPK Management Security Role: Forms Tab
            • IPK Management Security Role: Quick Launch Tab
            • IPK Management Security Role: Fwd Groups Tab
          • Workflow Management Security Roles
            • Workflow Management Security Role: Shared Tab
            • Workflow Management Security Role: Requests Tab
            • Workflow Management Security Role: Tasks Tab
            • Workflow Management Security Role: Processes Tab
            • Workflow Management Security Role: Groups Tab
            • Workflow Management Security Role: Request Screen Sets Tab
            • Workflow Management Security Role: Task Screen Sets Tab
            • Workflow Management Security Role: Appr. Screen Sets Tab
            • Workflow Management Security Role: User Approval Screen Sets Tab
            • Workflow Management Security Role: External Supplier Screen Sets Tab
            • Workflow Management Security Role: Closure Task Screen Sets Tab
            • Workflow Management Security Role: Forms Tab
            • Workflow Management Security Role: Template Tab
            • Workflow Management Security Role: Request Quick Launch Tab
            • Workflow Management Security Role: Task Quick Launch Tab
          • Configuration Management Security Roles
            • Configuration Management Security Role: CMDB Items Tab
            • Configuration Management Security Role: People Tab
            • Configuration Management Security Roles: Organizations Tab
            • Configuration Management Security Role: Locations Tab
            • Configuration Management Security Role: Contracts Tab
            • Configuration Management Security Role: Subscriber Groups Tab
            • Configuration Management Security Role: Cost Centers Tab
            • Configuration Management Security Role: Jurisdictions Tab
            • Configuration Management Security Role: Forms Tab
          • Service Level Management Security Roles
            • Service Level Management Security Role: Options Tab
            • Service Level Management Security Role: Forms Tab
          • Availability Management Security Roles
          • Knowledge Management Security Roles
            • Knowledge Management Security Role: Options Tab
            • Knowledge Management Security Role: Content Access Tab
            • Knowledge Management Security Role: Statuses Tab
          • Bulletin Board Security Roles
          • Dashboard Management Security Role
            • Dashboard Security Role Options
          • Integration Security Role
        • IPK and Workflow
          • Incident, Problem & Known Error (IPK) Management
            • Configuring IPK Settings
            • IPK Settings (Partitioned)
            • Action Type
            • Call Attributes
            • Call History Types
            • Call Impact
            • Call Physical Statuses
            • Call Priority
            • Call Screen Sets
            • Call Stakeholder Roles
            • Call States
            • Call Status Titles
            • Call Urgency
            • Closure Groups
            • Custom Call Profiles
            • User Survey
            • User Survey Screen Set
            • IPK classes
            • IPK Streams
            • IPK Statuses
            • Link Stream/Status to Call Screen Set
            • Link Type/Stream/Status to Call Screen Set
            • Link Screen Set to Reasons
            • Limit Type by IPK Status
            • Link Type to Call Screen Set
            • Link Type to Reason
            • Priority Matrix
            • Configuring Quick Forms
            • Quick Solutions
            • Reasons
            • Scripting
            • Type Tiers
            • Email and Pager Options for IPK and Workflow Groups
          • Workflow Management
            • Workflow Management Settings
            • Workflow Attributes
            • Approval Types
            • Request Action Types
            • Request Implementation Profiles
            • Request Implementation States
            • Request Link Types
            • Request Physical Statuses
            • Request Phases (Nano)
            • Request Priority
            • Request Risks
              • Request Risk Assessment
              • Request Impact
              • Request Complexity
              • Request Risk Assessment Matrix
            • Screen Sets for Requests, Tasks and Approvals
            • Linking Approval Screens to Partitions
            • Request Stakeholder Roles
            • Request Completion Statuses
            • Request Types
            • Task Action Types
            • Task Phases
            • Task Physical Statuses
            • Task Priority
            • Task Status Titles
            • Task Types
            • Workflow Management History Types
            • Request History Filters
            • Workflow Processes
            • Workflow Export and Import - Workflow Porting
        • Service Level Management
          • SLM Settings
          • Agreement Attributes
          • Agreement Selection Priority
          • CMDB Selection Priority
          • Agreement Stakeholder Roles
          • Agreement Statuses
          • Exclusion Reasons
          • Agreement Types
          • Event Activity Types
          • Agreement Matrices
          • Measurement Types
          • Payment Types
        • CMDB (Configuration Management Database)
          • CMDB Settings
          • CMDB Service Levels
          • CMDB Item Classes
          • CMDB Item Criticality
          • CMDB Item Physical Statuses
          • CMDB Item Types
          • CMDB Link Status
          • CMDB Link Types
          • Contract Support Type
          • Contract Types
          • Cost Center Category
          • Custom CMDB Profiles
          • Person Profile
          • External Contact Type
          • User VIP Statuses
          • Disposal Methods
          • Financial Statuses
          • Financial Category
          • Freeze Statuses
          • Link Manufacturer to Model Type
          • Manufacturers
          • Model Types
          • Organization Profiles
          • External Supplier Statuses
          • Purchase Method
          • Service Link Types
          • Service Portfolio Statuses
          • Service Cost Types
          • Service Periods
          • Asset Management - Asset Lifecycle Status
          • Asset Management - License Type
          • Asset Management - Transaction Status
          • Self Service Portal Display Categories
          • Stakeholder Roles
        • Availability
          • Configuring Availability Management
          • Outage Types
          • Schedule Definition
        • Depreciation
          • Batch Run Parameters
          • Depreciation by CMDB Item Type
          • Depreciation Methods
          • Depreciation Schedules
        • Knowledge Bank
          • Knowledge Bank Settings
          • Knowledge Base Types
          • Knowledge Entry Types
          • Knowledge Profiles
          • Knowledge Ratings
          • Knowledge Statuses
          • Knowledge Document Import
        • Bulletin Board
          • Configuring the Bulletin Board
          • Bulletin Board Priorities
          • Bulletin Stakeholder Roles
        • Text Retrieval
          • Common Words
          • Keywords
          • Synonyms
        • Dashboards
        • Self Service Portal
          • Self Service Portal Settings
          • Self Service Portal Settings (Partitioned)
          • Self Service Portal Roles
            • Options Tab
            • CMDB Tab
            • Content Access Tab
            • Workflow Templates Tab
            • Call Templates Tab
            • Dashboard Management Tab
          • Self Service Portal Systems
          • Self Service Portal My Options
          • Self Service Portal Tables
          • Service Order Status Titles
          • Question Mappings
          • Catalog Promoted Items
          • Suggested Knowledge in the Self Service Portal
          • Creating Custom Pages
          • Link Organization to Portal Key
        • Nano
        • Preview Features/Advanced Options
          • Settings
            • Multi Language
            • Call Activities
            • Enable Active Directory Mappings to Sub Groups
            • CTI
              • Setting up the Alemba Service Manager CTI
            • SignalR Scale Out Options
            • External Chat tool Integrations
          • Portal Settings
          • Global Search
          • Chat Bot
    • FAQ
    • Moving Configurations, Workflows and Screens From Test to Production
    • Designing/Configuring your System
      • Configuring Screens
        • Creating New Screen Sets
        • Screens Available for Configuration using ASM Designer
        • Building Screens in ASM Designer
          • Configuring Fields
          • Creating a Custom Field
          • Deleting Fields
          • Building Screen Widgets
          • Knowledge Article Screens
          • Configuring Message Templates
          • Importing/Exporting Screens
        • Dynamic Screens
          • Deep Linking Field Data Across Screen Sets
          • Field Calculations & Risk Calculation
          • Using Rules
          • Adding Images and Progress Indicators to your screens
        • Deleting a Custom Screen
        • Configuring Button Labels
      • Customizing Options for the Self Service Portal
      • Styling the Self Service Portal
      • Call Template Administration
      • Workflow Template Administration
        • Steps for Workflow (Request Template) Creation
          • Basic Process for Building a Workflow
          • Managing Tasks - Adding Tasks to the Dependency Diagram
            • Task Types in the Task Palette
              • Defining Request Start Details
              • Creating a Task
              • Creating a Standard Task
              • Create Request Task
              • Creating an Approval Task
              • Creating a User Approval Task
              • Conditional Branching Tasks
                • Defining a Dependency Rule
                • Defining Dependency Actions
              • Creating a Messaging Task
              • Creating a Delay Task
              • Creating a Manage CMDB Task
                • Recursive CMDB Task
                • Adding Transactions to a Manage CMDB task
                • Asset Management Transactions in a Manage CMDB Task
                • Mapping Fields to be Updated by a Transaction
              • Creating an Outbound Action Task
              • Creating an SLM Start Clock/Stop Clock Task
              • Creating an External Supplier Task
              • Creating a Run External Procedure Tasks
              • Creating a Change Window Task
              • Creating a Closure Task
              • Creating an Activation Task
          • Create a Service Action and Attach a Workflow to it
          • Setting Up Post Provision Service Actions
          • Troubleshooting Workflow and Service Action Linking
        • Component Workflows
        • Setting Up Amendable Requests
        • Sharing Parent Request Items with Child Requests
      • Planning Knowledge Management
      • Accessibility Features
      • Common ASM Use Cases and Solutions
        • Use Cases - Workforce and Talent Management
          • Example Configuration
        • Use Cases - Service Validation and Testing
          • Example Configuration
        • Use Cases - Project Management
          • ASM Project Management How-To Videos
        • Use Cases - Setup Major Incident Management
        • Use Cases - Business Continuity Planning
        • Use Cases - Environmental Impact Analysis (for TBL Accounting)
        • Use Cases - Capacity Planning
        • Use Cases - Knowledge Management
          • Enable and Configure the ASM KB
    • Limited Support/End of Life Capabilities
      • Configuration Portability
        • Overview & Best Practices
        • Porting Configuration Data
        • Viewing the Export and Import Logs
      • Ask a Question in Self Service Portal
      • Server Console
        • Accessing the Server Console
        • Creating a New ASM System
        • Server Console system tasks
        • Customization nodes
        • SQL Server and Table Ownership
        • Updating Scripts
        • ASM Core Registry Keys
      • Concurrent Licensing
        • License Corrals
      • Alemba Classic API
        • Programming with the Classic API
          • WCF Client
        • Code Examples
        • Return Values
        • API Message Types
        • API Lookups
        • API Transactions
          • Availability Transactions
          • Call Transactions
          • CMDB Item Transactions
          • Contract Transactions
          • Cost Center Transactions
          • Jurisdiction Transactions
          • Location Transactions
          • Organization Transactions
          • Person Transactions
          • Subscriber Group Transactions
          • Knowledge Transactions
          • Bulletin Transactions
          • System Transactions
            • Session Transactions
            • Add Note Transactions
            • Attribute Transactions
            • Development Transactions
            • Message Transactions
            • Object Transactions
            • Stakeholder Transactions
          • Workflow Transactions
            • Workflow (Request) Transactions
            • Task Transactions
        • API Classes
        • API WSTester Application
  • Integrate
    • Integration Overview
    • Managing Integration
      • Setting Up the Integration Platform
        • Defining Connectors
        • Defining Sources
        • Configuring an Integration Source
        • Resource Mapping
        • Defining Property Transforms
        • Defining Profile Maps
        • Defining Resolution Rules
        • Defining Link Type Mapping
      • Single Sign-On using SAML
        • Integrated Security vs. Single Sign On
        • Technical and Access Requirements
        • Configuring ASM for Single Sign-On
        • Importing Identity Provider Metadata
        • Service Provider Signing Certificate
        • Configuring the Service Provider
        • Exporting Service Provider Metadata
        • Importing Service Provider metadata into the Identity Provider
        • SSO Troubleshooting
        • SSL Binding
        • Creating a Self Signed Certificate
        • Extending the Single Sign-On Connector
      • Configuring Azure Active Directory discovery
      • Azure Multi-factor Authentication
      • Viewing Integration Activity
        • Viewing Integration Log
      • Connectors to ASM Core
        • Connector Matrix
        • Installing Connectors
        • CMDB Connectors
          • Altiris Network Discovery Connector
          • CA Cohesion Connector
          • Centennial Discovery/FrontRange Connector
          • EMC Smarts NCM Connector
            • Service Assurance Manager Connector
          • LANDESK Connector
          • Microsoft Azure Connector
          • Microsoft SCOM Connector
          • Microsoft SMS and SCCM Connector
          • Snow Connector
          • SolarWinds Connector
          • VMware Application Discovery Manager Connector
          • VMware vCenter Configuration Manager Connector
          • VMware vCloud Director Connector
          • vRealize Orchestrator Connector
        • LDAP Connectors to ASM Core
          • Microsoft Active Directory Server Connector
          • Novell eDirectory Server Connector
        • Generic Connectors to ASM Core
          • Email Event Connector
          • External Process Connector
          • Stored Procedure Connector
          • ASM to ASM Connector
          • Jira Connector
            • Developer Notes for the Jira ICNF
          • CSV File Connector
          • MS Azure DevOps Connector
          • Connector Suite for MS SQL Server Tables
          • Resource Databases Connector
            • Tutorial for Configuring the Database Resources Connector
      • Build your Own Connector
        • How to Build Your Own Connector
      • Managing the Federated CMDB
        • Managing Scheduled Integration Scans
      • Managing External Resources
      • Selecting Fields for Mapping
      • Managing Inbound and Outbound Actions
        • Configuring Inbound and Outbound Actions
          • Configuring Outbound Actions
            • Using Outbound Actions
          • Configuring Inbound Actions
        • Inbound or Outbound Action Source Parameters
      • Managing Events
        • Configuring Event Management
          • Event Management Source Parameters
          • Viewing Event Types
          • Managing Event Type Mappings
        • Using Events
      • Webhooks
      • Canvas App Widgets
      • Microsoft Teams Chat Integration
      • Microsoft Project Integration
      • Connector Diagnostics
    • API's
      • Alemba RestFul API
        • Alemba API Architecture
        • Installing the Alemba API
        • Logging In to the Alemba API Explorer
        • Navigating the Alemba API Explorer
        • Alemba API Programmers’ Guide
        • Alemba API Programmers' Cookbook
          • Recipes
        • Alemba API Related Database Tables
        • Using API Reporting Views
        • Authentication
          • Configuring Authentication for the Alemba API
          • Configuring Windows Authentication for the Alemba API
          • Configuring Single Sign On using SAML for the Alemba API
      • Azure/ Web API/Logic Apps
Powered by GitBook
On this page
  • What problems does building a connector via the Connector Designer solve?
  • What types of data are supported?
  • What happens after you build the connector in the configuration process?
  • Check out the following examples for some ideas
  • DEVICE 42 CMDB CONNECTOR USE CASE
  • ALEMBA API CONNECTOR USE CASE
  1. Integrate
  2. Managing Integration

Build your Own Connector

The Connector Builder Page allows you to develop custom connectors so you can integrate other external applications seamlessly with ASM.

PreviousTutorial for Configuring the Database Resources ConnectorNextHow to Build Your Own Connector

Communication with the supported external applications is performed through connectors that you can now build in the Connector designer page in ASM, rather than wait for others to build and install them on your server.The Connector Builder page only supports building custom CMDB connectors for the time being.

Available in HERMES (ASM Version 10.6) and higher

What problems does building a connector via the Connector Designer solve?

You can create a custom connector from scratch, build it exactly how you want it and get the information exactly how you need it!

You can now build a custom connector in ASM that will allow you to communicate with external applications to discover resources on those applications. Once detected, those resources can be imported into ASM as Federated CMDB records or lined to the existing CMDB records.

To create a custom connector, you must describe the API you want to connect to so that the connector you’re building understands the API’s operations and data structures.

In the Connector Builder page, you can determine the types of resources to be imported from the supported categories: Bulletin, CMDB Item, Contract, Cost Center, Knowledge, Location, Organization, Person and Subscriber Group.

What types of data are supported?

Depending on the 3rd party system and the type of data it provides, you can choose and specify which type of value a variable has.

What happens after you build the connector in the configuration process?

Once your connector has been built and tested, you can put your custom connector to work.

You will need to configure the connector for ASM to successfully connect to the 3rd party source with the specified parameters.

  1. Define a source to configure instances of external sources with which ASM can connect in order to import or update objects and exchange information. For integration with the Federated CMDB, a source is the system to which ASM can connect to import objects discovered by a network discovery tool into ASM or import users from a directory server.

  2. Configure the resources that you defined in the Connector Builder. This enables you to view the resource type configured on a selected source and create mappings for each of these resource types. This will allow you to create mappings between the external resource and ASM CMDB item fields.

  3. You can view and create schedules for running scans on sources for the purpose of importing external resources.

  4. You can view the resource link types configured on a selected source and create mappings for each of these link types.

  5. You can set up appropriate security rights for Analysts to manage external resources

Check out the following examples for some ideas

DEVICE 42 CMDB CONNECTOR USE CASE

Build and use a Device 42 Connector to get a complete out of the box CMDB integration based on all the accurate and correct data Device42 will collect. This will give you a complete full view of your IT infrastructure to identify, manage and verify all your configuration items in your system.

  • Client has been using the Device 42 Platform to document and manage his IT infrastructure in order to prepare for a Hardware Audit.

  • Client also uses Alemba Service Manager but not all the hardware infrastructure has been introduced in the system, the CMDB has recently started to be populated with CMDB items.

  • Client wants to collate all the information in a single record – in ASM.

  • Client will be able to connect to the Device 42 platform by building and defining a custom connector in the new Connector Builder Page in ASM:

    • Connector Details: Device 42 Connector, chooses authentication type according to needs and preferences.

    • Resource category: client determines the type of resources to be imported-configuration item in this case, gives the resource a name-Device, ID and a description so that resource can be used and identified in ASM.

    • Client needs to populate the Query section with 3 different types of API calls from Device 42.

    • Query All will run when retrieving all the resources (configuration items-Devices) in Device 42, runs a federated scan.

    • Query Search runs when the Client will do a Search External Resources in ASM and it will bring back a live view of Device 42 with all the listed devices.

    • Query Retrieve runs and brings back all the details when you select an individual item, a Device to see all the details.

    • Resource unique identifier field: client will put the JSON attribute of the resource unique ID (device_id), the resource display name (Name) and resource las modified field (last_updated) and specify the data type for each one as appropriate (Integer, String, etc).

    • Client creates a field set or multiple field sets to determine how the readable data retrieved from the Device42 platform will be represented as a list of fields in ASM and whatever will be specified here will appear in the Field mapping section when the connector will be configured. Field sets type needs to be specified, whether mapped (defines a query to execute to retrieve the raw field data while a list of field definitions define how individual fields should be extracted from the query results returned) or relative (works in a similar fashion, however does not execute a query, the fields are extracted from data associated with the current bookmark). It is important for the Client to ensure that all query definitions provide all the necessary data in which fields are retrieved (e.g. all, search and retrieve)).

    • Client will run a test to run the queries to make sure that the API calls work as expected. Client will find in the Response section on the Test page all the information from that API call.

    • Client will need to configure the connector for ASM to successfully connect to Device 42 source with the specified parameters. Client will view the Device resource configured on the Device 42 source and will create mappings between this resource and CMDB item fields in ASM.

    • All the information will be imported in ASM, giving the client a single pane of glass on his IT estate.

ALEMBA API CONNECTOR USE CASE

Build and use a Alemba API Connector to create, update, delete or retrieve entities, such as CMDB items. This can help you integrate with another ASM system to keep the resources in sync in both ASM instances.

  • Client has been using the ASM test system and has added new resources on that system in order to do some testing on that system.

  • Client also has Alemba Service Manager in production, but the new resources haven't been added here.

  • Client wants to collate all the information in a single record – in ASM production• Client will be able to connect to Alemba API Explorer and build a custom connector in the new Connector Builder Page in ASM:

    • Connector Details: Alemba Test to Prod Connector, chooses authentication type according to needs and preferences.

    • Resource category: client determines the type of resources to be imported-configuration item in this case, gives the resource a name-Person New HR, ID and a description so that resource can be used and identified in ASM production.

    • Client needs to populate the Query section with 3 different types of API calls from Alemba API Explorer.

    • Query All will run when retrieving all the resources (Person New HR) in the ASM test system, runs a federated scan.

    • Query Search runs when the Client will do a Search External Resources in ASM and it will bring back a live view of the ASM test system with all the listed person names and details.• Query Retrieve runs and brings back all the details when you select an individual item, a Person to see all the details.

    • Resource unique identifier field: Client will put the JSON attribute of the resource unique ID, the resource display name and resource las modified field and specify the data type for each one as appropriate (Integer, String, etc). Client will need to verify the name in the Property fields in the Alemba API Explorer page.

    • Client creates a field set or multiple field sets to determine how the readable data retrieved from the Alemba Test system will be represented as a list of fields in ASM and whatever will be specified here will appear in the Field mapping section when the connector will be configured.

    • Client will run a test to run the queries to make sure that the API calls work as expected. Client will find in the Response section on the Test page all the information from that API call.

    • Client will need to configure the connector for ASM to successfully connect to the ASM Test system source with the specified parameters. Client will view the Person New HR resource configured on the ASM Test to Prod source and will create mappings between this resource and CMDB item fields in ASM production.

    • All the information will be imported in ASM production, giving the client a single pane of glass on his person records, including the new resources that were only added in the ASM test system.