Publishers of technology books, eBooks, and videos for creative people

Home > Articles > Design > Adobe Acrobat

  • Print
  • + Share This
This chapter is from the book Rendering and Reader Extending

Rendering and Reader Extending

Rendering and Reader extending a PDF form at runtime is a common LiveCycle task. Rendering a form often includes merging data so the user will have a PDF with relevant data. After the form is rendered at runtime, it will usually need to be Reader extended for form fillers using the Reader program.

Using the renderPDFForm Operation

The renderPDFForm operation is located in the Forms node of the Services view in Workbench. Follow these steps to add this operation to your process diagram:

  1. Drag and drop this operation to your process diagram. The renderPDFForm icon appears.
  2. Click this icon and select the Properties view to set various properties at design time to control the behavior of this service at runtime (Figure 10.5).

Figure 10.5 A truncated Properties view for the renderPDFForm operation, showing the standard properties to render a form.

As you can see, there are many properties in the renderPDFForm operation to explore. The following are the standard properties to set to render a PDF form from an XDP template and an XML data file:

  • Input > Form to Render: This option can be set to a template, a process variable, a literal value, or an XPath expression. In Figure 10.5, it is set to a process variable called formTemplate. Either a process variable or an XPath expression will enable you to use different forms at runtime.
  • Input > Form Data: This option can be set to a process variable, a literal value, or an XPath expression. In Figure 10.5, it is set to a process variable called formData so you can also choose the data at runtime.
  • Input > PDF Form Render Options: These properties are not fully pictured here but you can see them in Workbench. Many of these properties have default settings.
  • Input > URL Options > Content Root URI: If your process uses a template from the LiveCycle repository, you must add repository:// to this property. If you are using ES2, this value is the default setting for the property.
  • Output > Rendered Form: This option can be set to a process variable or an XPath expression. In Figure 10.5, it is set to a process variable called renderedPDF.

Using the applyUsageRights Operation

You were introduced to the benefits of Reader Extensions in Chapter 2. You also saw the design time interface for LiveCycle Reader Extensions ES. In this chapter, you will learn to call Reader Extensions ES at runtime. One way is by adding the applyUsageRights operation to your process. The operation is located in the Reader Extensions node of the Services view. Follow these steps to add this operation to your process diagram:

  1. Drag and drop the applyUsageRights operation to your process diagram. The applyUsageRights icon appears.
  2. Click this icon and select the Properties view to set various properties at design time to control the behavior of this service at runtime (Figure 10.6).

Figure 10.6 The Properties view for the applyUsageRights operation, showing many of the same extended features you read about in Chapter 2.

The following are the standard properties to set to Reader extend a file with the applyUsageRights operation:

  • Input > Input PDF Document: This option can be set to a template, a process variable, a literal value, or an XPath expression. In Figure 10.6, it is set to a process variable called renderedPDF.
  • Input > Credential Alias: In Figure 10.6, this is set to the literal value of SMARTDOC because that is the credential alias we use on one of our internal development servers. You will need a credential file from Adobe to use Reader Extensions ES.
  • Output > Output PDF Document: This option can be set to a process variable or an XPath expression. In Figure 10.6, it is set to a process variable called readerExtendedPDF.

The renderPDFForm and the applyUsageRights operations can be combined in your process diagrams any time you need to generate a PDF document from an XDP template. In the next example, you will see how these operations can be used to generate an XFA PDF with traditional PDF attachments.

Rendering a Form with Attachments

An interactive XFA PDF can also include file attachments. The file attachments can be traditional PDF files or files from Microsoft Office and other applications. This capability is useful in health care and other fields because it enables a form filler to attach supporting documentation to an interactive form (Figure 10.7).

Figure 10.7 Acrobat/Reader’s Attachments panel showing two file attachments: document1.pdf and document2.pdf.

You can render a PDF form with attachments at runtime using the renderPDFForm operation. In this case, the renderPDFForm operation also requires a map type variable of document values for the Attachments property. You can set a map type variable with the Execute operation of the Set Value service that you learned about in Chapter 7. After the form is rendered, you can call the applyUsageRights operation to Reader extend the file (Figure 10.8).

Figure 10.8 This process diagram shows the Set Value service, the renderPDFForm operation, and the applyUsageRights operation working together to create a Reader extended XFA PDF with file attachments.

The Set Map Variable activity in Figure 10.8 includes the mappings detailed in Figure 10.9.

Figure 10.9 The mappings of the Set Map Variable activity.

These mappings will map the two document attachments (attachment_1 and attachment_2) to the map type variable (attachments). This new map type variable will be referenced in the Attachments property of the renderPDF activity (Figure 10.10).

Figure 10.10 The Attachments property uses an XPath expression to reference the attachments map type variable.

You can also Reader extend a file by calling Reader Extensions ES from your Java or .NET program. For instruction, download the PDF “Calling Reader Extensions from a Java or .NET Application” from http://www.paperlessbook.info.

  • + Share This
  • 🔖 Save To Your Account

Peachpit Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from Peachpit and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about Peachpit products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites; develop new products and services; conduct educational research; and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email ask@peachpit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by Adobe Press. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.peachpit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020