by Derek Lu
Table of contents
11 February 2013
User level: Intermediate
Original publication date: 08/08/2012
Modified: 02/11/2013 (Change log)
Library and Store API v2
Begin by downloading the sample files that are provided at the beginning of this article. The sample file contain the combined library / store custom template that offers an alternate view of the default library. Using source code, you can change the e-commerce interface to create a custom user experience. Figures 1-5 show the various views of the template.
Figure 1. The grid view of multiple folios.
Figure 2. The one up view of folios. Users can swipe horizontally to navigate.
Figure 3. Clicking the Options icon in the upper right corner displays available options.
Figure 4. Clicking Subscriber Login displays a login interface.
Figure 5. Clicking Subscribe enables a user to choose a subscription.
The Subscribe button is only displayed if the following conditions are true:
- Subscriptions are available
- The user does not already own the most recent folio
- The user does not already have an active subscription
Figure 6. Clicking Restore Purchases lets users restore purchases.
To use the provided library and store templates you must have some folios published as public.
Where does the data come from?
The template uses the new library and store APIs to display folio data and images. All other images are packaged with your viewer.
Download and uncompress the sample files folder to see the contents. Currently, Viewer Builder does not allow nested folders in HTMLResources. Because of this limitation, the template does not organize the files into folders.
During development, it is a best practice to build and test your content on the desktop using Safari. When testing on the desktop, the API file is not available so data is loaded from the Adobe fulfillment XML feed. Using Safari allows local files to access data across domains, which is required when testing your project on the desktop.
While testing on the desktop, be sure to remove the include for AdobeLibraryAPI.js —otherwise you will be unable to view the files in your desktop browser. When testing on the desktop, if nothing is displayed open the debugger to check if there are any file paths that can't be resolved.
The following list contains descriptions of the key files in the template:
- HTMLResources.zip – The file that is uploaded to the Viewer Builder. It is included as an example. This file can be uploaded to Viewer Builder as-is for testing purposes.
- assets/AdobeLibraryAPI.js – The file that contains the library and store APIs.
- assets/backbone-min.js – An open source application framework.
- assets/index.html — The HTML file used to display the custom slot.
- assets/jquery-1.7.2.min.js — The jQuery library.
- assets/library.css – the styles for the template.
- assets/.png – the images for the template.
Note: Files in the “assets” directory should be included in the custom slot Zip file you upload to the Viewer Builder.
To make use of this template with your own content, you'll complete the following steps:
- Modify assets/AppView.js.
- Upload files to the Viewer Builder.
The following sections describe each of these steps in more detail.
- Modify AppView.js.
This modification is only necessary if you would like to test your account on the desktop. Since the API file is not available on the desktop, this XML feed is used to display the folios.
Open AppView.js in your code editor. On line 41, modify FULFILLMENT_URL to match the accountId parameter with your accountId. If you need help finding your accountId, see the section titled Connecting to fulfillment in Building a custom storefront. Once you have located your accountId, modify the value after http://edge.adobe-dcfs.com/ddp/issueServer/issues?accountId=.
On line 45, modify isEntitlementViewer to true or false, based on whether or not this is an entitlement viewer. This setting determines whether or not the Subscriber Login button is displayed.
- Upload files to the Viewer Builder.
To upload your files to the Viewer Builder, you must first create an archive that contains the files from the “assets” directory. When the archive is created, be sure to zip the files at the file level rather than the directory level of the assets directory.
Once your files are compressed, open the Viewer Builder and navigate to the Navigation Toolbar section. For more information on the Viewer Builder, watch the Viewer Builder tutorial video.
In the Navigation Toolbar section, select the option to Use Custom Viewer Library. Navigate to the zip file you created above and use the Lock Orientation menu to choose Portrait. Select the checkboxes to Hide Title Bar and Auto Launch.
Figure 7. The Navigation Toolbar section of the Viewer Builder for the library.
When your IPA has finished building, install the viewer on your device and begin testing.
To learn more about how to extend Adobe DPS to meet your business needs, watch the video of Klaasjan Tukker's MAX 2013 session, Extending and Integrating Digital Publishing Suite.
- Changed FULFILLMENT_URL so it uses a proxy.
- Added condition to check for folio.isArchivable when archiving a folio.
- API updates.