Live Forms v6.3 is no longer supported. Click here for information about upgrading to our latest GA Release.

Skip to end of metadata
Go to start of metadata

frevvo supports the creation of a tenant using the SAML (Security Assertion Markup Language) Security Manager. Users in this tenant can log into frevvo via  (SAML) version 2.0. SAML enables internet single sign-on by allowing users to authenticate at an identity provider and then access service providers without additional authentication.

The SAML Security manager can be used in on-premise installations but it is primarily meant for cloud tenants who use LDAP but do not want to expose it over the internet.

SAML requires the configuration and installation of an identify provider that supports SAML 2.0. Some examples are Shibboleth, OpenSSO, ADFS, and PingFederate.

In a SAMLenvironment, integration with an LDAP server for authentication is common. In general, here's how it works:

  • User A attempts to access Live forms by typing the URL into the browser
  • Live forms sends a SAML request for authentication to the Identity Provider
  • The Identity Provider requires more information. The Identify Provider login screen is displayed.
  • User A logs into the Identity Provider.
  • The Identity Provider may communicate with your LDAP server if you are using Active Directory for authentication.
  • The Identity Provider builds and sends a SAML token to Live Forms containing the security information for User A.
  • Live forms processes the information. If User A has been authenticated, Live forms establishes a session and redirects User A to the correct Live Forms screen depending on User A's authorization level.

On this page:


 Authentication Only mode:

When you create your  SAML tenant, you can select Authentication Only mode..This is done by checking a checkbox when you configure your SAML tenant.

If Authentication Only is selected, SAML is used only for authentication. Authorization depends on the roles defined in frevvo.  SAML will authenticate the user but not retrieve any of the attributes.
You may choose to use this mode if you:

  • do not want to add frevvo roles to your LDAP.

  • LDAP has many roles that have no relevance to your workflow.

  • Find the SAML mapping for the other required attributes complex. For example, retrieving the manager user id and role names may require writing custom rules.

In this mode, manual creation of users & roles in the frevvo tenant is required. The frevvo CSV upload feature makes this easy.

If Authentication Only is not selected, u
sers will be added (discovery) at runtime when they log in for the first time. It is important to consider the following points before making your decision.

    • User discovery:

      • There is no guarantee that the first login will occur before a task is created for a specific user /role. If you have workflows, that are routed to users who have not logged in yet, your workflow may not do what you expect. If the user’s role changes after 1st login but before the next task is routed to their new role, the task will not appear on their Task List. For example, a user with the role of employee, logs into frevvo. The user then gets prompted to manager. The user will not receive a task routed to the user's new role of manager. workflow is initiated before the user logs out and logs in again and the user account is updated.

      • Manually creating/uploading users and roles ahead of time avoids this situation.

  •  Active Directory:
      • Customers using LDAP must ensure that the frevvo.User, frevvo.TenantAdmin and frevvo.Designer roles are specified on their LDAP/AD server. 
        • All users requiring access to frevvo must be assigned to the frevvo.User group. 
        • Tenant admin users must be assigned to the frevvo.User and frevvo.TenantAdmin groups,
        • Designer users must be assigned to the frevvo.User  and frevvo.Designer groups.

The group names for these three special roles must be frevvo.User, frevvo.TenantAdmin, and frevvo.Designer. Upper/lower case may be a factor for Open LDAP systems. 

Configuring the SAML Security Manager

In the directions given below, the Service Provider refers to frevvo frevvo. The metadata for your frevvo SAML tenant must be obtained first. Customers will need to configure the frevvo metadata when creating the SAML tenant.

  1. Generate your certificate (On-premise installations only)
  2. Create the frevvo Metadata file.
  3. Configure your Identity Provider
  4. Create/edit the SAML tenant
  5. Manage Users/Roles for your SAML tenant
  6. Logging into Live Forms in a SAML Tenant

Step 1 - Generate Your Certificate

Cloud customers can skip this step. These instructions are provided for On-premise customers only.

If you re using the frevvo tomcat bundle, the supplied keystore, frevvoKeystore.jks is located in the <frevvo-home>/tomcat/lib folder, The keystore contains a default certificate with alias=frevvo and password=p@ssw0rd. Replace this  with a certificate for your installation.

  • The alias and password can be configured with the properties, and in the <frevvo-home>\tomcat\conf\localhost\frevvo.xml file.

This certificate is used to sign/encrypt the SAML request. The use of a long-lived self-signed certificate is recommended.

Since the keystore is located outside the frevvo war, you can use the Java keytool to generate and store your certificates. Folllow these steps:

  1. Login as  Administrator.

  2. Delete the existing certificate:

    keytool -delete -alias frevvo -keypass p@ssw0rd -keystore frevvoKeystore.jks -storepass p@ssw0rd
  3. Generate a new certificate: Here is the command: Change the -dname value to the DNS name of your IDP

    keytool -genkey -dname "" -alias frevvo -keypass p@ssw0rd -keystore frevvoKeystore.jks -storepass p@ssw0rd -keyalg rsa -keysize 2048 -validity 3650
  4.  The certificate can be viewed (and used in the metadata XML) by exporting it to a file:

    keytool -exportcert -alias frevvo -file frevvo.rfc -rfc -keystore frevvoKeystore.jks -storepass p@ssw0rd

Step 2 - Create the frevvo Metadata file

Follow these steps to generate the frevvo metadata for your SAML tenant. You can do this even if the tenant has not been created yet.

  1. Paste this URL into your browsr:

    1. Cloud Customers:{t} - replace {t} with the tenant id of your SAML tenant.

    2. On-premise customers: http://<server>:<port>/frevvo/web/saml/metadata/alias/{t} - replace <server> with the ip of your server, <port> with the port number (if applicable) and t with your tenant id).

  2. When the metadata displays, right click and select the browser option to View the Page source.

  3. Save the page as an xml file.

  4. Metadata must be generated for each SAML tenant. Each tenant will have a unique URL.

Step 3 - Configure Your Identity Provider

  1. Configure the Service Provider metadata for your Identity Provider. For example, the Shiboleth Identity provider requires modification of a file to provide the path to the frevvo tenant metadata xml file created above.
  2. Your Identity Provider must be configured to expose the attributes that frevvo requires. Attribute mapping is done when you create the SAML tenant. These are:
    1. User Id
    2. First Name
    3. Last Name
    4. Email
    5. Manager Id (optional)
    6. Groups
    7. Custom Attributes (optional)

We know that your IDP software of choice is outside of the frevvo server software and that you have the expertise in house to install, configure and maintain your IDP software. But here are some tips we have found that may assist you.

 Click here for some tips when configuring ADFS

The information below applies to ADFS v2.0. If you are using a different version, your ADFS expert must locate the equivalent functions for that version.

  1. Save the frevvo tenant metadata as an xml file. Add Relying Party Metadata Trust. Use the 'Import data about the relying party from a file' option to upload the saved xml file.
  2. In Edit Claim Rules, create a rule to map AD attributes to the outgoing claim type as shown below.  Information about creating rules to send LDAP attributes as Claims can be found on this website

    1. samAccountName to NameID - If you rather generate an opaque identifier, you would need to create custom rules as described here.
    2. samAccountName to Windows Account Name
    3. givenName to Given Name
    4. Surname to Surname
    5. emailAddresses to Email Address
    6. Group membership is added using the wizard. Select Token-Groups Unqualified Names and map it to the Group claim

  3. Extract the Manager's samAccountName. This can be done using the following 3 custom claim rules. This rule assumes that the CN of the manager DN contains the samAccountName:

    c:[Type == "", Issuer == "AD AUTHORITY"]
    => add(store = "Active Directory", types = (""), query = ";Manager;{0}", param = c.Value); 
    Manager SAM1
    c:[Type == ""]
    => add(Type = "", Value = RegExReplace(c.Value, ",[^\n]*", ""));
    c:[Type == ""]
    => issue(Type = "", Value = RegExReplace(c.Value, "^CN=", ""))
  4. In the frevvo tenant, map the attributes as shown below. Refer to this website for more information about Claims.

  5. It is recommended that you turn on tracing in ADFS, so that the SAML response is visible. The response contains the names of the attributes to be used in the tenant configuration. If tracing is not turned on, the frevvo log can be searched for the class of the debug log entry.

 Click here for instructions to configure Google Apps as the SAML IDP

