Managing Services

AEM forms modules (for example, Forms, Rights Management, Output) operate as services. At times, you may need to stop or start the services for these AEM forms modules. For example, you must stop and then restart a AEM forms service after you change a setting for the service.

1. In administration console click Services > Applications and Services > Service Management.

2. On the Service Management page, select the check box beside the service to stop or start and click Stop or Start.

A complete implementation of AEM forms includes an application server and database services:

• [application server] for AEM forms

• [database] for AEM forms

On Windows, these services are accessible through the Administrative Tools > Services panel. For example, if you installed AEM forms on JBoss by using the turnkey method, the following services are available on your system:

• JBoss for Adobe Experience Manager forms

• MySQL for Adobe Experience Manager forms

Start or stop these services by selecting them from the list on the Services panel and then clicking the appropriate action button on the panel.

On UNIX® or Linux, enter the following text from a command line, where [service name] is the name of the service you are verifying:

    ps -A | grep [service name]

Workbench provides the ability to record process instances as they execute at runtime and then play them back to observe the behavior of the process. (See Workbench Help .) To conserve space on the forms server's file system, you can limit the amount of process recording data that is stored. You can configure the following properties of the Audit Workflow Service service ( AuditWorkflowService ):

maxNumberOfRecordingInstances:

The maximum number of recordings that are stored. When the maximum number is stored, the oldest recording is removed from the file system when a new recording is created. This property is useful if you tend to create many recordings and you want to remove old recordings automatically. The default value is 50.

MaxNumberOfRecordingEntries:

The maximum number of data entries that can be stored for each recording. Data entries are information about operations in the process. Several entries are stored for each execution of an operation, such as whether the operation started, whether the operation completed, and whether the route that leads to the operation is complete. This property is useful when processes can include many operation executions, for example, when an endless loop is encountered. The default value is 50.

The barcoded forms service (BarcodedFormsService) extracts barcode data from scanned images. The service accepts a barcoded form (TIFF or PDF) as input and extracts the machine representation of the data encoded by the barcode.

The following settings are available for the barcoded forms service. For details on how to configure these settings, see Configure service settings .

Read Left:

When selected, barcode images are scanned horizontally from right to left.

Read Right:

When selected, barcode images are scanned horizontally from left to right.

Read Up:

When selected, barcode images are scanned vertically from bottom to top.

Read Down:

When selected, barcode images are scanned vertically from top to bottom.

Note: By default, all of the options are selected. Deselect an option only if you are certain that no barcodes appear that way on your forms.

The Central Migration Bridge service ( CentralMigrationBridge ) invokes a subset of Adobe Central Pro Output Server (Central) functionality, which includes the JFMERGE, JFTRANS, and XMLIMPORT commands. Central Migration Bridge service operations allow you to reuse the following Central assets in AEM forms:

• template design (*.ifd)

• output templates (*.mdf)

• data files (*.dat files)

• preamble files (*.pre files)

• data definition files (*.tdf)

The following setting is available for the Central Migration Bridge service. For details on how to configure these settings, see Configure service settings .

Central Install Directory:

The directory where Adobe Central 5.7 is installed.

The Content Repository Connector for EMC Documentum service ( EMCDocumentumContentRepositoryConnector ) lets you create processes that interact with content that is stored in a Documentum repository.

The following setting is available for the Content Repository Connector for EMC Documentum service. For details on how to configure these settings, see Configure service settings .

Asset Link Object Default Path:

The default portion of the path in the Documentum repository for storing the Asset Link object. The actual path consists of the default path and the location of the form template in the AEM forms repository.

For example, if the default path is set to /LiveCycleES/ConnectorforEMCDocumentum/AssetLinkObjects , and the form template is stored in a folder /Docbase/forms/ , the Asset Link object is stored at the following location:

/LiveCycleES/ConnectorforEMCDocumentum/AssetLinkObjects/Docbase/forms/

The default value of this setting is /LiveCycleES/ConnectorforEMCDocumentum/AssetLinkObjects .

The Content Repository Connector for IBM FileNet lets you create processes that interact with content that is stored in an IBM FileNet repository.

The following setting is available for the Content Repository Connector for IBM FileNet service. For details on how to configure these settings, see Configure service settings .

Asset Link Object Default Path:

The default portion of the path in the IBM FileNet repository for storing the Asset Link object. The actual path consists of the default path and the location of the form template in the AEM forms repository.

For example, if the default path is set to /LiveCycleES/ConnectorforIBMFileNet/AssetLinkObjects , and the form template is stored in a folder /Docbase/forms/ , the Asset Link object is stored at the following location:

/LiveCycleES/ConnectorforIBMFileNet/AssetLinkObjects/Docbase/forms/

