AEM 6.4 has reached the end of extended support and this documentation is no longer updated. For further details, see our technical support periods. Find the supported versions here.
Adobe recommends using the SPA Editor for projects that require single page application framework-based client-side rendering (e.g. React). Learn more.
The AEM mobile application development process recognizes that users of different expertise contribute to the development of mobile applications. The following process map illustrates the general order in which content authors and application developers perform tasks.
Information about how to perform the Marketer tasks appear on this page. For information about the Developer tasks, see Building PhoneGap Applications.
AEM Mobile provides the Phonegap App blueprint for creating mobile applications. The blueprint defines the structure of the applications that you create. Applications consist of the following items:
The root page of the mobile applications that you create in AEM appears in the Apps console.
The root page is stored below the Destination Path property of the application that was specified upon creating the application (the default path is /content/phonegap/apps). The page name is the Name property of the application. For example, the default URL of the root page of the site named myphonegapapp
is http://localhost:4502/content/phonegap/apps/myphonegapapp.html
.
The first child pages of the root page are the language variations of the application. The name of each page is the language for which the application is created. For example, English is the name of the English variation of the application.
Note: The default PhoneGap blueprint creates only an English application. Your developer can modify the blueprint so that it can create more language variations.
The language page serves two purposes:
The Home page, or index.html page of a language variation of an application appears when the application is opened.The home page provides users with a menu of links to various pages in the application. The paragraph system enables you to add components to the page for creating content.
Mobile applications are based on a blueprint that defines a page structure and properties. You can configure the following application properties:
You can also provide an image file to use as the application thumbnail, select the PhoneGap Build configuration to use, and select the Mobile App analytics configuration to use. This image is only used as a thumbnail to represent your mobile application within the mobile apps console in Experience Manager.
Additional (and optional) tabs exist for build cloud service and integrating the Adobe Mobile Services SDK plug-in into your app.
Developers can use the AEM PhoneGap Starter Kit to create apps and add them to the console.
The following procedure uses the Touch UI to create a mobile application.
On the rail, click Apps.
Click or tap the Create icon.
(Optional) On the Advanced tab, provide a description for the application, and change the server URL if required.
(Optional) If you are using PhoneGap Build to compile the application, on the Build tab, select the Configuration to use.
To create a PhoneGap build configuration, click Manage Configurations.
(Optional) If you are using SiteCatalyst to track application activity, on the Analytics tab, select the configuration to use.
To create a Mobile App Configuration, click Manage Configurations.
(Optional) To provide an application icon, click the Browse button, select the image file from your file system, and click Open.
Click Create.
After you create a mobile application, you can change the properties.
On the rail, click or tap Apps.
Select the application to configure and click the View Page Properties icon.
To change property values, click or tap the Edit icon.
Configure the Basic and Advanced properties, and then click or tap the Done icon.
On the rail, click or tap Apps.
Click to drill-into the mobile application you wish to edit within the apps admin console. Select the language version of the application to configure and click the View Application Properties icon.
To change property values, click or tap the Edit icon.
Configure the properties on the Basic, Advanced, Build, and Analytics tabs, and then click or tap the Done icon.
After you create the mobile application, add content that is used as the application UI.
The Content Sync cache on the AEM publish instance is used as a repository of content for mobile applications:
Mobile applications include an Updates command that downloads and installs updated application content. When an application instance sends an Update request, Content Sync determines which content has changed since the last time the application was updated or installed, and provides the new content.
To make updated content available to applications, you update the Content Sync cache. The first time you update the cache, all published content is added. Subsequent updates adds only the published content that has changed since the previous update.
Content Sync also tracks when the updates occur. With this information, Content Sync can determine which cache update to send to a mobile application.
Perform the following procedure on the instance where you want to update the cache. For example, if your application requests updates from the publish instance, perform the procedure on the publish instance.
On the rail, click or tap Apps, then click or tap your application.
Select the splash page, and then click or tap the Update Cache icon.
This is a feature that is available with Apps 6.1 Feature Pack 2 and provides an easy way to leverage existing app templates for the creation of new apps within AEM.
What is an app template? Think of it as a collection of page templates and components that represent a baseline or foundation of an app.
When creating a new app based on the template of another app, you will get an app that has a starting point representative of the app in which it was created from.
You must have an existing mobile app template (or an app installed that has an app template) to make use of this feature.
The latest AEM Apps 6.1 samples package includes an updated version of the Geometrixx app with an app template. Alternatively, you can install the StarterKit which also provides a template.
Steps to creating a new app based on an app template:
Click Next.
Provide an App Id and Title, however you might want to also include a Name and a Description.
If you uninstall the Geometrixx Outdoors reference app package from AEM and have an app created based on its template, then that app will not longer be functional. The Geometrixx Outdoors app can be removed, however the app template must remain if it is used by other mobile applications.
Geometrixx Outdoors App is a sample PhoneGap application that demonstrates the features of the default PhoneGap application blueprint and the sample mobile components.
To open the application, from the rail click Mobile Applications and then select Geometrixx Outdoors App.
Each page of the mobile app includes the following features:
A back button for returning to the parent page. Note that the back button does not appear on the Home page.
An expandible rail that offers a menu of commands and links:
The paragraph system, for adding components and creating content.
The content of the Home page is comprised of the following navigation tools:
The Gear page provides users with access to product pages. A Menu list component provides access to the child pages of the Gear page. The child pages are categories of products that the website features.
Each category page uses the same content structure as the Gear page. The carousel provides access to child pages which are subcategories of products. The subcategory pages contain product listings that provide links to product pages.
The Products page and its heirarchy of child pages implement a classification system for product pages. The lowest pages in each branch of the heirarchy is a product page that contains an ng Product component.
The Products page is not available to application users. The Gear page provides access to each product page.
Contains a back button. The paragraph system allows you to add components.
When using the application, the Reviews page is available from the carousel on the English page.
Contains a back button. The paragraph system allows you to add components.
When using the application, the News page is available from the carousel on the English page.
The About us page contains serveral Two Column Row components. Each column contains either an Image or a Text component. The components are editable, and the paragraph system allows you to add components.
When using the application, the About Us page is available from the carousel on the English page.
The Locations page contains a Locations component.
When using the application, the Locations page is available from the menu list on the English page.
Several components are immediately available in Sidekick when authoring the pages of a mobile application. The components belong to the PhoneGap component group.
The Swipe Carousel component is a tool for showcasing and navigating site pages. The component includes a carousel that cycles through images for the pages above a list of page links. Edit the component to specify the pages to expose and the behavior of the carousel.
Note that images appear in the carousel for pages that are associated with an image in a specific way. When pages are not associated with images, only the list of links appears.
Carousel properties tab
Configure the behavior of the carousel:
List properties tab
Specify how the page list is generated:
The Swipe Carousel component provides the following values for the Build List Using property. The edit dialog changes according to the value that you select:
Child Pages
The component lists all of the child pages of a specific page. After you select this value, select the page on the Child Pages tab, or specify no value to list the children of the current page.
Fixed List
Specify a list of pages of include. After you select this value, configure the list on the Fixed List tab that appears when you select Fixed List:
The Order By property does not affect the order of fixed lists.
Search
Populate the list using the results of a keyword search. The search is performed in the children of a page that you specify:
Advanced Search
Populate the list using a Querybuilder query.
Add an image to your application content.
Add rich text to your application content.
The Store Locations component provides users with tools for finding business outlets:
The component requires that the repository contains location information for each store. Sample locations are installed at the /etc/commerce/locations/adobe node.
Enables you to add side-by-side components to a page.