FabSoft Universal Printer Driver

From FabSoft
Jump to: navigation, search

Description

This printer driver will allow a user to quickly identify documents by mapping, classifying, and routing them automatically in minutes. Once the quick learning is completed, the next time the document is printed to this special driver it will automatically follow the learned process.

Requirements

The FabSoft Universal Printer Driver is compatible on the following operating systems.

Windows workstations Windows 8 / 10
Windows servers Windows Server 2012 / 2016 / 2019

Installation

The latest download can be found on the product page. [Click Here]

Tutorial

After the FabSoft Universal Printer Driver is installed, you can create a new workflow by printing any document to it.

  1. Open the document you wish to print. For this tutorial, we'll be using Sample.rtf in Wordpad.
  2. Print the document to the FabSoft Universal Printer.
  3. You will be prompted to begin the quick learning process.
    • The quick learning process is a step by step guide which allows you to configure your workflow. You will first be asked to select a workflow type, using the Workflow Selection.
  4. For this tutorial, we'll want to select XML, then click Select.
  5. You will be prompted to enter a workflow description. We'll enter Demo Workflow as our description, then click Ok.
  6. You will now be prompted to enter different workflow properties.
  7. Click the gear icon 2019-09-09 11-34-22.png next to Document Identifier.
  8. Click Select a Field from the Document as the Key.
  9. The next screen will show you a text only version of the printed document. Click and hold to create a box around the text Quotation For. When the box around the text turns green, that means the text has been properly selected. This will be the text we use to identify this type of document. This means that any documents which are printed to the FabSoft Universal Printer which contain the words "Quotation For" in that area will run through this workflow.
  10. Click the gear icon 2019-09-09 11-34-22.png next to Output File Type, then select Create a PDF document.
  11. You can change the PDF options as needed, but for this tutorial we will keep the defaults. Click Select to continue.
  12. Click the gear icon 2019-09-09 11-34-22.png next to Directory. Make sure Single Value (Default) is selected, then click Ok.
    Note: The other option, "Concatenate Values" allows you to combine different things to generate both the output directory and the file name. For this tutorial, we will stick with "Single Value".
  13. Select an output directory where the PDF files will be stored. For the tutorial, we'll use C:\tmp\.
  14. Click the gear icon 2019-09-09 11-34-22.png next to File Name.
  15. Make sure Single Value (Default) is selected, then click Ok.
  16. You are given several options for setting the file name (Static Text, Dynamic Value, Document Text). For this tutorial, we'll use Document Text. This will allow you to select data from the document to use as the file name. Click the Select a Field from the Document button under Document Text to continue.
  17. The next screen will show you a text only version of the printed document. Here, you can select text that will be used for the PDF file name. For this tutorial, we'll draw a box around the quote number. Once you have selected the text, click Finish.
    Vmconnect 2019-09-10 09-44-39.png
  18. The workflow at this moment will create a PDF and XML document next to each other in the location specified. The XML file will contain the document path (as this is most commonly needed). To add additional information about the document into the XML file, click the Add Field near the top of the window.
  19. For this tutorial, we'll add the company name as an additional field in the XML file. Name this new field CompanyName, then click Ok.
  20. Click the Select a Field from the Document button under "Document Text" to continue.
  21. Draw a box around the company name "XYZ Corporation". When the box around the text turns green, that means the text has been properly selected. Click 'Select.
    Vmconnect 2019-09-18 14-15-03.png
  22. You can add as many additional fields as you'd like. Once you finished, click Finish.


The workflow setup is now complete, and the original document will have now been processed through the FabSoft Universal Printer driver. In the tutorial, we designated C:\tmp\ as our output folder. Navigating to that directory, we can see both our PDF and XML files have been created and named after the Quote # like we specified.

Vmconnect 2019-09-18 14-58-35.png

Inside the XML file, there is standard XML boilerplate, along with a "Document" field. This field contains the folder path of the corresponding PDF file. Additionally, there is also the CompanyName field we added during the workflow configuration, containing the value "XYZ Corporation".

<?xml version="1.0" encoding="utf-16"?>
<Document Path="C:\tmp\78456.pdf" Folder="C:\tmp\" Name="78456.pdf">
  <Field Name="CompanyName" Value="XYZ Corporation" />
</Document>

Export / Import a Workflow

Exporting a workflow allows it to become portable. You can copy the workflow file to another computer, or you can use it as backup and re-import the workflow on the same computer if needed. The exported workflow file contains all necessary information needed to re-create that workflow.

To export a workflow:

  1. Click on the FabSoft Universal Printer system tray icon Vmconnect 2019-09-18 16-40-42.png.
  2. Move the mouse over Workflows, then click Export Workflow.
  3. Select a worklow to export, then click Select.
  4. Choose a location to export the workflow to, then click Save.

