Skip to content

Directory Configuration

Enterprise Directory enables centralized employee contact management across your organization. This feature streamlines workflows by providing users with quick access to colleague information through intelligent search, customizable filters, and rich contact profiles, while giving administrators flexible configuration options for data sources, field mapping, and display settings.

Accessing the Enterprise Directory

Follow these steps to access and use the Enterprise Directory:

  1. Access the Directory
    1. Navigate to the application.
    2. Select Enterprise Directory to view the contact list.
    3. Alternatively, access your personal contact card through the Profile section.
  2. Browse Contacts
    1. Upon opening the directory, see a list of contacts ranked by designation.
    2. The interface displays contacts in an organized, hierarchical view based on organizational structure.

Searching and Filtering Contacts

Locate colleagues efficiently using the directory's search and filter capabilities.

  • Search Bar: Enter keywords in the search bar with real-time suggestions as you type. The system provides instant results matching names, designations, departments, or other searchable fields.
  • Apply Filters: Use default filters to narrow your search: Department, Designation, First Name, Location, and any additional custom filters your admin configures.

Contact Cards

Search results display compact contact cards showing Name, Designation, Team, Phone number, Email address, and other fields your admin configures.

Viewing Detailed Information: Click any contact card to open a side panel view. The side panel includes an option to expand to full-page view for comprehensive details.

The detailed contact view displays the Profile Picture, default fields (Name, Designation, Team, Email, Phone, Location, Time Zone, Employee ID, Manager, Reportees, and Team Members), and any additional custom fields that the admin configures.

user-details

Admin Setup and Configuration

Follow these steps to configure the Enterprise Directory:

  1. Access the Admin Console
    1. Navigate to Admin Hub in the left pane.
    2. Select Connections to access integration options.
    3. Choose Enterprise Directory.
  2. Initiate Directory Setup
    1. Click Add Directory Source to begin configuration.
    2. The Enterprise Directory Configuration Wizard guides you through the setup process.

Step 1: Source Configuration

Configure the directory data source. The system supports the following methods:

Service Accounts (Microsoft, LDAP)

Access directory data securely using a configured service account. This method automatically syncs employee information from your organization's identity provider.

  1. Select Service Accounts (Microsoft, LDAP) as your data source method.
  2. From the dropdown, choose the pre-configured service account you want to use (for example, Microsoft service Account).
  3. The system connects to your identity provider using the selected service account credentials to pull directory data.

Service accounts are configured in advance under Security > Service Accounts before they appear as available options in the directory source configuration.

Push Data to Directory through API

Send data directly to this directory using the API. Integrate your system to securely push updates or new entries in real-time using supported endpoints and authentication.

  1. Select Push Data to Directory through API as your data source method.
  2. Click Get API Details to Push Data to view integration instructions, including API endpoint URL, authentication credentials, required data format and schema, and sample API request payload.
  3. Implement the API integration in your system to push employee data to the directory.

Step 2: Field Configuration

Customize fields to capture relevant employee information for your organization.

Field Mapping for Service Account

When using a service account source, the system presents a field mapping interface with default fields pre-populated with mapping keys from your identity provider.

  • The Customise fields section displays all available fields in a two-column layout: Label (the field name displayed in the directory) and Mapper (the corresponding data key from the source system).
  • Default fields such as Display Picture, First Name, Last Name, and Designation are pre-mapped to their respective source keys (for example, data.fName, data.lName, data.designation).
  • Use the Select mapper dropdown on any field to assign or change the mapping key from the source data.
  • Add new custom fields to capture organization-specific information beyond the defaults.
  • Modify the key mapping on any field to align with your source system's data schema.
  • Remove custom fields that are not required. The system protects default fields from deletion.
  • At least one field must have a valid mapping to proceed.
  • Click Next to continue to the sync configuration.

Field Management for Push API

Simplified field management without a mapping interface.

  • Add fields as needed to capture organization-specific information.
  • Remove custom fields that are not required.
  • The system protects default fields (Name, Designation, Phone, and Email) from deletion.
  • Configure at least the four mandatory fields: Name, Designation, Phone, and Email.

