Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Section
Column

 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  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. 

Info

trial tenants in the cloud are initially configured with the frevvo Default security Manager. Once you have purchased your license, seamless migration of you can switch the Security Manager of your tenant and retain existing forms/flows, users and , roles and submissions is possible if you want to switch the security manager of your tenant.

Tenants using the Default Security Manager can be migrated to:

  • Default Security Manager → LDAP
  • Default Security Manager → SAML
  • LDAP → SAML

If you are planning want to switch the Security Manager security manager of your tenant, cloud customers should contact sales@frevvo.com to the LDAP Security Manager or a tenant using the SAML security manager and you are using LDAP for authentication, here's what we recommend:

  • Make sure the users created in the default security manager tenant have the same user names as the users in your LDAP server..
  • Migration of your trial tenant to LDAP or SAML or from an LDAP to SAML security manager automatically syncs your existing frevvo default security manager username accounts with your LDAP or SAML security manager username accounts.
  • Users need the frevvo.User role to access . This should be configured in your Active Directory on your LDAP server.

Refer to the Edit Tenant topic to see how easy it is to change the security manager for your production tenant.

Column
width350px

On this page:

Table of Contents
maxLevel2

Manage Tenants

The superuser admin can add new tenants to your  server using the Manage Tenants page.

Image Removed

  • Click Image Removed to add a new tenant.
  • Click Image Removed 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 Image Removed to edit the tenant information. This link displays the same page as the Edit Tenant link on the Manage Tenant page.
  • Click Image Removed to make a copy of the tenant.
  • Click Image Removed to remove the tenant from the server.
Info

You cannot remove or copy the d (Default tenant).

Add Tenant

The superuser admin can use the Tenant page to add a new  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, 

...

Image Removed

Here is a brief explanation of the fields:

...

Are you creating a tenant for Confluence? - Check this if you are planning on integrating 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 Default Security Manager will be used. 

If you are not using Confluence, select a Security Manager Option from the following choices: 

...

Column

Image Removed

...

initiate the procedure.

Column
width350px

On this page:

Table of Contents
maxLevel2

Manage Tenants

The superuser admin can add new tenants to your  server using the Manage Tenants page.

Image Added

  • Click Image Added to add a new tenant.
  • Click Image Added 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 Image Added to edit the tenant information. This link displays the same page as the Edit Tenant link on the Manage Tenant page.
  • Click Image Added to make a copy of the tenant.
  • Click Image Added to remove the tenant from the server.
Info

You cannot remove or copy the d (Default tenant).

Add Tenant

The superuser admin can use the Tenant page to add a new  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

    Image Added

  • Click Image Added 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.

Image Added

Here is a brief explanation of the fields:

  • Are you creating a tenant for Confluence? - Check this if you are planning on integrating 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 Default Security Manager will be used. 

  • If you are not using Confluence, select a Security Manager Option from the following choices: 

    Section
    Column

    Image Added

    Column
    1. Frevvo Default Security Manager (FSM) -  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. 
    2. LDAP Active Directory Security Manager (LDAPSM) - The user is authenticated outside . Typically, SSO or  performs the authentication using LDAP directly.
    3. SAML Security Manager - This security manager allows the  exchange of authentication and authorization data between an identity provider of your choice (ex:Shiboleth) and a service provider (frevvo). SSO is supported. Although this security manager can be used on-premise it is primarily meant for cloud tenants who use LDAP but do not want to expose it over the internet.
    4. DB Container Security Manager (DBCSM) - Authentication is the container's responsibility, but  provides a database interface to fetch users/roles for design time functionality from an external database.   
    5. 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. 
    6. Custom - (CSM) - Container managed security manager used when there is a requirement for a container to handle authentication.

...

Configuring the LDAP/Active Directory Security Manager

The connection to your LDAP server is configured at the tenant level. Existing in-house customers using LDAP should refer to the  Upgrade Guide for a quick way to import your current LDAP configuration parameters before migrating. 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.

Info

If you are a new in-house LDAP customer, use the Add Tenant screen to configure the LDAP tenant. If you are an existing LDAP customer, the  migration process 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

Before configuring the LDAP/Active Directory Security Manager, you will need the following information:

  • 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  designers. These users will be able to create forms and flows in frevvo.
  • LDAP groups and /or users that will be considered  designers. These users will be able to create forms and flows in frevvo. administrators.
  • LDAP groups and users that will be considered  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  administrators.
  • LDAP groups and users that will be considered  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 Steps

