frevvo is a multi-tenant application. Tenants allow you to segregate groups of users and roles. Users from one tenant cannot access users in any other tenant. Note: this does not apply to public forms/flow which do not require login access to a tenant.
The frevvo In-house superuser admin can create as many tenants on your form server as needed. Once the superuser admin creates the tenant, the tenant admin user can then login to manage the tenant, configure LDAP, add users & roles, etc. See the Admin Home Page for differences between the superuser admin and tenant admin.
On this page:
The superuser admin can add new tenants to your frevvo server using the Manage Tenants page.
- Click to add a new tenant.
- Click to display the Manage Tenant page. You use the links on this page to edit the tenant information and manage the tenant's roles, users, form and control categories, and production forms.
- Click to edit the tenant information. This link displays the same page as the Edit Tenant link on the Manage Tenant page.
- Click to make a copy of the tenant.
- Click to remove the tenant from the server.
You cannot remove or copy the d (Default tenant).
The superuser admin can use the Tenant page to add a new frevvo tenant. We recommend using lower case for the tenant name as the tenant name becomes part of your user's login names which are case sensitive.
To display the Tenant page,
- Login as the superuser admin. Enter admin@d as the userID and admin as the password. Click Manage Tenants.
- Click the plus icon to add a new tenant.
- Fill in the fields with the information for your new tenant.
- Click the Submit button to save.
Here is a brief explanation of the fields:
- Are you creating a tenant for Confluence? - Check this if you are planning on integrating frevvo with Confluence. If checked, the Security Manager Class field displays the Delegating Security Manager. This is the Security Manager needed for Confluence. If unchecked, the Frevvo Default Security Manager will be used.
If you are not using Confluence, select a Security Manager Option from the following choices:
- Frevvo Default Security Manager (FSM) - frevvo is responsible for authentication/authorization and managing users/roles. This is the default option. Your tenant will be created with this security manager if no other choice is selected.
- LDAP Active Directory Security Manager (LDAPSM) - The user is authenticated outside frevvo. Typically, SSO or frevvo performs the authentication using LDAP directly.
- DB Container Security Manager (DBCSM) - Authentication is the container's responsibility, but frevvo provides a database interface to fetch users/roles for design time functionality from an external database.
- LDAP Container Security Manager (LDAPCSM) - This is exactly the same as the DB Container Security Manager using LDAP/Active Directory instead of a database. Authentication is the container's responsibility.
- Custom - (CSM) - Container managed security manager used when there is a requirement for a container to handle authentication.
- Tenant ID - Enter the tenant Id in this field - The tenant id can contain characters, numbers, dot(.), hyphen (-) and the underscore. It cannot start with a number. A common practice is to use your domain name for the tenant id.
- Tenant Name - Enter the name of the new tenant.
- Tenant Description - Enter a description for the new tenant.
- Max Concurrent Users - Leave this field blank if you do not want to set a maximum number of concurrent users. Concurrent Users are users that are logged into frevvo simultaneously.
- Admin User Id - This is the tenant admin id. It can contain characters, numbers and the underscore. It cannot start with a number. The maximum length is 16 characters.
- Admin User Password - This is the tenant admin password. Notice the text will appear as bullets as you type.
- Reenter the Admin User Password - Reenter the tenant admin password. frevvo will display an error message, "Invalid Value" if what you type in this field does not match the contents of the Admin User Password field.
Configuring the LDAP/Active Directory Security Manager
The connection to your LDAP server is configured at the tenant level. Existing frevvo in-house customers using LDAP should refer to the for a quick way to import your current LDAP configuration parameters before migrating. frevvo in-house customers can add an LDAP tenant and configure the LDAP paramaters via the Add Tenant screen. LDAP properties can be updated at anytime via the Edit Tenant screen.
If you are a new in-house frevvo LDAP customer, use the Add Tenant screen to configure the LDAP tenant. If you are an existing LDAP customer, the copies any existing LDAP configuration from the frevvo.xml or config properties files to the tenant. Once migrated, updating frevvo.xml has no effect on the tenant configuration. Make changes using the Edit Tenant screen.
Cloud customers must request an LDAP tenant from frevvo customer support. Cloud customers will receive a default tenant login from frevvo and then they can edit the LDAP configuration properties using the Edit Tenant screen to connect to their LDAP server.
In all cases, follow these steps to configure 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 frevvo designers. These users will be able to create forms and flows in frevvo.
- LDAP groups and users that will be considered frevvo administrators.
- LDAP groups and users that will be considered frevvo 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.
Configuration StepsThese instructions assume that you have an in-house installation of Live Forms up and running or you have signed up for an LDAP tenant on the cloud server.
- Log into your LDAP Server and add a new group, frevvo.TenantAdmin (case sensitive)
Assign the frevvo.TenantAdmin group to one or more users to give them the privileges of a tenant admin.
There are four special roles in frevvo: frevvo.TenantAdmin, frevvo.Designer, frevvo.Publisher, frevvo.ReadOnly, that must be specified on your LDAP/AD Server if you have users that will be assigned these roles. The group names must be frevvo.TenantAdmin, frevvo.Designer, frevvo.Publisher, frevvo.ReadOnly . Upper/lower case may be a factor for Open LDAP systems.
- In-house customers:
- Login to frevvo as an administrator (user:admin and password:admin if you have not changed it)
- Click on Manage and then Manage Tenants
- 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
- Click on the plus icon to add a new tenant.
- Configure the new tenant:
- Choose LDAP/Active Directory Security Manager.from the Security Manager Class drop down.
- Enter your LDAP Configuration Properties. Alternatively, you can start off from one of the sample configurations and provide only the key information listed above. See below for information on the TLS checkbox.
- Enter a tenant id, a tenant name and description.
- The Max Concurrent Users is the maximum allowed by your license or less.
- Specify the LDAP User ID that will have the tenant admin permission.
- Click Submit. You will see your new tenant in the tenant list if the connection to your LDAP server is successful.
- Choose LDAP/Active Directory Security Manager.from the Security Manager Class drop down.
- Cloud customers:
- Contact frevvo to create an LDAP/Active Directory tenant. Login with the id and password information provided by frevvo.
- Click on the Edit tenant link
- Edit the LDAP Configuration Properties. Replace the default values with values for your LDAP server.
- Click Submit.
It is recommended that you check the Ignore Case checkbox when configuring LDAP. Refer to Mixed or Upper case User Names topic for more details.
Check if the configuration is correct
Here are some quick tests to check if the LDAP configuration is correct:
- Login as the frevvo tenant admin for the LDAP tenant.
- Click on the Manage Users link.
- Click All. You should see a list of LDAP users which were assigned one of these frevvo roles on the LDAP server: frevvo.TenantAdmin, frevvo.Designer, frevvo.Publisher, frevvo.ReadOnly
- Now, click Back To Manage Tenant.
- Click Manage Roles. You should see a list of groups from your LDAP server.
- Log out from frevvo (you should be currently logged in as the tenantadmin)
- 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 and the name of the LDAP tenant is MYLDAP, you should log in as john@MYLDAP. The password would be john's password in LDAP.
Since you are using LDAP to define frevvo users and roles (i.e., groups), you do not see an Add User icon or Add Role icon on the Manage Users or Manage Roles pages.
Secure LDAP Configuration
frevvo will be connecting to your LDAP server over the network. Here are two methods to secure the LDAP connection:
- Simple authentication over SSL - To enable SSL use the ldaps scheme in your LDAP tenant configuration in place of ldap and use port 636. This is supported by older LDAP products such as AD 2000. It is important that the hostname in the certificate matches the hostname in your ldaps url.
- Simple or external SASL authentication over TLS (Transport Layer Security) - To enable this method check the TLS checkbox in your LDAP tenant configuration. TLS is used by the LDAP v3 standard in products such as AD 2003 and above. TLS uses the standard LDAP port 389.
When using either of these two methods, the recommended approach is to use a CA signed certificate. If you do not have a CA signed certificate then you can use a self-signed certificate.
Self signed certificates are not supported for Live Forms Online. Although they are supported for frevvo in-house, use of self-signed certificates is not recommended.
Finally you need to install your signed or self-signed certificate. You can import the certificate into a keystore that frevvo can access and trust. Follow the instructions for your keystore. If frevvo is installed in a tomcat server, the tomcat keystore can be used. See the instructions for tomcat here.
External SASL and pooling are currently not supported. This is planned for a later release.
LDAP Configuration Properties
These are the properties used to configure the LDAP/Active Directory security manager. The properties in bold are required.
|Connection URL||ldap server url|
User to connect to LDAP. This user must have the proper permissions to read and run queries in the ldap server.
If using Active Directory, it is common to specify the domain. For instance, TEST\Administrator refers to the user Administrator in the TEST domain.
|Connection Password||Password for the user defined in com.frevvo.security.ldap.connection.name.|
|Users Base||Searches for users will start from the ldap node specified by this property.If the value is empty the searches will start from the root domain.|
|Groups Base||Searches for the groups will start from the ldap node specified by this property. If the value is empty, searches will start from the root domain|
|UserId Display |
User attribute that will be visible in frevvo. This is what will be displayed in the list of users a tenant admin sees and has to be unique in the server.
Another restriction is that the values for the attribute configured here cannot have spaces.
For instance, don't configure CN as the value since it can contain spaces in most systems.
Group attribute that will be visible in frevvo. This is, for instance, what will be displayed in the list of groups a tenant admin sees or the groups used in workflows. This attribute has to be unique in the server.
|Notify checkbox||Notifications are emails sent by frevvo to workflows participants. If checked, notifications will be sent.|
|All Groups Filter|
The expected value is an LDAP filter expression.
The expression should return the groups that will be available to be used in frevvo workflows. com.frevvo.security.ldap.groupIdDisplayAttribute
|All Users Filter|
The expected value is an LDAP filter expression. The expression should return the users that will be available to be used in frevvo work flows and authentication. com.frevvo.security.ldap.groupIdDisplayAttribute
|User Member Of||Attribute on a user object storing the groups the user is a member of.|
|Group Member||Attribute on a group object storing the users that are a member of this group.|
Name of the user ''first name'' attribute
|Last Name||Name of the user ''last name'' attribute.|
|Email ||Name of the user ''email'' attribute in the LDAP server. This value can be used in a rule is used in email notifications|
|Manager||Attribute on a user object storing the DN of the user’s manager. This value can be retrieved in a rule or used in flow navigation using the subject.reports.to data available in frevvo.|
|Ignore Case checkbox||If checked, frevvo ignores the case stored in LDAP systems, primarily for the purpose of determining roles.|
|Custom||This is a a comma separated list of attribute names to be retrieved from the LDAP Server.|
|TLS||This enables simple authentication over TLS. If checked, a trusted certificate for the LDAP server is required.|
|Property||Active Directory Sample Configuration|
OpenLDAP Sample Configuration
ldap://[your server]:[port, typically the default is 389 ]
ldap://[your server]:[port, typically the default is 389 ]
Check the Notifications checkbox
|All Groups Filter|
( | (objectClass=groupOfUniqueNames)(objectClass=organizationalRole))
|All Users Filter|
|User Member Of|
|Ignore Case||Check the Ignore Case checkbox||Check the Ignore Case checkbox|
|TLS||Check to secure the connection using||Check to secure the connection using|
Configuring the LDAP Container Security Manager
Adding a tenant that uses the LDAP Container Security Manager is exactly the same as configuring a tenant using the LDAP/Active Directory Security Manager. Please follow the steps above.
If the tenant admin user does not exist or it does not have the required roles, this error will display with the name of the tenant you are trying to add:
This error message can be seen in the <frevvo-home>\tomcat\logs\frevvo.log file if the LDAP-CSM tenant cannot be created.
Several additional steps are required to complete the LDAPCSM configuration. Return to Configuring the LDAP Container Security Manager for further instructions.
A tenant admin or a superuser admin can use the Tenant page to configure or edit information about a tenant.
To display the Tenant page:
- If logged in as a tenant admin click Edit Tenant.
- If logged in as a superuser admin click Manage Tenants and then click for the tenant you want to edit.
Note that you cannot change the Tenant Id, although you can change the Name and Description. Click thebutton to see details about a field. Click Submit to save your changes. The message "Your changes have been saved" will display.
The email address entered in this section is used as the from email address for email notifications and doc action emails for forms and workflows in the tenant. If you want to setup the email address with a user friendly name, enter the text in the Display Name field. You can specify a different from email address for Document Action and Activity Document action emails by entering a valid email address in the from field in both wizards. The values in these fields overrides the address entered on the Edit Tenant screen.
A user designing a form, viewing their task list, or using a form to enter values and submit has a certain number of minutes to complete the activity. This time limit is call the Session Timeout. By default the session will expire after 480 minutes of inactivity. When the session expires a designer user will have to re-login to frevvo to continue designing forms and users filling forms will have to get new form instance and re-enter the values. The tenant admin can override the default session timeout here. See Session Timeout topic in the Installation & Configuration Guide for full details.
Max Concurrent Users
The Max Concurrent Users field only appears if you are logged in as a superuser admin. This field enables you to restrict the number of users who can simultaneously login to a particular tenant. For example if you have purchased and installed a 20 user license key and want to set tenant A to use 5 and tenant B to use 15, setup that configuration here. See Concurrent Users for more information.
Max Users is subject to your license.
The Deployment State lets you toggle the default deployment state of your form between two states: PRODUCTION and DEVELOPMENT. When a form is in development state it contains a watermark. If you have a frevvo unlimited user license key you may want all the forms created by the designer to automatically be deployed for production with no water mark.
See also the deployment form property.
Anonymous signup lets you publish a registration Url for your tenant so people can signup and create a user account in your tenant themselves. In the Edit Tenant form, check the anonymous signup property and then select the default roles you want them to have when they signup. You can click the "+" to add multiple roles. If you select the designer role, these new users will have permission to design forms and workflows.
Then publish the registration Url:
At this Url people will see a signup form.
When they submit this form they'll be notified via email to activate their account. Until they activate via the email their account will remain disabled.
Now this person has a user account on your tenant and can login. If you gave them the frevvo designer role they will also be able to create forms and workflows. If not, when they login, they will see their task list as shown below.
To setup your tenant, first login to your new tenant as the tenant admin. The tenant admin can add users to the tenant. You need to add at least one designer user in order to begin creating forms.
We strongly recommend that you do not use the admin user to create your own forms. You can create users and roles in your new tenant for that purpose.
- Click the Manage Roles link.
- You will see several pre-created roles: frevvo.Designer, frevvo.Editor, frevvo.Publisher, frevvo.ReadOnly.
- Click the icon, fill in the form and submit it to create new roles e.g. Employee or Manager.
- Click the Back to Manage Tenant link.
- Next click the Manage Users link.
- For frevvo In-house you will see a single user – the administrative user you defined when you created the tenant. Note that you will have to click the link to display All users. By default, only users beginning with the later A are displayed. For frevvo Onlne you will see two users – the administrative user and the designer username you specified when you signed up for your trial SaaS account.
- To create a new user with permissions to create forms, click the icon, fill in the form and select the role frevvo.designer. If you do not select this role then this new user will not be able to create forms but will only be able to use forms created by others.
- The new user will be created. Create as many users and assign them roles as needed.
- Logout of the tenant admin account and login as one of the newly created users with the frevvo.Designer role and start building forms and workflows.
- Note that you must login using either the syntax: userid@tenant for the user name. For example, if the newly created tenant was named example.com then all users in that tenant must login using the ID: email@example.com. If you prefer to enter the username and tenant name in their own login page input fields, the configuration parameter, frevvo.login.show.tenant, can be modified to display the tenant name input field.