Custom Fields: Add any additional fields relevant to your organization. You can add or remove custom fields at any time.

Step 3: Data Synchronization

Monitor and manage data synchronization between your source system and the directory.

Sync for Service Account

When using a service account source, the directory provides manual and scheduled sync options to keep data current.

  • Sync Now: Click the Sync now button to trigger an immediate data sync from your identity provider. The system pulls the latest employee data and updates the directory.
  • Sync Summary: After each sync, the system displays the Last Updated timestamp (for example, "05:47 PM IST - 26th Feb 2026") along with a summary of changes: number of records Added, Updated, and Deleted during the sync.
  • Schedule Sync: Configure automatic sync schedules to keep the directory updated without manual intervention. Set the following options:
    • Frequency: Choose from Daily, Weekly, Monthly, or Never.
    • Day: Select the specific day for the sync to run (for example, Monday for weekly, or 1–31 for monthly).
    • Time: Set the time of day for the sync to execute (for example, 12:00 AM).
    • The default schedule is set to Never. Configure a recurring schedule to ensure directory data stays in sync with your identity provider.
  • Click Done to save the sync configuration.

API Integration for Data Sync

The directory updates automatically when your system pushes data through the API.

  • API Token Management: Access your API authentication token from the Get API Details to Push Data section. Store the token securely in your system, include the token in the auth header of all API requests, and regenerate tokens periodically for security compliance.
  • Display Information: The Last updated timestamp shows when data was last pushed to the directory. The Summary of records displays the number of records added, updated, or deleted in the last push.
  • Manual Updates: Trigger data updates from your system by calling the Push API endpoint with updated employee information.

Step 4: Display Settings

Configure how contacts appear to end users after completing data setup.

Hide Conditions:

Control contact visibility using hide conditions:

  • Full string match: Hide contacts where the field exactly matches the specified value.
  • Starts with: Hide contacts where the field begins with the specified prefix.
  • Use hide conditions to exclude test accounts, inactive employees, or specific user groups from the end-user view.

Detail Card Layout:

Customize the contact detail card appearance and field order.

  • The system displays a preview of the Detail Contact card with an Edit Layout option.
  • Click Edit Layout to customize:
    • Reorder field display (except Name, Designation, Phone, Email – these are fixed at the top).
    • Hide non-essential fields (four mandatory fields cannot be hidden: Name, Designation, Phone, Email).

Reordering Fields:

  1. Drag and drop fields to the desired position in the layout.
  2. Preview changes in real-time.
  3. Ensure critical information appears prominently for end users.

Filter Settings:

Configure which fields are available as search filters for end users.

  • Select single-select fields to expose as filters.
  • Common filter options include Department, Designation, First Name, and Location.
  • Enable filters for the most commonly searched attributes to improve user experience.
  • Only fields with discrete values (not free text) are configured as filters.

Step 5: Publishing the Directory

Publish your directory and define access permissions.

  1. Complete Configuration: Ensure data is available in the directory—either synced through a service account or pushed through the API—and complete the display configuration. The system prompts you to publish the directory.
  2. Choose Publishing Scope: Publish to all users makes the directory immediately available to everyone in the account, or Keep unpublished saves configuration for later activation.

Publishing Requirements: At least one contact record must be available in the directory before the system enables publishing. Ensure employee data has been synced or pushed before attempting to publish.

Admin View After Publishing: View the publish status indicator (Published/Unpublished), data settings summary showing the last synced date (for service account sources) or last updated date (for API push sources) and record count summary (total contacts, recently added, updated, or deleted), display settings overview, and live preview of how the directory appears to users.

Managing Individual Contacts: Administrators can hide individual contacts from the live preview. Navigate to the preview section in the admin console, hover over any contact card to reveal the hide option, and click the hide icon to exclude that specific contact from the user view. Hidden contacts remain in the directory data but are not visible to users.

Finalise Deployment: Click Publish to make the directory available to users. The directory appears in the application menu for users based on the selected publishing scope.