...

Integrating Live Forms with LDAP

Key Information to Collect

• LDAP server name or ip
• LDAP server port
• User name and password with proper permissions to access and browse LDAP.
• LDAP groups and/or users that will be considered

  Frevvoproduct

   designers. These users will be able to create forms and flows in frevvo.
• LDAP groups and users that will be considered

  Frevvoproduct

   administrators.
• LDAP groups and users that will be considered 

  Frevvoproduct

   publishers. This role gives a user the permission to go to the home page of every other tenant user. 
• LDAP groups and users that will be considered ReadOnly.
• The root distinguished names for both group and user searches.

Configuration Steps

1. Stop

   Frevvoproduct

   .
2. In a text editor, open <frevvo-home>/tomcat/conf/Catalina/localhost/frevvo.xml.
3. You can edit the LDAP Configuration Properties. Alternatively, you can start off from one of the sample configurations and provide only the key information listed above.
   1. Active Directory Sample 
   2. Open LDAP Sample
4. Log into your LDAP Server and add a new group, frevvo.TenantAdmin
5. Assign the frevvo.tenantadmin group to one or more users for tenant admin privilege.
6. Start

   Frevvoproduct

7. Login to

   Frevvoproduct

    as a

   Frevvoproduct

    administrator (user:admin and password:admin if you have not changed it)
8. Click on Manage and then Manage Tenants
9. You will see a page where the current tenants are listed. If this is a new installation you will only see the default tenant d
10. Click on the plus sign (+) to add a new tenant.
11. Configure the new tenant:
    1. In the drop down Security Manager Class choose LDAP/Active Directory Security Manager. If your version does not have a drop down, enter the following in the in the text box: com.frevvo.security.ldap.LDAPSecurityManager.
    2. Give it a tenant id. For the sake of this document lets assume you call it MYLDAP. Provide the tenant name and description.
    3. The Max Concurrent Users is the maximum allowed by your license or less.
    4. Specify the LDAP User ID that will have the tenant admin permission. 
    5. Click Submit. You will see your new tenant in the tenant list.  

Check if the configuration is correct

Here are some quick tests to check if the LDAP configuration is correct:

1. Login as the

   Frevvoproduct

    admin or the tenant admin for the LDAP tenant.
2. Click on the icon manage users/roles for the LDAP tenant you created.
3. Click Manage Users.
4. Click All. You should see a list of LDAP users.
5. Now, click Back To Manage Tenant.
6. Click Manage Roles. You should see a list of groups.
7. Log out from

   Frevvoproduct

    (you should be currently logged in as admin)
8. Try to login with the user name and password of a user in LDAP. You need to specify the proper tenant when logging in. For instance, if john is a valid LDAP user you should log in as john@MYLDAP. The password would be john's password in LDAP.

Live Forms and LDAP Use Cases

Single Sign On with Live Forms, IIS and Active Directory

In this scenario, a user authenticates to his windows account and tries to use

The basic deployment is IIS fronting

...

...

Please also refer to the force auth property for forms and flows. Force auth lets you override SSO for an individual form or flow.

Once all is configured and running it is possible to test these scenarios:

Signing in from within the network

In this case, the

http://[server]/frevvo/web/tn/[LDAP tenant]/login

Substitute LDAP tenant above with the tenant name you configured with the LDAP Security Manager. The server variable should be the ip address of the machine where Active Directory is installed .

The user will automatically authenticate to

Signing in from outside the network

In this case, the

 http://[server]/frevvo/web/tn/[LDAP tenant]/login 

Substitute LDAP tenant above with the tenant name you configured with the LDAP Security Manager and the server variable with the ip address of the machine where Active Directory is installed.

Since the user is not authenticated in the windows Network, he will be prompted by the browser for credentials. IIS will authenticate the user in the network and forward the request to

Configure frevvo.internal.baseurl in frevvo.xml for LDAP SSO

This parameter is needed in frevvo.xml for various activities like accessing ACL page , publishing templates , resetting tasks etc. Let's say you have a browser signed in via SSO to machine m1 (port 80).  IIS is running on m1 (port 80) redirecting /frevvo/web to frevvo running on m2:8082. The browser submits form to m1, IIS redirects to m2:8082.  The doc action is a frevvo:// URI which gets resolved to http://m1/frevvo/... 

To avoid situations such as these,  set frevvo.internal.baseurl to the actual host:port of the 