The default value of this setting is /LiveCycleES/ConnectorforIBMFileNet/AssetLinkObjects .

The Convert PDF service ( ConvertPdfService ) converts PDF documents to PostScript and to a number of image formats (JPEG, JPEG 2000, PNG, and TIFF). Converting a PDF document to PostScript is useful for unattended server-based printing on any PostScript printer. Converting a PDF document to a multipage TIFF file is practical when archiving documents in content management systems that do no support PDF documents.

The following settings are available for the Convert PDF service. For details on how to configure these settings, see Configure service settings .

Transaction Type:

Specifies how a transaction context should be propagated to an operation.

Required:

Supports a transaction context if one exists; otherwise, a new transaction context is created. This is the default value.

Requires New:

Always creates a new transaction context. If an active transaction context exists, it is suspended.

Transaction Time Out (in sec):

The number of seconds that the underlying transaction provider should wait before rolling back a transaction that is wrapping this operation. This value will be ignored if an existing transaction context is propagated. The default value is 180 .

Threshold Resolution For Smoothing (in dpi):

The image resolution below which smoothing (or anti-aliasing) is applied to text, line art and images, if you have selected the “Apply smoothing to” options for those elements.

Apply smoothing to text:

Controls anti-aliasing of text. To disable smoothing of text and make text sharper and easier to read with a screen magnifier, clear this checkbox.

Apply smoothing to LineArt:

Applies smoothing to remove abrupt angles in lines.

Apply smoothing to images:

Applies smoothing to minimize abrupt changes in images.

The Distiller service ( DistillerService ) converts PostScript, Encapsulated PostScript (EPS), and PRN files to PDF files over a network.

The following settings are available for the Distiller service. For details on how to configure these settings, see Configure service settings .

Adobe PDF Settings:

The following preconfigured settings are applied to the generated PDF:

• High quality print

• Oversized pages

• PDFA1b 2005 CMYK

• PDFA1b 2005 RGB

• PDFX1a 2001

• PDFX3 2002

• Press quality

• Smallest file size

• Standard

New settings can be created through the PDF Generator user interface.

Security Settings:

Preconfigured security settings that are applied to generated PDF documents. The default value is No Security. You must create security settings using PDF Generator and then enter the setting here.

Pool Size:

The initial size of the pool. When the Distiller service is deployed, this number is used to determine the number of service implementation instances that are created and allocated to the free pool awaiting invocation requests. The service container can then respond immediately to invocation requests without having to first initialize a service instance.

The Document Management service ( DocumentManagementService ) enables processes to use the content management functionality provided by Content Services (Deprecated). Document Management operations provide basic tasks that are required to maintain spaces and content in the content management system. Examples of such tasks are copy, delete, move, retrieve, and store content, create spaces and associations, and get and set content attributes.

The following settings are available for the Document Management service. For details on how to configure these settings, see Configure service settings .

Store Scheme:

The scheme of the store in which content is located. The default value is workspace.

HTTP Port:

The port used to access Content Services (Deprecated). The default value is 8080.

Email is commonly used to distribute content or provide status information as part of an automated process. The Email service ( EmailService ) enables processes to receive email messages from a POP3 or IMAP server, and send email messages to an SMTP server.

For example, a process uses the Email service to send an email message with a PDF form attachment. The Email service connects to an SMTP server to send the email message with the attachment. The PDF form is designed to let the recipient click Submit after completing the form. The action causes the form to be returned as an attachment to the designated email server. The Email service retrieves the returned email message and stores the completed form in a process data form variable.

The following settings are available for the Email service. For details on how to configure these settings, see Configure service settings .

SMTP Host:

The IP address or URL of the SMTP server to use for sending email.

SMTP Port Number:

The port used to connect to the SMTP server.

SMTP Authenticate:

Select if user authentication is required to connect to the SMTP server.

SMTP User:

The user name of the user account to use to log in to the SMTP server.

SMTP Password:

The password that is associated with the SMTP user account.

SMTP Transport Security:

The security protocol to use for connecting to the SMTP server:

• Select None if no protocol is used (data is sent in clear text)

• Select SSL if Secure Sockets Layer protocol is used.

• Select TLS if Transport Layer Security is used.

POP3/IMAP Host:

The IP address or URL of the POP3 or IMAP server to use for sending email.

POP3/IMAP Username:

The user name of the user account to use to log into the POP3 or IMAP server.

POP3/IMAP Password:

The password that is associated with the POP3 or IMAP user account.

POP3/IMAP Port Number:

The port used to connect to the POP3 or IMAP server.

POP3/IMAP:

The protocol to use for sending and receiving email.

Receive Transport Security:

The security protocol to use for connecting to the SMTP server:

• Select None if no protocol is used (data is sent in clear text).

• Select SSL if Secure Sockets Layer protocol is used.

• Select TLS if Transport Layer Security is used.

The Encryption service ( EncryptionService ) lets you encrypt and decrypt documents. When a document is encrypted, its contents become unreadable. An authorized user can decrypt the document to obtain access to the contents. If a PDF document is encrypted with a password, the user must specify the open password before the document can be viewed in Adobe Reader or Adobe Acrobat. Likewise, if a PDF document is encrypted with a certificate, the user must decrypt the PDF document with the public key that corresponds to the certificate (private key) that was used to encrypt the PDF document.

The following settings are available for the Encryption service. For details on how to configure these settings, see Configure service settings .

Default LDAP Server to connect to:

Host name of the LDAP server used to retrieve certificates for document encryption.

Default LDAP Port to connect to:

Port number of the LDAP server.

Default LDAP User Name:

If the LDAP server requires authentication, specify the user name to be used to connect to the LDAP server.

Default LDAP Password:

If the LDAP server requires authentication, specify the password that corresponds with the user name to be used to connect to the LDAP server.

Note: Use simple authentication (user name and password) only when the connection is protected via SSL (using LDAPS).

The FTP service ( FTP ) enables processes to interact with an FTP server. FTP service operations can retrieve files from the FTP server, put files on the FTP server, and delete files from the FTP server. For example, documents such as reports generated from a process may be stored on an FTP server for distribution. Or an external system may generate some files based on previous steps in a process. In a subsequent step in the process, the files may be transferred to a remote location.

The following settings are available for the FTP service. For details on how to configure these settings, see Configure service settings .

Default host:

The IP address or URL of the FTP server.

Default port:

The port used to connect to the FTP server. The default value is 21.

Default username:

The name of the user account that you can use to access the FTP server. The user account must have sufficient privileges to perform the FTP operations that this service requires.

Default password:

The password to use with the specified user name for authenticating with the FTP server.

The Generate PDF service ( GeneratePDFService ) converts files in various native formats to PDF documents, and converts PDF documents to a number of file formats.

The following settings are available for the Generate PDF service. For details on how to configure these settings, see Configure service settings .

Adobe PDF Settings:

The name of the pre-configured Adobe PDF settings to apply to a conversion job, if these settings are not specified as a part of the API invocation parameters. The Adobe PDF settings are configured in administration console, by clicking Services > PDF Generator> Adobe PDF Settings. These settings are applicable only to the PDFMaker based conversions.

Security Settings:

The name of the pre-configured security settings to apply to a conversion job, if these settings are not specified as a part of the API invocation parameters. The security settings are configured in administration console, by clicking Services > PDF Generator> Security Settings.

File type Settings:

The name of the pre-configured File Type Setting to apply to a conversion job, if these settings are not specified as a part of the API invocation parameters. The file type settings are configured in administration console, by clicking Services > PDF Generator> File Type Settings.

Use Acrobat WebCapture (Windows Only):

When this setting is true , the Generate PDF service uses Acrobat X Pro for all HTML to PDF conversions. This can improve the quality of the PDF files produced from HTML, though performance may be slightly lower. The default value is false .

Use Acrobat Image Conversion (Windows Only):

When this setting is true , the Generate PDF service uses Acrobat X Pro for all Image to PDF conversions. This setting is useful only if the default pure Java conversion mechanism is unable to convert a significant proportion of the input images successfully. The default value is false .

Enable Acrobat-based AutoCAD Conversions (Windows Only):

When this setting is true, the Generate PDF service uses Acrobat X Pro for all DWG to PDF conversions. This setting is useful only if AutoCAD is not installed on the server or the AutoCAD conversion mechanism is unable to convert files successfully.

Regular Expressions For Finding Out Prohibited Special Characters In User Name (Windows Only):

Specifies characters that interfere with the Export PDF and Optimize PDF operations when the characters appear in a user’s name.

ImageToPDF Pool Size:

The pool size of the default (pure Java) Image-to-PDF converter in the Generate PDF service. This setting controls the maximum simultaneous Image-to-PDF conversions that the Generate PDF service can perform. The default value of this setting (recommended for single-processor systems) is 3 , which you can increase on multi-processor systems.

HTML to PDF Pool Size:

The pool size of the HTML-to-PDF converter in the Generate PDF service. This setting controls the maximum simultaneous HTML-to-PDF conversions that the Generate PDF service can perform. The default value of this setting (recommended for single-processor systems) is 3 , which you can increase on multi-processor systems.

OCR Pool Size:

The pool size of the PaperCaptureService that PDF Generator uses for OCR. The default value of this setting (recommended for single-processor systems) is 3 , which you can increase on multi-processor systems. This setting is valid only on Windows systems.