To import a workflow:

  1. Click on the FabSoft Universal Printer system tray icon Vmconnect 2019-09-18 16-40-42.png.
  2. Move the mouse over Workflows, then click Import Workflow.
  3. Select a worklow file you want to import, then click Select.
  4. You will be asked if you want to import the workflow, click Yes.

Workflow Selection

The workflow selection window will show you all available workflow types.

Vmconnect 2019-05-09 16-50-32.png

You will need to select one of the workflow types to continue the quick learning process.

  • Load an existing workflow
    • If you already have a workflow and want to apply it to the print job.
  • PDF / Image Only
    • If you only need either a PDF or an image file, with no other processes or metadata files.
  • Print Only
    • If you only require a routed print job, with no other processes or metadata files.
  • FabSoft Reform Archive
  • Reform Spooler file (FCL)
    • You can send data from the print driver to a Reform VDP workflow using this.
  • Meta data file formats
    • These files are generally output alongside a PDF or TIFF image, and contain various pieces of information about the print job.
      • XML
      • CSV
      • JSON
      • Square9

Loading Existing Workflows

Workflow Configuration

Vmconnect 2019-05-09 16-57-15.png

Field Types

UPD-Field List.png

  • Document Identifier
    This field is responsible for determining how a print job is routed to a workflow. There are two available methods for identifying documents:
    Job Title
    The name of title/name of the print job will be used for identifying a workflow. Any time the print job title matches, it will trigger the workflow.
    Document Text
    The contents of the print job will determine which workflow to use. This allows you select an area of the printed page as the field's value. Each time a print job is submitted, the value will change based on the print job's contents.
  • Output File Type
    This field is used to select one of the following output file types:
    • TIFF
    • PDF (vector)
    • PDF (raster)
    • XPS
  • Directory
    This field is used to select where the output file(s) will be saved to. You can select a single/unchanging folder, or you can use the advanced options to have a dynamic output path.
    When using the advanced (concatenate) option, you can select the output folder using the following one or more of the following choices:
    Dynamic Value
    Dynamic variables are based on the print job's properties (job title, user, computer name, date, etc.).
    Document Text
    This allows you to select an area of the printed page as the field's value. Each time a print job is submitted, the value will change based on the print job's contents.
    Static Text
    Static text is used when you would like to manually enter the desired value. The value will never change based on the print job's contents or properties.
  • File Name
    This field manages the name of the output file. Similar to the Directory field, you can select between Dynamic Value, Document Text, or Static Text. Values may also be concatenated using the advanced option.
  • Overwrite existing files
    This field manages how to save files in a directory where the filename already exists. If the field value is YES, then the workflow will overwrite existing files. If the value is NO, then a number will be appended to the output file name to ensure it does not overwrite any existing file.
  • Break Field
    If you need the print job to be separated and saved into multiple files, you can add a break field. This field allows you select an area of the printed page to use as a break field. If the value of the break field changes on one page from the next, the document will be split at that point. For example, you may want to place a break field over an invoice number to split invoices into separate PDF files.
  • Printer
    If you need the print job to be separated and saved into multiple files, you can add a break field. This field allows you select an area of the printed page to use as a break field. If the value of the break field changes on one page from the next, the document will be split at that point. For example, you may want to place a break field over an invoice number to split invoices into separate PDF files.

Selection Types

When configuring a workflow, you will be prompted to choose between Static Text, Dynamic Value, and Document Text. Each of these behave very differently and have different use cases.

UPD-Selection Type.png

Static Text

Static text is used when you would like to manually enter the desired value. The value will never change based on the print job's contents or properties.

  • An example would be a folder path that you do not want to change, such as C:\Invoices\. Every time the workflow is processed, that same value will be used.
UPD-Static Dialog.png

Dynamic Variables

Use properties from the print job, such as the username of the print job owner, the date/time of the job, machine host name, etc.

  • Dynamic values are useful when you want to use a value that is not in the print data, and can change between each print job.
UPD-Dynamic Variables Dialog.png

Document Text Selection

  • Select an area on the document which you want to pull data from. Each time a print job is submitted, the value will change based on the print job's contents.
UPD-Document Text Section Dialog.png


Document Text Selection Tips

Single vs Concatenated Fields

UPD-SingleVsConcatenated Fields Dialog.png

Concatenating Multiple Fields

UPD-Concatenating Multiple Fields Dialog.png

Document Key

Vmconnect 2019-05-09 17-00-33.png

Adding Fields

UPD-SingleVsConcatenated Fields Dialog.png

Workflow Properties

Workflow Property Modifiers

Configuring Workflow Property Modifiers

Removing Fields

UPD-Remove Field.png

Resetting Fields

UPD-Reset Fields.png

API

The FabSoft Universal Printer Driver (UPD) allows plugins to control how documents are delivered. In addition to providing the ability to intelligently route the document, methods are available to prompt the user for details, retrieve data from back-end systems, and update statuses repeatedly. Combining these features provide a user-friendly experience that is capable of simplifying complex tasks with great accuracy. API documentation and samples can be found at: [FabSoft UPD API]