Configure Shinydocs Pro Control Center in Box

To analyze content from your organization's Box repository, you will need to create two new application in your Box tenant for Shinydocs Pro. This guide will show you how to add the application and get the following details required for Shinydocs Pro to connect to Box:

• Analysis Client ID

• Analysis Client Secret

• Search Client ID

• Search Client Secret

• Search Redirect URL

• Enterprise ID

Requirements

• Access to Box URL from server running Shinydocs Pro (internet connection required)

  • Example: http://box.com 

• Access to your organization’s Box Dev Console

• Your account must have MFA enabled in Box to use client secret authentication

Analysis Setup - Box

1. Log in to Box at Box Developer Console.

   

   
   

2. Create a Custom App:

   1. Select Custom App and choose

      1. App Name: Shinydocs Pro Control Center

      2. Description: (optional)

      3. Purpose: Other

      4. Please specify: Analyzing content

      5. Who is building this application? (optional): Partner

      6. Please specify: Shinydocs

   2. Click Next.

   3. Authentication Method: Server Authentication (Client Credentials Grant)

      

   4. Click Create App.

3. Configure your app and get connection details:

   1. Box Dev Console should automatically take you to your new application’s Configuration page. If not, find your newly created app in My Apps and click on the Configuration tab.

   2. Scroll down to the App Access Level section and change the access level to App + Enterprise Access.

   3. Scroll down to the Advanced Features section and enable:

      1. Make API calls using the as-user header

      2. Generate user access tokens

         

         
         

   4. Save your changes.

   5. While on the Configuration page, check the OAuth 2.0 Credentials section for your Client ID and Client Secret (you may have to click the Fetch code button).

4. Approve the application (requires Admin)

   1. Within the app details (https://app.box.com/developers/console/app/#######), click on the Authorization tab.

      

   2. Click on Review and Submit.

   3. Review the app details and provide a description, then click submit

      

   4. Navigate to https://app.box.com/master (you should also receive an email if you are the administrator with a link to the approval).

   5. Click on Apps on the left > Custom Apps Manager.

   6. Find your newly created app in the list of apps, hover your mouse over the entry and click View.

      

   7. Click the Authorize button and confirm the authorization.

5. Get your Enterprise ID:

   1. Go to https://app.box.com/master/settings/accountBilling

   2. You will find your Enterprise ID under Account Information.

Search Setup - Box

Still in the Box Developer Console:

1. Go to My Platform Apps.

2. Click Create Platform App.

3. Select Custom App:

   

4. Fill out the custom app details:

   

   1. App Name: Shinydocs Search

   2. Description: Integration with Shinydocs Search

   3. Purpose: Integration

   4. Categories: Productivity

   5. Which external systems are you integrating with?: Shinydocs Search

   6. Who is building this application: Partner

   7. Please specify: Shinydocs

5. Click Next.

6. In Step 2 of 2, select User Authentication (OAuth 2.0):

   

7. Click Create App.

8. You will now be in the Shinydocs Search app configuration

   

9. Scroll down to the OAuth 2.0 Credentials section

   

   1. Note the Client ID and Client Secret, you will need these later.

10. Scroll down further to OAuth 2.0 Redirect URIs

    1. Add the following URIs:

       1. https://localhost:9701/oauth/authorized

       2. https://<hostname>:9701/oauth/authorized
          Replace <hostname> with the machine name Shinydocs Pro is installed on.

       3. (optional) https://<FullyQualifiedDomainName>/oauth/authorized
          Replace <FullyQualifiedDomainName> with the machine name Shinydocs Pro is installed on.

11. Click Save Changes in the top-right of the page.

Configure Shinydocs Pro Control Center

1. In Shinydocs Pro Control Center, select Add source. It is on the Overview page and the Sources page.

2. On the New tab, select Box, then select Next. To add another source to a Box connection you already set up, use the Existing tab instead.

   

3. Enter the details from your Shinydocs Pro Control Center (analysis) app:

   

   • Connection name: leave as is, or enter a name of your own.

   • Client Id and Client Secret: from the analysis app’s configuration.

   • Enterprise ID: your Box Enterprise ID.

4. Under Search Authentication Type, select Protected - OAuth2, then enter the details from your Shinydocs Search app:

   

   • Search App Client Id and Search App Client Secret: from the Search app’s OAuth 2.0 credentials.

   • Login/Authorize Endpoint, Token Endpoint and Revoke Token Endpoint (optional): leave the Box defaults.

   • Redirect URL: the address users reach Shinydocs Search on, as domain and port only, for example https://<hostname>:9701. It must match a redirect URI you added to the Search app.

5. Select Next. Control Center checks the connection before you continue. If something is wrong, the error says which setting to fix. A source can only be added while an agent is online.

6. Optionally, enter the User ID of each Box user you want to analyze. Box user IDs are the users’ email addresses. If you don’t enter any, all users are analyzed.

7. Optionally, select More options to set the Schedule (Daily or None), then select Return.

   

8. Select Start analysis.

The new source runs the analysis set for Box connections under Settings > Analysis. To change what runs for this source, or its schedule, open it from the Sources page. See Shinydocs Pro Control Center Guide.