Topics

Federated search


In This Guide

In addition to searching for items in Brightspot, you can perform a federated search for items from third-party services, such as Getty Images and YouTube.

Items you discover through federated searches are read-only. If you want to modify them, you need to import the items into Brightspot.


Performing a federated search

To perform a federated search:

  1. In the search panel, enter a search term, and from the content-type filter, under External Types, select an external content type. Brightspot displays matching items.
    Federated Search 1.svg
  2. Click an item. Brightspot displays the item in the content edit form along with associated metadata.
    Federated Search 2.png
  3. If you want to modify the item, import it into Brightspot by clicking Import.

The following table lists external data types from third-party repositories and the content types to which Brightspot converts them.

External Type
Content Type
Getty Image
Image
Giphy
Image
Adobe Stock
Image
Shutterstock
Image
AP (Associated Press)
Image
Vimeo
Video
YouTube
Video
Dropbox
StorageItem
Box
StorageItem
Google Drive
StorageItem
Slack
Any of the above content types, depending on the file type imported.

See also:


Configuring Slack federated search

You can perform federated searches for files in Slack. You can also send notifications through Slack.

To configure federated search and notifications with Slack:

  1. For each workspace you are configuring federated search, ensure you have access to the workspace’s console.
  2. Click menu > Admin > Sites & Settings.
  3. In the Sites widget, select Global. The Edit Global widget appears.
  4. Under Main, ensure that the Default Tool URL field is set.
  5. In the Sites widget, select the site for which you want to configure Slack, or select Global to configure Slack for all sites.
  6. Under Main, expand Slack.
  7. Under Workspaces, click add_circle_outline. A selection field appears.
  8. From the selection field, select Create New. A New Slack Workspace widget appears.
  9. In the Workspace Name field, enter a name for the workspace (typically the name of the Slack workspace you are integrating).
  10. In the Client ID field, copy and paste the redirect URL into a text editor.
    Federated Search Slack 1.svg
  11. Click Slack API Console to access your Slack console. If prompted, log into your Slack account. The Slack Your Apps page appears.
  12. In the Your Apps page, click Create New App.
  13. Name the app and select the workspace that you would like Brightspot to use.
    Federated Search Slack 2.png
  14. Click Create App. The Basic Information page appears.
  15. Under Features, click OAuth & Permissions. The OAuth & Permissions page appears.
  16. Under Redirect URLs, do the following:

    1. Click Add New Redirect URL.
    2. Enter the redirect URL from step 10 and click Add.
    3. Click Save URLs.
      Federated Search Slack 3.png
  17. Under Scopes, do the following:

    • To enable federated search, under User Token Scopes, add files:read and search:read.
      Federated Search Slack 4.png
    • To enable notifications through Slack, under Bot Token Scopes, add chat:write and chat:write.public.
      Federated Search Slack 5.png
  18. Scroll to the top of the OAuth & Permissions page and click Install to Workspace. A list of permissions appears.
    Note
    Depending on your role in the Slack workspace, you may first have to request approval to install the app.
  19. Click Allow. You return to the OAuth & Permissions page.
  20. If you are configuring notifications, do the following (otherwise skip to step 21):

    1. In Slack, under Features, click OAuth & Permissions.
    2. Under OAuth Tokens for Your Team, copy the value for Bot User OAuth Access Token.
      Federated Search Slack 9.png
    3. In Brightspot’s Slack Workspace widget, paste the token into the Token field.
      Federated Search Slack 6.png
  21. If you are configuring federated search, do the following:
    1. In Slack, under Settings, click Basic Information.
    2. Scroll to App Credentials.
      Federated Search Slack 7.png
    3. Copy the client ID and client secret values to the Client ID and Client Secret fields in Brightspot’s Edit Site widget (see the illustration Slack tokens in Brightspot).
  22. Click Save.
  23. Click Back.
  24. From the Workspaces selection field, select the Slack workspace you just created.
  25. Click Save.
  26. Repeat steps 7–26 to integrate additional Slack workspaces.
  27. Verify the configuration is activated. In the search panel, under Global Filters, select Slack File.
    Federated Search Slack 8.png

Federated search with Adobe Stock

You can perform federated searches for files in Adobe Stock.

To configure federated search with Adobe Stock:

  1. In your Adobe Stock console, do the following:
    1. Obtain your Adobe Stock API key.
    2. Set the Default Redirect URI to https://<brightspotDomain>/cms.
    3. Set the Redirect URI Pattern to https://<brightspotDomain>\.com/cms (escape all dots in the URI with a single backslash).
  2. Click menu > Admin > Sites & Settings.
  3. In the Sites widget, select Global. The Edit Global widget appears.
  4. Under Main, expand Adobe Stock.
  5. In the API Key field, paste the API key from step 1.
  6. Click Save.

Federated Search with AP Images

You can perform federated searches for files in AP Images.

To configure federated search with AP Images:

  1. Obtain your AP Images API key.
  2. Click menu > Admin > Sites & Settings.
  3. In the Sites widget, select Global. The Edit Global widget appears.
  4. Under Main, expand Associated Press.
  5. In the API Key field, paste the API key from step 1.
  6. Click Save.

Federated Search with Box

You can perform federated searches for files in Box.

