Docbox File Agent Configuration

Once the Docbox File Agent (DFA) has been installed, it needs to be configured before it can send anything to Docbox.

This article walks through the quickest way to get DFA running, using the most common setup: a Docbox printer destination and a local folder source. If you need a different setup, such as sending to a local folder or monitoring a remote folder over SFTP, each section links to the full reference article.

There are three steps, and they must be done in this order:

  1. Create and add Docbox Token
  2. Create a Destination
  3. Create a Source

You can now send output to Docbox using DFA

Docbox Token

A token is used to allow DFA to access Docbox printers. This token is created by a Docbox user via the Docbox Dashboard. DFA will then be able to use all the printers that the user has access to.

The token gives DFA access to every printer the account that created it can use. Rather than generating the token against an individual user's account, we recommend creating a dedicated service account in Docbox for this purpose. That way, DFA's access doesn't depend on one person's account remaining active, and printer access can be managed independently of any individual's role changes or departure.

 

 

  1. Log into the Docbox Dashboard application (not the Docbox print driver), and navigate to the User Tokens screen (My Docbox > User Tokens).
  2. Click “Add New User Token”
  3. Enter a Token Name and select FileAgent from the Client dropdown. 
  4. Click Generate Token.
  5. Click Copy Token.The token value is only shown once, so copy it now - you'll need it in step 8.
  6. Log in to DFA as an admin user and navigate to Control Panel > Tokens.
  7. Click New Token.
  8. Enter a Name, paste in the Docbox URL (usually https://{your-docbox-domain}/api/v1), and paste the token value.
  9. Click Save

DFA will now be able to use all the printers that the user who created the token has access to.

See Tokens for the full field reference, how to check which printers a token can reach, and how to replace or delete a token.

Destination

The destination is where DFA is going to send the output. This is typically a Docbox printer.

DFA doesn't connect to Docbox printers directly - it connects via the token you've just added. When you create the destination below, the Printer dropdown lists every printer reachable through that token, shown as Token Name : Printer Name.

  1. Within File Agent, navigate to the Destinations screen. (Control Panel > Destinations)
  2. Click New Destination
  3. Enter a name.
  4. Select Docbox as the destination type.
  5. Select the printer from the dropdown.
  6. Click Save.

See Destination Details for more information or if you want to use a local folder.

Source

A source is the folder DFA monitors for files to send to Docbox. A source can't be created until its destination exists, since every source must point to one - that's why the order matters here.

Sources are typically local folders. See Source Details for more information.

  1. Within Docbox File Agent, navigate to the Sources window. (Control Panel > Sources)
  2. Click New Source
  3. Enter a name.
  4. Set the type to Local Folder.
  5. Enter the path to the folder to be monitored.
  6. Set the destination to the one you created above.
  7. Choose a sent action
    1. Archive – keeps copies of sent files in archive folder within the source folder 
    2. Delete – deletes the files once sent
  8. Set the failure threshold – once reached, the pipeline stalls and no further files are processed until investigated
  9. Set the poll interval (minimum 15 seconds)
  10. Tick Archive Failures if you want failed files archived rather than left in place
  11. Tick Reject duplicates? if you want to reject files with content matching a previously sent file
  12. Tick Active? to enable the source
  13. Click Save.

 

Docbox File Agent is now configured and output deposited in the source folders will be sent to the destination printer in Docbox for processing.