PdfBatch : User GuideV3.1. Manipulate your PDF files quickly. PdfBatch 3.0 allows you to manipulate Adobe Acrobat Portable Document Format.

Transcription

1 Manipulate your PDF files quickly PdfBatch 3.0 allows you to manipulate Adobe Acrobat Portable Document Format. PdfBatch 3.0 Introduction PdfBatch allows you to manipulate one or thousands of existing PDF files in one go with rapidity and robustness. This is achieved via command lines and batch process. Powerful With PdfBatch3.0, you can insert your personal text and meta data in PDF files. You can add images and watermark in batch mode. You do not need access to the PDF files since our application does it for you. Flexible Developed with the latest java technology, PdfBatch3.0 is platformindependent. You can choose your favourite system (Windows, Solaris and Linux) and run PdfBatch 3.0. For support : contact : V /05/2001 P : 1 / 1

2 Table of Contents 1. USER GUIDE PDFBATCH3.0 FUNCTIONALITIES : EXAMPLES Select an original Pdf file Collection of information from the Pdf document Result of Information extracted by PdfBatch3.0 (Xml Format) : Write information in the Pdf document Add graphical information in PDF SETTING PARAMETERS COMMAND LINE EXAMPLE COMMAND LINE DESCRIPTION get Option : get Parameters : set Option : set Parameters : add Option : add Parameters : output Option : extension option : extension parameters : PDF files Location :...16 Supported values...17 Supported font names...17 Supported alignments OUTPUTS GENERATED LIST OF OUTPUTS : EXAMPLES OF OUTPUTS GENERATED Get.xml...19 Set.Html...21 PdfOk.log INSTALLER For support : contact : V /05/2001 P : 2 / 2

3 1. USER GUIDE 1.1 PdfBatch3.0 functionalities : examples This part will explain with examples what PDF batch does SELECT AN ORIGINAL PDF FILE In this example, we select an existing "PDF" file, then we open it in order to display its attributes. PDF Document : Overview of InterestRateEuropeanCentralBank.pdf file. For support : contact : V /05/2001 P : 3 / 3

4 1.1.2 COLLECTION OF INFORMATION FROM THE PDF DOCUMENT This function allows you to collect different information contained in the PDF document structure and to display it in different modes. To access that information, you have to invoke some of following "commands": Some commands : -gp;a;t;f;s;k;c;o;b -ox,h,l C:\PdfBatch3.0_Outputs\ Original information from PDF document : Filename Font name Type Encoding Title Subject Author Keywords Creator Producer Optimized For support : contact : V /05/2001 P : 4 / 4

5 Result of information extracted by PdfBatch3.0 (Xml format) : For support : contact : V /05/2001 P : 5 / 5

6 WRITE INFORMATION IN THE PDF DOCUMENT. This function allows you to write (set) different information in the PDF document structure. Command : -sp=acrobatdistillercommand302bforwindows;t=interestrate; S=InterestRateAppliedByTheEuropeanCentralBank;A=JohnSmith; K=Interest;Z=100;C=KateDonaldson -ox,h,l C:\PdfBatch3.0_Outputs\ generate output file The Result : You have now added information to the title, subject, author, keyword, creator and producer. For support : contact : V /05/2001 P : 6 / 6

7 Verification : You can verify if the adding operation was successful without opening the PDF document. For that, you must open your output file named Set.(log/xml/html). For support : contact : V /05/2001 P : 7 / 7

8 1.1.4 ADD GRAPHICAL INFORMATION IN PDF DOCUMENTS Add text, images, watermarks and pagination to your PDF document. Command : -aw=c:\pdfbatchsources\clouds.jpg,0.1,0.5,1; I=C:\PdfBatchSources\watermark1.jpg,0.5,0.7,1; T=C:\PdfBatchSources\text.txt,24,0.5,1,1 -ox,h,l C:\PdfBatch3.0_Outputs\ C:\PdfBatch3.0_Outputs\ This command inserts an image, a watermark and a text entry in the PDF document. Overview the components : For support : contact : V /05/2001 P : 8 / 8

9 Result : Overview the new PDF document : The add log file contains the status of the add operation (for each component). Add log file (Html format) : For support : contact : V /05/2001 P : 9 / 9

