Readme File - Adobe LiveCycle Workflow SDK 7.0.2

Developing Custom Applications for LiveCycle Workflow is a new guide that provides the following conceptual and task-based information that you need to create custom applications that interact with LiveCycle Workflow Server and LiveCycle Workflow run-time data:

Describes the components of the LiveCycle Workflow architecture and the run-time environment
Describes the Persistent Object Framework (POF) and how to use it to query LiveCycle Workflow run-time data and retrieve results in Java objects
How to implement code that interacts with process instances, tasks, and user queues
How to implement code that performs administrative tasks such as deploying QPACs and workflows

To access Developing Custom Applications for LiveCycleWorkflow, open the developing_custom_applications.pdf file from the Documentation directory.

Updated QPACs

Several QPACs have been updated to resolve issues that have been discovered since the previous release:

Email With Attachments QPAC

The previous version of the Email With Attachments QPAC did not cause email messages to be deleted on the email server when the Delete After Processing option in the Processing tab was selected. The updated version of the QPAC (version 7.01) in this release deletes messages on the email server according to the settings of the Delete After Processing option.

JMS Queue Receiver, JMS Queue Sender, and JMS Topic Publisher QPACs

With the previous version of the JMS QPACs, if a queue did not require authentication and the user did not provide any user name and password, the QPAC could not connect to the queue. Now if the user does not provide a user name and password, the QPAC assumes anonymous connection and connects anonymously.

All QPACs

With the previous versions of the QPACs, if you started typing in a cell of a JTable and then clicked OK without pressing Enter, two errors occur:

The data you entered in the cell was not saved.
The next time you double-click the same type of QPAC (not necessarily the same instance), the value you were halfway through editing would still be in edit mode.

New Samples

The following new samples are available that demonstrate how to use the LiveCycle Workflow SDK API:

Initiation Forms: This sample retrieves a list of initiation forms that can be used to initiate processes.

Work Items: This sample retrieves a list of work items that are assigned to a specific user.

Process: This sample retrieves a list of processes for a process type.

Process Status: This sample retrieves the status of a specific process.

These samples are located in the Samples/API of the LiveCycle Workflow SDK directory.

Back to Contents

Overview

LiveCycle Workflow SDK includes:

QPACs for integrating LiveCycle Workflow with other Adobe document services
QPACs for integrating with standards based IT systems and technologies
Java API documentation for LiveCycle Workflow
Documentation about developing QPACs
Samples - including QPACs and workflows
Workflow objects for LiveCycle Designer 7.0

Back to Contents

Supported Platforms

The Workflow SDK supports:

All platforms supported by LiveCycle Workflow 7.0
QDE works with Eclipse 3.1 (QDE supports deleting data only)

Back to Contents

Supported Adobe Products

The QPACs associated with LiveCycle Workflow SDK support LiveCycle Workflow 7.0 and can be used with the following Adobe products:

Adobe LiveCycle Forms 7.0
Adobe LiveCycle Form Manager 7.0
Adobe Document Security Server 7.0
Adobe LiveCycle Policy Server 7.01 or 7.02
Adobe LiveCycle Reader Extensions 7.0.1
Adobe LiveCycle Barcoded Forms 7.0

Back to Contents

Digital Signatures FAQ

You can use digital signatures when routing PDFs. The following conditions apply:

PDF: All document services operate with PDF.
PDF+XD: All document services can operate with it, but they can only output PDF (not PDF+XDP). The one exception is the Form Submit QPAC, which you can configure to output XDP.

Back to Contents

Known Issues

QPAC Order of Execution

When multiple document services are applied to a single document, the services must be used in a specific order. If you are automating a process that applies multiple document services to a document, the QPACs that are associated with the document services must be executed in the required order.

Applying a Policy and Adding Usage Rights

To apply a LiveCycle Policy Server policy and add usage rights to an Adobe PDF document, you need to use the following QPACs in the specified order:

ApplyPolicy > Certify > ReaderExtensions

Digitally Signing

Before digitally signing a PDF document, the document must first be certified. Use the following QPACs in the specified order:

Certify > Sign

LiveCycle Forms QPACs

All LiveCycle Forms QPACs must use unencrypted forms as input parameters. For example, to encrypt a form that is generated with LiveCycle Forms, you need to render the form with LiveCycle Forms before the encryption occurs:

