LDAP Configuration

The LDAP Interface, when enabled, provides the ability to configure LDAP settings within the RALS™ SYSTEM for one or more LDAP servers.

Jump to a heading on this page:
Sync Status
Sync Options
Test Connection
LDAP Filters
Operator Defaults
LDAP Attribute Mappings
Institution Access
Adding
Editing
Cloning
Deactivating or Deleting
Fields

Sync Status

An LDAP configuration’s sync status will be in one of the following states:

Icon	Status	Notes
	Successful	Last LDAP sync was successful
	Pending	LDAP sync is in progress
	Error	Last LDAP sync encountered an error due to any problem or failure other than a connection problem; when displayed, refer to the Last Failure Reason field for more information regarding the type of error
	Failed	Last LDAP sync failed due to a connection problem with the LDAP server
	Never Synced	No LDAP sync has ever been requested

Sync Options

Sync options determine which action(s) the LDAP Interface will take when importing operators from an LDAP server. One or more of the following sync options may be selected for an LDAP configuration:

• Add Operators (see Adding Operators via the LDAP Interface for more information)
• Edit Operators (see Editing Operators via the LDAP Interface for more information)
• Activate Operators (see Activating Operators via the LDAP Interface for more information)
• Deactivate Operators (see Deactivating Operators via the LDAP Interface for more information)

Note that when Add Operators is selected, selections under Operator Defaults become available to view/edit.

Test Connection

A test connection exists in each LDAP configuration, which can be used to test connectivity to the LDAP server using the configuration’s connection settings.

When you perform a test connection, a message will be displayed with one of the following:

LDAP Filters

LDAP filters are used to refine the search selection, and they can be as broad or as narrow as necessary for any given LDAP configuration. Filtering begins at the configuration’s Base DN and is used in conjunction with the Search Scope to create the list of operators to return back from the hospital’s LDAP system to the RALS™ SYSTEM.

Search Filter

The search filter is used to restrict the number of search objects that are returned via the LDAP Interface. The search filter field defaults to:

(&(objectCategory=person) (objectClass=user))

For an instance where you want to return only person entities (operators) under a specific department number, the search filter would be:

(&(objectCategory=person) (objectClass=user) (departmentNumber=<desired department number>))

For an instance where you want to return person entities (operators) across multiple Organizational Units, the search filter would be:

(&(objectCategory=person) (objectClass=user)
(|(memberOf=CN=OU=Security,OU=Groups,OU=VA-CLV,OU=America,OU=Sites,DC=alere,DC=com)
(memberOf=CN=OU=Distribution,OU=Groups,OU=CN-OTT,OU=America,OU=Sites,DC=alere,DC=com)))

Search Scope

The scope determines which part of the hospital’s LDAP system is to be searched. Search scope is required, and the options are limited to:

• Base: Includes the level specified by the base DN, excluding any levels below it
• One-Level: Includes only the level immediately below the base DN
• Subtree: Includes the base DN and all levels below it

Operator Defaults

Operator defaults specify the default values for the RALS™ SYSTEM operator fields when operators are imported using the LDAP Interface. When an operator is added to the RALS™ SYSTEM using the LDAP Interface, the newly created operator’s fields will be set to the specified default values unless the LDAP configuration defines a specific mapping for a field (e.g. Home Location). Operator defaults are only applicable to the Add Operators sync option.

Note: A valid Home Location Optional Mapping will override the Home Location in Operator Defaults. However, if there is a failure with the mapped Home Location for added operators, the LDAP configuration will use the Home Location field located in Operator Defaults.

See Operators for more information about RALS™ SYSTEM operator fields.

LDAP Attribute Mappings

LDAP attribute mappings are used to map fields used in the hospital’s LDAP system to the RALS™ SYSTEM operator fields through common LDAP attributes. LDAP attribute mappings also allow the user to add text as a prefix and/or suffix at the individual attribute level and/or the overall generated text.

When an LDAP attribute mapping is created, the RALS™ SYSTEM will first apply any LDAP attribute’s prefix and suffix, then, if applicable, any RegEx match pattern and RegEx replace pattern to the individual attribute(s). Next, the individual attributes are combined in order from top to bottom. Then, any overall prefix and/or suffix are applied to the generated text, creating a combined value that is used to populate the specified operator field.

The following fields and sub-fields exist in required and optional LDAP attribute mappings:

RegEx Patterns

RegEx patterns are used to define text that is to be matched and replaced within an individual attribute.

The following are examples of RegEx patterns that can be used in an LDAP configuration’s attribute mappings:

Required Mappings

Mappings to the following RALS™ SYSTEM operator fields are required for LDAP configurations, as they are required for all operators in the RALS™ SYSTEM:

• Name
• Operator ID

See Operators for more information about operator fields.

Optional Mappings

Mappings to the following RALS™ SYSTEM operator fields are optional for LDAP configurations:

• Email
• Fax
• Home Location
• Notes
• Phone

Notes:

• For a mapped Home Location, the LDAP Alias on a RALS™ SYSTEM location (not the location’s name) is used for matching to the location in the hospital’s LDAP system. A location will not be mapped by the LDAP Interface if it does not contain an LDAP Alias.
  • If the result of the mapped Home Location attribute successfully matches a RALS™ SYSTEM location’s LDAP Alias, then that location is saved as the Home Location in the synced operator’s record.
  • If the result of the mapped Home Location attribute is unsuccessful in matching a RALS™ SYSTEM location’s LDAP Alias, then that operator’s details will not be updated in the RALS™ SYSTEM.
    

See Locations for more information about locations.

• A valid Home Location Optional Mapping will override the Home Location in Operator Defaults. However, if there is a failure with the mapped Home Location for added operators, the LDAP configuration will use the Home Location field located in Operator Defaults.

See Operators for more information about operator fields.

Institution Access

LDAP configurations are not institution-specific.

Adding

LDAP configurations can be manually added to the RALS™ SYSTEM. See Add Fields for more information.

Editing

LDAP configurations can be edited. See View or Edit Details Fields for more information.

Cloning

All LDAP configurations can be cloned. All values will be copied, except:

Deactivating or Deleting

LDAP configurations can be deactivated, but not deleted. Deactivated LDAP configurations cannot be synced. A deactivated LDAP configuration can be reactivated.

Fields

LDAP configuration fields are located in the following places in the RALS™ SYSTEM:

• Data Table Fields
• Add Fields
• View or Edit Details Fields

Data Table Fields

When viewing LDAP configurations in a data table, the fields are defined as follows:

Add Fields

When adding an LDAP configuration, the fields are defined as follows:

View or Edit Details Fields

When viewing or editing an LDAP configuration’s details, the fields are defined as follows: