Versions Compared

Key

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

Overview

The Manage Connectors page allows you to add and configure frevvoconfigure DocuPhase-provided connectors, such as the Docuware Connector or the DocuShare® Flex ConnectorDocuPhase Pro, Google or Filesystem Connectors. To get started, login as Tenant Admin and click Manage Connectors.

Image RemovedImage Added
Table of Contents
minLevel1
maxLevel6
outlinefalse
styledefault
typelist
printabletrue

Add Connector

When you first come to the Manage Connectors page, you will have no connectors. Click (blue star) Add to add a connector.

The Select Connector dialog will appear as a popup. Choose your connector from the dropdown. Click Select.

Image Removed879ae0bd-92a9-4976-b0ef-15ee481c8089.pngImage Added

The Configuration screen for your selected connector will appear. Proceed to Connector Configuration.

Note

Once you have added a connector the Add icon will turn gray. You may only add one connector per tenant at this time.

Connector Configuration

DocuPhase Pro

Enter your DocuPhase Pro location and credentials.

  • BaseURL - this is usually https://api.pro.docuphase.com/api

  • Department - your unique DocuPhase Pro department ID (not Department Name).

    • To find your department ID:

      • Log into to DocuPhase Pro and view any cabinet.

      • Right-click on any column header.

      • Click ‘Columns’ and select ‘location’

      • A location column will appear that includes the department ID (see screenshot below). It is usually client_files<####>. Once you copy the department ID, uncheck ‘location’ if this is not a column you normally show.

      • Note that this field is not validated; please double-check for accuracy.

        Image Added
  • User - Your DocuPhase Pro user name. The cabinets displayed in the Doc Action wizard will be those to which this user has access.

  • Password - Your DocuPhase Pro password.

Click Save. The save icon will turn light gray indicating your information was saved successfully.

Image Added

DocuShare® Flex

Enter your DocuShare® Flex location and credentials.

  • BaseURL - the location of your DocuShare® Flex platform

  • Username - your DocuShare® Flex user name

  • Password - your DocuShare® Flex password

Click Save. The save icon will turn light gray indicating your information was saved successfully.

v10.3 DocuShareFlex config complete.PNGImage Added

Docuware

Enter your Docuware location and credentials.

  • BaseURL - the location of your Docuware platform

  • OrganizationId - the id number provided by Docuware

  • Username - your Docuware user name

  • Password - your Docuware password

Click Save. The save icon will turn light gray indicating your information was saved successfully.

Image Removedv10.1 Docuware Configuration complete (test info).PNGImage Added

The Document Actions UI will display all cabinets, but you may only send to cabinets that the user configured in the Manage Connectors page has the correct permissions to edit. Incorrect permissions will result in a "403 Forbidden Form" error. To set up your Docuware permissions, please see this Docuware Documentation and ensure the user configured in frevvo has one of these permission combinations:

  • Read and Edit permission to Cabinet

  • Use permission to Document Tray

DocuShare® Flex

Enter your DocuShare® Flex location and credentials.

  • BaseURL - the location of your DocuShare® Flex platform

  • Username - your DocuShare® Flex user name

  • Password - your DocuShare® Flex password

Click Save. The save icon will turn light gray indicating your information was saved successfully.

Image Removed

DocuPhase Pro

Enter your DocuPhase Pro location and credentials.

  • BaseURL - this is usually https://api.pro.docuphase.com/api

  • Department - your unique DocuPhase Pro department ID (not Department Name).

    • To find your department ID:

      • Log into to DocuPhase Pro and view any cabinet.

      • Right-click on any column header.

      • Click ‘Columns’ and select ‘location’

      • A location column will appear that includes the department ID (see screenshot below). It is usually client_files<####>. Once you copy the department ID, uncheck ‘location’ if this is not a column you normally show.

      • Note that this field is not validated; please double-check for accuracy.

        Image Removed
  • User - Your DocuPhase Pro user name. The cabinets displayed in the Doc Action wizard will be those to which this user has access.

  • Password - Your DocuPhase Pro password.

    Google

    Create a Service Account in Google

    Notes

    • For the steps below, please follow this Google Documentation. We’ve provided some helpful hints, but you should always refer to Google’s own documentation for the most up to date information.

    • Service accounts have no direct user interface access to Google and you cannot log into a service account.

    1. Follow the four steps in this Google Documentation to create a Service Account.

      1. On Step 2, turn on the Drive and Sheets APIs.

      2. On Step 4, you must add a key to identify the client (DocuPhase Forms).

        1. Click Keys > Add Key > Upload existing key

          1. On Premise customers use the key-pair in the frevvoKeystore.jks that is shipped with the product. Run this command:
            The default password is p@ssw0rd; replace that with yours if you have changed it.

            Code Block
            keytool -export -alias frevvo -keystore frevvoKeystore.jks -storepass p@ssw0rd -rfc -file forms.pem
          2. Cloud Customers will be provided with the Cloud public key .pem file by your Project Manager during implementation. You may also contact support@frevvo.com to request the key.

        2. Upload the forms.pem into Google.

          image-20240620-192450.pngImage Added
    2. Take note of the Service Account email and the key alias, as you will need these in the next step. The default alias is ‘frevvo’.

    3. Share folders and sheets with the service account.

    Configure the DocuPhase Forms Tenant

    Login to DocuPhase Forms as the tenant admin. Select Manage Connectors, add a connector, and select Google.

    Enter your Google app credentials.

    • Client ID is the Service Account Email

    • Key Alias is the key alias of your DocuPhase Forms key

    image-20240613-181958.pngImage Added

    Click Save. The save icon will turn light gray indicating your information was saved successfully.

    Image Removed

    SharePoint

    Register the App in Microsoft

    Please consult the Microsoft Graph API documentation for the most up-to-date steps.

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

    2. Browse to Identity > Applications > App registrations and select New registration.

      1. Enter a Name for your application, e.g. Forms_Sharepoint_Connector.

    3. Browse to API Permissions.

      1. Select the permissions:

        1. Files.ReadWrite.All

        2. Sites.ReadWrite.All

        3. User.Read

      2. Click Grant admin consent above the permissions table.

    4. Browse to Certificates and Secrets. Create a new secret with an expiration of your choice. Please note, neither DocuPhase Forms nor Microsoft provides a warning when the secret is near expiration. Please mark your organization’s calendar to update the secret at the appropriate interval.

      1. Copy the Secret Value and paste to a text pad.

    5. Browse to the Overview tab.

      1. Copy the Director Directory (tenant) Id and paste to a text pad.

      2. Copy the Application (client) Id and paste to a text pad.

    Configure the DocuPhase Forms Tenant

    Login to DocuPhase Forms as the tenant admin. Select Manage Connectors, add a connector, and select SharePoint.

    Enter your SharePoint app credentials.

    v11.3 Manage Connectors SharePoint Config screen.PNG
    • TenantId is the Directory (tenant) Id copied from Microsoft

    • Client ID is the Application (client) Id copied from Microsoft

    • Client Secret is the secret value copied from Microsoft

    Click Save. The save icon will turn light gray indicating your information was saved successfully.