For AEM 6.2 Forms version of this help, see Set up and configure AEM Forms reference sites.

 

Overview

AEM 6.1 forms provides a reference site implementation to demonstrate how AEM forms helps Financial Services Industry and Government organizations in transforming their complex transactions into simple and engaging digital experiences anywhere, anytime, on any device.

The Geometrixx Finance and Geometrixx Gov reference sites draw real life use-cases to engage with existing and potential customers, right from the point of first touch to managing correspondences and transactions in a personalized and cost-effective manner.

For details about the reference site scenarios, see:

The reference site allows you to explore and showcase the following key capabilities of AEM 6.1 forms.

  • Adaptive documents to create interactive, personalized, and responsive documents that adapt to the device setting and layout.
  • Adaptive forms to create engaging and responsive forms that automatically render as PDF or HTML5 based on device and browser settings.
  • Integration with Adobe Campaign to create, automate, and manage marketing campaigns across multiple channels.
  • Integration with Adobe Target to serve targeted recommendations and perform A/B testing to maximize the ROI from a form.
  • Integration with Adobe Analytics to measure the performance of a form or a campaign and take informed decisions.

The reference site provides reusable assets that you can use as templates to create your own assets.

Workflow to set up the reference sites

Before you begin to explore the reference site, you need to deploy and set up the reference site. The following diagram depicts various installations, configurations, and integrations you need to perform for the reference site to be up and running.

Note:

To configure Campaign, Analytics, and Target, and experience their integration with AEM forms through Geometrixx Finance reference site, you must be registered with these solutions. 

Social login integration is applicable for Geometrixx Finance reference site only. 

Install AEM forms on JEE

To experience and execute one of the steps, which involves approving an application (credit card in Geometrixx Finance, child support in Geometrixx Gov), you need process management capabilities of AEM forms JEE. Choose an appropriate document according to your application server and installation type from the Installing, Upgrading, and Clustering AEM forms on JEE section on AEM 6.1 forms help landing page.

Install AEM forms on OSGi

Install AEM forms along with Geometrixx Finance and Geometrixx Gov referernce sites on OSGi as described in Install and deploy AEM forms.

Reference site package contents

The following resources and artifacts are included in the reference site package.

For Geometrixx Finance:

Content

Description

/apps/geometrixx-finance

Contains custom components, layout, and templates used in the reference site.

/content/geometrixx-finance

Contains Geometrixx finance web pages.

/content/dam/geometrixx-finance

Contains all the resources and assets, such as icons, images, and banners, used in the reference site.

/etc/designs/geometrixx-finance

Contains all the client libraries, including CSS and JavaScript, for the reference site.

/home/users/geometrixx/jjacobs

 

Contains a demo user, John Jacobs.

 

cq-geometrixx-finance-adaptiveform-pkg.zip

A package containing the credit card application used in the reference site. The credit card application is an adaptive form that you can use as a template and extend to create another adaptive form. 

cq-geometrixx-finance-layout-pkg.zip

A package containing a custom form view layout of the credit card application form on mobile devices. You can apply this layout on any other adaptive form.

cq-geometrixx-finance-content-pkg.zip

A package containing email templates and a welcome kit. The welcome kit is an interactive adaptive document, which you can use as a template to create your own adaptive document.

For Geometrixx Gov:

Content

Description

/apps/geometrixx-gov

Contains custom components, layout, and templates used in the reference site.

/content/geometrixx-gov

Contains Geometrixx Gov web pages.

/content/dam/geometrixx-gov

Contains all the resources and assets, such as icons, images, and banners, used in the reference site.

/etc/designs/geometrixx-gov

Contains all the client libraries, including CSS and JavaScript, for the reference site.

Configure LiveCycle client SDK component

You need to configure LiveCycle client SDK component in AEM forms on OSGi to communicate and invoke document services available on AEM forms on JEE. To configure the component, perform the following steps:

  1. Navigate to the AEM Web Console Configuration page at http://<hostname>:<port>/system/console/configMgr.
  2. Locate the Adobe LiveCycle Client SDK Configuration Component.
  3. Click the Edit icon to edit the configuration.
  4. Specify the server URL, username, and password for AEM forms on JEE server.
  5. Click Save.