Follow these steps to setup Google as the Identity Provider and Live Forms as the Service Provider to configure Single Sign On. These instructions are for Cloud. On-Premise customers follow the same steps with one additional step to generate a certificate:

  1. On - Premise customers ONLY: Generate a certificate. 
  2. Configure Google as the Identity Provider
    1. Login to your Google domain as an admin, go to the admin portal and click through to Apps > SAML Apps. If you have any existing SAML apps, you’ll see them here. Click the big PLUS (+) sign at bottom right to add a new one. A wizard will appear.
    2. Click the “Setup My Own Custom App” link at the bottom of the screen.

    3. Choose Option 2 and Download the IDP metadata file.

    4. Provide a name for your application, a description and a logo.

    5. Enter the Service Provider (frevvo) details.
      1. For ACS URL, type{tenant} - replace {tenant} with your cloud tenant.
      2. For Entity Id, type{tenant} - replace {tenant} with your cloud tenant.
      For example,
    6. Leave the built-in Name Id attribute configuration alone.

    7. Add a new Attribute Mapping: User Id | Basic Information | Primary Email

    8. Click Finish. The Setup Complete screen displays.
    9. Click OK.
    10. Your new SAML App will be displayed. Click the three dots at right and turn ON SSO. You can choose to turn it ON for everyone in your domain or for specific sub-domains.

  3. Create users in Google:
    1. Create your users in Google or move existing users into the appropriate sub-organization if you are limiting access to your SAML app in Google. You won’t have to create new users or move existing users if you enabled the SAML app for everyone in your Google domain.
    2. you’ll need a user in your Google domain to serve as the tenant administrator. Either, create a new one or choose an existing one (there’s nothing to do as long as you choose someone).
  4. Create users in frevvo:

    1. You need to ensure that the user you chose/created as the tenant admin exists in frevvo. Once we switch over to SAML, all authentication will use Google Apps credentials and you won’t be able to login using your current tenant admin or other users. We’ll use CSV upload. The file syntax looks like this:


      The fields are your Google login (e.g., your frevvo tenant id (e.g., any password (it is not used), the first name, last name and email address. In the roles field, use the roles indicated above.

    2. Login as the current tenant admin user.
    3. Click on Manage Users.
    4. Click on Download CSV users file.
    5. Edit the file to setup at least one Google User (the one you chose/created as the tenant admin).
    6. Click on CSV Upload (the Excel looking icon) and upload the file to create this user.

  5. Configure frevvo as the Service Provider:
    1. Generate the SP metadata file from frevvo. Visit the URL:{tenant} in your browser. Replace {tenant} with your cloud tenant. Right click to View Page Source and save as an XML file.
    2. Login to your Cloud account as tenant admin and click the Edit Tenant button.
    3. In the Security Manager section, click the Change button, choose SAML in the drop down that appears and click Ok. NOTE: Free Trial accounts do not show the Change button. If the Change button is not visible in your tenant, please contact customer support.
    4. The SAML configuration section will appear. In the Service Provider section, we must paste the SP metadata file we generated in Step 1 above. Unfortunately, the file contains an XML prolog (highlighted in the image below) which must be removed. Paste the contents of this SP metadata file without the prolog into the Service Provider text area of the configuration form.
    5. In the Identity Provider section, paste the IDP metadata file we generated and saved in the Google setup above. Once again, the file contains an XML prolog. Paste the contents of this IDP metadata file without the prolog into the Identity Provider text area of the configuration form.
    6. Check Authentication Only. This means SAML will authenticate the user but not retrieve any of the attributes. Users are not automatically discovered upon first login. Therefore, you must create users & roles using CSV upload.
      • If you do not wish to select the Authentication Only option, you’ll need to map other attributes in Google first before you can assign them in Frevvo. First Name, Last Name, and Email should be pretty straight forward since these attributes are surfaced by the Google SAML IdP app. The other attributes may be more difficult.
    7. With the Authentication Only option, attribute mapping only includes one attribute, the User Id. Since we mapped the email address to the User Id attribute in Google while setting up the SAML app, we can simply map the frevvo attribute to User Id in the configuration form.
    8. Submit the form and we’re done.

      Edit tenant.

      Setup SAML

      SP Metadata (paste without XML Prolog)

      IDP Metadata (paste without XML prolog)

  6. How to use your new SAML tenant
    1. Logout of all your Google accounts to test.
    2. Go to the tenant URL:{tenant}/login. Replace {tenant} with your tenant id.
    3. You will be redirected to the Google login page.
    4. Login to Google as the Google user you chose/created as the tenant admin.
    5. You will be redirected to frevvo to the Manage Tenant screen.

    The user id displayed in frevvo at the top will look like {user}@{domain}@{tenant} which is a bit confusing but is purely cosmetic.

  7. Load other users in frevvo

    Before your other Google users can login to frevvo using their Google Apps credentials, they must first be created in frevvo. You can download users from Google Apps as a CSV file (uncheck the create a Google Sheet option), modify it to follow frevvo’s syntax as shown above and upload it. You can also login as the tenant admin Google user and create users and roles using the UI.

    Once the user exists in frevvo, he/she can login using Google credentials and the system will behave as expected according to the roles assigned to the user.

Step 4 - Create/edit the SAML tenant

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

 frevvo metadata file

  • The metadata for your Identity Provider
  • Attribute mapping information  

frevvo cloud customers, migrating your tenant to the SAML Security Manager, will make the changes via the Edit Tenant screen. Once accessed, follow these steps beginning with step 3.

 Log onto frevvo as the superuser (on-premise) or the tenant admin (cloud).

  1. Access the Add Tenant (on-premise) or Edit Tenant (cloud) screen.
  2. Select SAML Security Manager from the Security Manager Class dropdown.
  3. 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:

  4. Retrieve the metadata for your Identity Provider. For example, for the Shiboleth product the metadata is located in the idp-metadata file.

  5. Paste the metadata into the Identity Provider field. This metadata should also be pasted without the prolog.

  6. Check the Ignore Case checkbox if you are using LDAP for authentication and you want frevvo to ignore the case stored in LDAP systems for users/roles. Refer to the Mixed or Upper case User Names topic for more information.
  7. Check the Authentication Only checkbox if you want SAML to handle authentication and provide user identification but users and roles are managed through the frevvo UI.
    1. When checked, the screen display changes as attribute mapping, other than the mapping for the user id and custom attributes, is no longer necessary.

    Authentication Only:

    • If Authentication Only is checked:
      • SAML will authenticate the user but not retrieve any of the attributes. Authorization depends on the roles defined in frevvo. Changes made in the frevvo UI will not be overridden if the user logs out and then logs in again.
      • Manual creation of users & roles in the frevvo SAML tenant is required. This can be done with a csv upload.

    • If Authentication Only is unchecked:
      • All users requiring access to frevvo must be assigned to the frevvo.User group in Active Directory. Tenant Admins must be assigned to the frevvo.User and frevvo.TenantAdmin groups. Designer users must be assigned to the frevvo.User and frevvo.Designer groups.

      • Users are added (discovered) when they log in. 
      • It is important to know that a SAML tenant in this mode (SAML/LDAP handles authentication and authorization) that users and tenant admins can modify user information in the frevvo UI. If user information/role assignment is changed in the frevvo UI, the changes will be overwritten by the information in SAML the next time the user logs out and then logs back in again. In this case, make the changes in your Active Directory to make them permanent.
  8. Map the attributes configured in your Identity Provider by entering the name for each attribute in the corresponding field on the frevvo screen. Be sure to provide the attribute name - not the friendly name. For example, if you are using Shibboleth for your Identity Provider the attribute information is located in the attribute-resolver.xml file. The image shows the section of the file where the attributes are defined. 

    The image below shows the attribute mapping on the frevvo screen with the attribute names from the Shibboleth file:

    If Authentication Only mode is enabled for your tenant, mapping is only required for the User Id. Refer to step 8 for the details

  9. Custom attributes can be mapped by typing the attribute names in the Custom field separated by a comma.
  10. Configure the Business Calendar for your tenant and HTTP Authorization Credentials if required.
  11. Click Submit.

Step 5 - Users/Roles in a SAML tenant

Choosing the Authentication only option in your SAML tenant implies that the user and roles will be managed from frevvo. You may choose this mode if:

    1. You do not want to add frevvo roles to your LDAP.
    2. LDAP has many roles that have no relevance to your workflow.
    3. Find the SAML mapping for the other required attributes complex. For some IDPs, retrieving the manager user id and role names may require writing custom rules.

When Authentication Only is selected (checked) there is no discovery of Users & Roles. They must be created in your tenant manually. The CSV upload is a good way to do this.

When Authentication Only is not selected (unchecked) frevvo will discover new users at run-time. However users are only discovered when the person tries to login. They are not discovered nor is their user data (email, name, report-to) kept in sync automatically. It requires the user to login. So, this does not necessarily remove the need for manually creating/uploading users and roles ahead of time nor does it remove the need to continuously update the users when changes are made in LDAP. 

If you have workflows that are routed to users/roles there is no guarantee that the required users will login before a task is created for that user (specifically or via a role). For example, if  a workflow is routed to a specific user and it is performed before the first login of that user, frevvo will send an email to the tenant admin indicating that the user is unknown. Routing based on the user's manager will fail. Routing based on a role will succeed but the user will receive no notification.

Manually creating/uploading users/roles in frevvo ahead of time avoids this situation. 

It is important to know that a SAML tenant with Authorization Only unchecked, means that authentication and authorization are handled by SAML/LDAP. Users are added/updated through discovery. If a tenant admin modifies user information in the frevvo UI, for example, changes an email address or adds a role for a user, the changes will stay in effect until the user logs out of the tenant and then logs back in. When the user logs back in, the changes made in the frevvo UI will be overwritten by the information in SAML/LDAP. In this case, make the changes in your Active Directory to make them permanent.

Step 6 - Logging into Live Forms in a SAML Tenant

  1. Paste this URL into your browser:
    1. Cloud Customers:{t}/login - Replace {t} with the name of your SAML tenant.

    2. On-premise Customers:http://<server>:<port>/frevvo/web/tn/{t}/login. Replace <server> and <port> with your server information and t with the name of your SAML tenant.
  2. frevvo screens display depending on the level of authorization specified for the user. Designer users will see the Application Home Page while non-designer users will be directed to their Task List.

This URL redirects to /web/saml/login/alias/{t}. This initiates the SAML authentication process by redirecting to the Identity Provider login page.  If the user is authenticated, the rest of the standard login processing is done (verify license, redirect on success etc).

Clicking the logout link in frevvo, logs the user out from frevvo only.

Logging into a SAML tenant directly (user@saml tenant name) displays an application error message.

On-premise customers using the tomcat bundle will see the following entry in the frevvo error log:

Application error processing /frevvo/web/login?null java.lang.UnsupportedOperationException: null

Session Timeout

Session timeouts are configured in frevvo and in your IDP. If a user's session ends before the IDP timeout is reached, they will automatically be logged back into frevvo if they try to access it again. It is recommended that the frevvo session timeout and the IDP session timeout be configured for the same value.

Embedding Forms/Flows in your website

Embedding forms and flows into your website when using the SAML Security Manager, will work in the following scenarios :

Embedding forms and flows into your website is NOT supported if the the visibility of the form is set to Public in Tenant and the user is NOT already authenticated to SAML. This is because frevvo must direct the user to the IDP login screen and the browser will not allow loading the IDP login page in frevvo's form iframe.

Some Troubleshooting Tips

Login fails with illegal Key Size Error

After a failed login, this error message may appear in the <frevvo-home>\tomcat\logs\frevvo.log file: Illegal key size 
at ~[xmlsec-1.5.7.jar:1.5.7]
org.opensaml.xml.encryption.DecryptionException?: Failed to decrypt EncryptedData? 
at org.opensaml.xml.encryption.Decrypter.decryptDataToDOM( ~[xmltooling-1.4.4.jar:na]


This error indicates the Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files are missing in the Java Development Kit (JDK) software of your on-premise installation. Follow these steps to install the JCE files into the JDK.

  1. Go to the Oracle Java SE download page
  2. Scroll down … Under "Additional Resources" section you will find "Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy File"
  3. Download the version that matches your installed JVM  - for example, download if you are using JDK/JRE version 8
  4. Unzip the downloaded zip. 
  5. Copy local_policy.jar and US_export_policy.jar to the <JAVA_HOME>/jre/lib/security (Note: these jars will be already there so you have to overwrite them)
  6. Restart frevvo.


  • No labels