SubmitForm > Encrypt

Use Only One Encryption Method At a Time

More than one encryption method cannot be applied to the same document at the same time. For example, if a process needs to password-encrypt a document at the start of a process and later needs to use a policy to encrypt the document, before you apply the policy, you need to remove the password encryption:

EncryptWithPassword > RemoveEncryption > ApplyPolicy

Using String Data As Input or Output

For all document services QPACs, if an input or output data type is string, make sure that the proper string length is specified using LiveCycle Workflow Designer. If you do not set the string length, an XML data error may occur.

Providing Revocation URLs in RevokeLicense QPACs

If you are connecting to LiveCycle Policy Server 7.0.1 with the RevokeLicense QPAC, you must provide a Revocation URL parameter that is non-null. Otherwise, the PDF document cannot be opened.

Certifying Policy-Protected Documents That Have Watermarks

If you apply a policy to a document and the policy uses a watermark, you cannot successfully certify the policy-protected document. Certifying documents that have policies that use watermarks results in the certification being invalid.

Multiple Connections Using Default Administrator User Account

Authentication fails when several simultaneous connections to LiveCycle Workflow Server are attempted using the default Administrator user account. If you need to make simultaneous connections to LiveCycle Workflow Server using the same user account, authenticate using the user credentials from a record in the LDAP server for which an Adobe User Management domain is configured. Authentication of the Administrator user in separate threads is not supported.

Turning off JMS Notification Events

By default, the LiveCycle Workflow Server and the underlying persistence layer send notification events to JMS Topics. These topics could be used to monitor both of these layers and react according to various situations that may occur during execution. If this is unnecessary we recommend turning off these events to increase performance since there is an overhead in posting events to JMS Topics. No functionality within the LiveCycle Workflow Server relies on these topic postings. In over to turn off these events the following parameters can be added to the Java command line of the Application Server:

To disable workflow process events, set:

Dadobe.workflow.engine.publish-process-events=false

To disable POF object events, set:

Dadobe.pof.log-object-events-in-new-tx=false

To disable POF schema events, set:

-Dadobe.pof.log-schema-events-in-new-tx=false

Email Receiver QPAC test tab

You must add the javamail jar files to the PAD classpath in order for the test tab on the Email Receiver QPAC to function correctly.

Operation of QPAC Retry tab

The Retry tab has changed and now specifies the number of retries rather than a timeout period.

EJBInvoker QPAC

The EJBInvoker QPAC does not function correctly in the LiveCycle Workflow Server due to a defect with JBoss 3.2.5. You must install this JBoss patch.

LiveCycle support libraries

You must ensure the LiveCycle support libraries in your LiveCycle Workflow Designer client and LiveCycle Workflow SDK QDE match the server component you are interacting with.

Documentation Updates

The Using Forms Server QPAC guide should have step 5 modified, and step 6 added as follows in the Deploying QPACs section. Also, the Using Policy Server QPAC guide have should step 6 modified and step 7 added as follows in the Deploying QPACs section:

6. In the JNDI_FACTORY_INITIAL box, specify the Initial Context Factory that will be used for JNDI operations:

(JBoss) Type org.jnp.interfaces.NamingContextFactory

(WebLogic) Type weblogic.jndi.WLInitialContextFactory

(WebSphere) Type com.ibm.websphere.naming.WsnInitialContextFactory

7. In the JNDI_ProviderURL box, type the URL to the server on which LiveCycle Forms has been deployed. The value of the property is a URL string. The format is protocol://host:port/path, where the following statements are true:

protocol is the JNDI protocol used by the server.

host is the server on which LiveCycle Forms has been deployed.

port is the JNDI port used by your server.

path is an option which specifies the JNDI name relative to the root context, such as files/ or files/tmp.

host is required, and protocol, port, and path are optional. For example, you could use the following values:

(JBoss) jnp://servername:1099

(WebLogic) t3://servername:7001

(WebSphere) iiop://servername:2809

Back to Contents

The Documentation Set

LiveCycle Workflow SDK includes a complete set of documentation to help you understand how to use the product and its components. The documentation resides in the Documentation directory of the LiveCycle Workflow SDK download. To view the documentation, you must have Adobe Reader^(R) 6.0 or later installed on your computer. You can download Adobe Reader from the Adobe website at http://www.adobe.com/.