Configure Day CQ Link Externalizer configuration

Perform the following steps on both author and publish instances:

  1. Go to OSGi Configuration at http://<hostname>:<port>/system/console/configMgr.
  2. Search for Day CQ Link Externalizer configuration.
  3. On the author instance, specify a publish URL that can be accessed from any external system. For example, use hostname or a publishing web server.
  4. On the publish instance, specify an author URL.
  5. On both author and publish instances, ensure that the URL to the server is specified in the local domain field.
  6. Click Save. Wait for a while for all services to restart.

Configure Day CQ Mail Service

Perform the following steps on the publish instance:

  1. Go to OSGi Configuration at http://<hostname>:<port>/system/console/configMgr.
  2. Search for Day CQ Mail Service configuration.
  3. Provide SMTP server hostname and port values.
  4. Click Save.

Configure Users in Email Server

Perform the following steps on your email Server, such as Apache James:

  1. Configure the email server domain as geometrixx.info.
  2. Create the following users accounts.
    • Sarah Rose - srose@geometrixx.info
    • John Doe - jdoe@geometrixx.info
      Create John Doe for Geometrixx Finance only. 
To add users in Apache James, see Creating User Accounts

Override default XSS configuration

Geometrixx Finance email templates contain personalized link in emails. These links have placeholder as ${placeholder}. These placeholders are replaced by actual values before sending emails. The default XSS protection configuration for AEM does not allow { and } (curly braces) in the URL in HTML content. However, you can override the default configuration by performing the following steps:

  1. Copy /libs/cq/xssprotection/config.xml to /apps/cq/xssprotection/config.xml.
  2. Open /apps/cq/xssprotection/config.xml.
  3. In the common-regexps section, modify the onsiteURL entry as follows and save the file.
    <regexp name="onsiteURL" value="([\p{L}\p{N}\\\.\#@\$\{\}%\+&amp;;\-_~,\?=/!\*\(\)]*|\#(\w)+)"/>
Note: We have added { and } (curly braces) to regex.

Configure AEM forms JEE server

Configure ContentRepositoryConnector service

  1. On AEM forms JEE, go to http://<hostname>:<port>/adminui.
  2. Navigate to Services > Applications and Services > Service Management.
  3. In the list of services, click ContentRepositoryConnector : 1.0.
  4. In the Configuration tab, select Named User from the Run As drop-down list.
  5. In the Experience Management Server URL, specify the path to the CRX server. For example: http://<hostname>:<port>/lc/crx/server/
  6. Specify admin in the CRX user field.
  7. Specify admin in the CRX Password field.
  8. Click Save.

Reference site configuration

Perform the following steps on publish instance:

  1. Go to OSGi Configuration at http://<hostname>:<port>/system/console/configMgr.
  2. Search for:
    • Geometrixx Gov Configuration for Gov refsite.
    • Geometrixx Finance Configuration for Finance refsite.
    It includes the following configurations:
    • Retargeting cron expression: A cron expression to schedule retargeting emails for applications that are saved but not completed. By default, the task is scheduled for 2 AM everyday.
    • Shared folder path: Path to a folder on the Campaign server that is shared with the publish server. The shared folder is used for publish server to communicate with Campaign server. The path to the shared folder should be accessible to publish server. For example, \\<campaign_server>\<watch_folder>.
    • Enable Campaign integration: A configuration for enabling email communication through Campaign server.
      By default, it is enabled. Disable this option to send email communications through Apache James Email Server, the SMTP server.
    • Enable JEE server: A configuration to enable application approval through AEM forms JEE server workflow. If you disable it, all applications are auto-approved after submission.
      If you do not have a JEE server setup or license, you can still use the refsite.
      Disable this option to use the refsite. 
  3. Click Save.

Sending Initial Email

Note:

These steps are applicable for Geometrixx Finance use case only. 

