Tabs: Insert

Note: This node works with PDF files (version 1.3 or later).

The Tabs: Insert Node is used to insert Tab sheets into a file. The inserted Tab sheet information is saved in the metadata and carried with the job to the next node of the workflow.

This node supports five metadata key-value pairs:

• job:tab.page (Required): The list of pages where insert Tab sheets are added.

• job:tab.text (Required): The list of Tab sheets and their text. The number of job:tab.text items must match the number of Tab pages.

• job:tab.paper.w (Optional): The Paper Width of the Tab sheets.

• job:tab.paper.h (Optional): The Paper Height of the Tab sheets. Paper Width and Paper Height must be set together. If they are not, the Paper Size applied is based on the size of the first page size of the PDF file.

• job:tab.paperweight (Optional): The Paper Weight of the Tab sheets. If the Tab Paper Weight metadata is invalid then the Tabs: Insert Node displays a message in the Activity Log of the workflow and moves the PDF document to the node’s Error folder.

  Notes:

  • This Help file contains detailed information about supported Tab Paper Weights. Refer to Job Ticket Metadata. When launched, the Metadata Browser window displays the pre-defined Job Ticket Metadata, the system-defined variables (such as Date, File, System and User info), and the metadata values from the active node.

  • The Orientation of the Tab Sheet is based on the first page of the merged input PDF. When the first page of the merged input PDF is Portrait, the Tab sheet inserted will be Portrait and the value entered in the Tab Order field is applied. When the first page of the merged input PDF is Landscape, the Tab sheet inserted will be Landscape and the value entered in the Tab Order field is applied._

Using the Tabs: Insert Node

Add the Tabs: Insert Node to the workflow by dragging the node’s icon onto the Workflow Builder canvas, and then double-clicking on the icon to open the Tabs: Insert Node’s window:

Specify the Tab and Text properties in this window. The Preview panel provides a real-time image of how the selected settings will look on the printed version of the document.

• Select the Enabled checkbox so that the process will run. When unchecked, this process is ignored. Documents pass through as if the node were not present (i.e., continue along the default or positive path). Note that a disabled node will not check for logic or error conditions.

• In the Node Name field, enter a meaningful name for the Tabs: Insert Node.

• In the Description field, enter a description for the Tabs: Insert Node. This is not required, but can be helpful with multiple collection points. If the description is long, hover the mouse over the field to read its entire contents.

• Click the Save button to save the changes. If Cancel is selected and the window is closed, the changes are not saved.

• Click the Help button to access online help.

Tab Page Information

Use the Tab Page Information panel to specify the Page Number and Tab Text metadata keys:

• Page Number: Click the Browse for metadata button (), and then drag-and-drop the {job:tab.page} metadata key onto the Page Number field. The metadata key can also be manually entered.

• Tab Text: Click the Browse for metadata button (), and then drag-and-drop the {job:tab.text} metadata key onto the Tab Text field. The metadata key can also be manually entered.

Set the Tabs and the Text Properties

The following sections describe the remaining setting options for the Tabs.

Number of Tabs

Specify the number of Tabs for the document from the drop-down.

Portrait Tab Order

Specify the Tab Order for Tab Sheets using Portrait Orientation.

• Top to Bottom: If the document’s Orientation is Portrait, Tabs are added from top to bottom.
• Bottom to Top: If the document’s Orientation is Portrait, Tabs are added from bottom to top.

Landscape Tab Order

Specify the Tab Order for Tab Sheets using Landscape Orientation.

• Right to Left: If the document’s Orientation is Landscape, Tabs are added from right to left.
• Left to Right: If the document’s Orientation is Landscape, Tabs are added from left to right.

Tab Text

In the Tab Text configuration panel, specify the following:

Note: When a tabbed document is printed, the text that prints in the Tab area, comes from the Chapter Name metadata. If these names contain Japanese characters that the selected Font does not support, the node displays an error message in the Activity Log of the workflow and the file is moved to the Error Folder.

• Font: Choose a font name and size from the drop-downs. Use the first set of icons to specify the jus-tification of the Tab text within the bounding box (left, center, right). Use the second set of icons to specify the alignment of the Tab text within the bounding box (top center, center, bottom center).

• Text Direction: Specify the orientation of the Tab text by choosing an option from the drop-down menu.

• Text Wrap: Select the checkbox to wrap the Tab text.

• Font Color: Click to open a color selection option, and then select a color value.

• Tab Background Color: Click to open a color selection option, and then select a color value.

• Tab Text: A real-time preview of the Tabs: Insert Node’s text.

  Note: The value entered in the Tab Text field displays in the Sample Preview as a visual aid but has no bearing on the output job when the job prints. The actual tab data printed comes from the Tab Text metadata in the PDF file.

Size and Margins

Use this section to specify the Height of the Tabs and the Top and Gap margin values. The Preview updates in real-time to show how the printed document will look.

• Tab Height: Specify the Height of the tab.

• Top: Specify the Top margin value. This is the distance between the top of the document and the first Tab.

• Gap: Specify the Gap margin value. This is the distance between each Tab.

• Auto Size: Select to automatically update the values of Tab Height, Top and Gap when the Number of Tabs value is modified.

  Note: If Tab text is too long to display in the text field, the characters are cut based on the selected horizontal and vertical text alignments.

Restore Default

Use the Restore Default button to restore all the default values of the Tabs: Insert Node.

Tool Bar

The Toolbar is at the top of the window. Use it to customize the Preview.

