Page tree

You are viewing documentation for IMS v6. If you are using Chorus, please switch to: https://www.thirdlight.com/docs/display/CDD/

The Third Light Browser Drupal Module provides a plugin for the popular CKEditor rich-text editing module for Drupal 7. Drupal 8 users, see Drupal 8 Module. It allows CKEditor users to locate files (images and office documents only) on a Third Light IMS site using the CMS browser tool, and embed them into pages.

This feature is available from IMS v6.0.18 onwards. It is included with IMS Premium and IMS Enterprise, or can be added as a module to IMS Standard (please ask [email protected]). API key based logins are only possible on the Premium and Enterprise packages where the API add-on module is present.

For a video overview of this feature, you may wish to view our video, here. There is also a write-up by Philip Norton (Access Advertising) for this feature, based on a deployment for BAFTA, which you can read here: http://www.accessadvertising.co.uk/blog/2014/08/digital-asset-management-in-drupal-creating-a-third-light-integration

  1. Download the plugin from http://www.thirdlight.com/downloads/drupal7/thirdlight_browser.zip
  2. Unpack the ZIP file into the sites/all/modules directory on your Drupal system
  3. Go to the Modules page in your site's Drupal administration
    1. Ensure the CKEditor module is installed and enabled - see https://drupal.org/project/ckeditor for details of how to do this.
    2. Enable the Third Light Browser module under the User Interface section
  4. Go to the Configuration > CKEditor module page; for each profile listed
    1. Click edit
    2. Expand the Editor Appearance section
    3. Check the "Plugin for using the Third Light Browser from CKEditor" box under "Plugins"
    4. Drag the Third Light Browser icon into the "Used Buttons" section of the toolbar
  5. Go to the Configuration > Text Formats page
    1. Select 'Filtered HTML'.
    2. Go to the 'Filter Settings' section and click the tab named 'Limit allowed HTML tags'.
    3. Add <img> to the end of the list
  6. Go to the Third Light Browser module configuration page
  7. Click "Change Settings", and enter your Third Light Site address

Additional options

The Third Light Browser module can control additional features of the CMS Browser tool.

The following basic options are available

  • Show file revisions - Enable the display of other versions of files inside the browser (where the user has permission)
  • Display metadata - Enable the display of metadata inside the browser
  • Choose a skin - You can choose between the "Light", "Dark" and "Blue" themes, which affect the appearance of the browser.
  • Title for inserted images - Optionally set the 'title' text for images inserted using the plugin based on the metadata of the selected file.

In addition, if a valid API key is specified, you can choose to log users in to IMS automatically based on their username or e-mail address.

Output formats

You can configure the output options displayed in the CMS browser by editing, adding or removing output formats from the Third Light Browser module configuration page.

For each size, you can specify

  • Name - used to identify the output option inside the CMS browser
  • Width - desired width (in pixels) of the output format
  • Height - desired height (in pixels) of the output format
  • Format - image file format to use
  • CSS Class - optional default CSS class to add to images inserted using this output format.

Permissions

Using the Drupal role-based permissions system you can grant roles the right to use or administer the Third Light Browser module.

By default only Administrators can use the tool, or change module settings.

IMS User accounts that you intend to use with the Third Light Browser module will need to have the 'Create published files' download permission

Users > Users & Groups > Edit User > Downloads > Create published files

IMS Authentication

By default, when a user launches the Third Light Browser, they will be prompted to log in (unless they have already logged in to IMS in the same browser session).

If a valid API key is specified, you can enable automatic log-in based on the Drupal username or e-mail address.

When configured, the Drupal module makes a server-to-server query to the IMS API, authenticated by the API key supplied, to try to find a user in IMS with the same username or e-mail address (depending on the option chosen). If such a user is found, the Drupal module retrieves an authenticated token for them, and passes it in to the Third Light Browser. This bypasses the username and password login that would otherwise be presented.

If the Drupal module cannot find such a user in IMS, the Third Light Browser tool is not enabled in the CKEditor toolbar.

Security Considerations

  • If your Third Light IMS site and Drupal site connect to each other over the internet and you are using the API key, you should configure an SSL certificate and use https:// for the Third Light site address.
  • If using automatic log-in, you should ensure that automatic user registration in Drupal does not allow users to access the Third Light Browser without verification of their e-mail address or username. For example, you could not grant the automatically assigned role permission to use the Third Light Browser (See Permissions above).
  • No labels