1. edit <frevvo-home>/tomcat/conf/catalina/localhost/frevvo.xml
2. Add the parameter shown below with your information: Save the changes to the file.

Parameter name="frevvo.internal.baseurl" value="http:// <ip of the m/c where frevvo server is hosted>:<port>" override="false"/>

Live Forms login page authenticating against LDAP

This is the case where the user will authenticate through the

Username: john@LDAP 
Password: *****      
Tenant: <blank>

The password provided in the login page is the user's password in LDAP. A very important point to note is that the user name, "john" in the example above, needs to match the value for the LDAP entry attribute configured in the property com.frevvo.security.ldap.userIdDisplayAttribute. For instance, for Active Directory, the value of this property is normally sAMAccountName. That means

Retrieving Custom Attributes from the LDAP server

Active directory attributes can be retrieved from the LDAP server using Business Rules. The rules use the 

Image Removed

Configure Retrievable Attributes 

Single-value Attributes

...

can be configured to integrate with your existing LDAP Active Directory server to authenticate users. There are two configuration options. Each one uses a different Security Manager. The first option is to use the  Frevvoproduct LDAP Security Manager. Here the authentication is handed off to an external LDAP/AD system.  Image Added   The second option is to use the Frevvoproduct  LDAP Container Security Manager. Here the  Frevvoproduct server is deployed to an existing servlet container that is already handling user authentications through LDAP. Authentication, in this case, is the responsibility of the container. Image Added Column width 300px On This Page: Table of Contents

Retrieving Custom Attributes from the LDAP Server

When a user is successfully authenticated by the LDAP security manager,

Last Name
First Name
Email address 

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

 Image Added

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 

Image Added 

You can retrieve additional custom attribute information from the LDAP server using the configuration parameter "com.frevvo.security.ldap.customAttributes" and business rules.   

Configure Retrievable Attributes

Single-value Attributes

If you want to pull additional information from Active Directory into your form, you must add a context parameter to the <frevvo-home>\tomcat\conf\catalina\localhost\frevvo.xml file.  

Image Removed

If you want to pull additional information, you must add the The configuration parameter is "com.frevvo.security.Idapldap.customAttributes" configuration parameter where and the value  is is a comma separated list of custom attribute names to be retrieved, . Let's use the employee's Middle Name Initial and Employee IDHome Phone as an example. The attributes for Middle Initial and Telephone Number are initials and telephoneNumber respectively. 

Follow these steps to modify the configuration:  

...

 <Parameter name="com.frevvo.security.ldap.customAttributes" value="employeeIDinitials,middleNametelephoneNumber," override="false"/> 

     5. Save the file after all your changes are made. Restart 

Add the addititonal lines to the business Write a rule to populate the Employee ID and Middle Name fields.

if(form.load)
{
mail.value=_data.getParameter('subject.mail');
firstName.value=_data.getParameter('subject.givenName');
lastName.value=_data.getParameter('subject.sn');
employeeID.value=_data.getParameter('subject.employeeNumber');
employeeType.value=_data.getParameter('subject.manager');
}

...

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.

Image Added

Multi-value Attributes

Attributes with more than one value are also supported. For example, The carLicense attribute can return multiple valueslicenses. You can write a rule to populate dropdown options with those options. First of all, make the specified car license values. Make sure the carLicense attribute is configured in the frevvo.xml file .  

 <Parameter name="com.frevvo.security.ldap.customAttributes" value="employeeNumber,employeeType,employeeID,middleName,carLicense" override="false"/> 

A JSON array string is returned and this rule will populate the options of a dropdown control named carLicense.

carLicense.options=JSON.parse(_data.getParameter('subject.carLicense'));

LDAP Troubleshooting

If things are not working as you expected:

1. The primary source of information is the

   Frevvoproduct

    log file. In most cases, the LDAP connector will try to indicate what the problem is in the logs. In the log file, look for lines with LDAPSecurityManager or FrevvoJNDIRealm.
2. It is useful to have an LDAP browser at hand, for instance, the Apache Directory Studio. With the browser you can:
   1.  Check if the connection parameters that you configured in

      Frevvoproduct

       are correct.
   2.  Run queries against LDAP and make sure that the expressions you configured in

      Frevvoproduct

        are correct and returning what you expect.
