ARTS PDF Split Pro. Version 2.0

Transcription

1 ARTS PDF Split Pro Version 2.0

2 Contents Contents 1. INTRODUCTION New to version Demo Limitations SETUP System Requirements Installation Activation Registration Uninstall SPLITTING METHODS Split by Bookmarks Split by Control File Split by Control File - Full Path Split by File Size Split into Single Pages Split by Coordinate File WATCHED FOLDERS ARTS PDF SPLIT PRO ASSISTANT What is a Coordinate File? Inside a Coordinate File Managing Coordinate Files Creating a New Coordinate File Activating the Rectangle Tool Editing a Coordinate File Opening a Coordinate File Saving a Coordinate File Closing a Coordinate File Viewing Text Viewing Text Runs Viewing Commands ARTS PDF SPLIT PRO GUI Splitting Methods Split by Bookmarks Split by Control File Split by Control File Full Path Split by Coordinate File Split by File Size Split into Single Pages Watched Folders Setting up a Watched Folder Watched Folder Splitting Methods CONTENTS Page 2 of 58

3 Contents 6.3. Options Logging enabled Silent Mode Overwrite output file Update navigational elements Output subfolders ARTS PDF SPLIT PRO CL Splitting Methods Split by Bookmarks Split by Control File Split by Coordinate File Split into Single Pages Split by Page Range Parsing Methods Parse a page Parse a page range Watched Folders Watched Folder Splitting Methods Options Overwrite Update navigational elements Run in the background ARTS PDF SPLIT PRO COM Registering the COM object Class Strings/Namespaces Visual Basic ASP VB.NET C# Delphi PHP Permissions for Web Applications ASP ASP.NET Object ARTSSplitPro GetErrorMessage GetVersionNumber SetLicenceKey SetOverwriteMode SetUpdateMode SplitByBookmarks SplitByControlFile SplitByCoordFile SplitByFileSize SplitIntoSinglePages COM Examples Visual Basic CONTENTS Page 3 of 58

4 Contents ASP APPENDIX A RECTANGLE COMMANDS APPENDIX B COMMAND LINE SWITCHES TROUBLESHOOTING Frequently Asked Questions Forum Updates Maintenance Technical Support...58 CONTENTS Page 4 of 58

5 Introduction 1. Introduction ARTS PDF Split Pro is an industrial grade, stand-alone PDF splitter that allows you to split large PDF files into smaller PDF files, in many different ways. The available splitting methods include: - Split by Bookmarks - Split by Control File - Split by Control File full path - Split by File Size - Split into Single Pages - Split by Coordinate File ARTS PDF Split Pro is made up of four components: with the first being ARTS PDF Split Pro Graphical User Interface (GUI) which performs the actual file splitting; the ARTS PDF Split Pro Assistant is used to create coordinate files and gives the user the power to perform advanced splitting operations; the ARTS PDF Split Pro Command Line Interface (CLI or CL) allows splitting to be utilized from the command-line; and lastly ARTS PDF Split Pro COM Object (COM) enables developers to create customized applications to accommodate PDF splitting in their workflow. Server based usage is supported by ARTS PDF Split Pro. The watched folder function allows users on a network to drop PDF files into a directory, and then use ARTS PDF Split Pro s engine to perform the file splitting New to version 2.0 ARTS PDF Split Pro version 2.0 includes: support for Unicode documents. retains bookmarks and links in output files Demo Limitations An ARTS PDF Split Pro watermark will appear on each page of every output file when using the ARTS PDF Split Pro demo version. Note: No limitations are present in the full retail version. See section 2.3 of this document, Activation, for information on how to activate the full version. CONTENTS Page 5 of 58

6 Setup 2. Setup 2.1. System Requirements Windows Intel Pentium processor or equivalent Microsoft Windows NT Workstation 4.0 with Service Pack 6, Windows 2000 with Service Pack 2, Windows XP Professional or Home Edition, or Windows XP Tablet PC Edition 64MB of RAM (128MB recommended) 50MB of available hard-disk space 1,024x768 screen resolution Note: ARTS PDF Split Pro Assistant requires Adobe Acrobat 5.0 or later. For technical support queries, please consult the Troubleshooting section of this manual or visit our website at Installation You may have received this software on either CD-ROM or as a downloaded file. Windows (CD-ROM) To install from a CD-ROM: 1. Verify that Adobe Acrobat is not running. 2. Insert the CD-ROM. 3. If the CD-ROM does not automatically start, navigate to the CD in Windows Explorer and execute the Windows Installer.exe file. 4. Navigate to ARTS PDF Split Pro. 5. Click Install. 6. Follow the prompts to install ARTS PDF Split Pro. Windows (.exe) If you downloaded ARTS PDF Split Pro, to install: 1. Verify that Adobe Acrobat is not running. 2. Execute the installation file provided. 3. Follow the prompts to install ARTS PDF Split Pro. CONTENTS Page 6 of 58

7 Setup 2.3. Activation If you have the demo version of ARTS PDF Split Pro installed, you can activate the full version using the following steps: 1. Open ARTS PDF Split Pro by going to Start > Programs > ARTS PDF > ARTS PDF Split Pro > ARTS PDF Split Pro Click the About button. 3. Ensure you have a valid serial. A valid serial can only be obtained by purchasing the product. To purchase ARTS PDF Split Pro : a. Select the Register tab page and click on Buy Now to purchase the full version. b. After your purchase has been confirmed, you will receive an containing your serial number. 4. Select the Register tab page and click on Activate. 5. Enter your license details, including your serial number, and click OK. Alternatively you can do the following to activate the full version using ARTS PDF Split Pro Assistant: 1. In Acrobat select Help > About 3 rd Party Plug-Ins > ARTS PDF Split Pro Assistant. 2. Ensure you have a valid serial. A valid serial can only be obtained by purchasing the product. To purchase ARTS PDF Split Pro : a. Select the Register tab page and click on Buy Now to purchase the full version. b. After your purchase has been confirmed, you will receive an containing your serial number. 3. Select the Register tab page and click on Activate. 4. Enter your license details, including your serial number, and click OK. CONTENTS Page 7 of 58