To initialize the reference site workflow, you need to send a newsletter to users. On your email server, go to the following url in a browser.

http://<publishHost>:<port>/content/campaigns/geometrixx-finance/start.html?email=srose@geometrixx.info

It sends a newsletter to Sarah Rose (srose@geometrixx.info). Further communications in the reference site workflow are based on user actions and triggered by AEM workflows.

Configure AEM and Campaign

Note:

Ensure that you have installed Campaign and integrated it with AEM as described in Adobe Campaign documentation.

Perform these steps only if the Campaign integration configuration is enabled as described in Reference site configuration.

Replace <refsite> with:

  • finance for Geometrixx Finance
  • gov for Geometrixx Gov

Configure Campaign service in AEM

  1. Log into AEM author instance and go to Tools > Operations > Cloud > Cloud Services.
  2. Click Configure now under Adobe Campaign.
  3. Specify title and name for the Campaign service.
  4. Click Create. The Adobe Campaign Settings dialog opens.
  5. Specify the username, password, and URL to connect to the Campaign server.
  6. Click Connect to Adobe Campaign.

Apply Campaign service on reference site emails

  1. In CRXDe Lite on the author instance, go to /content/campaigns/geometrixx-<refsite>/e-mails and open the following emails in authoring mode.
    For Finance refsite:
    • credit-card-campaign-newsletter
    • saved-form-intimation
    • statement-newsletter
    • welcomekit-newsletter
    • retarget-email
    For Gov refsite:
    • application-approval
    • application-submission
    • retargeting
    • saved-form-draft
  2. For each email, do the following:
    1. In the Page tab of AEM sidekick, click Page Properties.
    2. Click the Cloud Services tab.
    3. From the Adobe Campaign dropdown list, select the Campaign service you configured.
    4. Click OK.

Execute approval workflow for reference site emails

For each email, do the following:

  1. In AEM sidekick click the Workflow tab.
  2. From the Workflow drop-down list, select the Approval for Adobe Campaign workflow.
  3. Click Start Workflow. After email reloads, the current step in the workflow changes to Edit Email.
  4. Click Complete in the workflow tab. A dialog appears.
  5. Click OK. The current step in the workflow changes to Email Review.
  6. Click Complete in the workflow tab. A dialog appears.
  7. Select Next Step as Email Approval and click OK. The approval workflow is complete.

Import Campaign package

The reference site package includes a data package that contains built-in workflows, users, external account configurations, and delivery templates.

Perform the following steps to import the package:
  1. Open /apps/geometrixx-<refsite>/demo-artifacts/geometerixx-<refsite>-campaign.xml file in CRXDe Lite.
  2. Save the file content as an xml file on Campaign server file system.
  3. Open Campaign client console connected to the campaign server and go to Tools>Advanced>Import package.
  4. Select Install a package from a file option and click Next.
  5. Browse and select the xml file saved in the 2nd step.
  6. Click Next.
  7. Select Ignore warnings on the next screen and click Start.
  8. Close the dialog after the file is imported successfully.

Configure external accounts for AEM Server

  1. Connect to the Campaign server using Adobe Campaign Client console.
  2. Go to Administration > Platform > External Accounts.
  3. Click the account local-aem. By default, it points to http://localhost:4502.
  4. In Server input, provide the author server URL. For example, http://<hostname>:<port>.
  5. In Account, provide the username to connect with the author server.
  6. In Password, provide the password for the specified username.
  7. Click Save.

Configure AEM ResourceTypeFilter

  1. Connect to the Campaign server using Adobe Campaign Client console.
  2. Go to Administration > Platform > Options.
  3. Click AEMResourceTypeFilter and ensure that its value is specified as mcm/campaign/components/campaign_newsletterpage. Update the value, if required.
  4. Click Save.

Configure users email address

  1. Connect to the Campaign server using Adobe Campaign Client console.
  2. Go to Profiles and Targets > Recipients.
  3. Right-click the Recipients folder and select GeometrixxGov or GeometrixxFinance folder. It contains the pre-configured as listed in the following table.
  4. Add a valid email address for each user.
  5. Save the configuration.
