Installation & Configuration
| Site: | CIB eLearning |
| Course: | CIB fairBrief |
| Book: | Installation & Configuration |
| Printed by: | Guest user |
| Date: | Thursday, 5 June 2025, 4:49 AM |
1. Installation
CIB fairBrief is a component or add-on of CIB pdf brewer. You can get the latest version here: https://pdfbrewer.cib.de/#en
After installing CIB pdf brewer, you will have access to it with a simple right click on PDF documents. It can also be configured to activate CIB fairBrief automatically after document creation.
Settings can be seen here: https://elearning.cib.de/mod/page/view.php?id=108&lang=en. It is a JSON file with different entries to be tuned. Settings, as explained in the link, are stored in the user's application data folder.
Settings can also be configured during installation, so a template configuration is installed. This template configuration, if present, is the one used as base the first time each user executes CIB fairBrief. To provide a default configuration file, you can use the setup parameter /FairbrieftConfiguration=file.conf, you can read more information about setup parameters here: https://elearning.cib.de/mod/page/view.php?id=40&lang=en
2. Configuration
The user configuration file is located in %APPDATA%\CIB software GmbH\CIB fairbrieft client\ and named fairBrieftClient.settings.This JSON file is loaded at program's
start-up and any modification made during program execution will be overwritten at program's shutdown.
Configuration keys:
| Key | Type | Default | Comment |
|---|---|---|---|
| Username | string |
User name. | |
| Password |
string | User's password. You can enter manually a plain text password, which will be encrypted on next program's execution. |
|
| Remember | bool |
true | Keep user logged in on next restart. |
| Color | bool |
true | Default value for print job's color. |
| PartialDocumentAlignment | bool |
true | If enabled and if the document in the client has the duplex setting enabled, it will add an empty page if document was merged on an uneven page. |
| Duplex | bool |
true | Default value for print job's duplex. |
| Grammage | string |
G80 | Enumeration of possible grammages: G80, G100, G120, G140, G160. Currently locked to G80. |
| Envelope | string |
Automatic | Enumeration of possible envelopes: Automatic, C4, C6. |
| Certified | string | NONE | Enumeration of options to send the letter: NONE, THROW_IN |
| ExtendedTraces | bool |
false | If enabled, extra information of client-server transactions will be recorded on additional logs. Avoid its usage in production environments! It is inteded for development/complex debugging. |
| BaseURL | string |
https://fairbrieft-backend.cib.de/fairbrieft/ | Base URL of the CIB fairBrief server. If empty, the default value will be used instead. |
| CheckMask | string |
Local CheckMask of letters (see CIB pdf toolbox). |
|
| Threads | int |
4 | Concurrent server requests limiter. It also throttles down threading in the client UI. |
| Language | string |
de | Two letter ISO code, currently implemented: de, en, es. |
| IgnoreBrewerLanguage | bool |
false | By default, CIB pdf brewer's language will be used in the CIB fairBrief client. |
| UseBrewerPrintSettings | bool |
false | If enabled Simplex/Duplex settings of the print job will be forwarded to CIB fairBrief. |
| ProxyProtocol | string |
HTTP | Enumeration of the proxy protocol: HTTP, HTTPS, HTTP_1_0, SOCKS4, SOCKS4A, SOCKS5, SOCKS5_HOSTNAME. |
| ProxyHost | string |
If this value is set, the proxy settings will be used for new connections. |
|
| ProxyPort | int |
8080 | Port of the proxy server. |
| ProxyUserName | string |
User name of the proxy. |
|
| ProxyPassword | string |
Password of the proxy account. It can be written manually as a plain text password, on next use it will be encrypted. |
|
| EndAttachments | array |
Array of strings. Letter's complement, appended at the end of the letter, that will be shown in the UI. This settings holds memory of the last 5 documents used for this purpose. |
|
| Locked | object | Parameters to lock certain settings in the interface for users. Example: "Locked" : { "Duplex" : false, "Certified": "NONE" } |