3. If you can't spot the problem and need to contact frevvo support:
   1. Stop

      Frevvoproduct

   2. Go to <frevvo-home>/tomcat/logs/frevvo.log.
   3. Follow these steps to change the log level from INFO to DEBUG
   4. Restart

      Frevvoproduct

   5. Execute the steps that is causing problems.
   6. Send the log file (zip) to Live Forms support (support@frevvo.com) with a description of the problem.
   7. Restore the log level to INFO.

Below are some common cases to help with troubleshooting. All of them assume that the connectivity is working, meaning that you tested, from the same box where

As an admin I can't list the users or groups for the LDAP tenant

This is can be a problem with the expression you configured in com.frevvo.security.ldap.allUsersFilter (for users) and/or com.frevvo.security.ldap.allGroupsFilter (for groups). Also verify that the search bases are correct, properties com.frevvo.security.ldap.usersBase (users) and com.frevvo.security.ldap.groupsBase (groups). The LDAP Browser is useful here. Execute a search using the same expression and bases you configured in

A user that should be a designer logs in but can't design forms

1. Login to your LDAP/AD Server.
2. Make sure you have a group defined for the designer role and it is named FrevvoDesigners.
3. Make sure the user having the problem is a member of the FrevvoDesigners group.

Another potential issue is case sensitivity. Please refer to the topic Mixed or Upper case User Names below.

A user that should be an administrator logs in but can't manage the tenant

1. Login to your LDAP/AD Server.
2. Make sure you have a group defined for the designer role and it is named FrevvoAdmins.
3. Make sure the user having the problem is a member of the FrevvoAdmins group. 

Another potential issue is case sensitivity. Please refer to the topic Mixed or Upper case User Names below.

I can authenticate against LDAP via the Live Forms login page but SSO is not working

1. # In IIS:
   1. Make sure Windows Authentication is set in the Default Web App (or the web app used to send requests to

      Frevvoproduct

      )
   2. Verify that Anonymous Authentication is NOT set in the default Web App  (or the web used to send requests to

      Frevvoproduct

      )
2. In

   Frevvoproduct

   :
   1. Open FREVVO_HOME/tomcat/conf/server.xml
   2. Look at the AJP connector configuration.
   3. Verify that it has the attribute tomcatAuthentication="false"

Can't login via the Live Forms login page

A common cause is that the distinguished name attribute is incorrect. That attribute is defined by the property com.frevvo.security.ldap.distinguishedNameAttribute. If you can't determine the distinguished name attribute for your system you can try the fall back strategy described here. Some common distinguished name attributes can be found here

Problems with Mixed or Uppercase User Names

The first issue is cased by the user login in. For instance, John Stevens LDAP account is JStevens but he logs in as jstevens, he will be recognized by case insensitive LDAP and thus granted access but will not be recognized as a designer or as a tenant admin by

To prevent issues you could always login to

<context-param>     
    <param-name>frevvo.login.userid.case</param-name>     
    <param-value>lower</param-value>     
    <description>Force all login user ids to upper or lower case</description> 
</context-param>

The second problem is in directing tasks to frevvo users if your LDAP user names are mixed case. One solution is to use hidden controls on your forms with rules to convert the case of user names to lower case. The example below shows two text controls on a form, one visible, EmployeeMixedCase, and the other hidden, Employee.

Image Removed

A user types a name (regardless of case) into the EmployeeMixedCase control. The hidden Employee control has a business rule that takes the value of the visible control and converts it to lowercase.

Employee.value = EmployeeMixedCase.value.toLowerCase(); 

The form or workflow routing can then use {Employee} rather than the control that may be mixed case. 

Configure frevvo.internal.baseurl in frevvo.xml for LDAP SSO

This parameter is needed in frevvo.xml for various activities like accessing ACL page , publishing templates , resetting tasks etc. Let's say you have a browser signed in via SSO to machine m1 (port 80).  IIS is running on m1 (port 80) redirecting /frevvo/web to frevvo running on m2:8082.   Browser submits form to m1, IIS redirects to m2:8082.  The doc action is a frevvo:// URI which gets resolved to http://m1/frevvo/... 

To avoid situations such as these,  set frevvo.internal.baseurl to the actual host:port of the 

1. edit <frevvo-home>/tomcat/conf/cstalina/localhost/frevvo.xml
2. Add the parameter shown below with your information: Save the changes to the file.

