How to Add On-Demand Previews

About

On-Demand previews are accomplished using a feature called Fetchers.

How to add and configure fetchers in BA Insight SmartHub is described below.

How to Add a New Fetcher

To configure the fetchers, follow these steps:

  1. Navigate to the Configuration page for the Smart Previews Hybrid site.
    1. For example: https://<SmartPreviewsHybridAddress>/Pages/Configure.aspx.
  2. Expand the INSTALLED FETCHERS section and click the link Add new fetcher.


  3. Configure the fetcher using one of the following options:

Connector Framework Fetcher Settings

Complete the fields listed below after clicking the "Add new fetcher" button.

  • Fetcher Name:
    • Name as desired.
    • For example: "Connector Framework Fetcher"
  • Full Assembly Name:
    • BAInsight.SmartPreviewHybrid.OnPrem, Version=1.0.0.0, Culture=neutral, PublicKeyToken=bd5ed2e4b6962cd0
  • Full Class Name:
    • SmartPreviewService.Fetchers.ConnectorFrameworkFetcher
  • URL Prefix:
    • spworks://
  • Authentication Mode:
    • Select Basic Authentication.

  • User: 

    • Enter a user that has permissions to access all the content on the farm.

    The provided user must have one of the following formats:

    • domain\username
    • username@example.com

  • Password: 
    • Enter the password for the user.
  • Settings:
    •  This field must have the following format:
         site:http\://;version:
    • Add the following required parameters that enable the connection to the farm:
      • site:
        • For Connector Framework 4.0, enter an on-premise site collection.
          • The Central Administration address is typically used.
        • For Connectivity Hub, enter the home address of Connectivity Hub.
          • For example: https://connectivityhub.bainsight.com
      • version:
        • For Connector Framework 4.0, enter v1.
        • For Connectivity Hub enter v2.
        • Entering any value other than v1 or v2 causes this setting to default to v1.

File System Fetcher

After clicking the "Add new fetcher" button complete the fields listed below:

  • Fetcher Name:
    • Name as desired.
    • For example: "File System Fetcher"
  • Full Assembly Name:
    • BAInsight.SmartPreviewHybrid.OnPrem, Version=1.0.0.0, Culture=neutral, PublicKeyToken=bd5ed2e4b6962cd0
  • Full Class Name:
    • SmartPreviewService.Fetchers.FileSystemFetcher
  • URL Prefix:
    • file://
  • Authentication Mode:
    • Select Basic Authentication.
  • User: 
    • Enter a user that has permissions to access all the content on the farm.
  • Password: 
    • Enter the password for the user.
  • Settings:
    • Not required.

Website Fetcher

Complete the fields listed below after clicking the "Add new fetcher" button.

  • Fetcher Name:
    • Name as desired.
    • For example: SharePoint Fetcher
  • Full Assembly Name:
    • BAInsight.SmartPreviewHybrid.OnPrem, Version=1.0.0.0, Culture=neutral, PublicKeyToken=bd5ed2e4b6962cd0
  • Full Class Name:
    • SmartPreviewService.Fetchers.WebSiteFetcher
  • URL Prefix:
    • <Your website URL>
  • Authentication Mode:
    • Select Basic Authentication.
  • User: 
    • Enter a user that has permissions to access all the content on the farm.
  • Password: 
    • Enter the password for the user.
  • Settings:
    • Not required.

SharePoint Fetcher

Complete the fields listed below after clicking the "Add new fetcher" button.

  • Fetcher Name:
    • Name as desired.
    • For example: SharePoint Fetcher
  • Full Assembly Name:
    • BAInsight.SmartPreviewHybrid.OnPrem, Version=1.0.0.0, Culture=neutral, PublicKeyToken=bd5ed2e4b6962cd0
  • Full Class Name:
    • SmartPreviewService.Fetchers.SharePointFetcher
  • URL Prefix:
    • http://
  • Authentication Mode:
    • Select Basic Authentication.
  • User: 
    • Enter a user that has permissions to access all the content on the farm.
  • Password: 
    • Enter the password for the user.
  • Settings:
    • Not required.

SharePoint Online Fetcher

Complete the fields listed below after clicking the "Add new fetcher" button.

  • Fetcher Name:
    • Name as desired.
    • For example: SharePoint Online Fetcher
  • Full Assembly Name:
    • BAInsight.SmartPreviewHybrid.OnPrem, Version=1.0.0.0, Culture=neutral, PublicKeyToken=bd5ed2e4b6962cd0
  • Full Class Name:
    • SmartPreviewService.Fetchers.SharePointOnlineFetcher
  • URL Prefix:
    • https://
  • Authentication Mode:
    Select the authentication mode you want to use.
    • If Basic Authentication is selected provide: 
      • User: Enter a user that has permissions to access all the content on the farm.
      • Password: Enter the password for the user.
    • If Certificate Authentication is selected provide:
      • Certificate Distinguished Name:
        • Enter the distinguished name of the certificate.

      • Application ID:

        • Enter the Azure Application ID. 

        • You can find the Azure Application ID when you access your Azure App in the registered applications from the Azure Portal:


        Note: Follow the steps from the section Configure Certificate Authentication to get the Certificate Distinguished Name and Application ID.

  • Settings:
    • Provide parameters if needed in the format 'name:value' separated by a semicolon.
    • Use escaping \; or \: if you need to put these symbols as parameter name or value.
      • site:
        • Enter a SharePoint Online site collection. 
        • Required.
      • tenantName:
        • Optional
        • Enter the SharePoint Online tenant name.
        • Use this option only if you are using Certificate Authentication and your provided site URL doesn't contain the tenant name. 
      • tenantEntryPoint:
        • Optional
        • Enter the SharePoint Online root site.  
        • Use this option only if you are using Certificate Authentication and your provided site URL doesn't contain the root site. 
          • For Example: site:https\://tenant.sharepoint.com;tenantName:tenant

    4. Click the load fetcher UI button.

    5. Save the configuration.