8 Setup 2.4. Registration ARTS PDF provide the option of registering your copy of ARTS PDF Split Pro online. Online registration allows you to protect your serial number. In the event you lose or misplace your serial, we can locate and provide your serial to you on request. Registered customers will also receive important upgrade information and notification of product updates. 1. After activating your copy of ARTS PDF Split Pro you will be prompted to register online. Do one of the following: Click Now to register your product online 1. Click Later to register at a later stage. After entering your license details, you can register your product anytime by clicking on the Register Now button of the Register tab. 2. When registering your product, complete the online form and click Submit Registration. 3. You only need register your product with us once. To manually register your ARTS PDF product, please visit our online registration page, Uninstall Windows To uninstall on a Windows platform: 1. Verify that Adobe Acrobat is not running. 2. Click Start > Settings > Control Panel. 3. Open Add/Remove Programs. 4. Select ARTS PDF Split Pro 2.0 from the menu. 5. Click Add/Remove. 1 You must be connected to the Internet. CONTENTS Page 8 of 58

9 Splitting Methods 3. Splitting Methods ARTS PDF Split Pro can split PDFs into smaller PDF files (or fragments) using a number of different methods. ARTS PDF Split Pro can split PDFs by bookmarks, by control file 2, by file size, into single pages and by coordinate file. These splitting methods are explained in detail below Split by Bookmarks This method will split a PDF file by its bookmarks. Each page that is bookmarked will be the start of a new fragment, and the title of the bookmark will be used as the name of the file. All subsequent pages are added to that fragment, stopping at the next bookmarked page. You will be given a chance to choose the level of bookmarks to use. Top-level bookmarks are level 1. You can Split By Bookmarks using either of the following ARTS PDF Split Pro components: GUI CLI COM 3.2. Split by Control File This method will split a PDF file as specified in a pre-defined control file. A control file is a text file that specifies which pages will be split from the document, and the names of each PDF file that will be split from the document. An example of this is: 12 introduction.pdf chapter3.pdf 80 conclusion.pdf Using the above control file page 12 will be split and named introduction.pdf, pages 23 to 29 will be split and named chapter3.pdf and page 80 will be named conclusion.pdf. An error will occur if the page number specified is out of range. To avoid such errors, put ARTS PDF Split Pro in silent mode. 2 With control files you also have the option to specify full pathnames. CONTENTS Page 9 of 58

10 Splitting Methods You can Split By Control File (not full path) using either of the following ARTS PDF Split Pro components: GUI CLI COM 3.3. Split by Control File - Full Path This method of splitting will split a PDF file as specified in a control file, with each output file (or fragment) being stored in the directory indicated by the full path in the control file. A control file with the full path is a text file that specifies which pages will be split from the document, and the storage location and name of the pdf file that will be split from the document. An example of this is: 23,25,55 c:\splitpdf_files\project\introduction.pdf c:\splitpdf_files\project\sports.pdf 81 c:\splitpdf_files\media\movies.pdf Using the above example page 23, 25 and 55 will be split and named introduction.pdf and saved to c:\splitpdf_files\project\. Pages 23 to 30 will be split and named sports.pdf in the c:\splitpdf_files\project\ directory whilst page 81 will be named conclusion.pdf and saved to the c:\splitpdf_files\media directory. You can Split By Control File (full path) using either of the following ARTS PDF Split Pro components: GUI COM 3.4. Split by File Size This method of splitting allows PDFs to be split based on a file size value (in kilobytes) specified by the user. The way this works is that split pro will scan through your pdf document/s one page at a time, and check at the end of each page to see if the current fragment is equal to or greater than the specified file size. CONTENTS Page 10 of 58

11 Splitting Methods If the fragment size is equal to or greater than the file size specified then at that point the PDF will be split. Otherwise ARTS PDF Split Pro will move onto the next page and perform the same check again. You can Split By File Size using either of the following ARTS PDF Split Pro components: GUI COM 3.5. Split into Single Pages This method of splitting will split a PDF file into fragments containing one page each in the destination folder specified by the user. You can Split Into Single Pages using either of the following ARTS PDF Split Pro components: GUI CLI 3.6. Split by Coordinate File This method of splitting will split a pdf file based on the text that is on each page. Coordinate files are used to perform intelligent splitting of PDF files based on page content. Coordinate files can be created using ARTS PDF Split Pro Assistant. See ARTS PDF Split Pro Assistant for more detail. You can Split By Coordinate using either of the following ARTS PDF Split Pro components: GUI CLI COM CONTENTS Page 11 of 58

12 Watched Folders 4. Watched Folders The watched folders function in ARTS PDF Split Pro GUI and CLI allows an automated splitting solution to be set-up and accessible from the desktop or across a network. By selecting to use Watched Folders, then specifying the folders where the files are stored during the splitting process; PDF/s can be dropped in the specified input folder, split (either into single pages, by coordinate file or control file) and moved to the specified output folder. Making the input and output directories accessible across a network results in having a high-speed splitting solution available across a network. The GUI Watched Folder feature allows you to perform the following splitting methods using watched folders: split into single pages split by control file split by control file full path split by coordinate file The CLI Watched Folder feature allows you to perform following splitting methods using watched folders: split into single pages split by coordinate file CONTENTS Page 12 of 58

13 Assistant 5. ARTS PDF Split Pro Assistant The ARTS PDF Split Pro Assistant is a plug-in for Adobe Acrobat that assists the user to create coordinate files of which are utilized when splitting with ARTS PDF Split Pro. It has been designed to allow the user to create coordinate files quickly and easily without the need to directly create or edit coordinate (text) files. The ARTS PDF Split Pro Assistant can be accessed via the toolbar, or Plug-ins menu. Figure 1. ARTS PDF Split Pro Assistant menu-item Figure 2. ARTS PDF Split Pro Assistant menu-item CONTENTS Page 13 of 58

14 Assistant 5.1. What is a Coordinate File? A coordinate file must be used when performing a Split By Coordinate File split method. Coordinate files use a.crd file extension but they are plain text files that can be viewed or edited with any text editor. The contents of a coordinate file may contain a single line or multiple lines of commands. An example of a coordinate file is shown below: splitontextchange addtofilename "pageno " providefilename Inside a Coordinate File A single line within a coordinate file starts with a rectangle command, followed by rectangle coordinates and a string parameter. The structure of a line within a coordinate file is as shown below: rectangle command [space] left rectangle coordinate [space] top rectangle coordinate [space] bottom rectangle coordinate [space] right rectangle coordinate [space] string An example of this is: splitiftextcontainedinbox "arts" Where: Rectangle Command = splitiftextcontainedinbox Left coordinate = Top coordinate = Bottom coordinate = Right coordinate = String parameter = arts Rectangle command Each command line within the coordinate file has a rectangle command related to it, which indicates what is required when splitting a PDF file. Rectangle commands give the option to: split a PDF file if the page contains specific text. provide output filenames. exclude or include pages from output files. read text on a PDF file and export it to a text file. A full list of available Rectangle Commands can be found in Appendix A of this document. CONTENTS Page 14 of 58

15 Assistant Rectangle coordinates Rectangle coordinates (left, top, bottom and right) are used to view the rectangle using ARTS PDF Split Pro Assistant. The rectangle is used to look at text on a PDF page for the splitting of PDFs. Text within a rectangle area can be compared against the specified string parameter passed. Example: splitiftextcontainedinbox "arts" The coordinates, , form a rectangle. The rectangle area is viewable on a PDF page using ARTS PDF Split Pro Assistant. A rectangle can be viewed on each page of the PDF document. Depending on where the text run begins on the page, this rectangle may have text inside it. Using the splitiftextcontainedinbox command, if ARTS PDF Split Pro finds that the arts string is found inside the rectangle area then the PDF will split at that page i.e. PDF will split if the word arts is found within the text inside the rectangle. String parameter When creating coordinate files, particular rectangle commands may require a user specified text string to be entered in order to split PDFs the way the particular command is expected to. There is a text box in the rectangle tool properties window named Parameters for command where these text strings can be entered. An example for a parameter is when utilizing the split if text contained in box command when creating a coordinate file. This command checks if the parameter specified by the user within the parameter text box is present within the related ARTS PDF Split Pro rectangle in the PDF file. If this string is present, then the file is split. Commands that do not require a specified text string are: SplitOnTextChange SkipHeader providefilename providefilenamefromfirstword addtofilenametextinbox excludeifnotextcontainedinbox extracttext Note: Version 2 users will find that coordinate files created by ARTS PDF Split Pro Assistant have numeric values instead of a text string as the last parameter. This is to support Unicode. Version 2 is backwards compatible and can still support string parameters if coordinate files have been created or edited manually. CONTENTS Page 15 of 58

16 Assistant 5.2. Managing Coordinate Files Creating a New Coordinate File To create a coordinate file: 1. Open a PDF document in Adobe Acrobat. 2. Click the 'Create a new CRD file' button on the ARTS PDF Split Pro Assistant toolbar. You can alternatively go to 'Plug-ins > ARTS PDF Split Pro Assistant > New' in the Adobe Acrobat plug-ins menu. The Rectangle Tool button is now automatically activated enabling you to draw a rectangle on your PDF page. 3. With the Rectangle Tool button activated, drag a box over the area on the page that contains the text you wish to apply a command to. 4. The 'Rectangle Tool Properties' window will now appear. Select the command you wish to use for the rectangle and enter any parameters required. A full list of available Rectangle Commands can be found in Appendix A of this document. 5. Click OK. This command is now set to the rectangle currently selected. 6. Repeat steps 3 to 5 for every command you wish to add to the coordinate file. 7. Save the coordinate file. Figure 3. Create a new CRD file toolbar button Note: There is no limit to the number of rectangle commands within a coordinate file. If you wish to apply several commands to the same text on a page you can do so by creating another rectangle over the top of the existing one Activating the Rectangle Tool ARTS PDF Split Pro allows the user to split PDF files based on the text that appears on the pages throughout a PDF document. The rectangle tool is used to select which text on the page will be used for splitting the file. Figure 4. Activate Rectangle Tool toolbar button To activate or deactivate the rectangle tool, do one of the following: Select Activate Rectangle Tool from the ARTS PDF Split Pro Assistant menuitem, Click on the Activate the Rectangle Tool button located in the ARTS PDF Split Pro Assistant toolbar. CONTENTS Page 16 of 58

17 Assistant The rectangle tool will open the Rectangle Tool Properties window allowing you to: Create a new command Edit an existing command Figure 5. Rectangle Tool Properties dialog Rectangle Command The default command is noop which means there is no active command selected for this rectangle. Select the command you wish to use for the rectangle you just created on your page. A full list of available Rectangle Commands can be found in the Appendix A of this document. Parameters Enter any parameter that is required for your command in the parameters for command text box. This is where you enter the text when you wish to see if a particular/literal string is present on the page. Rectangle Position and Page Rotation Displays the rectangle coordinates for size and position on the page. If the page is rotated the text cannot be extracted by ARTS PDF Split Pro Assistant but ARTS PDF Split Pro will function as normal. Text found inside rectangle Displays the text that the rectangle reads off the current PDF page. CONTENTS Page 17 of 58

18 Assistant Editing a Coordinate File To edit a rectangle command or string parameter: 1. Open a PDF document in Adobe Acrobat. 2. Open a coordinate file to edit if one is not yet open. 3. Open the Rectangle Tool Properties dialog by doing one of the following: Activate the Rectangle Tool and then double click on the rectangle you wish to edit. Open the View Commands dialog, select the command you wish to modify and click Edit. 4. Select the new rectangle command you wish to use and/or modify any parameters required. 5. Click OK. 6. Save the coordinate file. To edit the size of a rectangle box (or rectangle coordinates): 1. Open a PDF document in Adobe Acrobat. 2. Open a coordinate file to edit if one is not yet open. 3. Activate the Rectangle Tool. 4. Click on a rectangle and move to the corner of the blue rectangle box until a double-headed arrow appears. Drag the box to the desired size. 5. Save the coordinate file. To edit a the position of a rectangle box (or rectangle coordinates): 1. Open a PDF document in Adobe Acrobat. 2. Open a coordinate file to edit if one is not yet open. 3. Activate the Rectangle Tool. 4. Click on the rectangle and drag it to a different position. 5. Save the coordinate file Opening a Coordinate File To open a coordinate file: 1. Open a PDF document in Adobe Acrobat. 2. Select Open from the ARTS PDF Split Pro Assistant menu or click on the open button located on the ARTS PDF Split Pro Assistant toolbar. 3. Select the coordinate file (.crd) to open. 4. Click Open. Figure 6. Open toolbar button CONTENTS Page 18 of 58

19 Assistant Saving a Coordinate File To save the active coordinate file: 1. Select Save from the ARTS PDF Split Pro Assistant menu or click on the save button located on the ARTS PDF Split Pro Assistant toolbar. 2. Enter a filename for your coordinate file and select the directory you wish to save to, ensuring that the file extension is of.crd type (it will be.crd by default). 3. Click Save. Figure 7. Save toolbar button Closing a Coordinate File To close the active coordinate file, select Close from the ARTS PDF Split Pro Assistant menu, or click on the close button located on the ARTS PDF Split Pro Assistant toolbar. Figure 8. Close toolbar button Viewing Text To view text as ARTS PDF Split Pro does, select Show Text from the ARTS PDF Split Pro Assistant menu, or click on the show text button located on the ARTS PDF Split Pro Assistant toolbar. Figure 9. Show Text toolbar button ARTS PDF Split Pro Assistant recognizes text on pages differently to how the human eye does. This must be taken into consideration when using ARTS PDF Split Pro Assistant as it could affect the accuracy of the users pdf splitting. It is recommended to use the show text tool when using the rectangle to ensure that the rectangle is positioned correctly around the text you wish to apply a command to. CONTENTS Page 19 of 58

20 Assistant Figure 10. How the human eye sees the text Figure 11. How ARTS PDF Split Pro sees the text (zoomed to 200%) Figure 10 and 11 show the difference between how the human eyes sees text on the page, and how ARTS PDF Split Pro sees it. In figure 11, the red text is what ARTS PDF Split Pro sees, and the text behind in and in figure 10 is how it appears to the user on the page Viewing Text Runs To view text runs, select Show Run Start from the ARTS PDF Split Pro Assistant menu, or click on the close button located on the ARTS PDF Split Pro Assistant toolbar. Figure 12. Show Run Start toolbar button ARTS PDF Split Pro Assistant allows the user to see where the start of each text run starts on the page. A small red cross represents the start of each text run. This can be seen in the diagram below (displaying text runs in ARTS PDF Split Pro Assistant). Figure 13. Displaying text runs in split pro assistant Within a PDF file, text is drawn by moving to a specific location on the page and drawing a line of text, which is formally known as a run of text. What appears to be one line of text can actually be made of a number of runs of text put together. In ARTS PDF Split Pro Assistant, if a line of text begins inside a rectangle that you have created on your screen then the entire run of text is considered inside that rectangle. The rectangle that has been drawn in figure 13 contains two runs of text CONTENTS Page 20 of 58

21 Assistant inside it, and as mentioned earlier the red crosses denote these runs of text. The text that ARTS PDF Split Pro Assistant would recognize from this triangle and the two runs of text inside it are: r in the list o down menu Note: if a line of text begins inside a rectangle, the entire run of text is considered "inside" that rectangle. The end of the rectangle in the figure 13 does not denote where ARTS PDF Split Pro Assistant will stop reading the text, rather the end of the text runs that begin within the rectangle will Viewing Commands The View Commands dialog is used for managing all the commands found within a coordinate file. Figure 14. View Commands dialog To open the View Commands dialog, select View Commands from the ARTS PDF Split Pro Assistant menu, or click on the Display and reorder commands button on the ARTS PDF Split Pro Assistant toolbar. CONTENTS Page 21 of 58

22 Assistant Figure 15. Display and reorder command toolbar button View Commands dialog lists all commands within a coordinate file. It is possible to change the order of commands within the coordinate file simply by clicking on the Move Up or Move Down button. With the dialog open, scroll through the PDF document to see what text on the page is recognized by the rectangle coordinates. CONTENTS Page 22 of 58

23 Graphical User Interface 6. ARTS PDF Split Pro GUI ARTS PDF Split Pro is referred to as the component that performs the actual PDF splitting. This is accessed through the ARTS PDF Split Pro Graphical User Interface (GUI). You can open ARTS PDF Split Pro from the Windows Start menu by going to Start > Programs > ARTS PDF > ARTS PDF Split Pro > ARTS PDF Split Pro 2.0 or if you are a Windows XP user go to Start > All Programs > ARTS PDF > ARTS PDF Split Pro > ARTS PDF Split Pro Splitting Methods The splitting methods available can be selected in the listbox shown below: Figure 16. Splitting methods found on the ARTS PDF Split Pro dialog Split by Bookmarks To split by bookmarks: 1. Select Split PDF by Bookmarks as the method of splitting. 2. Select the source PDF file to be split. 3. Enter the bookmark level in Split by bookmark level 4. Select the destination folder where the PDF files will be stored following splitting. This can be set to the same as the source folder, or in the folder of the users choice. 5. Click the Split button to begin the process. CONTENTS Page 23 of 58

24 Graphical User Interface Split by Control File To split by a control file: 1. Select Split PDF by Control File as the method of splitting. 2. Select the source pdf file to be split. 3. Select the control file that will determine the split files. This control file should not contain full pathnames. 4. Select the destination folder where the pdf files will be stored following splitting. This can be set to the same as the source folder, or in the folder of the users choice. 5. Click the Split button to begin the process. The file will be split, and each output file (fragment) will be given a file name as specified in the control file and placed in the selected folder Split by Control File Full Path To split by control file - full path: 1. Select Split PDF by Control File full path as the method of splitting. 2. Select the source pdf file to be split. 3. Select the control file that will determine the split pdf files. This control file should specify full pathnames. 4. Click the Split button. The file will be split, and each fragment will be saved with the specified location and name. If the full path specifies a directory that does not exist, the directory will be created Split by Coordinate File To split by a coordinate file: 1. Select Split PDF by Coordinate File. 2. Select the source pdf file to be split. 3. Select the coordinate file to be used to determine the split pdf files. 4. Select the destination folder where the pdf files will be stored following splitting. This can be set to the same as the source folder, or in the folder of the users choice. 5. Click the Split button. The file will be split based on the coordinate file command/s, and each fragment will be saved to the specified directory. CONTENTS Page 24 of 58

25 Graphical User Interface Split by File Size To split by file size: 1. Select Split PDF by File Size. 2. Select the source PDF file to be split. 3. Select the destination folder where the PDF files will be stored following splitting. This can be set to the same as the source folder, or in the folder of the users choice. 4. Enter the base name for each split fragments. All fragments will use the name you choose as a base name, and they will be saved in the directory you have chosen. Ascending numeric values will be appended to the base name to name every output file. If the user enters order.pdf or order, the fragments will be named order1.pdf, order2.pdf, and order3.pdf 5. Enter the file size value in KB. 6. Click the Split button Split into Single Pages To split into single pages: 1. Select Split PDF into Single Pages. 2. Select the source pdf file to be split. 3. Select the destination folder where the pdf files will be stored following splitting. This can be set to the same as the source folder, or in the folder of the users choice. 4. Enter the base name for each split fragments. All fragments will use the name you choose as a base name, and they will be saved in the directory you have chosen. Ascending numeric values will be appended to the base name to name every output file. If the user enters invoice.pdf or invoice, the fragments will be named invoice1.pdf, invoice2.pdf, and invoice3.pdf 5. Click the Split button. CONTENTS Page 25 of 58

26 Graphical User Interface 6.2. Watched Folders Setting up a Watched Folder Figure 17. Setting up watched folders To set-up watched folders: 1. Click the Watch Folder button on the ARTS PDF Split Pro GUI. 2. Select whether to Split into Single Pages, Split by Control File or Split by Coordinate File. More information on this can be seen in the following sections. 3. Leave the processing folders (input, busy, done, error, output) as default, or specify your own folders where the PDF files will be processed. Input: folder to place the source PDF ready for splitting. Busy: folder where the PDF in process is temporarily stored. Done: folder to store the source PDF that has been successfully processed. Error: folder to store the source PDF where the split process was incomplete due to an error. Output: folder to store split output PDF files. CONTENTS Page 26 of 58

27 Graphical User Interface 4. It is optional to select the overwrite the original file checkbox that will overwrite existing output files. 5. It is optional to add a suffix after the filename (but before number) for each split PDF. 6. Select to have the split PDFs placed directly into the output folder or within a subdirectory that would be created within the output directory. The subdirectory will be named by the name of the PDF file dropped into the input folder Watched Folder Splitting Methods Figure 18. Watched folder splitting methods Split into single pages By selecting this option, the watched folder will split each PDF placed in the input directory into fragments with one page in each fragment. That is, when a PDF is dropped into the input folder, the PDF will be split into single pages and saved to the output directory Split by control file By selecting this option, the watched folder will split each PDF into fragments based on a control file the user selects. Control files go into the input folder, and the first line of the control file should be a full path to the PDF file to be split. For example: C:\pdfsplit\reporting\annual_report.pdf 1,3,8 firstfewpages.pdf bobloseshisjob.pdf personnelplanning.pdf CONTENTS Page 27 of 58

28 Graphical User Interface Split by control file full path If splitting by control file - full path using watched folders, select the control file option and leave the output directory blank Split by coordinate file By selecting this option, the watched folder will split each pdf into fragments based on a coordinate file the user must select. Upon selecting to split by coordinate file with Watched folders, the user must specify the location of the coordinate file to be used Options Using ARTS PDF Split Pro you have the option to log the status of split processes, run the application in silent mode, overwrite original output files and update navigational elements. These options are also available for the GUI watched folders. To access the Options dialog, click on the Options button on the main ARTS PDF Split Pro dialog. Figure 19. Options dialog CONTENTS Page 28 of 58

29 Graphical User Interface In addition to the options found within the Options dialog, you can find options applicable to watched folders in the Watched Folder dialog. See Figure 20. Figure 20. Watched Folder options in red Logging enabled The option to enable logging can be found in the Options dialog. With Logging enabled selected, ARTS PDF Split Pro will log successful and unsuccessful split events. The error details for any unsuccessful processes will be recorded in the log file. The log file is a text file that is stored in the same location as the ARTS PDF Split Pro GUI executable. By default, the log file can be found in C:\Program Files\ARTS PDF Split Pro. CONTENTS Page 29 of 58

30 Graphical User Interface Silent Mode The option to run ARTS PDF Split Pro in silent mode can be found in the Options dialog. This will run ARTS PDF Split Pro with no visual output or required user interaction. It is recommended that the Logging enabled checkbox is selected if silent mode is checked. Logging enabled will notify you of any errors or status messages by writing entries to a log file. If running in silent mode and you wish to stop processing a file, you must exit the application Overwrite output file The option to overwrite existing files can be found in the Options dialog. By default, ARTS PDF Split Pro will avoid overwriting an existing file by appending a number to the new filename. Select this option to overwrite existing output files instead of appending a number 3. For example: First split produces the following output files: tax.pdf, invoice.pdf, order.pdf Second split does NOT have Overwrite output file selected. Output files are: tax_1.pdf, invoice_1.pdf, order_1.pdf Third split does have Overwrite output file selected. Output files of the third split will overwrite the output files of the first split: tax.pdf, invoice.pdf, order.pdf Watched folders will ignore the Overwrite output file option found in the Options dialog. To set the overwrite mode for watched folders, select Overwrite the original file in the Watched Folder dialog Update navigational elements The option to update navigational elements 4 can be found in the Options dialog and in the Watched Folder dialog. Select this option to update all links, bookmarks and named destinations so that they remain connected to the proper page. To set Update navigational elements for watched folders, select the checkbox in the Watched Folder dialog. 3 The Overwrite output file option will not affect control file split methods ( By Control File and By Control File full path). Any output files using a control file will always be overwritten because the filename is specified within the control file. 4 Form fields and annotations other than links, such as comments, are not updated and are removed from all output files. CONTENTS Page 30 of 58

31 Graphical User Interface GoTo 5 links are adjusted to stay connected to the proper page, even if the pages end up in a different order in the final document. GoTo links are changed into a GoToR 6 links to ensure that links are not broken should a linked page end up in different output file. GoToR links or Launch actions, both of which reference an external file, use a relative pathname that takes into account the difference if the files created by splitting are in a different directory from the original file. If you split a file with named destinations, the named destinations will be inserted into the output files. Links that use named destinations within the original document will be changed from GoTo to GoToR links as necessary. The links will still use named destinations. Bookmarks are copied into all files and are adjusted just as the links are Output subfolders The option to place output files in subfolders is only applicable to watched folders and can be found in the Watched Folder dialog. Select Put fragments into subfolders to place all output files in subfolders where the subfolder is named after the source file. The other option is to select Put fragments directly into the Output folder to place all output files directly into the specified output folder rather than into separate subfolders. 5 GoTo links are links that go to another page in the same document. 6 GoToR links are links that goes from one file to another using a reference external. CONTENTS Page 31 of 58

32 Command Line Interface 7. ARTS PDF Split Pro CL ARTS PDF Split Pro can be launched from the command line using command line switches to specify what type of splitting to process. ARTS PDF Split Pro Command Line Interface (CLI or CL) application can be found in the ARTS PDF Split Pro folder e.g. C:\Program Files\ARTS PDF Split Pro\ARTS PDF Split Pro CL.exe. It is important that spaces are placed between each switch specified. Some switches are followed by specific operands, and these operands must also be separated by a space. If a pathname contains a space, then the path must be enclosed in quotes. An example of this can be seen below: -i c:\artssplitpro.pdf correct -i c:\arts PDF Split Pro.pdf wrong -i "c:\arts PDF Split Pro.pdf" correct A full list of available Command Line Switches can be found in Appendix B of this document Splitting Methods Split by Bookmarks To split by bookmarks, you will need to use the split by bookmarks (-m), input (-i) and output (-o) switches. For example to split by level 1 bookmarks: c:\arts PDF Split Pro CL.exe" -m 1-1 -i "c:\inputfile.pdf" -o "c:\outputfolder\" Split by Control File To split using a control file, you will need to use the control file (-c), input (-i) and output (-o) switches. For example: c:\arts PDF Split Pro CL.exe" -i "c:\inputfile.pdf" -o "c:\outputfolder\" -c "c:\controlfile.txt" Split by Coordinate File To split using a coordinate file, you will need to use the coordinate file (-x), input (-i) and ouput (-o) switches. For example: c:\arts PDF Split Pro CL.exe" -i "c:\inputfile.pdf" -o "c:\outputfolder\" -x "c:\coordinatefile.crd" CONTENTS Page 32 of 58

33 Command Line Interface Split into Single Pages To split by single pages, you will need to use the fragment size (-k), input (-i) and output (-o) switches. For example: c:\arts PDF Split Pro CL.exe" -k 1 -i "c:\inputfile.pdf -o "c:\outputfolder\basefilename" In addition, you can use the serial number (-n) switch to add padded zeros to the suffix and use the fragment numbering (-f) switch to specify the starting number. For example, the following will add a suffix to all output filenames with an incrementing 3 digit value starting at 6: c:\arts PDF Split Pro CL.exe" -k 1 -f 6 -n 3 -i "c:\inputfile.pdf -o "c:\outputfolder\basefilename" Split by Page Range To split by page range, you will need to use the page range (-r), input (-i) and output (-o) switches. For example: c:\arts PDF Split Pro CL.exe" -r i "c:\inputfile.pdf -o "c:\outputfolder\outputfile.pdf" 7.2. Parsing Methods Parse a page To parse a single page to a text file, you will need to use the parse (-pa), input (-i) and output (-o) switches. For example: c:\arts PDF Split Pro CL.exe" -pa 2 -i "c:\inputfile.pdf -o "c:\outputfile.txt" Parse a page range To parse a range of pages of a PDF file to a text file, you will need to use the parse debug (-pr), input (-i) and output (-o) switches. For example: c:\arts PDF Split Pro CL.exe" -pr 1-5 -i "c:\inputfile.pdf -o "c:\outputfile.txt " CONTENTS Page 33 of 58

34 Command Line Interface 7.3. Watched Folders Watched Folder Splitting Methods Split into single pages Use the watch folder ( w) switch, along with the done (-d), input (-i), output (-o), busy (-b), error (-e), and fragment size (-k) switches, to split a file into single pages using a watched folder. For example: c:\arts PDF Split Pro CL.exe" -w -d "c:\donefolder\" -i "c:\inputfolder -o "c:\outputfolder -b "c:\busyfolder -e "c:\errorfolder -k Split by coordinate file 7.4. Options Overwrite Use the watched folder by coordinate file ( wc) switch, specifying the coordinate file, input, output, busy, done and error folder, to run a coordinate watched folder. For example: c:\arts PDF Split Pro CL.exe" -wc "c:\coordinatefile.crd" c:\inputfolder c:\outputfolder\ c:\busyfolder\ c:\donefolder\ c:\errorfolder\ By default, output files will be placed in subfolders named after the input file. Use the subfolder ( ns) switch to place output files directly into the output folder. For example: c:\arts PDF Split Pro CL.exe" -ns -wc "c:\coordinatefile.crd" c:\inputfolder\ c:\outputfolder\ c:\busyfolder\ c:\donefolder\ c:\errorfolder\ Use the overwrite (/de) switch to overwrite existing output files when splitting by coordinate file, by bookmarks or into single pages. For example: c:\path\arts PDF Split Pro CL.exe" -k 1 -f 6 -n 3 -i "c:\path\inputfile.pdf -o "c:\path\basefilename" /de CONTENTS Page 34 of 58

35 Command Line Interface Use the overwrite ( ow) switch for watched folders to overwrite existing output files when running a watched folder. For example: c:\path\arts PDF Split Pro CL.exe" -wc "c:\path\coordinatefile.crd" c:\path\inputfolder\ c:\path\outputfolder\ c:\path\busyfolder\ c:\path\donefolder\ c:\path\errorfolder\ ] -ow Update navigational elements Use the update navigational elements switch ( ne) to update bookmarks and links within output files. For example: c:\path\arts PDF Split Pro CL.exe" -ne -wc "c:\path\coordinatefile.crd" c:\path\inputfolder\ c:\path\outputfolder\ c:\path\busyfolder\ c:\path\donefolder\ c:\path\errorfolder\ Another example: c:\path\arts PDF Split Pro CL.exe" -ne -k 1 -f 6 -n 3 -i "c:\path\inputfile.pdf -o "c:\path\basefilename" Run in the background To run ARTS PDF Split Pro in the background and log errors in a log file use the headless ( h) switch. For example: c:\path\arts PDF Split Pro CL.exe" -w -d "c:\path\donefolder\" -i "c:\path\inputfile.pdf -o "c:\path\inputfile.pdf -b "c:\path\inputfile.pdf -e "c:\path\inputfile.pdf -k 1 h "c:\path\statuslog.txt" CONTENTS Page 35 of 58

36 COM Object 8. ARTS PDF Split Pro COM ARTS PDF Split Pro COM allows developers to integrate the ARTS PDF Split Pro methods of splitting in custom applications. The COM component comes as a DLL file containing methods that can be called to split PDF files and can be utilized in environments such as Visual Basic, Delphi, ASP, ASP.NET and PHP. Examples of Visual Basic and ASP code can be found in section 8.2 of this document, COM Examples Registering the COM object The ARTS PDF Split Pro COM Library is contained within the distributable file APSplitPro.dll. This interface is automatically registered as an OLE server when installed using the ARTS PDF Split Pro installer and can be located in the Windows System32 folder, typically C:\WINDOWS\system32\APSplitPro.dll To redistribute applications built using this library to other machines, copy this file to the target computer and register it using Windows REGSVR32 utility. Note that the APSplitPro.dll file does not need to be located in the SYSTEM32 folder; however it is recommended you copy it there to avoid any potential permissions problems. To unregister the COM object, use the u switch in the command line call, i.e. regsvr32 C:\WINDOWS\system32\APSplitPro.dll -u CONTENTS Page 36 of 58

37 COM Object 8.2. Class Strings/Namespaces Use the following class strings to instantiate the ARTS PDF Split Pro COM object. Please note that we do not provide a native.net assembly class. To use ARTS PDF Split Pro in a.net application you will need to utilize an Interop Assembly and include this within the bin folder of the application, i.e. bin\interop.artssplitprocomlib.dll Visual Basic ARTSSPLITPROCOMLib.ARTSSplitPro ' Early Binding Dim objapsplitpro As ARTSSPLITPROCOMLib.ARTSSplitPro Set objapsplitpro = New ARTSSPLITPROCOMLib.ARTSSplitPro ' Early Binding Dim objapsplitpro As New ARTSSPLITPROCOMLib.ARTSSplitPro ' Late Binding Dim objapsplitpro As Object Set objapsplitpro = New ARTSSPLITPROCOMLib.ARTSSplitPro ASP VB.NET C# ARTSSplitPro.ARTSSplitPro ' Late Binding Dim objapsplitpro Set objapsplitpro = Server.CreateObject("ARTSSplitPro.ARTSSplitPro") ARTSSPLITPROCOMLib Imports ARTSSPLITPROCOMLib ' Early Binding Dim objapsplit As ARTSSplitProClass objapsplit = New ARTSSplitProClass ' Early Binding Dim objsplit As New ARTSSplitProClass ARTSSPLITPROCOMLib CONTENTS Page 37 of 58

38 COM Object Delphi PHP Using ARTSSPLITPROCOMLib ARTSSplitProClass objapsplit; ARTSSplitPro.ARTSSplitPro APSP: Variant; APSP := CreateOleObject('ARTSSplitPro.ARTSSplitPro'); ARTSSplitPro.ARTSSplitPro $APSplitPro = new COM("ARTSSplitPro.ARTSSplitPro") 8.3. Permissions for Web Applications ASP When using ARTS PDF Split Pro COM within a web application, certain permissions must be granted to the designated output folder in order for these output files to be saved to disk. If these permissions are not granted correctly, the splitting method will generally return the error value 403 I/O Error. Both the Internet Guest (IUSR_MachineName) and Launch IIS Process (IWAM_MachineName) accounts require sufficient privileges to write to the specified output folder ASP.NET The Internet Guest (IUSR_MachineName), Launch IIS Process (IWAM_MachineName) and ASP.NET Machine (ASPNET) accounts require sufficient privileges to write to the specified output folder. If anonymous internet access is not permitted to your web application then substitute the Internet Guest Account with that of the authorized user account(s). CONTENTS Page 38 of 58

39 COM Object 8.4. Object ARTSSplitPro The ARTSSplitPro object carries informational properties as well as methods for the functionality to split a PDF file. ARTSSplitPro offers you the following methods: METHOD GetErrorMessage GetVersionNumber SetLicenceKey SetOverwriteMode SetUpdateMode SplitByBookmarks SplitByControlFile SplitByCoordFile SplitByFileSize SplitIntoSinglePages DESCRIPTION Returns error message Returns ARTS PDF Split Pro version number Sets the serial number Sets the overwrite mode Sets the mode for updating navigational elements Splits a PDF by bookmark levels Splits a PDF by control file Splits a PDF by coordinate file Splits a PDF by file size Splits a PDF into single pages GetErrorMessage GetErrorMessage Description Parameters Return Value Related methods String GetErrorMessage(Long lerrorcode) Returns an error message for unsuccessful split results. lerrorcode the error value of the split result. String of text describing the error that occurred. SplitByBookmarks, SplitByControlFile, SplitByCoordFile, SplitByFileSize, SplitIntoSinglePages GetVersionNumber GetVersionNumber String GetVersionNumber( ) Description Returns the version number of ARTS PDF Split Pro COM. Return Value Version number in the format of X.X[X] SetLicenceKey SetLicenceKey Description Long SetLicenceKey (String ssn, String soldsn) Sets the serial number to run COM in full version or demo mode. COM will run in full version only if the serial is CONTENTS Page 39 of 58

40 COM Object Parameters Return Value accepted. ssn Valid serial number or use DEMO to run in demo mode. SOldSN Optional parameter. Valid serial number of the previous version. Only required if an upgrade serial is used for ssn. 0 if serial number is accepted, COM will run in full. 1 if serial is invalid, COM will run in demo mode SetOverwriteMode SetOverwriteMode Description Parameters SetOverwriteMode (BOOL boverwritemode) Sets the overwrite mode. boverwritemode True will overwrite existing files SetUpdateMode SetOverwriteMode Description Parameters SetUpdateMode (BOOL bupdatemode) Sets the mode for updating navigational elements. bupdatemode True will update navigational elements SplitByBookmarks SplitByBookmarks Description Parameters Return Value Related methods Long SplitByBookmarks (String sinputfile, String soutputfolder, Long llowestlevel, Long lhighestlevel) This method splits a PDF using the split by bookmarks method. sinputfile Pathname of the source PDF. soutputfolder Path of the destination folder where output files are placed. llowestlevel The lowest bookmark level to split. lhighestlevel The lowest bookmark level to split. 0 if PDF split is successful otherwise returns an error value. GetErrorMessage CONTENTS Page 40 of 58