Configure Shinydocs Pro Control Center for Laserfiche

This connector is in early access. To enable it, you must enable Laserfiche Connector in https://localhost:9701/flags.

Requirements

• The server Shinydocs is installed on will require internet access to reach Laserfiche.

• You must be a Laserfiche administrator to configure this connector

Step 1 - Laserfiche Set Up

Before connecting Shinydocs Pro to Laserfiche, you must configure the required identities and applications in your Laserfiche Cloud account. This includes creating a service principal, granting it full rights, creating a service application for Shinydocs Pro, and creating a Web App for signed in Laserfiche users.

You will collect four values during this process.

• Service principal key

• Access key

• Web App Client ID

• Web App Client Secret

You will enter these in Control Center later.

1. Create the Service Principles group

1. You can skip this step if you already have a service account type group with the below permissions.

2. Sign in to your Laserfiche Cloud administration portal.

3. Open the App picker in the top-right, select Repository Administration.

4. Click Users on the left nav-bar.

5. Select the Groups tab.

6. Create the group servicePrinciples, and provide it all Feature rights

   

2. Create the ShinydocsPro service principal in Laserfiche

1. Open the App picker in the top-right, select Account.

2. Select Users on the left-nav bar, then select the Service Principals tab.

   

3. Click Add Service Principal.

4. Create a new service principal:
   • Username: ShinydocsPro
   • Display name: ShinydocsPro

5. Assign the service principal to all groups that require repository access (generally, add it to all of your existing groups for full coverage), make sure servicePrinciples group (or your permission equivalent group) is in the list.

6. Select Rights and apply the Full Rights preset. This gives the service principal full access needed for crawling and enrichment.

   

7. Click Create.

8. You will now be back at the list of Service Principals, select the ShinydocsPro principal from the list

9. Click Create Service Principal Key(s) to generate the service principal key.

   1. ✏️You can only view this key once, store this securely. You will need to enter it in Control Center.

   2. Laserfiche automatically generates two, though you only need one.
      

      

3. Create the ShinydocsServices service in the Laserfiche Developer Console

1. Open the Laserfiche Developer Console in App picker .

2. Click the New button to create a new application.

3. Select Create a new app.

4. Select Service and provide it a name like ShinydocsServices. Click Create.

5. On the service configuration page, set Service Account to the service principal you created earlier (ShinydocsPro). Laserfiche calls this the service account field in the UI.

6. Open the Authentication tab.

7. Generate a new access key for ShinydocsServices.

   1. Select Create a long-lasting ‘Authorization Key’ secrect used to obtain Laserfiche API Access Tokens.

      

   2. Click Next.

   3. Enter one of the Service Principal Keys generated when the Shinydocs Pro service principal was created.

   4. Click Create key.

      1. ✏️ Store the key in a safe place, you will need this later.

   5. Near the bottom of the page, select all OAuth 2.0 Scopes & ensure all projects or Global is selected

      

   6. Click Save.

3. Create the ShinydocsUsers Web App in the Laserfiche Developer Console

Next, we are going to add a Web App application, go back to the root of the Developer Console and click the New button.

1. Select Create a new app.

2. Select Web App and provide it a name like ShinydocsUsers, click Create.

3. In the App Configuration, select the Authentication tab.

4. Set the redirect URIs. At a minimum include:
   • https://localhost:9701/oauth/authorize
   • https://localhost:3000/oauth2/callback
   Note: localhost will only work on the server Shinydocs Pro is installed on. When you deploy Shinydocs Pro Control Center access, you will need to add additional URIs with your DNS/hostname instead of localhost! Setting up Shinydocs Control Center for Intranet Access

5. In the Client Credentials section, click Click to reveal to see the Client Secret, ✏️ you will need this secret and the Client ID later.

   

6. Enable the option labeled:
   Grant application ShinydocsUsers access to this Laserfiche Cloud account on behalf of all users

   

7. Select all OAuth 2.0 scopes again (same as your service application).

8. Click Save. Your configuration should look similar to this

   

You should now have everything required to analyze your Laserfiche environment:

1. ✏️Service Principal Key

2. ✏️Access key

3. ✏️Client ID

4. ✏️Client Secret

Step 2: Set up Laserfiche Source in Shinydocs Pro

Remember, you need to enabled this connector in /flags in Shinydocs Pro Control Center.

Laserfiche’s API does not support the retrieval of all fields available without significant API overhead which will worsen their API throttling. If you do wish to add all fields (increasing crawl time by at least 10x with more timeouts) you can enable Add all Laserfiche fields in /flags in Shinydocs Pro Control Center.

1. In Shinydocs Pro Control Center, click + Add Source

   1. If this is your first source, you will already be in the Add Source wizard

2. Select Laserfiche from the list of options

3. Fill out the fields with the information you generated in Laserfiche

   

   1. Connection name: Leave as Laserfiche or provide it a name you would like

   2. Service Principal Key: Enter one of the Service Principal Keys that were generated earlier.

   3. Access Key: Enter the access key that were generated earlier.
      Note: this key is typically VERY long

   4. Under Search Authentication Type, select Protected - OAuth2.

   5. Search App Client ID: Enter the Client ID from the Laserfiche Web App creation

   6. Search App Client Secret: Enter the Client secret from the Laserfiche Web App creation

   7. Login/Authorize Endpoint: Leave as is if you use laserfiche.ca, otherwise update it to the URL you use (i.e. laserfiche.com).

   8. Token Endpoint: Leave as is if you use laserfiche.ca, otherwise update it to the URL you use (i.e. laserfiche.com).

   9. Revoke Token Endpoint: Leave as is if you use laserfiche.ca, otherwise update it to the URL you use (i.e. laserfiche.com).

   10. Redirect URL: https://localhost:9701
       NOTE: You need to update the redirect URL in Shinydocs Pro, just like you need to do in Laserfiche when Shinydocs Pro Control Center is accessed outside of the server (Setting up Shinydocs Control Center for Intranet Access).

4. Click Next.

5. Now you can decide what you want to analyze in Laserfiche.

   

   1. You can use the following inputs:

      1. Leave the field blank to analyze all Laserfiche repositories

      2. Use the text value of the repository you want to scan, or the repository ID (r-<string>)
         E.g. Your repository name is Shinydocs Corporation

         

         Shinydocs Corporation would be the value you enter

         

         1. You can also get the repository ID in your browser URL:

            CODE

            https://app.laserfiche.ca/laserfiche/Browse.aspx?repo=r-0001464db7c...

            In this case, the ID is r-0001464db7c

      3. Use the text value of the repository (or repository ID) and the ID of the folder you want to analyze.
         Repository, folderID
         Folder IDs can be found in the Laserfiche UI by clicking the folder and viewing it’s details, or in the browser URL while in the folder

         

   2. 

      Click Start analysis, you’re now analyzing your Laserfiche content! It is also now searchable in Shinydocs Search.