These 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. 

    Note

    There are four special roles in : 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  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 Image Removed plus icon to add a new tenant.
  • Configure the new tenant: Choose LDAP/Active Directory Security Manager.from the Security Manager Class drop down.
    Image Removed
    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
    • considered ReadOnly

    Configuration Steps

    These 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.

    1. Log into your LDAP Server and add a new group, frevvo.TenantAdmin (case sensitive)
    2. Assign the frevvo.TenantAdmin group to one or more users to give them the privileges of a tenant admin. 

      Note

      There are four special roles in : 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. 

    3. In-house customers:
      1. Login to  as an  administrator (user:admin and password:admin if you have not changed it)
      2. Click on Manage and then Manage Tenants
      3. 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
      4. Click on the Image Added plus icon to add a new tenant.
      5. Configure the new tenant:
        1.  Choose LDAP/Active Directory Security Manager.from the Security Manager Class drop down.

          Image Added

        2. 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.

          Note

          The Name/value table highlighted in the image allows you to configure up to 10 additional LDAP properties. See this website for a complete list of all available LDAP properties. For example, you can configure to ignore or follow referrals.

          Setting the java.naming.referral property to a value of "ignore" in the Name/Value table configures to ignore treferrals. Consult your LDAP Administrator for the details.You will have to set the ‘java.naming.referral’ property to value ‘ignore’ in the Name/Value table of your Edit Tenant page.

        3. Enter a tenant id, a tenant name and description.
        4. The Max Concurrent Users is the maximum allowed by your license or less.
        5. Specify the LDAP User ID that will have the tenant admin permission. 
        6. Click Submit. You will see your new tenant in the tenant list if the connection to your LDAP server is successful.

    4. Cloud customers:
      1. Contact frevvo to create an LDAP/Active Directory tenant. Login with the id and password information provided by frevvo.
      2. Click on the Edit tenant link
      3. Edit the LDAP Configuration Properties. Replace the default values with values for your LDAP server.
      4. Click Submit. 

     

    Warning

    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.

     

    Clicking the submit button tests the connection. Any errors are displayed at the top of the form. Here is an example of an error when there is a typo in the LDAP server name:
     


    Here is another example if the connection password is incorrect:

    ...

    Finally you need to install your signed or self-signed certificate. You can import the certificate into a keystore that  can access and trust. Follow the instructions for your keystore. If  is installed in a tomcat server, the tomcat keystore can be used. See the instructions for tomcat hereRefer to this Apache Tomcat website for instructions .

    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.

    Property Description
    Connection URLldap server url
    Connection User

    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 PasswordPassword for the user defined in com.frevvo.security.ldap.connection.name.
    Users BaseSearches 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 BaseSearches 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.

    GroupId Display

    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 checkboxNotifications 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 OfAttribute on a user object storing the groups the user is a member of.
    Group MemberAttribute on a group object storing the users that are a member of this group.
    First Name

    Name of the user ''first name'' attribute

    Last NameName 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
    ManagerAttribute 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 .
    Ignore Case checkboxIf checked,  ignores the case stored in LDAP systems, primarily for the purpose of determining roles.
    CustomThis is a a comma separated list of attribute names to be retrieved from the LDAP Server.
    TLSThis enables simple authentication over TLS. If checked, a trusted certificate for the LDAP server is required.

    Sample Configurations

    Property Active Directory Sample Configuration

    OpenLDAP Sample Configuration

    Connection URL

    ldap://[your server]:[port, typically the default is 389 ]

    ldap://[your server]:[port, typically the default is 389 ]

    Connection User

    [user name]

    cn=admin,dc=test,dc=frevvo,dc=com
    Connection Password

    [user password]

    [user password]

    Users Base

    CN=Users,DC=test,DC=windows,DC=frevvo,DC=com

    DC=test,DC=frevvo,DC=com

    Groups Base

    CN=Users,DC=test,DC=windows,DC=frevvo,DC=com

    DC=test,DC=frevvo,DC=com

    UserId Display

    sAMAccountName

    uid

    GroupId Display

    sAMAccountName

    entryDN

    Notify checkbox

    Check the Notifications checkbox

     
    All Groups Filter

    (objectClass=group)

    ( | (objectClass=groupOfUniqueNames)(objectClass=organizationalRole))

    All Users Filter

    (objectClass=user)

    (objectClass=person)

    Group Member

    member

    uniqueMember

     User Member Of

    memberOf

    " "

     First Name

    givenName

    cn

     Last Name

    sn

    sn

     Email

    mail

    mail

    Manager

    manager

    manager 

    Ignore CasCheck the Ignore Case checkboxCheck the Ignore Case checkbox
    CustomcarLicense, employeeNamecarLicense
    TLSCheck to secure the connection using TLSCheck to secure the connection using TLS

    Refer to this documentation for more information and here for some troubleshooting tips. 

    Configuring the LDAP Container Security Manager

    ...

    Several additional steps are required to complete the LDAPCSM configuration. Return to Configuring the LDAP Container Security Manager for further instructions. \

    Configuring the SAML Security Manager

    To successfully create a tenant using the SAML Security manager.You , you will need the following:

    • metadata file
    • The metadata for your Identity Provider
    • Attribute mapping information  

    ...

    1. Log onto as the superuser (on-premise) or the tenant admin (cloud).
    2. Access the Add Tenant (on-premise) or Edit Tenant (cloud) screen.
    3. Select SAML Security Manager from the Security Manager Class dropdown.
    4. Copy the Service Provider (frevvo) metadata into the Service Provider field. The xml should be pasted without the prolog. For example, the image shows an example of the frevvo metadata file before pasting:
    5. Retrieve the metadata for your Identity Provider. For example, for the Shiboleth product the metadata is located in the idp-metadata file.
    6. Paste the IDP metadata into the Identity Provider field. This metadata should also be pasted without the prolog.
    7. Check the Ignore Case checkbox if you are using LDAP for authentication and you want to ignore the case stored in LDAP systems for users/roles. Refer to the Mixed or Upper case User Names topic for more information.
    8. Map the attributes configured in your Identity Provider by entering the name for each attribute in the corresponding field on the screen. Be sure to provide the attribute name - not the friendly name. Here is an example of For example, if you are using Shibboleth for your Identity Provider the attribute information is located in the attribute-resolver.xml file in a Shibboleth IDP implementation.

    ...

    1. . The image shows the section of the file where the attributes are defined.
      Image Modified
      The image below shows the attribute mapping on the screen with the

    ...

    1. attribute names from the Shibboleth file:

    ...

    1. Image Added

     

     

    1. Custom attributes can
    2. be retrieved from your Identity provider
    3. be mapped by typing the attribute names in the Custom field separated by a comma.
    4. Refer to this topic which discusses an example that pulls additional attributes from Active Directory into a form using business rules. 
    5. Click Submit. 
    6. Return here to see how to login to your SAML tenant to Logging into LiveForms in a SAMLTenant for login instructions.

    Edit Tenant

    A tenant admin or a superuser admin can use the Tenant page to configure or edit information about a tenant. 

    ...

    Note that you cannot change the Tenant Id, although you can change the Name and Description. Tenants using the Default

    The following Security Manager changes can be changed to the following Security Managers made by clicking the Change button and making a selection from the dropdown,. Cloud customers should contact sales@frevvo.com to initiate the procedure.

    • Default Security Manager → LDAP
    • Default Security Manager → SAML
    • LDAP → SAML

    ...

    If you are editing a tenant using the LDAP/Active Directory Security Manager or the LDAP Container Security Manager configured LDAP properties will display. These properties  can be modified using this screen.

    Image RemovedImage Added

    If you are editing a tenant using the SAML Secuirty Manager, configured metadata and attribute mappings will display. These values can be modified using this screen.

    ...

    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.

    ...

    1. Click the Manage Roles link.
    2. You will see several pre-created roles: frevvo.Designer, frevvo.Editor, frevvo.Publisher, frevvo.ReadOnly.
    3. Click the icon, fill in the form and submit it to create new roles e.g. Employee or Manager.
    4. Click the Back to Manage Tenant link.
    5. Next click the Manage Users link.
    6. For  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  Onlne you will see two users – the administrative user and the designer username you specified when you signed up for your trial SaaS account.
    7. 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.
    8. The new user will be created. Create as many users and assign them roles as needed.
    9. 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.
    10. 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: user@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.  

    ...