10 2.SETTING PARAMETERS. PdfBatch3.0 is a java application that works in batch mode. For launching the application you must type : Java jar Pdfbatch.jar + Options + parameters. For example, see "Command line example". For more facilities, you can write your command line in a batch file. PdfBatch3.0 is delivered with an installer program that creates a java run-time environment and a PdfBatch.jar on your disk. For more details, see section "PdfBatch3.0 Installer". 2.1 Command line example. Windows 9x, 2000, NT platform (Case- and space- sensitive) : Java jar PdfBatch.jar gp;a;t;f;s;k;c;o;b -sp=producer; T=Title;S=Subject;A=Authors;K=Keywords;Z=100; C=Creator;I=c:\template.txt aw=c:\logo.jpg,1,1,1#2#3; I=Watermark.jpg,0.5,0.5,a;T=c:\text.txt,24,0,1,a; P=d:\Template1.txt,24,0.2,0.8 a -ol,x,h -XP,u=UserPassword,o=OwnerPassword,O=OldPassword,c,s,f,p c:\test For support : contact : V /05/2001 P : 10 / 10

11 2.2 Command line description. -GET OPTION : gp;a;t;f;s;k;c;o;b Get information from PDF files found in the directory and subdirectories. Information is set in a log file named "Get.log" in the parent directory. -get Parameters : gp;a;t;f;s;k;c;o;b Title: Authors: Subject: Keyword: Creator: Producer: Fonts: Optimization: Pdf Version: ASCII or Binary: All Above: T A S K C P F O V I or B X WARNING : - no white spaces and. are allowed within parameters and extra parameters! - on Solaris platform, the ; must be replaced by \;. For support : contact : V /05/2001 P : 11 / 11

12 -SET OPTION : sp=producer;t=title;s=subject;a=authors;k=keywords; Z=100;C=Creator;I=c:\template.txt Set information in PDF files found in the directory and subdirectories. Results are in a log file named Set.log in the parent directory. -set Parameters : sp=producer;t=title;s=subject;a=authors;k=keywords; Z=100;C=Creator;I=c:\template.txt Title: T Title * Authors: A Authors Subject: S Subject Keyword: K Keyword Creator: C Creator Producer: P Producer Preferred Zoom: Z Zoom Information: I Template File ** * Set title according to information collected in filename and defined template. ** Template file structure for information parameter : The template file is a text property file. You must define the template, the property name, the begin index and the last index of the value to be collected in the file. Nomenclature : Template = Article [ART] [Test] ART=2,3 Test=4,8 The template property is mandatory. Other properties are dynamically computed, make sure that the name of the property is the same (case sensitive) as the parameter in the template. The parameter in the template must be surrounded by []. Example : The image you are working on is a PDF file named PdfBatchNewFeatures.pdf and you define your template file as : Template = Article [First] [SECond] First =1,8 SECond=12,19 For support : contact : V /05/2001 P : 12 / 12

13 (Remember : parameters are case sensitive). First value = PdfBatch. SECond= Features. Now, the subject of your PDF file named PdfBatchNewFeatures.pdf is : Subject : PdfBatch Features -ADD OPTION : a W=c:\logo.jpg,1,1,1#2#3; I=Watermark.jpg,0.5,0.5,a;T=c:\text.txt,24,0,1,a; P=d:\Template1.txt,24,0.2,0.8 a c:\test Add components to PDF files found in the directory and subdirectories. Results are in a log file named Add.log in the parent directory. -add Parameters : a W=c:\logo.jpg,1,1,1#2#3; I=Watermark.jpg,0.5,0.5,a;T=c:\text.txt,24,0,1,a,f=c,a=r; P=d:\Template1.txt,24,0.2,0.8,b=1,f=c,a=r c:\test Watermark: W Watermark parameters : PDF filename, X position, Y position, pages where the watermark must be inserted(separated by #) a (All pages). Image: I Image parameters : PDF filename, X position, Y position, pages where the image must be inserted (separated by #) a (All pages). Text: T Text parameters : PDF filename, font height, X position, Y position, pages where the text must be inserted (separated by #) a (All pages), f=font name (optional)*, a=alignment (optional)*. For support : contact : V /05/2001 P : 13 / 13

14 * for values see : supported font names and alignment section. Pagination: P Pagination parameters : PDF filename, font height, X position, Y position, b=page where the pagination starts, f=font name (optional)*, a=alignment (optional)*. * for values see : supported font names and alignment section. -OUTPUT OPTION : ol,x,h Generate output files that contains information generated by Pdfbatch output Parameters: ol,x,h Log files: L text format Xml files : X xml format Html files: H Html format For support : contact : V /05/2001 P : 14 / 14

15 -EXTENSION OPTION : XP,u= UserPassword,o= OwnerPassword,O= OldPassword,c,s,f,p Create and manage security in PDF files. -extension parameters : XP,u= UserPassword,o= OwnerPassword,O= OldPassword,c,s,f,p Permission: P Permission parameters : u= set a user read password for the PDF document. o= set a user read/write password for the PDF document *. O= specify the initial owner password of the PDF document before changing. c : changing not allowed in the PDF document. s : selecting (copy/paste) not allowed in the PDF document. f : adding/modification of forms/annotations not allowed in the PDF document. p : printing not allowed for the PDF document. For support : contact : V /05/2001 P : 15 / 15

16 - PDF FILES LOCATION : c:\test Parent directory of the PDF files. If the directory is empty an exception is generated. The other values for this option can be : a PDF file (e.g. : MyPdf.pdf); a zip files including PDF files (e.g. : MyPdf.zip). For support : contact : V /05/2001 P : 16 / 16

17 SUPPORTED VALUES. X/Y positions The allowed values are doubles from 0 to 1 (e.g:0.5). X position 0 Left 1 Right Y position 0 Bottom 1 Up Supported font names Font Name Courier Courier-Bold Courier-BoldOblique Courier-Oblique Helvetica Helvetica-Bold Helvetica-BoldOblique Helvetica-Oblique Times-Roman Times-Bold Times-Italic Times-BoldItalic Values C CB CBO CO H HB HBO HO TR TB TI TBI Supported alignments Alignment Left Center Right Values L C R For support : contact : V /05/2001 P : 17 / 17

18 3. OUTPUTS GENERATED Pdfbatch3.0 works in batch mode. The outputs generated are not on screen but saved on disk in text, XML or HTML format. 3.1 List of outputs Outputs Add Get PdfAll PdfKo PdfOk Security Description List of PDFs where components where added. List of information acquired from the PDFs. Contains the list of all PDFs in directory and subdirectories Contains PDFs which are not correctly processed. If one error occurs during its process, it will be logged. Contains PDFs which are correctly processed. Status of the security process for all processed PDFs. For support : contact : V /05/2001 P : 18 / 18

19 3.2 Examples of outputs generated GET.XML <?xml version="1.0" encoding="iso "?> - <Log Name="/D:/My Projects/PdfBatch/PdfBatch/Get.log"> - <Directory Name="d:\PdfBatchTest"> - <afile> <Filename>d:\PdfBatchTest\OPP1.pdf</Filename> <Title>Y</Title> <Subject>Y</Subject> </afile> - <afile> <Filename >d:\pdfbatchtest\c_ da pdf </Filename> <Title>Y</Title> <Subject>Y</Subject> </afile> - <afile> <Filename >d:\pdfbatchtest\c_ da pdf </Filename> <Title>Y</Title> <Subject>Y</Subject> </afile> </Directory> - <Directory Name="d:\PdfBatchTest"> - <afile> <Filename>d:\PdfBatchTest\OPP1.pdf</Filename> <Title>Y</Title> <Subject>Y</Subject> </afile> - <afile> <Filename >d:\pdfbatchtest\c_ da pdf </Filename> <Title>Y</Title> <Subject>Y</Subject> </afile> - <afile> <Filename >d:\pdfbatchtest\c_ da pdf </Filename> <Title>Y</Title> <Subject>Y</Subject> </afile> </Directory> - <Directory Name="d:\PdfBatchTest"> For support : contact : V /05/2001 P : 19 / 19

20 - <afile> <Filename>d:\PdfBatchTest\OPP1.pdf</Filename> <Title>Y</Title> <Subject>Y</Subject> </afile> - <afile> <Filename >d:\pdfbatchtest\c_ da pdf </Filename> <Title>Y</Title> <Subject>Y</Subject> </afile> - <afile> <Filename >d:\pdfbatchtest\c_ da pdf </Filename> <Title>Y</Title> <Subject>Y</Subject> </afile> </Directory> </Log> For support : contact : V /05/2001 P : 20 / 20

21 SET.HTML PDFOK.LOG For support : contact : V /05/2001 P : 21 / 21

22 4. INSTALLER. You can install the application by executing a file according to your operating system. Windows : Execute the file named "w32.exe" Solaris Sparc : Execute the file named "Solaris". An installation wizard will guide you through the different steps required to install the PdfBatch3.0 application. For support : contact : V /05/2001 P : 22 / 22

23 For support : contact : V /05/2001 P : 23 / 23

24 For support : contact : V /05/2001 P : 24 / 24