Drupal Integration

About the Plugin

Drupal is a content management system that powers millions of websites and applications. It’s the platform-of-choice for more complex projects and organizations, and the go-to for projects with multiple user roles. Drupal is a highly-customizable platform. Please reach out to your IT team to determine if this module can be added to your organization’s Drupal instance. 

PhotoShelter’s Drupal Integration enables you and your team to easily browse and search for files located in your PhotoShelter Library and import those files into your Drupal file library. Only Library Staff (Admins, Editors) can authenticate within the module. 

• Purchasing
• Authenticating
• Setup
• Adding Media 

Purchasing

The PhotoShelter for Brands Drupal Integration requires an additional Editor seat to be added to your subscription. This seat serves as your designated integrations account that connects the integration to your organization’s PhotoShelter Library without impacting your account’s login limit. Our team will also provide an API key to use with this Integration.

Contact the Customer Success team to add the Drupal Integration to your PhotoShelter for Brands account.

Authenticating

After purchasing the Drupal integration, you’ll be connected with our Technical Support team and will be asked to provide an email address specifically for use with any supported PhotoShelter Integrations. This email address cannot be associated with any current user in our system and will be assigned the PhotoShelter Integrations Editor Seat included with purchase of the integration. If you already have a designated Integrations Editor Seat, please let our Technical Support team know.

Note: Your organization’s IT team will install the PhotoShelter module within your Drupal instance.

To authenticate your account within the Drupal module: 

1. Navigate to the PhotoShelter module within your Drupal instance
2. Click the link that says Authenticate with PhotoShelter
3. In the window that appears, log in to your PhotoShelter account. Only Library Staff may authenticate within the module. 
4. When prompted, enter the API key provided to you by our Support team.
5. Select your Organization from the drop-down menu.

Setup

Your organization's Drupal admin must configure content types to include the PhotoShelter entity browser as a widget. To do this, they will need to create a new Content Type or edit an existing one.

1. In Drupal, navigate to the Content Type that you want to contain the PhotoShelter widget. This is under Manage > Structure > Content Types > {Click the name of the Content Type you want to add the widget to}. For these instructions, our Content Type is called "PhotoShelter Post." Click “Manage fields” on the right of your desired Content Type.

2. Create a Field that will contain the PhotoShelter entity browser.  Click “+ Add field.” The field type should be “Media” or “Other” under the Reference subcategory. You can label it anything, but for the purposes of these instructions, we'll refer to this as "PhotoShelter_media." Click “Save and continue.”

   

3. On the next page for “Field Settings,” select “Media” as the “Type of item to reference.” Your Drupal admin can decide to limit this number of values that can be imported or make this value unlimited. Click “Save field settings.”

   

4. On the page that loads after saving, click the tab for “Manage form display” and make sure the field you created for that content type is in the "Enabled" list on the form.

5. For the Widget type dropdown menu for that new field (”Photoshelter_media”), select “Entity browser.”

   

6. Find the gear icon to edit the setting for the new field ("PhotoShelter_media") on the right and click it to expand the options.

7. On the expanded menu, under the Entity browser dropdown options, select “PhotoShelter.” For "Entity display plugin" choose "Rendered entity" to display the imported file. Clicking "Show widget details as open by default" will show the "Select Entities" button without having to expand the section when adding content. The other settings on this page are up to the Drupal administrate to modify but they can be left as defaults.

   

8. Save the setting with “Update” and then “Save."

9. Under "Manage Fields," click "Edit" on the right of the field you created (PhotoShelter_media).
10.  Select the files types you want to support in this field (these will correspond with the PhotoShelter file types you can import for this Content Type). Save Settings.
11. Under "Manage Display," click "Rendered Entity" as the format to display the rendered file. You can also change the "label" to "Hidden" for a cleaner display in your content. Save.

These steps will enable the PhotoShelter entity browser to appear in the new field you created ("PhotoShelter_media") for the Content Type you chose to add it to.

Adding Media

1. To add PhotoShelter media to Drupal content, select Manage > Content > Add Content.
2. Choose the Content Type that contains the PhotoShelter entity browser (configured in "Setup" above). 
3. Navigate to the field that contains the PhotoShelter entity browser (if configured as described in "Setup," this field is called PhotoShelter_media. Click "Select entities."
4. The PhotoShelter entity browser will appear and display your Library Assets. Use the Search bar to search for keywords from your files' IPTC Titles, Description/Captions, and Keywords fields. To navigate from search results back to your Library browser, click "Library" under the search bar. You can also browse through content in your PhotoShelter Library.
   • Note: Asset metadata can be viewed within Drupal using the i icon on the asset thumbnail. 
5. Select an asset using the checkbox on an asset thumbnail. If your chosen Content Type allows, multiple assets may be selected at once. If your Content Type only allows one selection, you can click the thumbnail to select it and all other thumbnails will fade. Click the chosen asset again to deselect.
6. After making your selections, click Select Entities. This will import the assets into Drupal.
7. Save your Content.

Note: Media will be imported to your Drupal media library at the file's original size. At this time, presets for specific media sizes are not available within this integration. Your organization's IT team may use other modules in Drupal to resize or edit images after import.