Fallback Font Family For HTML To PDF Conversions:

The name of the font family to use in PDF documents when the font used in the original HTML is not available to the AEM forms server. Specify a font family if you expect to convert HTML pages that use unavailable fonts. For example, pages authored in regional languages could use unavailable fonts.

Retry Logic for Native Conversions

Governs PDF generation retries if the first attempt at conversion has failed:

No retry

Do not retry the PDF conversion if the first conversion attempt has failed

Retry

Retry PDF conversion regardless of whether the timeout threshold has been reached. The default timeout duration for the first attempt is 270s.

Retry if time permits

Retry PDF conversion if the time consumed for the first conversion attempt was less than the specified timeout duration. For example, if the timeout duration is 270s and the first attempt consumed 200s, PDF Generator will reattempt the conversion. If the first attempt itself consumed 270s, conversion will not be retried.

When you create a Guide, some resources, such as the Guide definition, are embedded in the Guide. Resources can also exist as references to application assets stored locally or on the AEM forms server. The Guide does not contain data, and the values for the submit location and inputs are not suitable for all external environments.

In most cases, the default Guides render services is sufficient to prepare a Guide for use in Workspace or other external environments. (In the Services view, in Workbench, the default service is Guides (system)/Processes/Render Guide - 1.0.) The Guide Utilities service ( GuidesUtility ) allows you to create a customized process for rendering a Guide, if necessary.

The Guide Utilities operations allow you to add the following Guide rendering tasks to a process:

• Determine whether data is available to populate the Guide with

• Embed the Guide data or convert it to a link

• Convert referenced content to URLs that are externally accessible

• Substitute values in an HTML document or other wrapper, or convert them to URLs that are externally accessible

• Set the submit location

• Specify input values

• Create a parameter to represent referenced content

• If variations are available, set a variation

The default values for the Guide Utilities service support most use cases. However, if necessary, you can change the following values.

publicPaths:

This option has been deprecated. Do not use this option with AEM forms.

pathInfoExpiryInSeconds:

The interval after which a request for path information from a client expires. Default is 1 .

collateralExpiryInSeconds:

The interval after which a request for collateral from a client expires. Default is 315576000 .

mismatchExpiryInSeconds:

The interval after which a request for collateral from a client expires, when the eTag (entity tag) does not match. (An eTag is an HTTP response header.) Default is 1 .

guideContext:

The context root of the Guides web application. Matches the value set using the Guides web application. Default is /Guides/ .

secureRandomAlgorithm:

The algorithm to use when generating keys and identifiers. This value is passed to the getInstance method of the SecureRandom Java class. Default is SHA1PRNG .

idBytes:

The number of random bytes to use for a key identifier. Default is 6 .

macAlgorithm:

The MAC (message authentication code) algorithm to use for collateral URL verification. This method is passed to the getInstance method of the Mac class. Default is HmacSHA1 .

macRefreshIntervalInMinutes:

The amount of time a key is active. When a key has been active for this interval, a new key is generated. The new key becomes the active key. The previously active key is kept for 10% of the refresh interval. This behavior allows URLs that are generated by using the old key to continue to work across the key switch. Default is 144000 .

macOverlapIntervalInMinutes:

Length of time that the previous key will remain valid after a new one is generated. The default is 1440 minutes (1 day).

macKeySeed:

A seed value for generating the secure URL. When this is option, the key is never refreshed. Setting the same seed on different servers will result in those servers generating secure URLs that are compatible. This may be useful if multiple forms servers are in use behind a load balancer. Enter a random sequence of characters and numbers as the seed.

The JDBC service ( JdbcService ) enables processes to interact with databases.

The following setting is available for the JDBC service. For details on how to configure these settings, see Configure service settings .

datasourceName:

A string value that represents the JNDI name of the data source to use to connect to the database server. The data source must be defined on the application server that hosts the forms server. The default value is the JNDI name of the data source for the AEM forms database.

The JMS service ( JMS ) enables interaction with Java Messaging System (JMS) providers that implement both point-to-point messaging and publish/subscribe messaging.

Configure the JMS service with default properties so that the service operations can connect and interact with a JMS provider and an associated JNDI service. The values of the service properties are set to default values based on the JBoss Application Server. Change these values if you are using a different application server to host AEM forms.

The following settings are available for the JMS service. For details on how to configure these settings, see Configure service settings .

Provider URL:

The URL of the JNDI service provider. The default value is based on the JBoss Application Server. The following URL are default values for the application servers that AEM forms supports:

JBoss:

< server name >:1099

WebLogic:

< server name >:7001

WebSphere:

< server name >:2809

