Prerequisite knowledge
 
To follow along with this tutorial you will need:
 
  • Knowledge of the Adobe Digital Publishing Suite
  • Knowledge of Drupal Content Management System
  • Access to a Web Server and Database
  • Basic HTML/CSS Knowledge
User level:
 
Intermediate
 
Required Adobe products
 
Additional required other products
 
  • Drupal 7 (DPS Bridge requires additional 3rd party Drupal modules to be installed. Requirements detailed in installation instructions)
Sample files:
 
 
Note: If you have questions about this article, use the comments feature at the bottom of the article. Please don’t contact technical support with questions about Adobe Developer Connection articles.
 

 
What is DPS Bridge?

DPS Bridge is a free module for the Drupal 7 open source content management system. Once enabled, DPS Bridge gives publishers the ability to export Drupal article content for inclusion in Adobe Digital Publishing Suite Folios. Adobe DPS Enterprise publishers can use DPS Bridge to upload Drupal article content directly to the Adobe Folio Producer site and can continually check to make sure articles are in sync with the latest changes.
 

 
How to install DPS Bridge into an existing Drupal 7 environment

Detailed installation instructions are included in the DPS Bridge Readme.
 
Before installing DPS Bridge, first make sure that the following Drupal modules have been installed and enabled:
 
  1. Entity Reference
  2. Entity API
  3. Chaos Tools
  4. Views
  5. Views Bulk Operations
  6. Views PHP
Download the latest version of the DPS Bridge module [coming soon].
 
After installing the DPS Bridge module, enable it by going to the Adobe section on the module configuration page.
 
Figure 1: Enabling DPS Bridge
Figure 1: Enabling DPS Bridge
 
 
Note: In the module description you will see a list of dependencies. Make sure that each dependent module has been enabled.
 
Note: Please disable the Overlay module as it will interfere with functions in the DPS Bridge module.
 
Next, go to the structure menu, and under Blocks look for “Adobe Folio Creator.” Click configure and under the Administration theme, choose “Content” from the dropdown menu. After saving the block you will notice three buttons – Folio Article Selection | Folio Management View | Adobe DPS Folio Module Config. If you want to restrict these buttons from appearing on all pages, you can restrict their display in the block settings.
 
Figure 2: Configuring and saving the Adobe Folio Creator block
Figure 2: Configuring and saving the Adobe Folio Creator block
 
 

 
How to enable permissions on DPS Bridge

DPS Bridge has three main functions – 1) Article Selection 2) Folio Management 3) Module Configuration. By default, only admin users can access these module functions. To enable additional user roles and permissions, go to the People menu and under Permissions locate “Drupal to Adobe DPS.” From this menu you can enable different module permissions for various user classes.
 
Figure 3: Setting DPS Bridge permissions
Figure 3: Setting DPS Bridge permissions
 
 

 
Configuring the DPS Bridge module

Navigate to http://[yourservername]/fpconfig to setup the DPS Bridge module.
 
Figure 4: Configuration page for DPS Bridge
Figure 4: Configuration page for DPS Bridge
 
 
There are three main sections in the module configuration page: API Key/Secret entry, Folio Producer account setup and Publication Stylesheet management.
 
 
API Key and Secret
If you are a DPS Enterprise licensed publisher you can contact your Adobe representative to request a unique Folio Producer API Key and Secret. By enabling the DPS Bridge module to directly connect to the Folio Producer APIs, publishers can maintain a sync status with all article content published through Drupal. Publishing through the Folio Producer APIs will streamline the Drupal folio publishing workflow by uploading the article content directly to Folio Producer (requires no interaction with Adobe InDesign). The module will also automatically generate a Cover article and Table of Contents article if desired.
 
Figure 5: Entering your Folio Producer API Key and Secret
Figure 5: Entering your Folio Producer API Key and Secret
 
 
 
Folio Producer Accounts
 
 
Figure 6: Entering one or more Folio Producer account credentials and restricting dimensions
Figure 6: Entering one or more Folio Producer account credentials and restricting dimensions
 
As rendition mapping to various Android based devices can be a little tricky, we have found that most publishers producing Folios for multiple markplaces tend to silo content into different accounts. By publishing Folios into marketplace specific accounts, publishers can have full control over which Folios will end up on specfic devices. Having this level of control also allows the publisher to make marketplace adjustments, such as replacing advertisements.
 