Tool Bar Icons	Description
	Image icon. Click on this icon to change the sample preview image. Only PNG, JPEG and PDF formats are supported. Supported image display sizes are: A3,A4,A5,B4,B5,Half Letter,Letter,Tabloid.
	Actual Size icon. Click on this icon to revert the preview sample document to its original size.
	Fit to Width icon. Click on this icon to stretch the sample document to fit the width of the Preview area.
	Whole Page icon. Click on this icon and the sample document fills the Preview area.
	Zoom controls. Use either the magnifying glass icons or the sliding bar to zoom in and out of the Preview area.

Sample of a Tabs: Insert Node Workflow

The purpose of this workflow is to receive XML files, parse the job ticket into XML metadata, and then add Tabs to the file based on the chapter information contained in the job ticket. The modified file is then sent to an Output Folder.

Note: This node produces metadata output with key name as “Job”.

A detailed explanation of each node of the workflow follows:

Input Folder Node: Configure the Input Folder to collect job tickets and forward them to the Job Ticket Parser: XML Node. The forwarded job ticket files contain the job ticket attribute information. This order information is used when Tabs are added to the files in the Tabs: Insert Node. Below is a sample job ticket that contains the file order information:

<Ticket>
	<Media>
    	<Width>8.5</Width>
    	<Height>11</Height>
  	</Media>
	<Paper>
		<Unit>inch</Unit>
	</Paper>
  	<Tab>
    	<Width>9</Width>
    	<Height>11</Height>
		<Weight>60</Weight>
    	<ChapterInfo>
      		<Page>
        		<Chapter>1</Chapter>
        		<Chapter>4</Chapter>
      		</Page>
      		<Text>
        		<Chapter>Chapter1</Chapter>
        		<Chapter>Chapter2</Chapter>
     	 	</Text>
    	</ChapterInfo>
  	</Tab>
  	<File>file</File>
  	<Src>C:\\test files\\10Pages_Letter.pdf</Src>
</Ticket>

Job Ticket Parser: XML Node: If the document is formatted as XML, the XML information is converted to job ticket metadata and sent forward in the workflow. If a document is not formatted as XML, that document is moved to the Error Folder.

Use this process to map an XML job ticket:

1. Open a text editor then copy the sample XML code noted is the sample job ticket above.

2. Save locally as XML_Tabs_Insert.XML.

3. Double-click on the Job Ticket Parser: XML Node.The settings screen opens.

4. In the left panel, set the following values:

   • Enabled checkbox: Select to enable the node to accept jobs
   • Node Name: Assign a name value to the node in the text field
   • Measurement unit: Select the radio button that corresponds to the measurement unit required for the node.

   Note: The job ticket referenced above (XML_Tabs_Insert.XML), has Tab paper size in inches.

5. In the Job Ticket Reference panel (far-right), locate the Open icon:

6. Click the icon. On the screen that opens, navigate to and select the file saved in Step 2 above (XML_Tabs_Insert.XML).

7. When the file opens, its contents (or XPaths) display in the Job Ticket Reference panel (far-right).

8. In the Category panel (far-left), click on Basic Settings. The Parameter Name, Metadata Keys, and Job Ticket Paths columns display in the main panel:

9. Values from the Job Ticket Reference panel need to be moved to the Job Tickets Paths column, to the open cell that corresponds to the value’s Parameter Name.

10. Drag-and-drop /Ticket/Media/Width to the Job Ticket Paths cell of the Paper Width row.

11. Drag-and-drop /Ticket/Media/Height to the Job Ticket Paths cell of the Paper Height row.

12. Drag-and-drop /Ticket/Paper/Unit to the Job Ticket Paths cell of the Paper Unit row.

13. In the Category panel (far-left), click on Tab Settings. The Parameter Name, Metadata Keys, and Job Ticket Paths columns display in the main panel:

    

14. Values from the Job Ticket Reference panel need to be moved to the Job Tickets Paths column, to the open cell that corresponds to the value’s Parameter Name.

15. Drag-and-drop /Ticket/Tab/Width to the Job Ticket Paths cell of the Tab Paper Width row.

16. Drag-and-drop /Ticket/Tab/Height to the Job Ticket Paths cell of the Tab Paper Height row.

17. Drag-and-drop /Ticket/Tab/Weight to the Job Ticket Paths cell of the Tab Paper Weight row.

18. Drag-and-drop /Ticket/Tab/ChapterInfo/Text/Chapter to the Job Ticket Paths cell of the Tab Text row.

19. Drag-and-drop /Ticket/Tab/ChapterInfo/Page/Chapter to the Job Ticket Paths cell of the Tab Sheet Page Number row.

20. In the Category panel (far-left), click the Job Download option. The Documentation Source and Job Ticket Path: File Type fields and the Retrieve Print File Option checkboxes display in the main panel:

    

21. In the Retrieve from File Option column, select the checkboxes of all four options: Retrieve from Local Path, Download from URL, Retrieve Encoded base64 from Job Ticket, and Retrieve from Network share.

22. From the Job Ticket Reference panel, drag-and-drop /Ticket/Src to the Documentation Source field.

23. From the Job Ticket Reference panel, drag-and-drop /Ticket/File to the Job Ticket Path: File Type field.

24. Once these actions are completed, the screen will appear as shown in the image above.

25. Click Save to apply the changes to the node.

Tabs: Insert Node: The Tabs: Insert Node will insert Tabs to the PDF document based on the chapter information in XML_Tabs_Insert.XML. Inserted Tab sheet information is added to the metadata, and then the file is sent forward in the workflow. In the job ticket example noted at the beginning of this discussion, page1 and page4 are taken as chapters and at the beginning of each, a Tad Sheet is inserted.

Output Folder Node: The document (which includes its updated Tabs) is placed into the folder path that is configured in the Output Folder Node.