JNDI Username:

The user name of the account to use for authenticating with the JNDI service provider that is used for looking up queue and topic names. The default value is guest .

JNDI Password:

The password that is associated with the user name specified for JNDI Username. The default value is guest .

Initial Context Factory:

The Java class to use as the initial context factory. The JMS service uses this class to create an initial context, which is the starting point for resolving names of topics and queues. The default value is the initial context factory for the JMS service on JBoss. The following classes are the initial context factories for the application servers that AEM forms supports:

JBoss:

org.jnp.interfaces.NamingContextFactory

WebLogic:

weblogic.jndi.WLInitialContextFactory

WebSphere:

com.ibm.websphere.naming.WsnInitialContextFactory

Connection Username:

The password that is associated with the user name specified for Connection Username. The default value is guest .

Connection Password:

The password that is associated with the user name specified for Connection Username. The default value is guest .

Other Properties:

Property name and value pairs that you can pass to the JNDI service provider. These properties depend on the implementation and configuration of the provider that you are using.

The property name and value pairs are separated by semi-colons (;). For example, the following text shows the value that would be specified for two properties named name1 and name2, with values value1 and value2, respectively:

name1=value1;name2=value2

The LDAP service ( LDAPService ) provides operations for querying LDAP directories. LDAP directories are generally used to store information about the people, groups, and services in an organization.

The following settings are available for the LDAP service. For details on how to configure these settings, see Configure service settings .

Initial Context Factory:

The Java class to use as the context factory. This class is used to create a connection to the LDAP server. The default value is com.sun.jndi.ldap.LdapCtxFactory , which is appropriate for most LDAP servers.

Provider URL:

The URL to use to connect to the LDAP service. The format of the value is ldap:// server name : port

server name is the name of the computer that hosts the LDAP server

port is the communications port that the LDAP service uses. The default value is 389, which is the standard port used for LDAP connections.

User Name:

The user name of the user account to use to log in to the LDAP server. The user account needs to have permission to connect to the server and read the information in the LDAP directory.

Depending on the LDAP server, the user name could be a simple user name such as myname or a DN, such as cn=myname,cn=users,dc=myorg .

Password:

The password that corresponds with the user name provided for the Username setting.

Other Properties:

A string value that represents other properties and their corresponding values that you can provide to the LDAP server. The value is in the following format:

property=value;property=value;...

The Microsoft SharePoint configuration service (MSSharePointConfigService) lets you specify credentials for the AEM forms user that has impersonation permissions. For information about impersonation permissions, see Configuring the Connector for Microsoft SharePoint .

The following settings are available for the Microsoft SharePoint configuration service:

• Username for a user with impersonation permissions

• Password for the above user

The Output service (OutputService) enables you to merge XML form data with a form design created in AEM forms Designer to create a document output stream in one of the following formats:

• A PDF or PDF/A document output stream.

• An Adobe PostScript output stream.

• A Printer Control Language (PCL) output stream.

• A Zebra Programming Language (ZPL) output stream.

The output stream can be sent to a network printer, a local printer, or a disk file. When you use the Output service as part of a process, you can also send the output stream to an email recipient as a file attachment.

The following settings are available for the Output service. For details on how to configure these settings, see Configure service settings .

Transaction Type:

Specifies how a transaction context should be propagated to an operation:

Required:

supports a transaction context if one already exists; otherwise, a new transaction context is created. This is the default value.

Requires New:

Always creates a new transaction context. If an active transaction context exists, it is suspended.

Transaction Time Out (in sec):

The number of seconds that the underlying transaction provider waits before rolling back a transaction that is wrapping this operation. This value is ignored if an existing transaction context is propagated.

When processing large data files or operating on a busy server, it may be necessary to increase the Output service time out. To change the time-out value, ensure that hardware servers have adequate memory and that the memory is available to the Java Application Server heap. The default value is 180 .

The following settings are available for the PDFG Config service ( PDFGConfigService ).

User Job Options Directory:

The path of the file-system folder where the c service writes the job options files that are accessible to Acrobat Pro Extended. The default value is [user.home]/Application Data/Adobe/Adobe PDF/Settings .

PS Startup Directory:

The path of the file-system folder where the startup files required by Adobe Acrobat Distiller are saved. The default value is [user.home]/Application Data/Adobe/Adobe PDF/Distiller/Startup .

PS Startup File:

The name of the startup file required by Adobe Acrobat Distiller. The default value is example.ps .

Server Conversion Timeout:

The maximum job conversion timeout (in seconds) for the Generate PDF service and the Distiller service. This setting limits the maximum conversion timeout that can be specified in the config.xml file and in the administration console pages for PDF Generator. The default value is 270 .