To configure federated search with Box:

  1. In your Box console, do the following:
    1. Obtain your Box account’s client ID and client secret.
    2. Set the OAuth 2 redirect URI to https://<brightspotDomain>/boxAuth.
  2. Click menu > Admin > Sites & Settings.
  3. In the Sites widget, select Global. The Edit Global widget appears.
  4. Under URLs, copy one of the secure URLs and paste it into your Box console.
  5. Under Main, expand Box.
  6. In the Client ID and Client Secret fields, paste the values from step 1.
  7. Click Save.

Federated Search with Dropbox

You can perform federated searches for files in Dropbox.

To configure federated search with Dropbox:

  1. In your Dropbox console, do the following:
    1. Obtain your Dropbox account’s application key and application secret.
    2. Set the OAuth 2 redirect URI to https://<brightspotDomain>/dropboxAuth.
  2. Click menu > Admin > Sites & Settings.
  3. In the Sites widget, select Global. The Edit Global widget appears.
  4. Under Main, expand Dropbox.
  5. In the Dropbox Application Key and Application Secret fields, paste the values from step 1.
  6. Click Save.

Federated Search with Getty Images

You can perform federated searches for files in Gettty Images.

To configure federated search with Getty Images:

  1. Obtain your Getty Images application key and application secret.
  2. Click menu > Admin > Sites & Settings.
  3. In the Sites widget, select Global. The Edit Global widget appears.
  4. Under Main, expand Getty.
  5. In the API Key and API Secret fields, paste the values from step 1.
  6. Click Save.

Federated Search with Giphy

You can perform federated searches for files in Giphy.

To configure federated search with Giphy:

  1. Obtain your Giphy account’s API key.
  2. Click menu > Admin > Sites & Settings.
  3. In the Sites widget, select Global. The Edit Global widget appears.
  4. Under Main, expand Giphy.
  5. In the API Key field, paste the API key from step 1.
  6. If you want to use still Giphy images instead of animations in Brightspot’s search panel, toggle on Use Still Images for Search Preview.
  7. Click Save.

Federated Search with Shutterstock

You can perform federated searches for files in Shutterstock.

To configure federated search with Shutterstock:

  1. In your Shutterstock console, do the following:
    1. Obtain your Shutterstock account’s consumer key and consumer secret.
    2. Set the OAuth 2 redirect URI to https://<brightspotDomain>/shutterstockAuthorization.
  2. Click menu > Admin > Sites & Settings.
  3. In the Sites widget, select Global. The Edit Global widget appears.
  4. Under Main, expand Shutterstock.
  5. In the Consumer Key and Consumer Secret fields, paste the values from step 1.
  6. Under Linked Enterprise Accounts, click the link to connect to your Shutterstock enterprise account. Enter your credentials on the Shutterstock login page.
  7. Click Save.

Searching for files in Slack

Depending on your version of Brightspot, you can search for and import files stored in Slack. Brightspot’s search is the same as Slack’s: you can find files whose name contains a search term, and you can find text files that contain a search term.

Brightspot can search for the files to which you have access; if you can find the file in Slack’s search, you can also find it with Brightspot.

To search for files in Slack:

  1. In the header, click in the search field. The search panel appears.
  2. Under Global Filters, select Slack File.
  3. If this is the first time you are searching for files in Slack, do the following:
    1. Under Slack Authentication, click Sign in with Slack. A list of permissions appears.

      Slack_files_1.png

    2. Click Allow. A confirmation message appears in Brightspot.
    3. Click Close.
  4. In the search text field, type a search term. Brightspot retrieves the matching files.

    Slack_files_2.svg

  5. Click the file to view its metadata.
  6. To import the file into Brightspot, click Import.

Federated Search with Vimeo

You can perform federated searches for files in Vimeo

To configure federated search with Vimeo:

  1. Obtain your Vimeo account’s client ID and client secret.
  2. Click menu > Admin > Sites & Settings.
  3. In the Sites widget, select Global. The Edit Global widget appears.
  4. Under Main, expand Vimeo.
  5. In the Client ID and Client Secret fields, paste the values from step 1.
  6. In the Number of Videos to Load Each Request field, enter the number of videos Brightspot retrieves for each search.
  7. Click Save.

Federated Search with YouTube

You can perform federated searches for videos in your YouTube account. If you have multiple YouTube channels and Brightspot sites, you can restrict an individual Brightspot site’s federated search to a specific Video channel.

To configure federated search with YouTube:

  1. Obtain your YouTube account’s API key. You can obtain the key from the APIs & Services page on your Google account.
  2. Click menu > Admin > Sites & Settings.
  3. In the Sites widget, select Global. The Edit Global widget appears.
  4. Under Main, expand YouTube.
  5. In the API Key field, paste the API key from step 1.
  6. (Optional) If you want to restrict federated search to a specific YouTube channel, in the Channel ID enter the channel’s ID.
  7. To restrict a Brightspot site’s federated search to an individual YouTube channel, do the following:
    1. In the Sites widget, select the site for which you want to configure federated search.
    2. Under Main, expand YouTube.
    3. In the Channel ID enter the channel’s ID. The ID you enter here overrides the channel ID you set in step 6.
  8. Click Save.