Credentials store the connection details that Docbox uses to deliver print jobs to an output channel. Each credentials record is assigned to one or more printers — without valid credentials, Docbox cannot send jobs for production. You can manage credentials via Control Panel > Credentials.
The Administrator and Control Panel roles can view credentials. Only Administrators can create or modify them.
Your credentials will be provided by CFH. You will be told which type to select and what values to enter.
Caution
Incorrect credentials will prevent jobs from being sent. Do not change existing credentials without first checking with CFH.
Refer to Docbox Help Centre for information on the common layout of this page.
What are credentials and why do they matter?
Credentials store the connection details that Docbox needs to send completed print batches to your output channel - either the Docmail API or CFH Managed (via SFTP or HSCN) - for fulfilment.
Credentials are assigned to printers, and it is the printer definition that determines which credentials are used when a batch is ready to send. If the credentials assigned to a printer are incorrect or incomplete, batches cannot be transmitted and jobs will not reach CFH. Changes to existing credentials affect every printer they are assigned to, so check your printer assignments before making any amendments.
All connection details are provided by CFH. If you are unsure about any values, contact CFH Support before making changes.
Adding New Credentials
Click Add New Credentials in the bottom left of the panel. The form will open on the right with the title New Credentials.
Select the Type first — the form will update to show the relevant fields for that connection type.
Type:Docmail
| Field | Description |
|---|---|
| Type | Select Docmail from the dropdown. Files will be sent to Docmail for printing. |
| Connection URL | The address of the Docmail API endpoint. This will be provided by CFH. |
| Description | A short description to help identify this record — for example, Production Docmail or UAT Docmail. |
| Username | The username for your Docmail account. Provided by CFH. |
| Password | The password for your Docmail account. Provided by CFH. Click Show to reveal the value if needed. |
Type: SFTP
| Field | Description |
|---|---|
| Type | Select SFTP from the dropdown. Files will be sent to CFH Managed for processing. |
| Connection URL | The address of the SFTP server. This will be provided by CFH. |
| Description | A short description to help identify this record. |
| Username | The username for the SFTP connection. |
| Password | The password for the SFTP connection. Only required if your SFTP private key is passphrase-protected — enter the passphrase here. Click Show to reveal the value if needed. |
| SFTP Settings | |
| SFTP Private Key Filename | The RSA private key used to authenticate with the SFTP server. Paste the full key in PEM format, including the -----BEGIN CERTIFICATE----- header and footer lines. |
| SFTP Transfer path | The folder path on the SFTP server where Docbox will deposit files. |
| SFTP Tracking Codes path | The folder path on the SFTP server where tracking code files will be deposited. |
Saving and Testing
Once you have entered the credentials, click Save & Test. Docbox will save the record and immediately attempt to connect to the output channel to verify the details are correct.
A notification will confirm whether the test was successful. If the test fails, check each field carefully against the details you have been provided. Common causes of failure are a typo in the Connection URL, an incorrect username or password, or an SFTP private key that has been copied incompletely.
If you cannot resolve a test failure, contact CFH support. (Contact Us)
Tip
Always use Save & Test rather than Save alone when setting up credentials for the first time. It is much easier to resolve a connection problem now than when a printer goes live and jobs start failing.