Rendering form guides using the web service API

To render a form guide using the web service API, perform the following tasks:

1.	Include project files

•	Create Java proxy classes that consume the Forms service WSDL. For information, see Creating Java proxy classes using Apache Axis.

•	Include the Java proxy classes into your class path.

2.	Create a Forms Client API object

Create a FormsService object and set authentication values.

3.	Set form guide run-time options

•	Create an ActivityGuideRenderSpec object by using its constructor.

•

To render only SWF content, invoke the RenderOptionsSpec object’s setGuidePDF method and pass false. The default is that both PDF and SWF content are rendered. This is an optional run-time option. All form guide run-time options are optional. It is not necessary to set these options to render a form guide. For information about other run-time options, see LiveCycle ES API References.

4.	Render the form guide

Invoke the FormsService object’s renderFormGuide method and pass the following values:

•	A string value that specifies the name of the form design, including the file name extension. If you are referencing a form design that is saved in theLiveCycle ES repository, ensure that you specify the / character before the file name.

•	A BLOB object that contains data to merge with the form. If you do not want to merge data, then pass null. For information about merging data into forms, see Prepopulating Dynamic Forms.

•	A PDFFormRenderSpecc object that stores run-time options used to render the form. For information about run-time options, see LiveCycle ES API References.

•	An ActivityGuideRenderSpec object that stores form guide run-time options used to render a form guide.

•	A URLSpec object that contains URI values that are required by the Forms service to render a form. For information, see Specify URI values.

The renderFormGuide method returns a FormsResult object that contains a form data stream that must be written to the client web browser.

5.	Write the form guide data stream to the client web browser

•	Create a BLOB object that contains form data by invoking the FormsResult object’s getOutputContent method.

•	Get the content type of the BLOB object by invoking its getContentType method.

•	Set the javax.servlet.http.HttpServletResponse object’s content type by invoking its setContentType method and passing the content type of the BLOB object.

•	Create a javax.servlet.ServletOutputStream object used to write the form data stream to the client web browser by invoking the javax.servlet.http.HttpServletResponse object’s getOutputStream method.

•	Create a byte array and populate it by invoking the BLOB object’s getBinaryData method. This task assigns the content of the FormsResult object to the byte array.

•	Invoke the javax.servlet.http.HttpServletResponse object’s write method to send the form data stream to the client web browser. Pass the byte array to the write method.

View Quick Start

Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/programmer/sdkHelp/renderingFormGuides.35.4.html