Publishing to each marketplace is optional and is not required. For each marketplace that you wish to target you can enter in the associated Adobe ID and password. Alongside the username and password, you can also define which dimensions you would like to allow a user to select when publishing to a specific marketplace. For example, if you are publishing Folios to Apple but currently only have an iPad app available, you may restrict content from being created at the iPhone dimensions (1136 x 640, 960 x 640 & 480 x 320).
 
 
Publication Stylesheets Management
 
 
Figure 7: Managing stylesheet templates
Figure 7: Managing stylesheet templates
 
 
Currently, Publication Stylesheet templates are managed at the module configuration level. Stylesheets added to this list will be available to select when building a new Drupal Folio. As all HTML articles within Drupal need to conform to a specific DPS Folio article schema we have written an export translation that will map all Drupal Node elements to their appropriate corresponding fields with the DPS article schema. To ensure that all mapped elements are styled, we settled on building style translations based off of two popular responsive CSS frameworks – Foundation and Bootstrap. Stylesheet templates based off of one of these two frameworks will likely work with minor tweaks.
 
 
Modifying Publication Stylesheets
To make quick adjustments to an existing Stylesheet template, or to build a new variation, users can select Download Stylesheet and choose which Stylesheet they wish to download. Upon download completion, users will find a complete package of Stylesheets and required JavaScript files. After modifying the CSS Style templates users can re-zip the contents and upload the changes.
 
When adding a new Stylesheet to the listing of available publication stylesheets, the DPS Bridge module will ask you if the styles that you are about to upload are a derivitive of Bootstrap or Foundation. Choosing the appropriate framework here ensures that all Drupal node elements will be translated correctly.
 
 
Test Connections
The "Test Connection" button in the DPS Bridge module configuration page is used to ensure that Drupal can connect to Adobe DPS Folio Producer using the supplied API Key, Secret, and Adobe ID. A successful connection will display the message in the figure below.
 
Figure 8: Successful connection test result
Figure 8: Successful connection test result
 
 
A failed connection will display the message below.
 
Figure 9: Example of a connection test failure
Figure 9: Example of a connection test failure
 
 

 
Selecting Drupal articles to include in a DPS Folio

Navigate to http://[yourservername]/fpselect to begin selecting content for inclusion in a DPS Folio.
 
Tip: For quick access to any of the DPS Bridge module pages, make sure to add the individual pages to the Admin shortcut menu bar.
 
Figure 10: Shortcut links in Admin menu bar
Figure 10: Shortcut links in Admin menu bar
 
 

 
Managing Folios

Navigate to http://[yourservername]/fpmanage to begin managing DPS Folios.
 
Figure 11: Folio Status page
Figure 11: Folio Status page
 
 
The Folio Status page displays a listing of all Folios created in Drupal. While other Folios created outside of Drupal may exist for a particular publication account they will not be displayed in this list as Drupal would have no internal reference to the content. If you have multiple Adobe IDs configured for Amazon, Apple, and Google, the Folio Status page will list provide a complete list of all Folios pretaining to these accounts.
 
For publishers already familiar with DPS, the initial fields viewed here should look familiar. Folio Name, Publication Name, Folio Number, Description, Publication Date and Viewer Version all map to corresponding fields in Adobe Folio Producer. The Status field is used to indicate if the Folio has been uploaded to Folio Producer. Folios with the status “Not Uploaded” exist in Drupal only and are not yet available in Adobe Folio Producer. Folios uploaded from Drupal to Folio Producer are a static copy of all articles at the time of upload. The Sync Status field in Drupal offers an at-a-glance indication of whether or not the Folio contains any articles that have been modified in Drupal post-upload.
 
 
Folio Action Buttons
  • Clone Selected Folio — Selecting this action creates a copy of the selected Folio and all article references. Creating a cloned Folio is necessary if you wish to publish the same content to multiple publication accounts i.e. Google, Apple, Amazon.
  • Delete Selected Folio — Deleting a selected Folio will ONLY delete the Folio Node reference in Drupal. This action will NOT delete a Folio from Folio Producer and will not delete any associated articles.
  • Upload Selected Folio to Folio Producer — Uploads selected Folio and associated articles to Folio Producer. Note — This function requires a defined API Key and Secret. Once a publish action has started you will see a status readout, similar to the image below. After all articles have been sucessfully uploaded the status window will close and the Folio management screen will refresh.

 

Figure 12: Folio upload status
Figure 12: Folio upload status
 
 

 
Folio options explained

