====== Steps to Fill in the Branches Table (Complete Guide) ======

This guide provides a step-by-step approach to correctly fill the **Branches** table. This table stores detailed information about each branch associated with a client, including branch names, unique codes, and logos.

The table is critical for maintaining **multi-branch environments**, where each client may have multiple branches, each with its own branding, location, and invitation settings.

For a complete description of the table structure and field explanations, please refer to the → [[fw_branches|Branches Table Structure]]


==== 1. Add the ID (id) ====
This is the **primary key** (auto-incremented) for the table.\
**Do not manually enter** this value if inserting data directly via the database.\
It is automatically generated.


==== 2. Enter the Client ID (clientid) ====
The **clientid** column is a **foreign key** reference that links the branch to a client. This ensures that each branch belongs to a particular client.

**How to find the clientid:**
- Navigate to the **fw_clients** table.
- Find the **id** of the client that owns this branch.
- Enter that **id** in the **clientid** column.

**Example:**  
clientid = 1   (Refers to 'People Pulse')


==== 3. Enter the Branch Name (branchname) ====
This column captures the **name of the branch**. This name will appear in:
- Email invitations (if customized per branch)
- Dashboard overviews
- Reports (if configured)

**Example:**  
branchname = "Zevenaar-Didam"


==== 4. Set the Branch Code (branchcode) ====
The **branchcode** is a unique identifier for the branch. This must be:
- **Unique across all branches** within the system.
- Used as a key to distinguish branches during survey distribution.

**Example:**  
branchcode = "3464"

✅ **Important:**
- If you encounter a duplicate entry error, ensure that the branchcode does not already exist.


==== 5. Enter the Location (location) ====
This column captures the **physical location** of the branch. It is optional and can be left blank if the location is irrelevant.

**Example:**  
location = "Arnhem, Netherlands"


==== 6. Enter the Website (website) ====
If the branch has its own website, enter the URL here. This URL can appear in email invitations or reports.

**Example:**  
website = "https://zevenaardidam.nl"

✅ **Optional:** If no website exists, leave this field **NULL**.


==== 7. Upload the Questionnaire Logo (questionnairelogo) ====
The **questionnairelogo** is the logo displayed in the questionnaire interface for this branch.\\
If no branch-level logo is provided, the **clientlogo** from the **fw_clients** table will be used.

**Logo Requirements:**  
  -  **Size:** 110x100 pixels  
  -  **Format:** PNG, JPG  

**File Upload Location:**  
questionnairelogo = Upload File (Binary Data/BLOB)


==== 8. Upload the Invitation Header (invitationheader) ====
The **invitationheader** appears in email invitations if it differs from the client's main logo.\
If no header is uploaded, the **client's header** will be used.

**Logo Requirements:**  
  - **Size:** 120x32 pixels  
  - **Format:** PNG, JPG  

**File Upload Location:**  
invitationheader = Upload File (Binary Data/BLOB)


==== 9. Example: Final Record ====
Here’s an example of a complete record for a single branch:

| id | clientid | branchname     | branchcode   | location         | website                    | questionnairelogo | invitationheader |
| 3  | 1        | Zevenaar-Didam  | 3464   |  |  |           |        |
| 5      | 1           | Swietelsky                | 3                        |             |            |                |                |  

==== Relationships ====  
  * **clientid** → References **fw_clients** table (Each branch belongs to one client).  
   

==== ✅ Notes ====
  * **branchcode** → Must be **unique** across all branches.
  * If the branch doesn’t have a logo, the system will use the **client's logo**.
  * Avoid uploading large-sized images; adhere to the recommended dimensions.
  * Leaving the website or location blank is acceptable.