Server Global Timeout:

While performing PDF conversions, a forms server takes into account the timeout limit. Configure the timeout value to resolve the issue.

Job Options Prefix:

A prefix used by the Generate PDF service to prepend a short string to the job options files that it creates temporarily for use by Acrobat Distiller. The default value is pdfg .

Non Unicode Apps:

A comma-separated list of application names that are known to be Unicode-incapable. This list is pre-populated with the names of several applications, support for which is pre-configured in PDF Generator. If you choose to add support for PDF conversions through other third-party applications that are Unicode-incapable, you must add to them to this list. The default value is Autocad,Excel,PowerPoint,Project,Publisher,Visio,Word,WordPerfect .

Server Threadpool Count:

Controls the size of the thread pool that the Generate PDF service uses internally to service HTML-to-PDF conversion requests that involve spidering (converting linked pages accessible from the main page). The default value is 20 .

PDFG Cleanup Scan Seconds:

See the Job Expirations Seconds section for details.

Job Expiration Seconds:

The Generate PDF service deletes input files as soon as they are converted. It stores output files temporarily, for a length of time determined by the PDFG Cleanup Scan Seconds and Job Expiration Seconds settings.

The Job Expiration Seconds setting specifies how old a file or empty folder must be before it is eligible for deletion. The PDFG Cleanup Scan Seconds setting specifies how often a cleanup thread scans the temporary folders for files that can be deleted.

For example, if Job Expiration Seconds is set to 100 and PDFG Cleanup Scan Seconds is set to 200, the cleanup thread runs every 200 seconds and deletes files that are 100 seconds or older.

The default value of PDFG Cleanup Scan Seconds is 43200 (12 hours). The default value of Job Expiration Seconds is 86400 (24 hours).

Default Locale:

Used to override the default locale (country + language) of the server where the Generate PDF service is deployed. If this parameter is unspecified, then the default locale is determined from the operating system on which the service is deployed. This parameter controls the language in which the error messages are returned to the APIs.

The following services extend Data Services and expose assemblers that Workspace uses to talk to the server. Do not change the configuration options for these services unless you are instructed to do so by Adobe Support. These services are not intended for direct access:

• ProcessManagementLcdsAttachmentService

• ProcessManagementLcdsPropertyService

• ProcessManagementLcdsTaskService

Most services are configured so that you can access them through (Deprecated for AEM forms) AEM forms Remoting. For information on (Deprecated for AEM forms) AEM forms Remoting, see Programming with AEM forms .

The following settings are available for the Remoting service.

Flex Client Authentication Method:

Determines the type of response that the server sends back to the client when the invoked service is security enabled, the operation invoked does not support anonymous invocations, and the client passes in either no or invalid credentials. Choose from Custom or Basic. The default value is Basic .

Allow Serialization Of Non-Serializable Classes:

Most AEM forms endpoints allow only Serializable classes to be used for invocation. In older versions, the Remoting endpoint allowed non-Serializable classes to be used for invocation from Flex-based clients. To prevent a security vulnerability described in APS11-15 , this was changed. If you want to continue to use non-Serializable classes with the Flex Remoting endpoint, select this checkbox.

The Repository service ( RepositoryService ) provides resource storage and management services to AEM forms. When developers create an application, they can deploy the assets in the repository instead of on a file system. The assets can include any type of collateral, including XML forms, PDF forms (including Acrobat forms), form fragments, images, profiles, policies, SWF files, DDX files, XML schemas, WSDL files, and test data.

You can use the default repository included with AEM forms, or use a third-party repository (EMC Documentum Content Server, IBM FileNet Content Manager, or IBM Content Manager).

Repository Provider service is a service delegate that acts as the interface to a provider service. This allows you to connect to a common API and not have to be aware of which provider service is implementing the storage capabilities. Repository Provider service provides database storage for the Repository service resources.

The following setting is available for the Repository service. For details on how to configure these settings, see Configure service settings .

Provider Service:

The name of the service that is used as the storage provider. The default value is RepositoryProviderService .

The Signature service ( SignatureService ) enables your organization to protect the security and privacy of Adobe PDF documents that it distributes and receives. This service uses digital signatures and certification to ensure that documents are not altered. Altering a document breaks its signature. Because security features are applied to the document itself, the document remains secure and controlled for its entire life cycle; beyond the firewall, when it is downloaded offline, and when it is submitted back to your organization.

The following settings are available for the Signature service. For details on how to configure these settings, see Configure service settings .

Name Of The Remote HSM SPI Service:

This option is for use when the HSM is installed on a remote computer. Specify this option when AEM forms is installed on a 64-bit Windows and you are using HSM devices for signing.

URL Of The Remote HSM Web Service:

Specify this option when AEM forms is installed on 64-bit Windows and you are using HSM devices for signing.

Certification To Include Form Load Changes:

When this option is selected, the XFA Form State is certified in addition to the XFA template. Note that enabling this option may have a negative impact on performance. The default value is true.

Execute Document JavaScript scripts:

Specifies whether to execute Document JavaScript scripts during signature operations. The default value is false.

Process documents with Acrobat 9 compatibility:

Specifies whether to enable Acrobat 9 compatibility. For example, when this option is selected, Visible Certification in Dynamic PDFs is enabled. The default value is false.

Embed Revocation Info While Signing:

Specifies whether revocation information is embedded while signing the PDF document. The default value is false.

Embed Revocation Info While Certifying:

Specifies whether the revocation information is embedded while certifying the PDF document. The default value is false.

Enforce Embedding of Revocation Info For All Certificates During Signing/Certification:

Specifies whether a signing or certification operation fails if valid revocation information for all certificates is not embedded. Note that if a certificate does not contain any CRL or OCSP information, it is considered valid, even if no revocation information is retrieved. The default value is false.

Revocation Check Order:

Specifies the order of revocation checking when checking is possible through both Certificate Revocation List (CRL) and Online Certificate Status Protocol (OCSP) mechanisms. The default value is OCSPFirst .

Maximum Size Of Revocation Archival Info:

The maximum size of the revocation archival info in kilobytes. AEM forms attempts to store as much revocation information as possible without exceeding the limit. The default value is 10 KB.

Support Signatures Created From PreRelease Builds Of Adobe Products:

When this option is selected, signature created using pre-release version of Adobe products will validate correctly. The default value is false.

Verification Time Option:

Specifies the time of verification of a signer's certificate. The default value is Secure Time Else Current Time .

Use Revocation Information Archived in Signature during Validation:

Specifies whether the revocation information that is archived with the signature is used for revocation checking. The default value is true.

Use Validation Information Stored In The Document For Validation Of Signatures:

When this option is selected, validation information (including revocation and timestamp information) embedded in the doument is used to validate signatures. The default value is true.

Maximum Nested Verification Sessions Allowed:

The maximum number of nested verification sessions that are allowed. AEM forms uses this value to prevent an infinite loop when verifying the OCSP or CRL signer certificates when the OCSP or CRL certificate is not set up correctly. The default value is 10 .

Maximum Clock Skew for Verification:

The maximum time, in minutes, that the signing time can be after the validation time. If the clock skew is greater than this value, the signature will not be valid. The default value is 65 minutes.

Certificate Lifetime Cache:

The lifetime of a certificate, retrieved online or through other means, in the cache. The default value is 1 day.

The Watched Folder service ( WatchedFolder ) configures attributes that are common for all watched folder endpoints. It also provides default values for watched folder endpoints. (See Configuring watched folder endpoints .) It is not invoked by external client applications or used in processes created in Workbench.

The following settings are available for the Watched Folder service.

Cron Expression:

The cron expression as used by quartz to schedule the polling of the input directory.

Repeat Count:

The number of times the input directory is polled. The default repeat count to use if this value is not specified in the endpoint configuration. A value of -1 indicates indefinite scanning of the directory. The default value is -1 .

Repeat Interval:

The default number if seconds between each poll. This value is used as the repeat interval unless a different value is specified in the watched folder endpoint configuration. The default value is 5 . See the description of the Batch Size setting for additional information.

Asynchronous:

Identifies the invocation type as asynchronous or synchronous. Transient and synchronous processes can only be invoked synchronously. The default value is asynchronous .

Wait Time:

The default value for time, in seconds, after which the files are retrieved from the input folders. If the file or folder is older than the time specified in the wait time, it is picked up for processing. The default value is 0 .

Batch Size:

The default value for the number of files or folder that are processed per scan. The default value is 2 .

The Repeat Interval and Batch Size settings determine how many files Watched Folder picks up in every scan. Watched Folder uses a Quartz thread pool to scan the input folder. The thread pool is shared with other services. If the scan interval is small, the threads scan the input folder often. If files are dropped frequently into the watched folder, keep the scan interval small. If files are dropped infrequently, use a larger scan interval so that the other services can use the threads.

If there is a large volume of files being dropped, make the batch size large. For example, if the service invoked by the watched folder endpoint can process 700 files per minute, and users drop files into the input folder at the same rate, then setting the Batch Size to 350 and the Repeat Interval to 30 seconds will help Watched Folder performance without incurring the cost of scanning the watched folder too often.