First name Last name Gender Email
Sarah
Rose Female
<a valid email ID>
John Doe Male <a valid email ID>

Re-sync delivery templates

  1. Connect to the Campaign server using Adobe Campaign Client console.
  2. Go to Resources > Templates > Delivery templates.
  3. Expand and select the GeometrixxGov Templates or GeometrixxFinance Templates folder for Gov or Finance refsite respectively.
  4. Perform the following steps for each template under the folder.
    1. Open the template.
    2. Click Desynchronize.
    3. Now click Synchronize. A dialog appears listing all campaign emails available in the author instance.
    4. Select the email created for the delivery template.
    5. Click OK.

Note:

If you face an error while desynchronizing, right-click the template editor and select Edit XML source. In the XML source, search for remoteContent entry and remove it. Now, click OK and synchronize.

Configure Geometrixx Finance campaign workflow

Note:

Replace <refsite> with:

  • Finance for Geometrixx Finance
  • Gov for Geometrixx Gov

  1. Connect to the Campaign server using Adobe Campaign Client console.
  2. Go to Campaign Management > Campaigns.
  3. Open Geometrixx <refsite> Campaign
  4. In the campaign editor, click Targeting and workflows tab.
  5. Open Geometrixx<refsite>Workflow.
  6. Open File collector step in the workflow.
  7. The default directory configured is C:\workflow-watchfolder. Create a folder with this name, if it does not exist on the Campaign server file system. You can specify some other folder but ensure that it is shared with the publish server and also configured in the Shared Folder path entry in Geometrixx <refsite> Configuration as described in Reference site configuration.

The workflow includes file collector, JavaScript code, query, update data, and delivery activities.

Start campaign workflow

Start the Geometrixx<refsite>Workflow.

The GeometrixxFinanceWorkflow sends an email based on the Geometrixx Finance Credit Card Newsletter template to all recipients added to the GeometrixxFinance recipient folder. In the next step, the file collector will keep watching any XML file placed in the shared folder by the publish server. The publish server places XML files for triggering emails for draft application, welcome kit, and credit card statement.

The GeometrixxGovWorkflow sends an email based on the acknowledgment email template to all recipients added to the GeometrixxGov recipient folder. In the next step, the file collector will keep watching any XML file placed in the shared folder by the publish server. The publish server places XML files for triggering emails for draft application and enrollment.

Configure Analytics

AEM forms integration with Adobe Analytics allows you to monitor and analyze how your customers interact with your forms and documents. It helps you identify and fix problem areas and increase conversion rate.

To experience this functionality in reference site, configure your Analytics account as described in Configuring analytics and reports.

Configure Target

The reference site showcases the integration of AEM forms with Adobe Target that allows you to include targeted and personalized content in adaptive documents. It also enables creating A/B tests for adaptive forms.

To experience the integration in the reference site, do the following to configure Target in AEM:

  1. Access http://<hostname>:<port>/libs/cq/core/content/tools/cloudservices.html.
  2. In the Adobe Target section, click Show Configuration and then the + icon to add a new configuration.
  3. In the Create configuration dialog, specify a Title and optionally a Name for the configuration. And click Create. The Edit component dialog for the configuration opens.
  4. Specify your Client Code, Email and Password associated with your Target account.
  5. Click Connect to Adobe target. Once the Target account is configured successfully, you need to create a framework.
  6. Go to http://<hostname>:<port>/system/console/configMgr.
  7. Click AEM Forms Target Configuration.
  8. Select a Target Framework.
  9. In the Target URLs field, specify the URL to AEM forms. For example: http://<hostname>:<port>
  10. Click Save.

Enable login through social accounts

Note:

Social login integration is applicable for Geometrixx Finance reference site only. 

With AEM, you can allow your customers to log in using their Facebook and Twitter accounts. To allow this, you need to enable authentication handler and create Facebook and Twitter applications as described in Social Login and Personalization.

Next step

Now you are all set to explore the reference site. For more information about reference site workflow and steps, see:

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy