You can use the PDFWriter activity to write data into editable fields of input PDF files, and then produce filled PDF files as the outputs. The data source of the input PDF files can come from any other BusinessWorks activities.
General
The following table describes the fields on the
General tab of the PDFWriter activity.
| Field
|
Module Property?
|
Description
|
| Name
|
No
|
(Required) The name of the activity displayed in the process. The default value is
PDFWriter.
|
| Input File
|
No
|
(Required) The input PDF template file that is used to generate the input schema of the
TIBCOROOT field on the
Input tab. Type the directory and the input PDF file name directly in the field, or click the
Choose a resource
 icon to navigate to the PDF file.
Note: When the input PDF template file is not read because it cannot be decrypted, an error message is displayed in the
Input File Password field. Only if the PDF template file cannot be read because it is encrypted with an empty string, the error message is displayed next to the
Input File field.
|
| Input File Password
|
Yes
|
(Optional) Type a correct password for the input PDF template file if it is encrypted.
Note: If the input PDF template file is not encrypted, leave this field blank.
|
| Output File Directory
|
Yes
|
(Optional) The output PDF file directory in this activity. The generated PDF output file is installed in this directory if the application runs successfully. Type the directory in this field, or click the
Choose a resource icon to navigate to the directory.
Note: If you only type the output file directory, the generated PDF file is appended with a universally unique identifier (UUID). For example, if the input PDF file is named
test.pdf, and you only specify this field, the generated PDF file is named as
test524623ad-dcda-4c5d-8eac-74dda7fe5452. pdf.
|
| Output File Name Prefix
|
Yes
|
(Optional) Type a prefix for your output PDF file in this field. When you use the prefix, UUID is appended to the prefix, and the string is used in the output file name.
|
| Is Output File Encrypted
|
No
|
(Optional) Select this check box if you want to encrypt the output PDF file.
|
| Use Process Data
|
No
|
(Optional) Select this check box to get the processed data on the
Output tab.
|
Description
On the
Description tab, you can add a short description for the PDFWriter activity.
Advanced
The following table describes the fields on the
Advanced tab of the PDFWriter activity.
| Field
|
Module Property?
|
Description
|
| Restrict Printing
|
No
|
Select the
Restrict Printing check box to disable printing of a generated PDF file in any application that can read or edit PDF files.
|
| TTF File for Watermark
|
No
|
The path of the
Arial Unicode MS.ttf file, which is used to install multiple languages that might be used in a generated PDF file. The
Arial Unicode MS.ttf file is provided with the sample project, which is located in the
TIBCO_HOME\bw\palettes\pdf\version\samples\Samplefiles\MultibyteTTF directory.
|
Input
The input schema of the activity depends on the input PDF file specified on the
General tab. The following table describes the input elements on the
Input tab of the PDFWriter activity.
| Input Item
|
Data Type
|
Description
|
| userPassword
|
String
|
This option is displayed only when the
Is Output File Encrypted check box is selected. Type the password used to encrypt the output PDF file.
|
| outputPDFFilePath
|
String
|
Type the path and name of the output PDF file in double or single quotation marks for example,
"D:\PDF\test.pdf".
Note: Any data entered as value for the output PDF file name with path in this field takes precedence over any value for the
Output File Directory field and the
Output File Name Prefix field. The
outputPDFFilePath is not displayed when
Use Process Data is selected on the
General tab.
|
| watermark
|
N/A
|
Two options are available for adding a watermark: textContent and
binaryContent.
For details on how to add watermarks, see
Adding Watermarks.
|
| TIBCOROOT
|
N/A
|
All fields of a PDF file are listed. You can optionally specify field values for a PDF file to be generated.
|
Output
The following table describes the output element on the
Output tab of the PDFWriter activity.
| Ouput Item
|
Data Type
|
Description
|
| outputPDFFilePath
|
String
|
Displays the path and name of the generated output PDF file.
|
| processedData
|
Binary
|
It is displayed on the
Output tab when
Use Process Data is selected on the
General tab.
|
Fault
The following table describes the error schema elements on the
Fault tab of the PDFWriter activity.
| Error Schema Element
|
Data Type
|
Description
|
| msg
|
String
|
This error message is displayed when the PDF plug-in captures an exception for the PDFWriter activity.
|
| msgCode
|
String
|
This error code is displayed when the PDF plug-in captures an exception for the PDFWriter activity.
|
Copyright © TIBCO Software Inc. All rights reserved.
