Are you viewing the right article?
This article refers to Digital Publishing Suite. For the AEM Mobile article, see Building apps for iOS.
Use the DPS App Builder to create a custom viewer app for the iPad or for both the iPad and iPhone. If you specify valid files and information, DPS App Builder generates both a development app and a distribution app. The development app is for testing. If it works properly, submit the distribution .zip file to the Apple Store.
The information such as certificates and passwords that you provide is not stored on the Adobe server. Only the application files are stored on the Adobe server.
- If you have a Professional or Enterprise DPS account, see iOS Publishing Companion Guide for Professional and Enterprise for information about creating the required certificates and images.
- If you’re a Creative Cloud or Single Edition user, see Step-by-Step iPad Publishing Guide for Single Edition.
Mac OSX 10.7 or later
DPS App Builder
A valid Adobe ID that has been assigned the DPS App Builder role using the Account Administration tool (Professional or Enterprise)
Start the DPS App Builder and sign in using a valid Adobe ID.
The Adobe ID you use to sign in to the DPS App Builder may be different from the Adobe ID you use to specify the Title ID in the App Details panel.
The Account Administration tool lets you or the administrator assign the DPS App Builder role to an Adobe ID. See Account Administration tool.
(Professional/Enterprise) If you’re creating a single-folio app, you can select the folio in the Folio Builder panel and choose Create App from the panel menu. Make sure that the account you use to create the folio includes both Application and DPS App Builder roles.
Provide a viewer name that appears below the App icon on the iPad. As a general rule, use 13 characters or fewer to avoid truncating the name.
To test your App name on the iPad, open a website in iPad Safari, choose Add to Home Screen from the Safari menu, and then type the desired Viewer name. If the name is truncated, use a smaller name.
Specify the most recent viewer.
The DPS App Builder includes a previous version for backup purposes. With the v28 release, you might want to create a v27 viewer, which supports iOS 5 and the iPad 1. The v28 viewer supports iOS 7 features but not iOS 5.
Specify the viewer type (see Types of custom viewer apps). The availability of some options depends on the type of account.
Adobe Content Viewer
Create a version of the Adobe Content Viewer instead of downloading it from the App Store. See Create a custom Adobe Content Viewer for iPad.
Title (Library View)
Provide the title that will appear at the top of the viewer library. For best results, use no more than 35 characters.
Select the appropriate Adobe ID your app. Choose the same Adobe ID you use to create folios for this particular app. The Title ID for the app can be different from the Adobe ID used to sign in to DPS App Builder.
Optional URL Scheme
Specify the custom URL scheme that launches the viewer app from Safari and other apps. To ensure uniqueness, Apple recommends that you use the reverse-domain format (com.publisher.publication). For best results with Twitter social sharing, use 32 characters or fewer.
For example, suppose you specify “com.sportspub.kayaking” as the URL scheme. If you embed a “com.sportspub.kayaking://” link on your webpage, clicking the link from the mobile browser opens the viewer app. For more information, see Apple’s developer website.
If you selected Built-in Single Edition App for App type, specify the .zip file to be built in with the viewer. To create a .zip file, use the Export option in the Folio Producer Organizer. See Export folios for single-folio viewers. (Instead of using the exported .zip file, you can select the folio in the Folio Builder panel and choose Create App.)
Optional Welcome Screen
Specify the .zip file containing your HTML files. If your app supports both iPad and iPhone, your HTML files should display content that works on both device sizes. For instructions and sample HTML files, see the Welcome Screen article in the DPS Developer Center.
Enable PDF Zooming
Select this option to allow your users to pinch and zoom non-interactive pages. Make sure that you select the PDF image format option when creating your folio.
Select this option to allow your users to bookmark their favorite articles in the app. If enabled, a Favorites icon appears on the upper right area of the viewer nav bar. Favorites are not yet available in the iPhone viewer.
Enable Auto Hiding of Folio Scrollbars
By default, a 6-pixel scrollbar area appears on the right side of articles in a folio. If you select this option, the scrollbar appears only when the user is scrolling in the article.
Always Open Background Downloaded Issue
When this option is selected, any folio that has been downloaded in the background since the previous viewing session opens on launch. If this option is not selected, the most recently viewed folio is opened in its previous reading position. This option is especially useful for daily and weekly magazines.
Enable Left and Right Hot Zone Navigation
If you select this option, invisible hot zones appear on the left and right sides of every article (or page if the article scrolls only horizontally). Tapping a hot zone jumps to the next or previous article. Hot zones are especially useful for full-screen overlays, such as slideshows. Hot zones are enabled for both iPad and iPhone viewers.
If a button appears in the hot zone area, tapping the area triggers the button. For any other overlay that appears in the hot zone area, tapping the area triggers the hot zone.
Enable Hot Zone to Display Folio View Controls
If you select this option, tapping in the hot zone area at both the top and bottom of the page displays the navigation bars (also called the “HUD”). Tapping anywhere outside the hot zones does not display the navigation bars. Hot zones are enabled for both iPad and iPhone viewers.
Buttons take precedence over the folio-view hot zones, the folio-view hot zones take precedence over the left and right hot zones, and the folio-view hot zones take precedence over all non-button overlays.
Hide Top Navigation Bar in Folio View
If you select this option, only the bottom navigation bar is displayed when a user taps an article. This allows publishers to create a custom navigation bar on all article pages to navigate within the folio.
Enable Auto Folio Archiving
Select this option enable auto-archiving of folios when the customer downloads the maximum number of folios allowed. Indicate whether the archiving is turned on by default. Customers can use the device settings to turn auto-archiving on or off. Also specify the maximum number of downloaded folios (between 6 and 90) for your viewer app. When the threshold number is reached, the least recently updated folios are archived automatically. Customers cannot change the threshold number. Customers can re-download any archived folio.
Enable Caching of Library Information
Select this option to cache folio information such as the price of a folio. Selecting this option improves performance for apps with large libraries because the viewer does not check the Apple server each time the library is loaded. However, selecting this option can cause folio information to become out of date. For example, if you select this option and change the cost of retail folios, your library will display misleading information. This option is currently available only for subscription apps.
Hide Sign In Button in Library (Enterprise only)
By default, the Sign In button appears in the upper left corner of the library in subscription apps with custom entitlement. You can hide the Sign In button if your custom library provides a different method for signing in.
Hide Folio Update Prompt
If this option is selected, tapping a cover image in the library downloads and applies the folio update without prompting users to accept or ignore the update. For example, this option is especially useful in a sales app in which members of the sales team are required to have the most updated content.
With a WiFi connection, updating a folio is mandatory in order to view it. With a cellular connection, updating the folio is optional. If there is no connection, users can continue to view the older folio version. If the folio is updated while a user is viewing the folio, an update prompt appears.
Hide Subscribe Button in Library (Enterprise only)
By default, the Subscribe button appears in the upper left corner of the library in subscription apps. You can hide the Subscribe button.
Auto-Download Latest Entitled Folio on First Launch
If this option is selected, the most recently entitled folio is downloaded automatically when the app is launched. Use the Account Administration tool make the most recent folio free to first-time downloaders. This option works only with apps that have retail content.
Auto-Open Latest Entitled Folio After Download
If "Auto-download latest entitled folio on first launch" is selected, this "Auto-open" option is selected by default so that first-time readers can download the app and start reading the most recent folio immediately. If you turn off the "Auto-open" option, users see the folio downloading in the library, but the folio doesn't open until they tap the cover image. This allows publishers to provide a message in the banner that lets first-time users know that they're receiving a free folio.
Enable Rate the App Dialog
Select this option to display a “Rate the App” prompt after your customers have launched the app a specified number of times. For example, if you set the “Rate the App Dialog Count” value to 5, users are prompted to rate the app on the fifth launch of the app. If they select “Remind me later,” they’re prompted on the next launch.
Specify the 9-digit Application ID for your app. To obtain this ID, sign in to itunesconnect.apple.com, click Manage Your Applications, and then click your app. Copy the 9-digit Apple ID string (not the Bundle ID).
Show Analytics Opt-in Dialog
If you select this option, your customers can opt out of data tracking. They can use the library settings in the viewer app to opt in at any time. This option is especially useful for regions in which you are obligated to allow users to opt out of data tracking.
To edit the default text that appears, select Use Customized Strings, and download and edit the values for “Analytics Opt-In Dialog Title” and “Analytics Opt-In Dialog Text.”
Use Legacy Store APIs (Enterprise only)
Select this option if you have an older custom store configuration that you would like to use. If you select this option, you cannot specify a custom library.
iTunes displays the languages in which the viewer app is available. The viewer interface is translated into multiple languages, but your folio content most likely isn’t. Select at least one language in which your viewer should appear.
Use Customized Strings
You can customize all strings stored in the viewer in all supported languages. For example, you can customize button text in the library and text in dialog boxes. See Customizing UI text in DPS iOS apps.
For detailed information about setting up a custom entitlement server, contact your Adobe representative.
Specify the URL in the form http://[:]/contextroot/api/, such as http://lighthouse.adobe.com/dps/entitlement_starter/api. The Service URL and Service AUTH URL should match the Integrator ID, but the value of the integratorID takes precedence if they are different. For details, see the direct entitlement API documentation or contact your Adobe representative.
Adobe provides the Integrator ID when your entitlement account is provisioned within our servers. You can use the same Integrator ID for multiple apps. The API contains 'appId' and 'appVersion' on every method, so your implementation can detect which application is asking for entitlement information
Contact your Adobe representative for information about the Integrator ID.
Optional Create Account URL
Specify the URL where customers can sign up for a subscription through the publisher, not through the Apple subscription process. This URL is used when users tap a “Subscribe” button that links to your entitlement service.
Optional Existing Subscription URL
Specify the URL where customers can indicate an existing print subscription while signing up for a digital subscription. Leave this field blank to disable the print subscription link button in the viewer.
Send App ID and Version
This option allows the Viewer app’s ID and Version strings to be sent in entitlement API calls. We recommend that you select this option.
Entitlement Banner Enabled
Select this option to display a full-width subscription banner in the viewer library instead of the subscription tile. If this option is not selected, only the subscription tile appears in the library. If you use a banner instead of the subscription tile, consider including links to subscription options in your HTML content.
Banner Page URL
Specify the URL that displays the subscription banner if the user is connect to the internet. This full-width banner appears in the upper section of the viewer library above the subscription tile and available folios. You can specify different URLs for SD and HD devices.
Offline Banner Assets
Select the .zip file containing the assets to be used as the banner if the user is not connected to the internet. The .zip file should include a single HTML file, one or more image files, and optional CSS files. The .zip file should not contain subfolders; all content should be on the same level. You can specify different .zip files to target SD and HD devices.
Specify the height of the banner that appears in the viewer library as either a fixed size or a percentage of the library area. You can specify a value between 1 and 1280, but the displayed banner height cannot exceed 40% of the library area.
Specify background images that describe the Apple subscription options. For landscape tiles that appear when the device is rotated sideways, specify a 964x184-pixel image for iPad SD, and specify a 1928x368-pixel image for iPad HD. For portrait tiles, specify 708x250 and 1416x500-pixel images for the different iPad sizes.
Tapping any part of the tile launches the iOS subscription options. These options are determined by the subscription in-app purchase information you specify in iTunes Connect.
Note: If you enable an entitlement banner, the entitlement banner is displayed instead of—not in addition to— the subscription tiles. However, due to a bug in the DPS App Builder, it is still necessary to specify the subscription tiles even though they are not used in the app.
Optional Library Subscription Tile URL
Specify a URL that is displayed in an in-app browser window when the customer taps the subscription tile. This webpage can include messaging that is not necessarily related to subscriptions.
Optional Remote Custom Dialog URL
This URL loads when the customer completes the subscription process. For example, you can request user information or provide additional details about your products.
Subscription Type/Subscription Products
Select Paid if you have a retail subscription app. For Subscription Products, click the plus icon to specify at least one Apple iTunes Connect product ID and corresponding duration. These options appear when customers tap the subscription tile or the Subscribe button.
Select Free if you are creating a Newsstand app with Apple’s Free Subscription option. Specify the Free Subscription Product ID you specified in iTunes Connect.
Shared secret information is required for subscription apps. Use iTunes Connect to create or view your shared secret. Use the Account Administrator tool to specify the shared secret characters for the application account. Then sign in to the Folio Producer Organizer to trigger the shared secret update.
Instead of specifying each icon file one at a time, select the files in a Finder window and drag them into the Icons and Splash Screens panel.
The icons that you specify will be used on the iPad home screen when installed, and on the device App Store when viewed from the iPad. Specify 29x29, 50x50, 72x72, 76x76, and 1024x1024 pixel icons in PNG format for iPad SD devices. Specify 58x58, 100x100, 144x144, and 152x152 pixel icons in PNG format for iPad HD devices. Specify 29x29, 57x57, 58x58, 87x87, 114x114, 120x120, and 180x180 icons for the iPhone. Apple rounds the corners automatically. Do not scale up smaller artwork. Use 72ppi, RGB, flattened, high-quality PNG files.
Always include a .png extension in your image filenames.
When the Viewer is started, a splash screen (also known as a launch image) appears for approximately three seconds. For splash screens, specify the following images using 72 ppi, RGB, flattened, high-quality PNG files. To reduce file size, use Save for Web & Devices in Photoshop to save 8-bit PNG files.
1024x768 and 768x1024 pixel images for iPad SD
2048x1536 and 1536x2048 pixel images for iPad HD
320x480 pixel image for iPhone SD
640x960 pixel image for iPhone HD, 640x1136 pixel image for iPhone 5, 750x1334 for iPhone 6, and 1242x2208 for iPhone 6 Plus.
For best results, make your splash screen image different from your cover. If the cover and the splash screen are identical, users may think the app is frozen when they first start it. Some publishers add “Loading . . .” to the splash images.
Enable shine effect on app icon
Indicate whether you want your application icons to include the shine effect, which looks like a light is shining on the upper portion of the icon.
Optional Fonts ZIP for HTML
If you apply fonts to text in your HTML stacks or web view overlays, you can include them in either the .folio file or the Viewer. If you choose to include them in the Viewer, compress the fonts in a .zip folder. The .zip file should not contain subfolders; all content should be on the same level.
If you enable Newsstand, your viewer app appears in the Newsstand folder of iPads with iOS5 installed. To enable Newsstand, you must create a viewer app with iTunes subscription—either iTunes Subscription only or Entitlement with iTunes Subscription, but not Entitlement only. In addition, you must enable push notifications.
Determine whether Newsstand should classify your viewer app as a magazine or newspaper.
Select an option to determine the adornment appearance on the Newsstand icon when a customer double-taps the Home button to display the active apps. For example, choosing Left binding displays a binding edge on the left and page adornments on the right.
Specify a PNG icon that appears in the Newsstand folder. Use a 72 ppi, RGB, flattened, high-quality PNG file at 384x512 pixels for the iPad SD and 768x1024 for the iPad HD. This icon is used as the initial cover image in Newsstand. This icon is replaced by the portrait cover image of the most recently published folio.
This panel lets you customize the Navigation Toolbar that appears in your custom viewer at the bottom of the library.
Hide Library Button
If the Navigation Toolbar is displayed, tapping the Library button on the bottom navigation bar does the same thing as tapping the Library button in the upper left navigation bar. To avoid this redundancy, you can hide the Library button, but only if the bottom navigation toolbar is enabled.
Show Navigation Toolbar
Select this option to display the Navigation Toolbar at the bottom of the viewer.
Specify whether the Navigation Toolbar should appear in all views, including the library and folio view, or if it should be hidden when folios are viewed.
If you want to include a custom library and hide the Navigation Toolbar, select Use Custom Library and specify the file and settings, and then select the option to hide the Navigation Toolbar.
Hide Viewer Icon
If Show Navigation Toolbar is selected, you can hide the Viewer icon that appears by default. Tapping the Viewer icon displays the previously viewed folio.
Hide Buy Buttons
Select this option if you want folios to be available for purchase only through a subscription and not through individual purchase, or if you want to use a custom store as the primary means of selling content. If this option is selected, the library displays only folios to which the user is entitled.
If Hide Buy Buttons is selected, the library displays a grid of folios instead of showcasing the most recent folio.
Hide Sign In Button
Selecting this option prevents the Sign In button from appearing in the upper left corner of the screen when a custom icon is tapped.
Hide Free Folios
Select this option to hide free folios from your library. This option is especially useful if you want to use your custom server to entitle customers to specify folios based on their sign in account information.
For information on restricting folios, see Using restricted distribution with Digital Publishing Suite.
Lock App Orientation
If you select Portrait or Landscape, the app remains in that orientation on an iPad. This setting affects all views, including the library view and folio view, even if the folio is dual-orientation.
Customize and Preview the Toolbar and Custom Icons
Use this section to specify custom icons for the navigation toolbar of the default library or to specify a custom HTML library.
Use Custom Viewer Library
When you click the Library icon in the Navigation Toolbar section of DPS App Builder, the Use Custom Viewer Library option appears. If you click the option icon, you can specify the .zip file that includes your HTML code. When you specify a custom library, a house icon appears in the top navigation bar instead of a "Library" icon.
Note that this option does not appear if "Use Legacy Store APIs" is selected in the App Details page. For more information about creating custom library, see Creating a custom library (Enterprise).
Click the plus icon on the right side of the panel to create a custom button (also called a "custom slot") for the Navigation Toolbar. Or, select the Library or Viewer icons to replace the default Library and Viewer icons with default icons.
You can include as many as 8 navigation icons for the iPad (6 custom plus the Library and Viewer icons) and 2 for the iPhone (1 custom plus Library).
For each icon, specify 30x30 and 60x60-pixel PNG files with a transparent background. Use any color for the foreground image. iOS applies a system color (usually light blue) to non-transparent pixels and changes the appearance of the icon to indicate whether it's selected.
When users tap a custom icon, an in-app browser displays the contents of the HTML file you provide, such as a website for a store, a news feed, or help page. Customers can tap a Close button to return to library view.
Specify the text, such as "Store" or "Help" that appears below the icon.
If your app includes multiple languages in the UI, you can edit the XML file that you download when you select the Use Customized Strings option in the App Details section. You can also use this XML file to change the "Library" and "Viewer" labels. For details, see the "Use Customized Strings" description earlier in this article.
Select WebView to display the contents of an HTML file you specify. Select Navigation only if you’re publishing a Woodwing-based app in which you can use the Intent metadata to jump to a cover, table of contents, or help article. Specify the name in the Intent field.
Navto Link Name
This option lets you use the goto:// format to create article links that open the HTML content associated with the custom icon. For example, if your link name is “Store,” creating a button with a goto://ApplicationViewState/Store action opens the Store webview. See Create goto links to custom icons.
Icon HTML Resources ZIP
Specify a .zip file containing the assets to be used for the web view that appears when users tap the toolbar button. The .zip file should include a single HTML file and any required image and CSS files. The .zip file should not contain subfolders; all content should be on the same level.
If you want the web view that appears when users tap the toolbar button to display in only one orientation, choose Horizontal or Vertical.
Hide Title Bar
Select this option to hide the title bar that appears at the top of the viewer library when the custom icon’s HTML content is displayed.
Show Navigation Controls
Display navigation controls such as a Back button and a Refresh button for the web page. These options appear in the title bar above the HTML content.
One of the custom toolbar buttons can be set to Auto Launch. When Auto Launch is turned on, opening the viewer library displays the HTML page automatically.
Click the plus icon on the right side of the Navigation Toolbar panel to include as many as eight buttons for iPad apps. You can also replace the default Library and Viewer buttons. Click the buttons in the preview bar to switch between buttons.
The Social Sharing settings control whether customers can share articles from your app through Facebook, Twitter, email, or copy/paste. Social Sharing is available for iPad and iPhone viewers. However, this feature is not available for single-issue apps or Android viewers. To learn more about the Social Sharing workflow, see Using social sharing.
If you select Enable Sharing, the Activity Sheet on iOS 7 devices displays all valid sharing options. At this time, you cannot turn off sharing options for iOS 7.
For iOS 6 devices, the social sharing menu is no longer available in any app built after February 11, 2014 due to new restrictions related to the Advertising Identifier reference in the Facebook SDK. The options under "iOS 6 Specific Settings" are no longer relevant.
Publication URL (v28 only)
For v28 apps, specify the URL that contains information about your publication. The link to the Publication URL appears when customers share a protected article. For v29 apps, the Publication URL is no longer necessary. When protected articles are shared, the full article URL is now included in the link, and a paywall message appears.
Apple requires all applications to be signed by a valid certificate and provisioned before they can be run on the iPad. In the Provisioning section, you specify the mobileprovision files. You specify the certificates when you download the generated viewer apps.
For information on creating certificates and mobileprovision files, see the iPad Publishing Companion Guide PDF, which is available on the Dashboard or from the Help menu in the DPS App Builder.
Enterprise Signed Viewer App
Select this option only if you want to use an enterprise provisioning certificate for a viewer to be distributed only within your organization. Specify an App ID and your enterprise mobileprovision file. You can also enable push notifications in an enterprise-signed app. The mobileprovision file must have a non-wildcard Bundle ID. See Creating an enterprise signed iPad viewer app.
The mobileprovision file determines which iPads can install and use your viewer app. The mobileprovision file for the development app includes a list of iPad IDs called UDIDs.
The mobileprovision file determines which iPads can install and use your Viewer app.
Sideloadable Developer Build
Select this option so that you can manually add .folio files to the development viewer through iTunes. You can use only .folio files, not .zip files created using the Export button in the Folio Producer Organizer.
Enable Push Notifications
Select this option to enable Adobe push notifications. If you select this option, a red badge appears on the viewer app icon and indicates the number of available folios, or Newsstand activates a push notification process. This option is required when Newsstand is enabled.
To set up push notifications, use the Apple Developer site to configure your App ID, create new mobileprovision files, and create production and development push certificates. For detailed instructions on creating push certificates, see the iPad Publishing Companion Guide PDF, which you can download from the Help menu in the DPS App Builder.
Push certificates are stored on a server and not included in the app itself. Use the Push Notifications Portal on the DPS Dashboard (https://digitalpublishing.acrobat.com) to specify push certificates.
For details, see Push notifications.
Use Adobe Push Server
If you deselect the Use Adobe Push option (Enterprise only), you can specify a third-party push server. Specify the server in the Push URL field. Specify any additional server requests your server requires in the Custom Push Parameters field. For basic requirements in setting up your push server, see Push notifications.
If you signed in using an Adobe ID provisioned for Omniture tracking, settings for tracking user data appear on the Build Details page. This data is populated automatically. If you have an enterprise account and these options do not appear, contact your Adobe representative.
After you specify information or files for all mandatory fields, click Submit Build, and then click Finish.
The amount of time it takes to create the development and distribution apps depends on how busy the server is.
Certificates are required for two different Viewer apps—a development app and a distribution app. The development app is for testing; the distribution app is what you submit to Apple once you test and approve the development app.
Developer P12 Certificate
The .p12 file saves your certificate private key information. Creating the .p12 certificate requires you to use the Apple Developer site to create and download a certificate and then use the Keychain Access utility to export the private key of that certificate as a .p12 certificate.
Submitting the development app
If your developer app works as designed, submit the distribution app (.zip) to the Apple Store. For details, see the iPad Publishing Companion Guide PDF.
Updating an app
If you need to create different icons or make other changes, select the viewer app on the main page, and click Edit. Your information and selections remain intact. Make the necessary changes, and then submit the build again. Your app will be updated.
To submit a new version of your app to Apple, you can either edit an existing app or create a new one. If you create a new version of your app, use mobileprovision files based on the same App ID as the previously built app. The versioning information is updated automatically.
To change the viewer type, such as converting a Multi Folio app to a Multi-Folio with iTunes Subscription app, you cannot edit the existing app. Instead, create a new app using the same mobileprovision files.