Parameter name="frevvo.internal.baseurl" value="http://<ip of the m/c where frevvo server is hosted>:<port>" override="false"/>

Active Directory Sample Configuration

...

...

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.  

 <Parameter name="com.frevvo.security.ldap.connection.urlcustomAttributes" value="ldap://[your server]:[port, typically the default is 389 ]" override="false"/>   
<Parameter name="com.frevvo.security.ldap.connection.name" value="[user name]" override="false"/>  
<Parameter name="com.frevvo.security.ldap.connection.password" value="[user password]" override="false"/>  
<Parameter name="com.frevvo.security.ldap.usersBase" value="CN=Users,DC=test,DC=windows,DC=frevvo,DC=cominitials,telephoneNumber,carLicense" override="false"/>   
<Parameter name="com.frevvo.security.ldap.groupsBase" value="CN=Users,DC=test,DC=windows,DC=frevvo,DC=com" override="false"/>  
<Parameter name="com.frevvo.security.ldap.userIdDisplayAttribute" value="sAMAccountName" override="false"/>  
<Parameter name="com.frevvo.security.ldap.groupIdDisplayAttribute" value="sAMAccountName" override="false"/>   
<Parameter name="com.frevvo.security.ldap.notifications" value="true" override="false"/>     
<Parameter name="com.frevvo.security.ldap.allGroupsFilter" value="(objectClass=group)" override="false"/>  
<Parameter name="com.frevvo.security.ldap.allUsersFilter" value="(objectClass=user)" override="false"/>         
<Parameter name="com.frevvo.security.ldap.distinguishedNameAttribute" value="distinguishedName" override="false"/>  
<Parameter name="com.frevvo.security.ldap.userMemberOfAttribute" value="memberOf" override="false"/>    
<Parameter name="com.frevvo.security.ldap.groupMemberAttribute" value="member" override="false"/>   
<Parameter name="com.frevvo.security.ldap.firstNameAttribute" value="givenName" override="false"/>  
<Parameter name="com.frevvo.security.ldap.lastNameAttribute" value="sn" override="false"/>  
<Parameter name="com.frevvo.security.ldap.emailAttribute" value="mail" override="false"/>   

OpenLDAP Sample Configuration

<Parameter name="com.frevvo.security.ldap.connection.url" value="ldap://[your server]:[port, typically the default is 389 ]" override="false"/>  
<Parameter name="com.frevvo.security.ldap.connection.name" value="cn=admin,dc=test,dc=frevvo,dc=com" override="false"/> 
<Parameter name="com.frevvo.security.ldap.connection.password" value="[user password]" override="false"/> 
<Parameter name="com.frevvo.security.ldap.usersBase" value="DC=test,DC=frevvo,DC=com" override="false"/>  
<Parameter name="com.frevvo.security.ldap.groupsBase" value="DC=test,DC=frevvo,DC=com" override="false"/> 
<Parameter name="com.frevvo.security.ldap.userIdDisplayAttribute" value="uid" override="false"/> 
<Parameter name="com.frevvo.security.ldap.groupIdDislayAttribute" value="entryDN" override="false"/> 
<Parameter name="com.frevvo.security.ldap.notifications" value="true" override="false"/>  
<Parameter name="com.frevvo.security.ldap.allGroupsFilter" value="(|(objectClass=groupOfUniqueNames)(objectClass=organizationalRole))" override="false"/> 
<Parameter name="com.frevvo.security.ldap.allUsersFilter" value="(objectClass=person)" override="false"/>        
<Parameter name="com.frevvo.security.ldap.distinguishedNameAttribute" value="entryDN" override="false"/>    
<Parameter name="com.frevvo.security.ldap.groupMemberAttribute" value="uniqueMember" override="false"/> 
<Parameter name="com.frevvo.security.ldap.userMemberOfAttribute" value="" override="false"/>    
<Parameter name="com.frevvo.security.ldap.firstNameAttribute" value="cn" override="false"/> 
<Parameter name="com.frevvo.security.ldap.lastNameAttribute" value="sn" override="false"/> 
<Parameter name="com.frevvo.security.ldap.emailAttribute" value="mail" override="false"/>  

LDAP Configuration Properties

These are the properties used to configure the LDAP connector. The properties in bold are required.

...

A JSON array string listing multiple car licenses is returned and it can be used in a 

Image Added