Egnyte Fetcher

Note: The Egnyte fetcher requires the Egnyte backend is installed in SmartHub.

Complete the fields listed below after clicking the "Add new fetcher" button.

  1. Fetcher Name:
    1. Name as desired.
    2. For example: "Egnyte Fetcher"
  2. Full Assembly Name:
    1. BAInsight.SmartPreviewHybrid.OnPrem, Version=1.0.0.0, Culture=neutral, PublicKeyToken=bd5ed2e4b6962cd0
  3. Full Class Name:
    1. SmartPreviewService.Fetchers.Egynte.EgnyteFetcher
  4. URL Prefix:
    1. https://<appYourDomain>.egnyte.com
  5. Load Fetcher UI:
    1. Click "Load Fetcher UI" to load additional fields.


  6. Egnyte Domain:
    1. Enter your Egnyte app domain.
    2. For example: appYourDomain.egnyte.com.
  7. Client Id:
    1. Enter your Egnyte client ID
  8. Client Secret:
    1. Enter your Egnyte client secret
  9. Click the Authorize button.
  10. A new tab opens. Follow the prompts to login to your Egnyte account.


  11. Click Allow Access.
  12. A web pages opens entitled "404 File Not Found." This is expected.
  13. Copy the code from the URL location bar at the top of your browser, from after the '=' character to the '&' character. See the graphic below.


  14. Return to the Edit Fetcher page (in a previous browser tab).
  15. Paste the copied code into the "Authorization Code" field.
  16. Click the Get Tokens button.
  17. A new web page opens with a generated Access token. No Refresh token is required.
  18. Copy the Access token.
  19. Return to the Edit Fetcher page (in a previous browser tab).
  20. Paste the Access token into the Access Token field.
  21. Click Save.
  22. Navigate back to the Configuration page for the Smart Previews Hybrid site.
    • For example: https://<SmartPreviewsHybridAddress>/Pages/Configure.aspx.
  23. Refresh the page. Your new Egnyte fetcher appears.

NetDocuments Fetcher

Note: NetDocuments fetcher requires the NetDocuments backend is installed in SmartHub.

Complete the fields listed below after clicking the "Add new fetcher" button.

  1. Fetcher Name:
    1. Name as desired.
    2. For example: netdocuments Fetcher
  2. Full Assembly Name:
    • BAInsight.SmartPreviewHybrid.OnPrem, Version=1.0.0.0, Culture=neutral, PublicKeyToken=bd5ed2e4b6962cd0
  3. Full Class Name:
    • SmartPreviewService.Fetchers.NetDocsFetcher.NetDocsFetcher
  4. URL Prefix:
    1. Choose a prefix based on your NetDocuments Data Center.
    2. Supported values are:
      • https://vault.netvoyage.com
      • https://eu.netdocuments.com
      • https://de.netdocuments.com
      • https://au.netdocuments.com

  5. Continue Setup: Click "Continue Setup" to load additional fields.

    Note

    After clicking Continue Setup, any changes you make to the previous fields will not be picked up.

    If you need to change the URL Prefix afterwards, you must cancel the current configuration screen and start again.

  6. Click the Authorize button.
  7. This opens the NetDocuments web page.


  8. Login using your NetDocuments credentials.
  9. Click Allow on the page that appears next.


  10. Copy the code that appears.
  11. Return to the Edit Fetcher page and paste the code into the Authorization Code field.
  12. Click the "Get Tokens" button.
  13. A web page appears showing an Access token and Refresh token. 
  14. Copy the tokens separately.
  15. Return to the "Edit Fetcher" page.
  16. Paste the tokens into their respective fields.
  17. Click the Save button.
  18. Navigate back to the Configuration page for the Smart Previews Hybrid site.
    • For example: https://<SmartPreviewsHybridAddress>/Pages/Configure.aspx.
  19. Refresh the page. Your new NetDocumentsfetcher appears.

iManage Fetcher

  1. Fetcher Name:
    1. Name as desired.
    2. For example: iManage Fetcher
  2. Full Assembly Name:
    • BAInsight.SmartPreviewHybrid.OnPrem, Version=1.0.0.0, Culture=neutral, PublicKeyToken=bd5ed2e4b6962cd0
  3. Full Class Name:
    • SmartPreviewService.Fetchers.iManage.IManageFetcher.
  4. URL Prefix:
    Enter either:
    • https://cloudimanage.com
    • or the address that iManage DataCenter enforces
  5. Load Fetcher UI:
    1. Click "Continue Setup" to load additional fields.


  6. Fill in the Client Id/Secret fields.
    • Leave empty to use the default values.


  7. Click Authorize
  8. Login to iManage.
  9. A web page appears showing an Access token and Refresh token. 
  10. Copy the tokens separately.
  11. Return to the "Edit Fetcher" page.
  12. Paste the tokens into their respective fields.
  13. Click the Save button.


  14. Navigate back to the Configuration page for the Smart Previews Hybrid site.
    • For example: https://<SmartPreviewsHybridAddress>/Pages/Configure.aspx.
  15. Refresh the page. Your new iManage fetcher appears.
Important: Make sure that a Redirect URL for the Hybrid site is set in iManage.

  • It must have the format https://<SmartPreviewsHybridAddress>/Pages/OAuth.aspx