DocuPhase Forms latest - This documentation is for DocuPhase Forms v11.3. Not for you? Earlier documentation is available too.

Working with LDAP

Owned by Megan Ellis
Jun 03, 2024
3 min read

Cloud and in-house customers can configure frevvo to integrate with an LDAP Active Directory server to authenticate users.

frevvo only supports/certifies the LDAP Security Managers when frevvo is running in the tomcat container. Refer to our Supported Platforms for the list of Application Servers supported/certified by frevvo.

On This Page:

Configuring the LDAP Security Manager

frevvo integrates with an external LDAP/AD system and is in full control of user authentications. Use the LDAP Security Manager in this situation. Refer to Configuring the LDAP Security Manager for In-house if your frevvo and LDAP server are both located behind your firewall (on-premise.) Refer to Configuring the LDAP Security Manager LDAP(s) for Cloud tenants if you want to connect your frevvo cloud tenant to your on-premise LDAP server.




frevvo only supports/certifies the LDAP Security Manager when frevvo is running in the tomcat container. Refer to our Supported Platforms for the list of Application Servers supported/certified by frevvo.

Retrieving Custom Attributes from the LDAP Server

When a user is successfully authenticated by the LDAP security manager, frevvo retrieves the following basic user information from the LDAP server: 

Last Name
First Name
Email address 

Using a business rule, you can populate controls in your form with this information. 

 

There are many attributes available in Active Directory. View this website for a partial list. Single and multi-value attributes are supported. Active Directory custom attributes can be retrieved for users in a frevvo tenant using the LDAP Security Manager or the LDAP Container Security Manager.  

 

Additional custom attributes can be retrieved from the LDAP server by typing the attribute names in the Custom field on the LDAP Configuration screen and writing a business rule to pull that information into your form.   

Configure Retrievable Attributes

Single-value Attributes

If you want to pull additional information from Active Directory into your form, enter  a comma separated list of custom attribute names to be retrieved in the Custom field on the LDAP Configuration screen. Let's use the employee's Middle Initial and Home Phone as an example. The attributes for Middle Initial and Telephone Number are initials and telephoneNumber respectively. 

Follow these steps to modify the configuration:  

  1. Login to frevvo as the tenantadmin.
  2. Click the Edit Tenant link.
  3. Type the custom attribute names (telephoneNumber and initials) in the Custom field on the LDAP Configuration screen separated by a comma. Make sure there are no spaces between the attributes.



  4. Click submit to save the changes.
      

Write a rule to populate controls in your form with the firstname, lastname, email address plus the additional attributes specified in the configuration parameter. Notice the initials and the telephone number controls in the image are filled with the user information from the LDAP server.

The manager attribute maps to the frevvo built-in data - subject.reports. to. This means you can retrieve this value in a rule or use subject.reports.to to specify workflow navigation if you configure the manager attribute in your LDAP tenant.

Multi-value Attributes

Attributes with more than one value are also supported. For example, The carLicense attribute can return multiple licenses. You can write a rule to populate dropdown options with the specified car license values. Make sure the carLicense attribute is configured in the Custom field of the LDAP Configuration screen and of course, there are multiple carLicense attributes, each one containing a different value for the dropdown options, set up for appropriate users on the LDAP server. 


A JSON array string listing multiple car licenses is returned and it can be used in a frevvo rule to populate the options of a dropdown control named carLicense.