Live Forms Latest - This documentation is for Live Forms 8.0 Not for you? Earlier documentation is available too.

Versions Compared

Key

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

Frevvoproduct
Live Forms supports the creation of a tenant using the Azure SAML ( Security Assertion Markup Language) Security Manager. Users in this tenant are redirected to the Microsoft Azure login screen and then to
Frevvoproduct
when that login screen is submitted.The Azure SAML Security manager can be used in cloud Manager for Single Sign On. Users/roles are automatically pulled from Azure AD into Live Forms cloud tenants and on-premise installations.

  • Allows on-premises AD to be exposed to the frevvo cloud via synchronization with Azure AD
  • Uses the graph API to access users and groups from AD.
  • SAML is used for authentication only, providing single sign on.
  • SAML is built into Azure AD. It is not necessary to setup an identity provider.

The Azure SAML Security Manager pulls users/roles from Azure AD. Users are redirected to the Microsoft Azure login screen for authentication.

frevvo recommends using the SAML Security Manager for customers who want to manage users/roles from the 

Frevvoproduct
UI.

Column
width450px

On this page:

Table of Contents
maxLevel2

...

  • You will need a valid Microsoft Azure subscription
  • The frevvo.TenantAdmin and frevvo.Designer groups must must be specified on your Active Directory server. The group names must be spelled as shown. Upper/lower case may be a factor for Open LDAP systems. These groups are required.

    • Tenant admin users must be assigned to the frevvo.TenantAdmin group.
    • Designer users must be assigned to the frevvo.Designer group.
  • The frevvo.Publisher and the frevvo.ReadOnly groups are optional. Refer to the links provided for information about when these groups are used to help you decide whether or not you want to create them.
    • Users with the frevvo.publishers role must be assigned to the frevvo.Publisher group. Refer to the Administrator Best Practices for an explanation of this role.
    • Users with the frevvo.ReadOnly role must be assigned to frevvo.ReadOnly group.

...


Warning
  • Contact the frevvo Customer Success team to schedule your Security Manager configuration.
  • frevvo Best Practice recommends that you create a user account in your Active Directory or IDP that will house all of your deployed Production forms/flows. This user can be named anything i.e.frevvoProduction but it must be a member of the frevvo.Designer group
  • If you want to preserve Applications/Forms/flows Flows developed in your trial/starter tenant , download them to to your desktop, perform these steps BEFORE changing the Security Manager. :
    1. Download the Applications/Forms/Flows that you want to preserve to your desktop as a backup
    BEFORE changing the Security Managerfrevvo
    1. . Do this for all
      Frevvoproduct
      user accounts that have Applications/Forms/flows that you want to keep.
    2. When the backup of all Applications/Forms/flows is completed, delete the user accounts in your Default Security Manager tenant.
  • There are two additional roles in
    Frevvoproduct
    frevvo.Publisher and frevvo.ReadOnly.  These roles are optional.
    • In order to give a user the frevvo.publishers role, create the  frevvo.Publisher  group in your AD and assign users to it. Refer to the Administrator Best Practices for an explanation of this role.
    • In order to give a user the frevvo.ReadOnly role, create the frevvo.ReadOnly group in your AD and assign users to it. Following frevvo Best Practice eliminates the need for this role.
  • frevvo only supports the Azure SAML Security Manager when
    Frevvoproduct
    is running in the tomcat container. Refer to our Supported Platforms for the list of Application Servers supported/certified by frevvoApplication Servers.

Configuring the Azure SAML Security Manager

...

Step 1 - Create an Application for Live Forms in Azure

frevvo assumes that customers have someone on staff that can successfully perform this step of the procedure. Information about 

Frevvoproduct
 is listed below to help you with this process.

Info

The Azure global administrator MUST create the application for

Frevvoproduct
in Azure.

If you are familiar with the Microsoft Azure Legacy Portal, review this Microsoft Training Guide before setting up the Azure application for 

Frevvoproduct
.

