---
title: "Retainers > Retainer Module Setup"
canonical: "https://technology.bytangram.com/space/TGKB/770015250/Retainers%20%3E%20Retainer%20Module%20Setup"
format: markdown
---
In WorkBook, system controls are used to enabled and configure the retainer module. These controls are called variables and are usually setup as part of your WorkBook implementation and, are based on your agencyโs business process.
Company and system variables are found in the **settings **module and are controlled by a system administrator.
> ๐ In WorkBook, there are a number of ways you can setup retainers, depending on the type of retainer and your agency process. This article refers specifically to WorkBookโs retainer module.
| **ON THIS PAGE YOU WILL FIND:** |
| --- |
| > Macro (toc) |
---
## ENABLE THE RETAINER MODULE
To enable the retainer module go to:
- The **settings** module > **global system settings**
- Select **system variables **> **retainer project**
- Here you will see a **list of all system variables** related to the retainer module
- Go to **system variable** **1092** > check the box to **enable retainer project**
- With this enabled, you can now create [retainer projects](https://tangram.atlassian.net/wiki/spaces/TGKB/pages/770179073) globally in WorkBook
---
## COMPANY SETUP
Now that we have enabled retainer projects globally in WorkBook, itโs time to configure the setup at a company level.
To enable the retainer module go to:
- Navigate to the **resources** module > **resource default grid** > select the **company** > open the company **id card**
- Go to **settings** > **invoice settings **> scroll down to **correctional invoice/credit notes on retainers**
- Complete the following details:
- Invoice number start
- Invoice number ending
- Prefix โ A prefix is an affix which is placed before the invoice/credit note number
- Suffix โ A suffix is an affix which is placed after the invoice/credit note number
- Reset interval
- Insert leading zeros up to x digits
> ๐ We recommend setting up a prefix or suffix for delivery job numbers
> ๐ You need to follow this process for every company that will be using the retainer module
---
## ADDITIONAL RETAINER MODULE CONFIGURATION
The other system variables related to the retainer module can be used to add additional configuration around your retainers.
Letโs take a look at the function of each system variable in relation to the retainer module.
| **SYSTEM VARIABLE** | **IMPACT** | **FUNCTIONALITY** |
| --- | --- | --- |
| **1092** | Retainer Project | When checked on, system variable 1092 enables retainer projects. Meaning, you can now create retainer projects against a client and create master and delivery jobs.
> ๐ If this is not enabled, you cannot use the WorkBook retainer module |
| **1115** | Retainer Reporting & Notifications | System variable 1115 triggers a notification to the resource responsible for the retainer project jobs. It allows you to set a percentage of hours used vs hours quoted in which to trigger the notification.
> ๐ If the percentage value is set to 0 then the notification is disabled |
| **1150** | Retainer Price Quotes | When switch on, this system variable disallows further changes to the price quote status once the price has been used to create an offset price quote on the master job.
> ๐ System variable 1058 can apply further restrictions in relation the price quote status (see below for details) |
| **1151** | Retainer Price Quotes | When switched on, this system variable creates an offset retainer price quote at status 40 (internally approved), instead of the default status 50 (externally approved). |
| **1058** | Price Quotes | This variable can be set to disallow further changes to the price quote status once a certain status has been achieved.
> ๐ This variable applies to ALL price quotes in WorkBook, not just retainer price quotes |
> โน๏ธ Go to [https://tangram.atlassian.net/wiki/spaces/TGKB/pages/770179073](https://tangram.atlassian.net/wiki/spaces/TGKB/pages/770179073) to continue your retainer setup
---
> Macro (contentbylabel)