Skip to main content
ExLibris
  • Subscribe by RSS
  • Ex Libris Knowledge Center

    Directory Search

    Overview

    The campusM Directory Search product integration allows users to search for individuals and view contact information, such as phone numbers and email addresses.
    The Directory Search product integration will be available for the September release.

    Vendors

    The Directory Search product integration is currently supported by the Azure Active Directory vendor.

    User Experience

    The following section describes information relating to the user experience for the Directory Search product integration.

    User Activities

    • Users can search the directory for an individual based on first or last name.
    • Users can select an individual from the directory to view the available contact information.

    Offline Support

    No offline support is provided. The user must be online to retrieve the directory data.

    Screenshots

    The following is an overview of the Directory Search product integration user interface for a reference when configuring it:

    Directory Search Directory Search Results Directory Search Contact Information
    directory_search.png directory_search_results.png directory_search_contact_information.png

    Technical Overview

    The following section describes technical information for the Directory Search product integration.

    Supported Versions

    The following version is supported: Microsoft Graph API v1.0.

    Prerequisites

    For information concerning prerequisites, see the Microsoft documentation for the Microsoft Graph API for Azure Active Directory. Complete steps 1 and 2:

    1. Register your app.
    2. Configure permissions for Microsoft Graph on your app.

    Configuration

    To configure the Directory Search product integration, select Product Integrations > Add Product Integration.
    Select Directory Search. The following table describes the configuration options available on this page. Note that while the majority of these fields are not mandatory, they are displayed with their default values unless otherwise stated.
    Configuration Option Description Mandatory Data Type Default Example
    Manage Integration
    Enable Product Integration Select to enable the product integration on the user's campusM app. No Checkbox Unselected  
    Product Integration Description A description of the product integration for internal use Yes String    
    Screen Title Appears in the top header (of the integration, in the app). No String Directory  
    Vendor
    Vendor Name Defines which vendor the integration connects to. Yes Object - Azure Active Directory
    Tenant Sets the tenant ID for the integration, your Microsoft 365 tenant ID is a globally unique identifier (GUID) that is different than your organization name or domain Yes String -  
    Client ID Sets the client ID for the integration Yes String -  
    Client Secret Sets the client secret for the integration Yes String -  
    Directory Page

    Filter Contacts

    Filters out contacts from displaying within the Directory

    No

    Boolean

    False

     

    Filter Code

    This defines the attribute that will be used to filter out users

    No

    String

    accountEnabled

     

    Filter Value

    This defines the value of the attribute that will be used to filter out users

    No

    String

    false

     
    Look and Feel
    Primary Theme Color Used for the Screen Title header and other header elements. No Color Picker #444444  
    Secondary Theme Color Used for the block headers. No Color Picker #6f8ea4  
    Text / Labels Enter replacement text for the default titles and labels No String    
    Directory Page Header This is shown at the top of the page No String Directory  
    Search Bar Text Sets the placeholder text in the search bar No String Enter search term . . .  
    Search Button Text Sets the text displayed in the search button No String Search  
    More Results Button Text Sets the text displayed in the button that displays additional results No String Show More Results    
    No Results Message Sets the texts that appears when the search returns zero results No String Your search did not match any records.  
    Service Failure Message Sets the message that appears when the integration is unable to reach or process the service call correctly No String The page is having trouble fetching the directory - please try again shortly  
    Job Title Label Text Sets the label for the job title field on the contact details page No String Job Title  
    Department Label Text Sets the label for the department field on the contact details page No String Department  
    Email Label Text Sets the label for the email field on the contact details page No String Email  
    Mobile Phone Label Text Sets the label for the mobile phone field on the contact details page No String Mobile Phone  
    Work Phone Label Text Sets the label for the work phone field on the contact details page No String Work Phone  
    Office Location Label Text Sets the label for the office location field on the contact details page No String Office Location  
    Display Labels If Empty Shows all the contact detail labels, even if the field is empty No Boolean No  
    Import/ Export Configuration
    You can configure product integration and then export it to another campusM environment, for example, from sandbox to production or from preview to production.  
    Export Create a JSON file with all product integration configuration. No      
    Import Use this option in order to load configuration from JSON of an exported product integration. No      
    • Was this article helpful?