...

  1. Cloud Customers should use https://app.frevvo.com:443/frevvo/web/alias/{t} - replace {t} with the name of your frevvo Cloud tenant.

    Info

    For example, if you were changing the Security Manager from the Default Security Manager to the Azure SAML Security Manager for a frevvo Cloud tenant named mycompany.com,the AP ID URL would be:

    https://app.frevvo.com:443/frevvo/web/alias/mycompany.com 

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

    Info

    For example, if you were changing the Security Manager from the Default Security Manager to the Azure SAML Security Manager for a frevvo in-house tenant named mycompany.com, the AP ID URL would be:

    https://<server:port>/frevvo/web/alias/mycompany.com 

...

Expand
titleClick here for some more tips....
Info

Do not include the curly braces in the URLs discussed below.

  1. Login to the Microsoft Azure Management console: https://manage.windowsazure.com or https://portal.azure.com with your Azure global administrator account.

...

  1. Click on the Azure Active directory link on the left side of the screen.
  2. Click on the App Registrations link.
  3. Click on the New application registration link for creating a new application.
  4. Enter the following details:
    1. Name:- Name of your frevvo Azure application
    2. Select who can use this application or access this API
  5. Configure the Redirect URL:
    1. Cloud Customers should use https://app.frevvo.com:443/frevvo/web/saml/SSO/alias/{t} - replace {t} with name of your frevvo tenant.

      Info

      For example, if you were changing the Security Manager from the Default Security Manager to the Azure SAML Security Manager for a frevvo Cloud tenant named mycompany.com, the REPLY URL would be:

      https://app.frevvo.com:443/frevvo/web/saml/SSO/alias/mycompany.com 

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

      Info

      For example, if you were changing the Security Manager from the Default Security Manager to the Azure SAML Security Manager for a frevvo in-house tenant named mycompany.com, the REPLY URL would be:

      https://<server:port>/frevvo/web/saml/SSO/alias/mycompany.com 

...

    1. Click Register.
  1. Select the frevvo application from the list.
  2. Click the Branding tab
Expand
titleClick here for some more tips....
  1. Login to the Microsoft Azure Management console: https://manage.windowsazure.com or https://portal.azure.com with your Azure global administrator account
  2. Click on Azure Active directory link present on the left side of the screen.
  3. Click on App Registrations link.
  4. Click on New application registration link for creating a new application.
  5. Enter the following details:
    1. Name:- Name of your frevvo Azure application
    2. Application type:-Web app/API
    3. SIGN-ON URL - Refer to Step1 - Create an Application for Live Forms in Azure for an example.
      1. Cloud Customers should use https://app.frevvo.com:443/frevvo/web/tn/{t}/login - replace {t} with the name of your frevvo Cloud tenant.

      2. On-premise customers should use http://<server>:<port>/frevvo/web/tn/{t}/login - replace <server> with the ip of your server, <port> with the port number (if applicable) and t with the name of your frevvo in-house tenant.

  6. Click on the Settings link then click on the Properties link.
  7. Configure the App ID URL and Home page URL as follows:AP ID URI: - Refer to Step1 - Create an Application for Live Forms in Azure for an example.
  8. Configure the Home Page URL:
    1. Cloud Customers should use https://app.frevvo.com:443/frevvo/web/tn/{t}/login - replace {t} with the name of your frevvo Cloud tenant.

      Info

      For example, if you were changing the Security Manager from the Default Security Manager to the Azure SAML Security Manager for a frevvo Cloud tenant named mycompany.com, the SIGN-ON URL would be:

      https://app.frevvo.com:443/frevvo/web/tn/mycompany.com/login

    2. On-premise customers should use http://<server>:<port>/frevvo/web/tn/{t}/login - replace <server> with the ip of your server, <port> with the port number (if applicable) and t with the name of your frevvo in-house tenant.

      Info

      For example, if you were changing the Security Manager from the Default Security Manager to the Azure SAML Security Manager for a frevvo in-house tenant named mycompany.com, the SIGN-ON URL would be:

      https://<server:port>frevvo/web/tn/mycompany.com/login

