Testing Adobe LiveCycle form with OutputIVS
May 31st, 2012

Working on dynamic generation of Adobe PDF documents using LiveCycle ES 2.5 server APIs I have come across the necessity to conduct some initial testing to forms developed with LiveCycle Designer. The goal was to emulate the API call to LiveCycle’s Output service to make sure that the form merges with the given data properly and renders the way the forms designer intended it to render preserving the layout, form elements position, etc. One obvious way to do it was to create a small standalone utility wrapping around required API calls. The other way has been discovered upon examining the related documentation.

LiveCycle ES 2.5 provides a sample application called Output Installation Verification Sample (IVS). The sample is a web application that interacts with the Output ES service to generate PDF or printed output. After you deploy the application, you can browse to the web page it provides and render form designs for testing purposes. So, the Output IVS application enables you to debug the Output ES part of your solution in isolation from the rest of your LiveCycle ES application.

This guide assumes that you have configured deployment of respective packages during the server installation and your OutputIVS sample application is available at          
http://your_LC_server_address:8080/OutputIVS.

If you haven’t deployed OutputIVS yet then you can follow this simple guide to do so:
Please note that the following directions apply to the JBoss turnkey on Windows.

1) go to C:\Adobe\Adobe LiveCycle ES2\deploy and locate adobe-output-ivs-jboss.ear
2) copy adobe-output-ivs-jboss.ear to C:\Adobe\Adobe LiveCycle ES2\jboss\server\lc_turnkey\deploy
3) if necessary, start LiveCycle
4) open a browser and go to           
http://your_LC_server_address:8080/OutputIVS/
If deployment was successful then you should see OutputIVS main page

OutputIVS Main Page

OutputIVS Main Page

Now, let’s prepare our test template with Adobe LiveCycle Designer and create sample data for it.

Check this screencast out to walk yourself through the process.

Now it’s time to go back to your browser and navigate to OutputIVS. Once there, click the Check/Change your preferences on the main page. You’ll be taken to Preferences page where the only thing you need to make sure is Admin Credentials are entered. Let me remind you, that default credentials are: User ID is administrator and Password is password. If credentials are NOT there enter them and click Save button to save preferences.

Admin Credentials verification

Admin Credentials verification

Next step is to upload your template and sample data into OutputIVS repository. For this click Maintenance link in the OutputIVS menu bar.

OutputIVS Menu Bar

OutputIVS Menu Bar

You should see Maintenance page that looks something like the one below:

OutputIVS Maintenance Page

OutputIVS Maintenance Page

Noted those warnings marked with red boxes? If your maintenance page doesn’t have them you’re good to go to the next step, otherwise to proceed you will need to enable file management on the server by clicking that Click here link for each section. Once, it’s all done, Maintenance page should look like this

OutputIVS Maintenance page

OutputIVS Maintenance page

Now, we’re ready to start uploading the form and the sample data on the server.
Use Choose File button (1) from Manage form designs section to open file selection dialog window. In the pop-up window choose the PDF or XDP file saved earlier, confirm the selection and once you see the file name next to Choose file button (2) click Upload link (3) in Upload File box.

Form design file upload process

Form design file upload process

This may take some time depending on the file size and your type of network connection. Once uploading completes you should see your form design file name in the list of files.

Form design file upload is completed

Form design file upload is completed

To upload data file please repeat all the steps for uploading the form file but this time do this in Manage data files section and instead of form file choose your previously saved XML sample data file in pop-up file selection window. Upon completion the file list in Manage data files section should look something like this:

Data file upload completed

Data file upload completed

Now, it’s finally the time to test the form!
Click Test Output in menu bar to get to the testing page.

Test Output menu bar item

Test Output menu bar item

Test output page will open. On that page:
1) Choose desired Output Format (PDF by default, leave it like that unless you know that you need a different output format).
2) Select your previously uploaded PDF/XDP file in Form designs box
3) Select your previously uploaded XML file in Data files (optional) box
4) Click Use Web Service button in Issue Request section

OutputIVS test output page

OutputIVS test output page

Depending on settings of your browser Adobe Reader plugin you should either see the generated PDF directly in browser window or receive a request to begin PDF downloading. Download the file if prompted and open it with your choice of PDF files viewer. Either way your PDF should look something very similar to this Sample of generated PDF.
Enjoy!

Tags: , , , , , , ,
No Comments
Leave a Reply
You must be logged in to post a comment.