Configure the Automated Forms Conversion service
This help describes how an AEM administrator can configure Automated Forms Conversion service to automate conversion of their PDF forms to adaptive forms. This help is for IT and AEM administrators at your organization. The information provided is based on the assumption that anyone reading this Help is familiar with the following technologies:
-
Installing, configuring, and administering Adobe Experience Manager and AEM packages,
-
Using Linux® and Microsoft® Windows® operating systems,
-
Configuring SMTP mail servers
Onboarding
The service is available for free to AEM 6.4 Forms and AEM 6.5 Forms On-Premise term customers and Adobe-Managed Service enterprise customers. You can contact Adobe Sales team or your Adobe representative to request access to the service. The service is also available for free and pre-enabled for AEM Forms as a Cloud Service customers.
Adobe enables access for your organization and provide required privileges to the person designated as administrator in your organization. The administrator can grant access to your AEM Forms developers (users) of your organization to connect to the service.
Prerequisites
You require the following to use the Automated Forms Conversion Service:
- Automated Forms Conversion service is enabled for your organization
- An Adobe ID account with administrator privileges for the conversion service
- An up and running AEM 6.4, AEM 6.5, or AEM Forms as a Cloud Service author instance with latest AEM Service Pack or latest updates.
- An AEM user (on your AEM instance) which is member of forms-user group
Set up the environment
Before using the service, prepare your AEM author instance to connect to the service running on Adobe Cloud. Perform the following steps in the listed sequence to prepare your instance for the service:
Download and install AEM 6.4 or AEM 6.5 or onboard AEM Forms as a Cloud Service
Automated Forms Conversion service runs on AEM author instance. You require AEM 6.4, AEM 6.5, or AEM Forms as a Cloud Service to set up an AEM author instance.
-
If you do not have AEM 6.4 or AEM 6.5 up and running, download it from the below locations. After you download AEM, for instructions to set up an AEM author instance, see deploying and maintaining.:
-
If you are an existing AEM customer, download AEM 6.4 or AEM 6.5 from Adobe Licensing website.
-
If you are an Adobe partner, use Adobe Partner Training Program to request AEM 6.4 or AEM 6.5.
-
-
If you are using AEM Forms as a Cloud Service see onboard to AEM Forms as a Cloud Service and setup a local development environment.
(For AEM 6.4 and AEM 6.5 only) Download and install AEM latest Service Pack
Download and install latest AEM Service Pack. For detailed instructions see, or AEM 6.4 Service Pack Release Notes or AEM 6.5 Service Pack Release Notes.
(For AEM 6.4 and AEM 6.5 only) Download and install AEM Forms add-on package
An AEM instance contains basic forms capabilities. The conversion service requires full capabilities of AEM Forms. Download and install AEM Forms add-on package to avail all the capabilities of AEM Forms. The package is required to set up and run the conversion service. For detailed instructions, see Install and configure data capture capabilities.
Create custom themes and templates
If you start AEM 6.4 or AEM 6.5 in production mode (nosamplecontent run mode), the reference packages are not installed. The reference packages contain sample themes and templates. Automated Forms Conversion service requires at least one theme and one template to convert a PDF form to an adaptive form. Create a custom theme and template of your own and point service configuration to use custom templates and themes before using the service.
You can also download and install the AEM Forms Reference Assets package on your Author instance. It creates some reference themes and template.
Configure the service
Before you proceed to configure the service and connect your local instance with the service running on Adobe Cloud, learn about the personas and privileges required to connect to the service. The service uses two different types of personas, administrators and developers:
- Administrators: Administrators are responsible for managing Adobe software and services for their organization. Administrators grant access to developers in their organization to connect to Automated Forms Conversion service running on Adobe Cloud. When an administrator is provisioned for an organization, the administrator receives an email with title ‘You now have administrator rights to manage Adobe software and services for your organization’. If you are an administrator, check your mailbox for email with previously mentioned title and proceed to grant access to developers of your organization.
- Developers: A developer connects a local AEM Forms author instance to Automated Forms Conversion service running on Adobe Cloud. When an administrator grants rights to a developer to connect to Automated Forms Conversion service, an email with title You now have developer access to manage Adobe API integrations for your organization is sent to the developer. If you are a developer, check your mailbox for email with previously mentioned title and proceed to Connect your local AEM instance to Automated Forms Conversion service on Adobe Cloud.
(For administrators of AEM 6.4 and AEM 6.5 only) Grant access to developers of your organization
After Adobe enables access for your organization and provides required privileges to the administrator, the administrator can log into Admin Console (detailed instructions below), create a profile, and add developers to the profile. Developers can connect a local instance of AEM Forms to Automated Forms Conversion service on Adobe Cloud.
Developers are members of your organization designated to run the conversion service. Only those developers which are added to Adobe Automated Forms Conversion service profile are entitled to use the Automated Forms Conversion service. Perform the below steps to create a profile and add developers to it. A minimum of one profile is required to grant required access to developers of your organization:
-
Log in to Admin Console. Use Adobe ID of administrator provisioned to use Automated Forms Conversion service to login. Do not any other ID or Federated ID to login.
-
Click the Automated Forms Conversion option.
-
Click New Profile in the Products tab.
-
Specify Name, Display Name, and Description for the profile. Click Done. A profile is created.
-
Add developer to the profile. To add the developers:
- In the Admin Console, navigate to the Overview tab.
- Click Assign Developers on the required product card.
- Enter the developers email address and, optionally, first and last names.
- Select product profiles. Tap Save.
Repeat above steps for all the users. For more details about adding developers, see Manage developers.
Once an administrator adds developers to Adobe I/O profile, the developers are notified via email. After receiving the email, the developers can proceed to connect a local AEM Forms instance with Automated Forms Conversion service on Adobe Cloud.
(For developers only) Connect your local AEM Forms instance to Automated Forms Conversion service on Adobe Cloud
After an administrator provides you developer access, you can connect your local AEM Forms instance to Automated Forms conversion service running on Adobe Cloud. Perform the following steps in the listed sequence to connect your AEM Forms instance to the service:
Configure email notification
Automated Forms Conversion service uses the Day CQ mail service to send email notifications. These email notifications contain information about successful or failed conversions. If you choose not receive notification, skip these steps. Perform the following steps to configure the Day CQ Mail Service:
-
For AEM 6.4 Forms or AEM 6.5 Forms:
-
Go to AEM configuration manager at
http://localhost:4502/system/console/configMgr -
Open the Day CQ Mail Service configuration. Specify a value for the SMTP server host name, SMTP server port, and From address fields. Click Save.
You can contact your email service provider or IT administrator for information about host name and port of SMTP server. You can use any valid email address in the from field. For example, notification@example.com or donotreply@example.com.
-
Open the Day CQ Link Externalizer configuration. In the Domains field, specify the actual host name or IP address and port number for local, author, and publish instances. Click Save.
-
-
For AEM Forms as a Cloud Service, log a support ticket to enable the email service.
Add user to the forms-users group
Specify an email address in the profile of the AEM user designated to run the service. Ensure that the user is the member of the forms user group. Emails are sent to the email address of user running the conversion. To specify an email address for the user and add user to the forms user group:
-
Log in to your AEM Forms author instance as an AEM administrator. Use your local AEM credentials to login. Do not use Adobe ID to login. Tap Adobe Experience Manager > Tools > Security > Users.
-
Select a user designated to run the conversion service and tap Properties. The Edit User Settings page opens.
-
Specify an email address in the Email field and tap Save. The emails are sent to specified email address on successful completion or failure of the conversion.
-
Tap the Groups tab. In the select group tab, type and select the forms-users group. Tap Save & Close. The user is now a member of the forms-users group.
(For AEM 6.4 and AEM 6.5 only) Obtain public certificates
A public certificate allows you to authenticate your profile on Adobe I/O.
-
Log in to your AEM Forms author instance. Navigate to Tools> Security > Adobe IMS Configurations. Tap Create. The Adobe IMS Technical Account Configuration page appears.
-
Select Automated Forms Conversion Service in Cloud Solution.
-
Select the Create new certificate check box and specify an alias. The alias serves as name of the dialog. Tap Create certificate. A dialog appears. Click OK. The certificate is created.
-
Tap Download Public Key and save the AEM-Adobe-IMS.crt certificate file on your machine. The certificate file is used to Configure the service APIs on Adobe Developer Console. Tap Next.
-
Specify the below:
- Title: Specify a title.
- Authorization Server: https://ims-na1.adobelogin.com\
Leave the other fields blank for now (to be provided later). Keep the page open.
(For AEM 6.4 and AEM 6.5 only) Configure the service APIs on Adobe Developer Console
To use Automated Forms Conversion service, create a project and add Automated Forms Configuration Service API to the project on Adobe Developer Console. The integration generates API Key, Client Secret, Payload (JWT).
-
Log in to https://console.adobe.io/. Use your Adobe ID, developer account that your administrator has provisioned to login to Adobe I/O console to login.
-
Select your organization from the top-right corner. If you do not know your organization, contact your administrator.
-
Tap Create new project. A screen to get started with your new project appears. Tap Add API. A screen with list of all the APIs enabled for your account appears.
-
Select Automated Forms Conversion service and tap Next. A screen to configure the API appears.
-
Select the Upload your public key option, upload the AEM-Adobe-IMS.crt file downloaded in the Obtain Public Certificates section and tap Next. The Create a new Service Account (JWT) credential option appears. Tap Next.
-
Select a Product Profile and Tap Save configured API. Select the profile created while granting access to developers of your organization. If you do not know the profile to select, contact your administrator.
-
Tap Service Account (JWT) to view the API Key, Client Secret, and other information required to connect your local AEM instance to Automated Forms Conversion service. The information on the page is used to create IMS configuration on your local machine.
-
Open the IMS Configuration page on your local instance. You kept the page open at the end of section, Obtain public certificate.
-
On the Adobe IMS Technical page, specify API Key and Client Secret. Use the values specified on Service Account (JWT) of the Adobe Developer console page.
note note NOTE For payload, use the code provided in the Generate JWT tab of the Service Account(JWT) page of Adobe Developer Console. -
Tap Save. The IMS configuration is created.
note caution CAUTION Create only one IMS configuration. Do not create more than one IMS configurations. -
Select the IMS configuration and tap Check Health. A dialog box appears. Tap Check. On successful connection, the Token retrieved successfully message appears.
Configure the Cloud Service
Create a Cloud Service configuration to connect your AEM instance to the conversion service. It also allows you to specify a template, theme, and form fragments for a conversion. You can create multiple cloud service configurations separate for each set of forms. For example, you can have a separate configuration for sales department forms and a separate one for customer support forms. Perform the following steps to create a cloud service configuration:
-
On your AEM Forms instance, tap Adobe Experience Manager > Tools> Cloud Services > Automate Forms Conversion Configuration.
-
Tap the Global folder and tap Create. The page to create Automated Forms Conversion configuration appears. The configuration is created in the Global folder. You can also create the configuration in a different folder that exists or create a folder for your configurations.
-
On the Create Automated Forms Conversion Configuration page, specify value for the following fields and tap Next.
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 Field Description Title Unique title for the configuration. The title is displayed in the UI used to start conversion. Name Unique name for the configuration. The configuration is saved in the CRX-Repository with the specified name. The name can be identical to the title. Thumbnail location Location of the thumbnail for the configuration. Service URL URL of the Automated Forms Conversion service on Adobe Cloud. Use the https://aemformsconversion.adobe.io/URL.Template Default template to be applied to converted forms. You can always specify a different template before starting the conversion. A template contains basic structure and initial content for an adaptive form. You can choose a template from the templates provided out-of-the-box. You can also create a custom template. Theme Default theme to be applied to converted forms. You can always specify a different theme before starting the conversion. You can click the icon to choose a theme provided out-of the box. You can also create a custom theme. Existing Fragments Location of existing fragments, if any. Custom Meta-model Path of the .schema.json file of custom meta-model. You can create separate meta-models for English, French, German, Spanish, Italian, and Portuguese languages. -
In the Advanced tab of the Create Automated Forms Conversion Configuration page, specify value for the following field:
table 0-row-2 1-row-2 2-row-2 Field Description Generate Document of Record Select the option to automatically generate Document of Record for converted forms. The option is only for XFA-based forms (XDP and PDF Forms). When you enable the option, after submitting a form, you can allow your customers to keep a record, in print or in document format, of the information they have filled in the form for their future reference. This is referred to as a document of record. Enable Analytics (For AEM 6.4 and AEM 6.5 only) Select the option to enable Adobe Analytics on all the converted forms. Before using the option, ensure that Adobe Analytics is enabled for your AEM Forms instance. - When the source is an XFA-based form with extension .XDP, then the output DOR retains the XFA layout, else the conversion service uses an out-of-the-box template to generate DOR for other XFA-based forms.
- When an XFA form is submitted, submit data of the form is saved as an XML element or an attribute. For example,
<Amount currency="USD"> 10.00 </Amount>. The currency is saved as an attribute and currency amount, 10.00 is saved as an element. Submit data of an adaptive form does not have attributes, it has only elements. So, when an XFA-based form is converted to adaptive form, the adaptive form submit data contains an element for each such attribute. For example,
code language-css { "Type": "Principal", "Amount": "10.00", "currency": "USD" } -
Tap Create. The cloud configuration is created. Your AEM Forms instance is ready to start converting legacy forms to adaptive forms.