You will need the Azure tenant ID, the client id and client secret key that are created for the frevvo application when configuring your

Frevvoproduct
Azure SAML tenant.

Click the Overview tab.
  1. Copy the Application ID into your notepad. This is the value of the Client ID on the frevvo configuration screen.
  2. Copy the Directory ID into your notepad. This is the value of the Tenant ID on the frevvo configuration screen.
    Click Endpoints at the top of the screen. Copy the Federation Metadata Document URL from the list to your notepad. This is the URL that you will use to generate the Azure metadata


    1. Click Save.
  1. Click on the API Permissions tab.
    1. Click Add a Permission.
    2. Select Azure Active Directory Graph from the Supported legacy APIs section.
    3. For Application Permissions, select Read and write directory data (under Directory).
    4. For Delegated Permissions, select Sign in and read user profile (under User) AND Read directory data under (under Directory).
    5. Click on the Grant Permissions button select "Yes" option  and click on the Save button.
  2. Click on the Expose an API tab.
    After clicking on Save button copy the value of "Value" column. This is the Client secret that you will need when configuring the
    Frevvoproduct
    tenant screen.
    1. Configure the Application ID URI:
      1. Cloud Customers should use https://app.frevvo.com:443/frevvo/web/alias/{t} - replace {t} with the name of your frevvo Cloud tenant.

      2. On-premise customers should use http://<server>:<port>/frevvo/web/alias/{t} - replace <server> with the ip of your server, <port> with the port number (if applicable) and t with the name of your in-house frevvo tenant.
    2. Home page URL:Cloud Customers should use
      1. Info

        For example, if you were changing the Security Manager from the Default Security Manager to the Azure SAML Security Manager for a frevvo Cloud tenant named mycompany.com,the AP ID URL would be:

        https://app.frevvo.com:443/frevvo/web/

    3. tn/{t}/login - replace {t} with the name of your frevvo Cloud tenant.
      1. alias/mycompany.com 

      2. On-premise customers should use

    4. -
      1. http://<server>:<port>/frevvo/web/

    5. tn
      1. alias/{t}

    6. /login 
      1. -

    7.  replace
      1. replace <server> with the ip of your server, <port> with the port number (if applicable) and {t} with the name of your frevvo in-house tenant.

  3. Click on Save button at the top of screen.
  4. Navigate to the Settings column then click on the Reply URLS link.
  5. Enter one of the following to create the reply URLs:
    1. REPLY URL: - Refer to Step1 - Create an Application for Live Forms in Azure for an example.
      1. Cloud Customers should use https://app.frevvo.com:443/frevvo/web/saml/SSO/alias/{t} - replace {t} with the name of your frevvo Cloud tenant.

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

  6. Click on Save button.
  7. Navigate to the Settings column then click on the Required permissions link.
  8. Click API
  9. Select Read and write directory data under Application permissions.
  10. Select Sign in and read user profile AND Read directory data under Delegated permissions
  11. Navigate to the Required permissions column:
    1. Click on the Grant Permissions button select "Yes" option  and click on the Save button.
  12. Navigate to the Registered app column and click on Manifest.
    1. Check the value of the Home Page
    2. Check the code at the end of the Manifest. Make sure the "id": "5778995a-e1bf-45b8-affa-663a9f3f4d04" has "Role,Scope" for the type. Modify if necessary.

      Code Block
      requiredResourceAccess": [                                {
                                          "resourceAppId": "00000002-0000-0000-c000-000000000000",
                                          "resourceAccess": [
                                      {
                                          "id": "5778995a-e1bf-45b8-affa-663a9f3f4d04",
                                          "type": "Role,Scope"
                                      },
                                      {
                                          "id": "78c8a3c8-a07e-4b9e-af1b-b5ccab50a175",
                                          "type": "Role"
                                      },
                                      {
                                          "id": "311a71cc-e848-46a1-bdf8-97ff7156d8e6",
                                          "type": "Scope"
                                      }
    3. If you made changes, click the Save button at the top of the screen.
  13. Click on the Settings link then click on the Keys link
  14. Enter the following details:
    1. Description- Enter any Text here.
    2. Expires-<Select any value from the dropdown>
  15. Click on Save button.
      1. Info

        For example, if you were changing the Security Manager from the Default Security Manager to the Azure SAML Security Manager for a frevvo in-house tenant named mycompany.com, the AP ID URL would be:

        https://<server:port>/frevvo/web/alias/mycompany.com

      2. Click Save.

  16. Click the Certifiates & secrets tab.
    1. Generate the Client Secret. COPY/SAVE the VALUE in a notepad - you will need this for the frevvo tenant screen.  
      There is only one chance to retrieve the client secret key when you create the application for
      Frevvoproduct
      in Azure. Once you leave this screen the value will be hidden.
    Warning

    You will need the Azure tenant ID, the client id and client secret key that are created for the frevvo application when configuring your

    Frevvoproduct
    Azure SAML tenant.

  17. To find the client id - same as the Application ID:
    1. Click on App registrations
    2. Click on your application-
    3. Copy the application ID shown for your application
  18. To find the tenant id:
    1. Select Azure Active Directory.
    2. Select Properties for your Azure AD tenant
    3. The value in the Directory ID field is the tenant ID for your Azure application.
  19. OR click the Endpoints button under App registrations. The value in between the login.microsoftonline.com and federationmetadata is the tenant id

Code Block
Code Block
titleExample of the Federation Metadata Document URL
https://login.microsoftonline.com/3d532ac1-a43c-45c7-b0e9-cc814400ca11/federationmetadata/2007-06/federationmetadata.xml

 

  • Proceed to Step 2 - Create the Live Forms metadata file
  • Warning

    Just a reminder - you will need the Azure tenant ID, the client id and client secret for the frevvo application when configuring your

    Frevvoproduct
    Azure SAML tenant.

    Step 2 - Create the Live Forms metadata file

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

    ...

    Follow these steps:

    1. Browse the azure tenant (IdP) metadata at: https://login.microsoftonline.com/{azure-tenant-name}/FederationMetadata/2007-06/FederationMetadata.xml - replace {azure-tenant-name} with the id of your

      Frevvoproduct
       application in the Azure Active Directory. This can be obtained by viewing the endpoint URLS listed when you click Endpoints Federation Metadata Document URL that you copied to your notepad when creating the Azure application for 
      Frevvoproduct
      . It is located on the Endpoints tab in your frevvo Azure application. In this example, fece6b7e-fbc6-4b3a-8287-fc07c29aa2d2 is the application id in Azure Active Directory.

      Code Block
      titleExample of Federation Metadata Document URL from Endpoints
       https://login.microsoftonline.com/fece6b7e-fbc6-4b3a-8287-fc07c29aa2d2/FederationMetadata/2007-06/FederationMetadata.xml
    2. Save all the metadata returned as an xml file. We will need to copy the entire metadata from this file to the Azure SAML Security Manager configuration screen.

    ...

    1. Log onto
      Frevvoproduct
      as the superuser (on-premise) or the tenant admin (cloud).
    2. Access the Add Tenant (on-premise) or Edit Tenant (cloud) screen.
    3. Select Azure SAML Security Manager from the Security Manager Class dropdown.
    4. Copy the Service Provider (frevvo) metadata into the Service Provider field. You can include the xml prolog when you paste the Service Provider (frevvo) metadata.



    5. Copy the metadata from the Azure tenant IDP file previously created and paste it into the Identity Provider field.



    6. Enter the Federation Metadata Document URL that you used in Step 3 to generate the Azure IDP metadata into the URL field below the Identity Provider sectioncopied from Endpoints in your frevvo Azure application. The URL is needed to handle Signing key rollover in Azure Active Directory. This URL is polled and refreshes the Azure IDP metadata every 3 hours. The new metadata is stored and automatically used as backup in case the URL is not accessible.

      In this example, fece6b7e-fbc6-4b3a-8287-fc07c29aa2d2 is the 

      Frevvoproduct
      application id in Azure Active Directory. It was obtained by viewing the endpoint URLS listed when you click Endpoints in your frevvo Azure application.

      Code Block

       

      Code Block
      titleExample of Federation Metadata Document URL
      https://login.microsoftonline.com/fece6b7e-fbc6-4b3a-8287-fc07c29aa2d2/FederationMetadata/2007-06/FederationMetadata.xml  
    7. Check the Ignore Case checkbox if you are using LDAP for authentication and you want

      Frevvoproduct
      to ignore the case stored in LDAP systems for users/roles. The field is checked by default. Refer to the Mixed or Upper case User Names topic for more information.

    8. Enter the User Id. This should be the User property name that identifies the user. A typical value is userPrincipalName, givenname etc.

    9. Custom attributes can be mapped by typing the attribute names in the Custom field separated by a comma.
    10. Enter the following information in the API Access section.
      1. Enter the Azure tenant identifier into the tenant Id field. This can be obtained by viewing the endpoint Urls listed when you click View Endpoints in your frevvo Azure application.
      2. Enter the client id and client secret key that were created as part of registering the frevvo application into the respective fields.

    11. Configure a tenant admin account. This account  does not require Azure SAML authentication. This tenant admin can log directly into
      Frevvoproduct
      providing a default security manager backdoor.

      1. The tenant admin id, password and email fields are required.
      2. When this tenant admin performs a form based login i.e. /frevvo/web/login, the password entered on this screen is used for authentication. This is also the URL used by the API.
      3. If the tenant based login url is used i.e. /frevvo/web/tn/{t}/login then the Azure SAML login is used.



      The forgot password function works for an Azure SAML tenant admin user. For all others, it will display the error message about not being supported for the tenant.

    12. Configure the Business Calendar for your tenant. The
      Frevvoproduct
      escalation feature will use this calendar to calculate deadlines and send notification and reminder emails.
    13. Enter HTTP Auth credentials if required. Credentials for external secure web services accessed by the forms and flows in your tenant can be specified in this section.
    14. Click Submit.


    ...

    If your Azure SAML userIds are in the format <username>@<domain name>, when you login to 

    Frevvoproduct
    the
    Frevvoproduct
    tenant name is appended to the userId . This is as designed. You will see <username@domain name@frevvo tenant name> as the logged in user at the top of the screen. If your domain name is the same as your
    Frevvoproduct
    tenant name, it will appear as if the domain name is listed twice.


      Excerpt
    hiddentrue

    Azure SAML Tenant backdoor admin user

    Just a reminder that the tenant admin account can login directly into Live Forms or use the Azure SAML login.

    When you create a new tenant you are prompted to set up a tenant admin user id and password. This tenant admin does not authenticate via your Azure SAML IDP. It only exists in Live Forms. If you experience an issue with your Azure SAML configuration such that you can't login as an Azure SAML authenticated user, this account provides a backdoor you can use to login to your tenant as a tenant admin in order to fix your Azure SAML configuration issue. Only one backdoor tenant admin account is supported.

    Image Modified

    If your tenant originally used the Default Security Manager and then you changed to the Azure SAML Security Manager, this tenant admin account has already been setup. If you have forgotten the password, you can change it by :

    • Using the Live Forms Forgot Password? feature for the tenant admin account.
    • Logging in as a Azure SAML authenticated tenant admin and changing the password via Manage Users.

    What if you do not remember the userid of your original tenant admin? Follow these steps:

    1. Login as your authenticated Azure SAML tenant admin
    2. Click Manage Users and click the Image Modifiededit admin icon.

    Session Timeout

    Session timeouts are configured in

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

    ...