This package was created for AEM Forms 6.4 OSGI Author, has been tested, and is therefore supported on the following platform versions:
AEM VERSION | AEM FORMS PACKAGE VERSION | STATUS |
---|---|---|
6.4 | 5.0.86 | Supported |
6.5 | 6.0.80 | Supported |
6.5.3 | 6.0.122 | Supported |
This package contains cloud configuration which support the following platform versions:
CLOUD PROVIDER | SERVICE VERSION | STATUS |
---|---|---|
Adobe Sign | v5 API | Supported |
Microsoft Dynamics 365 | 1710 (9.1.0.3020) | Supported |
Adobe Analytics | v1.4 Rest API | Supported |
Package Installation considerations: |
The AEM Forms We.Gov demo package (we-gov-forms.pkg.all-<version>.zip) comes as a package which includes several other subpackages and services. The package includes the following modules:
we-gov-forms.pkg.all-<version>.zip - Complete demo package
we-gov-forms.ui.apps-<version>.zip - Contains all components, client libraries, samples users, workflow models, etc.
we-gov-forms.core-<version>.jar - Contains all OSGI services, custom workflow step implementation, etc.
we-gov-forms.derby<version>.jar - Contains all OSGI services, database schema, etc.
core.wcm.components.all-2.0.4.zip - Collection of sample WCM components
grid-aem.ui.apps-1.0-SNAPSHOT.zip - AEM Sites Grid layout package for Sites page column control
we-gov-forms.ui.content-<version>.zip - Contains all of the content, pages, images, forms, interactive communication assets, etc.
we-gov-forms.ui.analytics-<version>.zip - Contains all We.Gov Forms Analytics data to be stored within the repository.
we-gov-forms.config.public-<version>.zip - Contains all of the default configuration nodes including placeholder cloud configurations to help avoid forms data model, and service binding issues.
The assets included in this package include:
This section contains information on installing the demo package.
Open Software Distribution. You require an Adobe ID to log in to the Software Distribution.
Tap Adobe Experience Manager available in the header menu.
In the Filters section:
Tap the we-gov-forms.pkg.all-<version>.zip package name, select Accept EULA Terms, and tap Download.
Open Package Manager and click Upload Package to upload the package.
Select the package and click Install.
Allow the installation process to complete.
Navigate to https://<aemserver>:<port>/content/we-gov/home.html?wcmmode=disabled to ensure the installation was successful.
Download and locate the we-gov-forms.pkg.all-<version>.zip file.
Navigate to https://<aemserver>:<port>/crx/packmgr/index.jsp.
Select the “Upload Package” option.
Use the file browser to navigate to and select the downloaded ZIP file.
Click “Open” to upload.
Once uploaded, select the “Install” option to install the package.
Allow the installation process to complete.
Navigate to https://<aemserver>:<port>/content/we-gov/home.html?wcmmode=disabled to ensure the installation was successful.
To install new package version, follow the steps defined in 4.1 and 4.2. Installing a newer package version while another older package is already installed is possible, but it is recommended to uninstall the older package version first. To do so, follow the steps below.
Navigate to https://<aemserver>:<port>/crx/packmgr/index.jsp
Locate the older we-gov-forms.pkg.all-<version>.zip file.
Select the “More” option.
From the dropdown, select the “Uninstall” option.
On confirmation, select “Uninstall” again, and allow the uninstallation process to complete.
This section contains details and instructions on the post-deployment configuration of the demo package before presentation.
Navigate to https://<aemserver>:<port>/libs/granite/security/content/groupadmin.html
Login as an administrator in order to perform the tasks below.
Scroll down to the end of the page to load all user groups.
Search for “workflow”.
Select the “workflow-users” group and click on “Properties”.
Navigate to the “Members” tab.
Type in wegov in “Select User or Group” field.
Select from the dropdown “We.Gov Forms Users”.
Click “Save & Close” in the menu bar.
Repeat steps 2-7 by searching for “analytics”, selecting the “Analytics Administrators” group, and adding the “We.Gov Forms Users” group as a member.
Repeat steps 2-7 by searching for “forms users”, selecting the “forms-power-users” group, and adding the “We.Gov Forms Users” group as a member.
Repeat steps 2-7 by searching for “forms-users”, selecting the “forms-users” group, and this time adding the “We.Gov Users” group as a member.
Review setup documentation Configuring Email Notification
Login as administrator to perform this task.
Navigate to https://<aemserver>:<port>/system/console/configMgr
Locate and click on the Day CQ Mail Service service to configure.
Configure the service to connect to the SMTP server of your choice:
Click “Save” to save the configuration.
This section contains details on configuring SSL on the AEM instance in order to be able to configure the Adobe Sign Cloud configuration.
References:
Notes:
Navigate to https://<aemserver>:<port>/aem/inbox where you will be able to complete the process explained in the reference documentation link above.
The we-gov-forms.pkg.all-[version].zip
package includes a sample SSL key and certificate that can be accessed by extracting the we-gov-forms.pkg.all-[version].zip/ssl
folder that is part of the package.
SSL certificate and key details:
Private key is the localhostprivate.der.
Certificate is the localhost.crt.
Click Next.
HTTPS Hostname should be set to localhost.
Port should be set to a port that the system has exposed.
This section contains details and instructions on the Adobe Sign Cloud Configuration.
References:
Review the prerequisites. See AEM SSL Configuration for required SSL configuration.
Navigate to:
https://<aemserver>:<port>/libs/adobesign/cloudservices/adobesign.html/conf/we-gov
The URL used to access the AEM server should match the URL configured in the Adobe Sign OAuth Redirect URI to avoid configuration issues (e.g. https://<aemserver>:<port>/mnt/overlay/adobesign/cloudservices/adobesign/properties.html)
Select the “We.gov Adobe Sign” configuration.
Click on “Properties”.
Navigate to the “Settings” tab.
Enter the oAuth URL e.g.: https://secure.na1.echosign.com/public/oauth
Provide the configured Client Id and Client Secret from the configured Adobe Sign instance.
Click “Connect to Adobe Sign”.
After successful connection, click “Save & Close” to complete the integration.
This section contains details and instructions on the MS Dynamics Cloud Configuration.
References:
Navigate to:
https://<aemserver>:<port>/libs/fd/fdm/gui/components/admin/fdmcloudservice/fdm.html/conf/we-gov
Select the “Microsoft Dynamics OData Cloud Service” configuration.
Click “Properties”.
Navigate to the “Authentication Settings” tab.
Enter the following details:
Service Root: e.g https://msdynamicsserver.api.crm3.dynamics.com/api/data/v9.1/
Authentication Type: OAuth 2.0
Authentication Settings (see MS Dynamics cloud configuration settings to collect this information):
https://msdynamicsserver.api.crm3.dynamics.com
Click “Connect to OAuth”.
After successful authentication, click “Save & Close” to complete the integration.
The steps detailed in this section are included to help you locate the Client Id, Client Secret and details from your MS Dynamics Cloud instance.
Navigate to https://portal.azure.com/ and login.
From the left hand menu select “All Services”.
Search for or navigate to “App Registration”.
Create, or select an existing application registration.
Copy the Application ID to be used as the OAuth Client Id in the AEM cloud configuration
Click on “Settings” or “Manifest” to configure the Reply URLs.
From the Setting view, click “Keys” to view create new key (this is used as the Client Secret in AEM ).
To locate the Resource URL/Service Root URL, navigate to the MS Dynamics instance dashboard.
In the top navigation bar, click “Sales” or your own instance type and “Select Settings”.
Click on “Customizations” and “Developer Resources” near the bottom right.
There you’ll find the Service Root URL: e.g
*https://msdynamicsserver.api.crm3.dynamics.com/api/data/v9.1/
Details on the Refresh and Access Token URL are available here:
https://docs.microsoft.com/en-us/rest/api/datacatalog/authenticate-a-client-app
Once the cloud configuration is complete, you may want to test the form data model.
Navigate to
https://<aemserver>:<port>/aem/forms.html/content/dam/formsanddocuments-fdm/we-gov
Select the “We.gov Microsoft Dynamics CRM FDM” and select “Properties”.
Navigate to the “Update Source” tab.
Ensure that the “Context-Aware Configuration” is set to “/conf/we-gov” and that the configured data source is “ms-dynamics-odata-cloud-service”.
Edit the Form Data Model.
Test the services to ensure they successfully connect to the configured Data Source.
After testing the services, click Cancel to ensure that involuntary changes are not propagated to the Form Data Model.
It has been reported that an AEM Server restart was required for the Data Source to successfully bind to the FDM.
Once the cloud configuration is complete, you may want to test the forms data model.
Navigate to https://<aemserver>:<port>/aem/forms.html/content/dam/formsanddocuments-fdm/we-gov
Select the We.gov Enrollment FDM and select Properties.
Navigate to the Update Source tab.
Ensure that the Context-Aware Configuration is set to /conf/we-gov
and that the configured data source is We.Gov Derby DS.
Click on Save and Close.
Test the services to ensure they successfully connect to the configured Data Source
This section contains details and instructions on the Adobe Analytics Cloud Configuration.
References:
This package comes pre-configured to connect to Adobe Analytics. The steps below are provided to allow this configuration to be updated.
Navigate to https://<aemserver>:<port>/libs/cq/core/content/tools/cloudservices.html
Locate the Adobe Analytics section, and select “Show Configurations” link.
Select the “We.Gov Adobe Analytics (Analytics Configuration)” configuration.
Click on the “Edit” button to update the Adobe Analytics configuration (you will need to provide the Shared Secret). Click on “Connect to Analytics” to connect, and “OK” to complete.
From the same page, click “We.Gov Adobe Analytics Framework (Analytics Framework)” if you wish to update the framework configurations (see Enable AEM authoring to enable Authoring).
In order to locate the user credentials for a Adobe Analytics account the account administrator must perform the following tasks.
Administrators can provide users with AEM analytics permissions by performing the following actions.
Navigate to the Adobe Admin Console.
Click on the Analytics instance that is exposed to the Admin console.
Select Analytics full admin access.
Add a user to the Profile.
Click the permissions tab once the user id has been mapped into the profile.
Make sure all the permissions are mapped over to the profile.
Note that once the permissions have been mapped over the ability for a user to login may take a few hours.
AEM Forms Analytics data is available while offline or without an Adobe Analytics cloud configuration if the we-gov-forms.ui.analytics-<version>.zip
package is installed, but AEM Sites data requires an active cloud configuration.
Navigate to https://<aemserver>:<port>/sites.html/content
Select the “AEM Forms We.Gov Site” to view the site pages.
Select one of the site page (e.g. Home), and choose “Analytics & Recommendations”.
On this page, you will see fetched information from Adobe Analytics which pertains to the AEM Sites page (note: by design this information is periodically refreshed from Adobe Analytics and is not displayed in real-time).
Back on the page view page (accessed in step 3.), you can also view the page view information by changing the display setting to view items in the “List View”.
Locate the “View” dropdown menu and select “List View”.
From the same menu, select “View Setting” and select the columns you wish to display from the “Analytics” section.
Click “Update” to make the new columns available.
AEM Forms Analytics data is available while offline or without an Adobe Analytics cloud configuration if the we-gov-forms.ui.analytics-<version>.zip
package is installed, but AEM Sites data requires an active cloud configuration.
Navigate to
https://<aemserver>:<port>/aem/forms.html/content/dam/formsanddocuments/adobe-gov-forms
Select the “Enrollment Application For Health Benefits” adaptive form and select the “Analytics Report” option.
Wait for the page to load, and view the Analytics Report data.
In order to install and configure AEM Forms with the Adobe Forms, Conversion tool users must have the following.
Access to Adobe I/O.
Permission to create an integration with Adobe Forms Conversion service.
Adobe AEM 6.5 latest service pack running as an Author.
Please review the following prior to reading further instructions:
In order to configure the service to correctly communicate with the forms conversion tool users must configure the Identity Management System (IMS) service to be able to register with Adobe I/O.
Navigate to https://<aemserver>:<port> > Click Adobe Experience
Manager on the top left > Tools > Security >Adobe IMS Configuration.
Click Create.
Perform the actions in the image below.
Make sure to download the certificate.
Do not proceed with the remainder of the configuration - review section Creating Integration in Adobe I/O
The certificate created in this section is going to be used to create the integration service in Adobe I/O. Once users have created in the integration service users can use that information from Adobe I/O to finish the configuration.
Make sure you have the ability to create an integration within your Adobe domain if you do not contact your system administrator in order to do so.
Navigate to the Adobe I/O Console.
Click Create Integration.
Select Access an API.
Make sure you are in the correct group (top right dropdown list).
In the Experience Cloud section select the Forms Conversion Tool.
Click Continue.
Enter the name and description of your integration.
Using the Public Key from Section 2.1 place it within the integration of the key.
Select a profile for your automated forms conversion.
Now that you have created an integration let us complete the installation of the IMS configuration.
Click on your integration within Adobe I/O in order to expose the connection details.
Navigate to your IMS configuration within AEM (Tools > Security > IMS)
Click Next on the IMS Configuration screen.
Enter the Authorization server (value displayed in the screenshot).
Enter the API key.
Enter the client Secret (must click expose on the Integration in Adobe I/O for it to be revealed).
Click on the JWT tab in Adobe I/O in order to get the JWT payload and paste it in the payload of the IMS configuration.
Once created click on the IMS Configuration and select Health Check, users should see the following result.
Once the IMS configuration is complete then we can proceed to review the cloud configuration in AEM. If the configuration do not exist, use the following steps to create the cloud configuration in AEM:
Open your browser and navigate to the system URL https://<domain_name>:<system_port>
Click Adobe Experience Manager on the top left corner of the screen > Tools > Cloud Services > Automated Forms Conversation Configuration.
Select the configuration folder you would like to place the configuration in.
Click Create.
Enter the information in the screenshot below.
Provide the configuration with a Title and a Name.
The service URL for the system is set to https://aemformsconversion.adobe.io/.
Template URL /conf/we-gov/settings/wcm/templates/we-gov-flamingo-template.
Theme URL: /content/dam/formsanddocuments-themes/adobe-gov-forms-themes/we-gov-theme
Click Next.
For this configuration, we left the two checkbox values empty.
Once the IMS configuration is complete then we can proceed to create the cloud configuration in AEM.
Open your browser and navigate to the system URL https://<domain_name>:<system_port>
Click Adobe Experience Manager on the top left corner of the screen > Tools > Cloud Services > Automated Forms Conversation Configuration.
Select the configuration folder you would like to place the configuration in.
Click Create.
Enter the information in the screenshot below.
Provide the configuration with a Title and a Name.
The service URL for the system is set to https://aemformsconversion.adobe.io/
Template URL: /conf/we-finance/settings/wcm/templates/we-finance-adaptive-form
Theme URL: /content/dam/formsanddocuments-themes/adobe-finance-forms-themes/we-finance-theme
Click Next.
For this configuration, we left the two checkbox values empty.
Once the configuration is set up users can test it by uploading a PDF document.
Navigate to the AEM system https://<domain_name>:<system_port>
Click on Forms > Forms & Documents > AEM Forms We.gov Forms > AFC.
Select the We.Gov Enrollment Application PDF.
Click on the Start Automated Conversion button in the top right corner.
Users should be able to see the option as shown below.
Once the button has been selected then users will be presented with the following options
Select start conversion once you have configured all of the options that you would like to use.
As the conversion process begins then users should see the following screen:
When the conversion is complete then users will see the following screen:
Click the Output folder to view the generated adaptive form.
The Automated Forms Conversion service includes certain best practices, known complex patterns, and known issues. Review these before you begin using AEM Forms Automated Forms Conversion service.
Generate the Form with Generate adaptive form(s) without data bindings enabled if you would like to bind the form to an FDM after conversion.
Make sure the template folder has jcr:read for everyone permission enabled or else the service user will not be able to read the template from the repository and the conversion will fail.
This section includes instructions on customization of the demo.
Editable Templates can be found at the following location:
https://<aemserver>:<port>/libs/wcm/core/content/sites/templates.html/conf/we-gov
These templates include the AEM Site, Adaptive Form, and Interactive Communications templates, created and assembled with components that can be found at:
https://<aemserver>:<port>/crx/de/index.jsp#/apps/we-gov/components
This site also features client-libraries, one of which imports Bootstrap 4 ( https://getbootstrap.com/ ). This client library is available at
https://<aemserver>:<port>/crx/de/index.jsp#/apps/we-gov/clientlibs/clientlib-base/css/bootstrap
The editable templates included in this package also come preconfigured with template/page policies that use the Bootstrap 4 CSS classes for pagination, styling, etc. Not all classes have been added to the template policies, but any class that is supported by Bootstrap 4 can be added to the policies. See the getting started page for a list of available classes:
https://getbootstrap.com/docs/4.1/getting-started/introduction/
Templates included in this package also support the Style System:
Project DAM Assets also include We.Gov logos and images. These assets are available at:
https://<aemserver>:<port>/assets.html/content/dam/we-gov
When editing the Page and Form Templates, one may choose to update brand logos by editing the Navigation and Footer components. These components offer a configurable brand and logo dialog that can be used to update logos:
See Editing Page Content for more information:
All site pages are available from: https://<aemserver>:<port>/sites.html/content/we-gov
These site pages also make use of the AEM Grid package to control the layout of a few components.
Pages included in this package also support the Style System:
You can also refer to Templates customization style system for documentation on supported styles.
All adaptive forms are available from:
https://<aemserver>:<port>/aem/forms.html/content/dam/formsanddocuments/adobe-gov-forms
These forms can be customized to fit certain use cases. Note that certain fields, and submission logic should not be modified to ensure that the form continues to function correctly. This includes:
Enrollment Application For Health Benefits:
Adaptive forms can also be styled using the Style Editor or Theme editor:
The Enrollment Adaptive Form submit to an OSGI workflow for processing. This workflow can be found at https://<aemserver>:<port>/conf/we-gov/settings/models/we-gov-process.html.
Due to certain limitations, this workflow contains several scripts and custom OSGI workflow process steps. These workflow steps were created as generic steps and have not been created with configuration dialogues. At this time, configuration of the workflow steps relies on process arguments.
All workflow step Java code is contained in the we-gov-forms.core-<version>.jar bundle.
This section contains information on demo features and design decisions that may require special considerations during the demonstration process.
In order to perform accessibility testing first you need to install the Chrome plugin, this can be found here.
Once it is installed, load the page that you wish to test within the Chrome Browser (Note: Having multiple tabs open may affect your score, it is preferable to only have one tab open). Once the page is loaded
right click on the page and select Audits tab . There developers can select the type of audit to be performed by the Accessibility plugin. Once all the desired options have been selected then the user can select the Generate Report button. This will generate a PDF document that shows the overall accessibility rating and what can be used to increase accessibility rating overall.
Once the report has been executed users can expect to see the following:
The number displayed in front of users is the overall accessibility rating that they have acquired. There is also a description of how this was calculated following the score.
If users wish to export this they can click on the three buttons on the right of the screen and select from the further options that the plugin offers.
The publicly available Ultramarine theme maintained by Adobe is built into the
we-gov-forms.pkg.all-<version>.zip
installable ZIP file. Once this package is installed using CRX.
Package Manager, users can access the Ultramarine theme in AEM Forms by navigating to Forms > Themes > Reference Themes > Ultramarine-Accessible.
Users have the ability to configure various workflow service options which include the following:
In order to configure them to be enabled within the Workflow users need to perform the following tasks.
Navigate to https://‘[server]:[port]’/system/console/configMgr.
Locate the WeGov Configurations.
Open the service definition and enable the selected services to be invoked within the workflow.
Just because a user enables the service within the Configuration Manager page, users are still required to setup a service configuration in order to communicate with the external services requested.
Once completed click on the Save button in order to save the settings.
Now you are all set to explore the We.Gov reference site. For more information about We.Gov reference site workflow and steps, see We.Gov reference site walkthrough.