Figure 13: Folio fields
Figure 13: Folio fields
 
 
  1. Folio Name — This is the “filename” for the Folio and is not public facing.
  2. Publication Name — This is the name of the publication i.e. Pluralist Magazine.
  3. Folio Number — This is the issue name or volume number.
  4. Publication Date — This is the intended date for the publication.
  5. Description — This is a short description of the publication, max 128 characters.
  6. DPS Account — Selects which Adobe ID (added in the module configuration page) to publish to.
    Note – To ensure compatibility with other articles potentially added to the Folio via Folio Producer, this option is locked after the Folio has been uploaded.
  7. Library Filter — Can be used to add a filter menu to the viewer application library. This is often used to distinguish Folios based on language, region, or topic.
  8. HTML Resources — Selects which stylesheet set to use for the publication. Note – At this time, the selected stylesheet will be used across all articles.
  9. Resolution — This menu is dependent on selected DPS Account above. A defined resolution is required for all Folios published.
    Note – To ensure compatibility with other articles potentially added to the Folio via Folio Producer, this option is locked after the Folio has been uploaded.
  10. Viewer Version — This value is set to ensure Folio compatibility with the version of the application that is released in various marketplaces.
  11. Folio Orientation — Choose vertical, horizontal or both orientations to determine how HTML articles will behave.
  12. TOC & Cover — If you so choose, DPS Bridge can automatically generate a Cover Article using images uploaded to the Folio. Likewise, a TOC article that contains a listing of all associated articles with jump links can be created automatically.
  13. Cover Previews — Click on Cover Previews to upload a Horizontal and Vertical cover image for the Folio.
 
Article Options within Folio Management
  1. + — The first column is used to drag and drop the order of articles contained within a Folio.
  2. Order — This column indicates the order in which articles will appear within a Folio.
  3. Edit — This is a jump link to bring the user to the edit page for a particular article.
  4. Article Title — Title of the article. Click the title of the article to bring up article preview options. The preview function is designed to give publishers an idea of what their HTML articles will look like on a device in a particular set of dimensions. The preview uses Javascript to open a new window set at the selected dimensions. The HTML preview rendered will display the HTML article with the publication stylesheet selected. Note – If you have changed publication stylesheets between previews, you may need to refresh the preview window once or twice to see the style change take affect. This is due to CSS caching in the browser.

 

Figure 14: Article preview options
Figure 14: Article preview options
 
 
  1. Type — Indicates the Drupal Node’s content type.
  2. Last Modified — Timestamp for the last time the article was modified.
  3. Is Ad — Checkbox to define the HTML article as an Advertisement within DPS.
  4. Is Sync — Shows the status of article content in relationship with what has been uploaded to Folio Producer. An “X” status indicates that the article has either NOT been uploaded to Folio Producer previously, or that the article has been modified in Drupal since the last Folio Producer update. A checkmark status indicates that both the content in Drupal and up on Folio Producer are the same. A locked status indicates an article has been placed into the Folio that was not originally sourced from Drupal. Read the section on Hybrid Folio publications for more information on this status.
  5. Export Selected Articles as HTML Stacks — This button will zip up all selected articles and download the contents to a user’s local machine. This feature can be used by DPS Professional licensed publisher as a way to include HTML articles into their InDesign created Folios.
  6. Remove Selected Articles from Folio — This button will remove any selected articles from the Folio. Removing an article from a Folio does not automatically delete the article in Folio Producer. To remove the article from Folio Producer, either A) Manually remove the article in Folio Prodcer, or B) Go back to the main Folio management screen, select the Folio and choose “Upload to Folio Producer” to update the Folio on the server.

 
Downloading HTML Articles for inclusion in Folio Builder Panel

If you are a DPS Professional licensed publisher you will not have access to obtain API Keys that would allow for automatic uploading of Drupal content to Folio Producer. Fear not, as there is still a way for you to use the DPS Bridge module.
 

 
Hybrid Publication Workflows

Creating a hybrid publication that contains a mixture of Drupal HTML articles alongside InDesign created content is an attractive option for publishers that wish to insert PDF or InDesign based advertisements. A hybrid publication may also be necessary in the case of highly designed feature articles that cannot be achieved through HTML and CSS.
 
InDesign based content that is added to a Drupal managed Folio will appear in the Folio details page as a locked item. The placement and order of the locked article can be managed within Drupal, but all metadata and content will need to be modified via the InDesign Folio Builder panel, or the Folio Producer web site.

 

 
Managing Publication Stylesheets

Watch the video below to see how a user can download, alter, and then upload a new version of a publication stylesheet.
 

 
Requesting API Keys

Folio Producer API Keys are available to DPS Enterprise customers upon request. Contact your Adobe or DPS Partner representative for more information.
 

 
Where to go from Here

If you'd like to learn more about DPSBridge and how DPCI can help you get up and running, please contact Natasha Davis at (800) 818-2905.
 
Comments are currently closed as we migrate to a new commenting system. In the interim, please provide any feedback using our feedback form. Thank you for your patience.