The Adobe website also provides overview information about LiveCycle Workflow at www.adobe.com/products/server/workflowserver/main.html. For information about available developer resources, see partners.adobe.com/public/developer/livecycle/devcenter.html and the LiveCycle Workflow Developer Center partners.adobe.com/public/developer/livecycle/workflow/devcenter.html.

Back to Contents

Licenses and Copyrights

This product includes software developed by the Apache Software Foundation (http://www.apache.org/).

The Apache Software License, Version 1.1

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. The end-user documentation included with the redistribution, if any, must include the following acknowledgment:

"This product includes software developed by the Apache Software Foundation (http://www.apache.org/)."

Alternately, this acknowledgment may appear in the software itself, if and wherever such third-party acknowledgments normally appear.

4. The names "Xerces" and "Apache Software Foundation" must not be used to endorse or promote products derived from this software without prior written permission. For written permission, please contact apache@apache.org.

5. Products derived from this software may not be called "Apache", nor may "Apache" appear in their name, without prior written permission of the Apache Software Foundation.

THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including

without limitation the rights to use, copy, modify, merge, publish, distribute, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, provided that the above copyright notice(s) and this permission notice appear in all copies of the Software and that both the above copyright notice(s) and this permission notice appear in supporting documentation.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Except as contained in this notice, the name of a copyright holder shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization of the copyright holder.

All trademarks and registered trademarks mentioned herein are the property of their respective owners.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

3. Neither the name of the University nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Sun grants you ("Licensee") a non-exclusive, royalty free, license to use, and redistribute this software graphics artwork, as individual graphics or as a collection, as part of software code or programs that you develop, provided that i) this copyright notice and license accompany the software graphics artwork; and ii) you do not utilize the software graphics artwork in a manner which is disparaging to Sun. Unless enforcement is prohibited by applicable law, you may not modify the graphics, and must use them true to color and unmodified in every way.

This software graphics artwork is provided "AS IS," without a warranty of any kind. ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN AND ITS LICENSORS SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR DISTRIBUTING THE SOFTWARE GRAPHICS ARTWORK.

IN NO EVENT WILL SUN OR ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF THE USE OF OR INABILITY TO USE SOFTWARE GRAPHICS ARTWORK, EVEN IF SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

If any of the above provisions are held to be in violation of applicable law, void, or unenforceable in any jurisdiction, then such provisions are waived to the extent necessary for this Disclaimer to be otherwise enforceable in such jurisdiction.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions, and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions, and the disclaimer that follows these conditions in the documentation and/or other materials provided with the distribution.

3. The name "Jaxen" must not be used to endorse or promote products derived from this software without prior written permission. For written permission, please contact license@jaxen.org.

4. Products derived from this software may not be called "Jaxen", nor may "Jaxen" appear in their name, without prior written permission from the Jaxen Project Management (pm@jaxen.org).

In addition, we request (but do not require) that you include in the end-user documentation provided with the redistribution and/or in the software itself an acknowledgement equivalent to the following:

"This product includes software developed by the Jaxen Project (http://www.jaxen.org/)." Alternatively, the acknowledgment may be graphical using the logos available at http://www.jaxen.org/

THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE Jaxen AUTHORS OR THE PROJECT CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

====================================================================

This software consists of voluntary contributions made by many individuals on behalf of the Jaxen Project and was originally created by bob Mcwhirter <bob@werken.com> and James Strachan <jstrachan@apache.org>. For more information on the Jaxen Project, please see <http://www.jaxen.org/>.

This code is Copyright 1999-2001 by Eric Albert (ejalbert@cs.stanford.edu) and may be redistributed or modified in any form without restrictions as long as the portion of this comment from this paragraph through the end of the comment is not removed. The author requests that he be notified of any application, applet, or other binary that makes use of this code, but that's more out of curiosity than anything and is not required. This software includes no warranty. The author is not responsible for any loss of data or functionality or any adverse or unexpected effects of using this software.

Back to Contents

Readme File -- Adobe LiveCycle Workflow SDK, Version 7.0.2 -- 11/1/2005 1:47:57 PM