When files are dropped into the watched folder, it lists the files in the input, which can reduce performance if scanning is happening every second. Increasing the scan interval can improve performance. If the volume of files being dropped is small, adjust the Batch Size and Repeat Interval accordingly. For example, if 10 files are dropped every second, try setting the Repeat Interval to 1 second and the Batch Size to 10.

In a cluster configuration, the batch size for a watched folder endpoint does not scale to multiple cluster nodes. For example, if the batch size is set to 2 for a two-node cluster and the Throttle option is selected, the nodes process files collectively in batches of two instead of each node processing two files at a time.

Overwrite Duplicate Filenames:

A Boolean string that specifies whether the watched folder overwrites duplicate result filenames and whether preserved documents of the same name should be overwritten.

Preserve Folder:

The default value for the preserve folder. This folder is used to copy the source files into in case of successful processing of the input. This value can be an empty, relative, or absolute path with a file pattern as described for the Result Folder setting.

Failure Folder:

The name of the folder where the failure files are copied. This value can be an empty, relative, or absolute path with a file pattern as described for the Result Folder setting.

Result Folder:

The default name for the result folder. This folder is used to copy the results files into. This value can be an empty, relative, or absolute path with the following file pattern.

• %F = filename prefix

• %E = filename extension

• %Y = year (full)

• %y = year (last two digits)

• %M = month

• %D = day of month

• %d = day of year

• %H = hour (24-hour clock)

• %h = hour (12-hour clock)

• %m = minute

• %s = second

• %l = millisecond

• %R = random number (from 0 through 9)

• %P = process or job id

For example, if it is 8 PM on July 17, 2009 and you specify C:/Test/WF0/failure/%Y/%M/%D/%H/ , the result folder is C:/Test/WF0/failure/2009/07/17/20 .

If the path is not absolute but relative, the folder is created inside the watched folder. For more information about file patterns, see About file patterns .

Note: The smaller the size of the result folders, the better Watched Folder performance will be. For example, if the estimated load for the watched folder is 1000 files every hour, try a pattern like result/%Y%M%D%H so that a new subfolder is created every hour. If the load is smaller (for example, 1000 files per day), you could use a pattern like result/%Y%M%D .

Stage Folder:

The default name for the stage folder inside the watched folder.

Input Folder:

The default name for the input folder inside the watched folder.

Preserve On Failure:

If true, original files are preserved in the failure folder on failure.

Throttle:

When this option is selected, it limits the number of watched folder jobs that AEM forms processes at any given time. The Batch Size value determines the maximum number of jobs (See About throttling ).

The Web Service service ( WebService ) enables processes to invoke web service operations.

The Web Service service enables processes to invoke web service operations. For example, an organization may want to integrate a process to store and retrieve information such as contact and account details by invoking a service provider’s exposed web services. The Web Service service invokes a specified web service and passes through values for each of its parameters. It then saves the return values from the operation into a designated variable within a process.

The Web Service service interacts with web services by sending and receiving SOAP messages. The service also supports sending MIME, MTOM, and SwaRef attachments with SOAP messages by using the WS-Attachment protocol. The Web Service service interactions are compatible with SAP systems and .NET web services.

The following settings are available for the Web Service service. For details on how to configure these settings, see Configure service settings .

Key Store:

The full path of the keystore file that contains the private key to use for authentication. The forms server must be able to access the file.

Key Store Password:

The password for the keystore file.

Key Store Type:

The type of the keystore. Provide no value to use the default keystore type that is configured for the JVM that runs the forms server. Otherwise, provide one of the following values:

• jks

• pkcs12

• cms

• jceks

Trust Store:

The full path of the trust store file that contains the public key of the web service server.

Trust Store Password:

The password for the truststore file.

Trust Store Type:

The type of the truststore. Provide no value to use the default keystore type that is configured for the JVM that runs the forms server. Otherwise, provide one of the following values:

• jks

• pkcs12

• cms

• jceks

The XSLT Transformation service ( XSLTService ) enables processes to apply Extensible Stylesheet Language Transformations (XSLT) on XML documents.

The following setting is available for the XSLT Transformation service. For details on how to configure these settings, see Configure service settings .

Factory Name:

The fully qualified name of the Java class to use for performing XSLT transformations. If no value is specified, the default factory configured in the Java Virtual Machine that runs the forms server is used.

forms server enables you to configure security settings for each service, which allows you to configure fine-grained access control on a service-by-service level.

Default security profiles are installed, which can then be configured to meet your system needs. Each security profile has an associated domain and is created at either the user level or the group level.

Each service can take advantage of the pooling capabilities to handle incoming invocation requests. Using a service pool ensures that service instances are invoked by a single thread at a time and are reused across invocation requests, which may result in improved performance. You can also use pooling to specify the Maximum Asynchronous Service Instances option, which allows services to limit the number of requests handled in parallel.