This document provides instructions for installing and configuring AEM Forms Workbench. The installation program also installs Forms Designer.
This document is intended for administrators or developers who are responsible for installing, configuring, administering, or deploying Workbench. Also included is information to configure your system to support your upgraded AEM Forms processes. The information provided is based on the assumption that anyone reading this document is familiar with Microsoft® Windows® operating system.
The resources in this table can help you learn more about and get started using AEM Forms.
For information about
Procedural information for Workbench
General information about AEM Forms and how it integrates with other Adobe products
All the documentation available for AEM Forms
Patch updates, technical notes, and additional information on this product version
Contact Adobe Enterprise Support
The Flex Workspace is deprecated for AEM Forms. It is available for the AEM Forms release.
Workbench is an integrated development environment (IDE) that developers and form authors use to create automated business processes and forms. It is also used to manage the resources and services that the processes and forms use.
The following illustration depicts the Workbench installation including:
The AEM Forms Server requires a separate installation program. For more information, see the AEM Forms on JEE installation documentation.
This section outlines the hardware and software requirements and supported platforms.
The following requirements are recommended as the minimum:
Disk space for installation:
If all these locations reside on a single drive, there must be 1.5 GB of space available during installation. The files copied to the temporary directories are deleted when installation is complete.
You must have Administrative privileges to install Workbench. If you are installing using a non-administrator account, the installer prompts you for the credentials for an appropriate account.
See the complete list of supported platforms for Workbench at AEM Forms Supported Platforms.
By default, the Workbench installation includes a corresponding English-only version of Designer. If the Workbench installation application detects an existing version of Designer on your computer, the installation may terminate, and you are required to remove the current version of Designer before you can continue.
The table below has a complete list of possible Designer installation scenarios that you may encounter, and any actions you must take, when installing Workbench.
Version of Designer currently installed
Acrobat Pro or Acrobat Pro Extended (includes Designer)
This chapter describes how to install Workbench.
Before you install Workbench, you must ensure that your environment includes the software and hardware required to run it (See section: Before You Install).
To install and run Workbench:
Do one of these tasks:
The Workbench installer only runs from a local drive. It cannot be run from a remote site.
If you encounter an error “Could not create the Java™ Virtual Machine”, then create an environment variable named _JAVA_OPTIONS with value -Xmx512M and run the installer.
On the Introduction screen, click Next.
Read the Product License Agreement, select I accept the terms of the License Agreement, and then click Next.
(Optional) Select Install Adobe Designer if you require this tool to create and modify forms.
You can continue to use Designer installed with Acrobat 10 by leaving this option deselected.
Accept the default directory as listed or click Choose and navigate to the directory where you want to install Workbench, and then click Next.
The installation directory path should not contain # (pound) and $ (dollar) characters.
Review the preinstallation summary and click Install. The installation program displays the progress of the installation.
Review the installation summary. Select Start AEM Forms Workbench to launch Workbench and click Next.
Review the Release Notes and click Done.
The following items are now installed on your computer:
AEM Forms on JEE processes can be upgraded to AEM Forms applications using the Upgrade Wizard. See Upgrading legacy artifacts documentation in Workbench Help for more information.
To use Workbench, you must have an instance of AEM Forms running, typically on a separate computer. You must have a user name and password to log on to AEM Forms, and details about the location of the server.
If you configured AEM Forms to use the EMC Documentum® or IBM® FileNet repository provider and you want to log in to a repository other than the repository that is configured as the default in AEM forms administration console, provide the user name as username@Repository.
By default, Workbench times out after two hours, regardless of activity or inactivity. To edit the time-out setting, see “Configuring User Management > Configure advanced system attributes” in the administration console Help.
To connect Workbench to an AEM Forms Server over HTTPS, you must ensure that the certificate authority (CA) that issued the public key will be recognized as being trusted by Workbench. If the certificate is not recognized as coming from a trusted source, you must update the cacert file in the [Workbench_HOME]/workbench/jre/lib/security directory.
[Workbench_HOME] represents the directory where you installed Workbench. The default location is C:\Program Files (x86)\Adobe Experience Manager forms Workbench.
Ensure that you connect to HTTPS by using the name that is specified in the certificate. This name is typically the fully qualified host name.
To update the cacert file:
Ensure that you have a copy of the Secure Sockets Layer (SSL) certificate. Either contact the administrator who configured the SSL server or export the certificate by using a web browser.
To export the certificate, open a web browser and log in to administration console, install the certificate in the browser, then export the certificate from the browser to a temporary storage location (or directly to the [Workbench_HOME]/workbench/jre/lib/security directory).
Copy the certificate to the [Workbench_HOME]/workbench/jre/lib/security directory.
Open a command prompt window, navigate to [Workbench_HOME]/workbench/jre/bin, and then type the following command:
keytool -import -storepass changeit -file [Workbench_HOME]\workbench\jre\lib\security\ssl_cert_for_certname.cer -keystore [Workbench_HOME]\workbench\jre\lib\security\cacerts -alias example
changeitis the default password to the cacerts keystore.
When prompted to trust the certificate, type Yes and hit the Enter key. The keytool proceeds to import the cacerts file into the [Workbench_HOME]/workbench/jre/lib/security directory.
Close and restart Workbench to apply changes.
The following aspects of cache operation should be considered if your application generates unique templates on the fly by automatically updating XFA content. In effect, each transaction uses a new, unique template.
When forms generator or output searches for, or updates, entries in the cache for a specific form template, it uses several key values to locate the specific cache entry that will be accessed.
Template file name: The location and filename of the template used as the primary unique identifier of the cached form.
Timestamp: The template file contains a timestamp used to determine the last update time of the form.
Template UUID: Designer inserts in each template a unique identifier (UUID) for the form and its version. Each time the form is updated, the embedded UUID is updated. For example, an XDP template might show the following content:
<?xml version="1.0" encoding="UTF-8"?>
<?xfa generator="AdobeAEM formsDesignerES_V8.2" APIVersion="2.6.7185.0"?><xdp:xdp xmlns:xdp=https://ns.adobe.com/xdp/ timeStamp="2008-07-29T21:22:12Z" uuid="823e538f-ff6c-4961-b759-f7626978a223"><template xmlns="https://www.xfa.org/schema/xfa-template/2.6/">
Render options: Within the rendered form cache, the cache contents are stored separately for each set of unique render options.
The Forms service receives templates by reference to filename or repository location, or by value as an XML object in memory.
To prevent the cache from growing endlessly, consider the following factors for rendering dynamically generated templates using the new AEM Forms APIs, those being renderHTMLForm2, and renderPDFForm2.
When using the new APIs, the template is passed as a document object, which is handled in the Forms service based on whether it is passivated or not.
For passivated documents in which the UUID and content root serve as the cache key, consider the following aspects:
For non-passivated documents in which the filename and content root serve as the cache key, consider the following aspect:
Use the Add or Remove Programs function in the Control Panel to start the Uninstaller. The Workbench and Designer applications have separate uninstall programs.
Using the XDC Editor, network printer administrators can create and modify XML Forms Architecture Device Configuration (XDC) files. XDC files describe the capabilities of printers, such as the printer language or the correlation between paper size and tray location.
Before your network printer administrator uses the XDC Editor, relocate the sample XDC files and see Creating device profiles using XDC Editor.
To obtain the sample XDC files:
To obtain the XDC Editor Help: