# Edit branch logo

## Edit branch logo

An existing branch record holds the branch information used in company
administration, together with its logo, contact information, address, currency,
margin settings, and modification history. Use this page to update the record,
change or remove its logo, and save the result.

A logo is the image associated with the branch record.

| If you need to… | Go to |
|---|---|
| Open an existing branch | [Find and open the branch](#find-and-open-the-branch) |
| Change or remove the logo | [Add, replace, or remove the logo](#add-replace-or-remove-the-logo) |
| Change branch, address, currency, or contact information | [Branch fields](#branch-fields) and [Save branch and contact changes](#save-branch-and-contact-changes) |
| Review default-margin settings | [Review default-margin settings](#review-default-margin-settings) |
| Read recorded changes | [Review history](#review-history) |
| Create a branch that does not exist yet | [New branch](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-company-branchs-new) |
| Work from the branch list | [Branches](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-company-branchs-view) |
| Continue with the general existing-branch page | [Edit branch](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-company-branchs-edit-record) |

## Before you start

The edit page works on a saved branch record. The branch must already exist, and
the page must load the branch together with an included subscription before the
record form and its lower review areas are available.

**Prerequisites**

- Have the branch you need to change already saved.
- Have a subscription included for the page to display the branch body.
- Have the branch identifier available through the branch record before using the
  lower tabs.
- Have the branch information, contact values, address values, currency choices,
  and logo file you intend to use.

Open the branch from the **Branches** list to work on an existing record. The branch
form requires both an included subscription and a branch; the lower tabs require
the branch identifier.

## Find and open the branch

The **Branches** page is the list used to select an existing branch before you
edit its record.

**Prerequisites**

- Have a saved branch to open.

**Steps**

1. Open **Configurations**.
2. Open **Company**.
3. Select **Branches**.
4. In the branch list, select the row for the branch you want to edit.
5. Select the row's edit link to open the existing-branch record.

The **Branches** list uses **Branch Name**, **Country**, and **Mail**. Its available
list actions include **New**, **Branches**, **Refresh**, **Table Layout**, and
**Settings**. Select the edit link in the row for the branch you need.

![Select the branch row from the Branches list before opening its edit record.](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/27801caf413f79f12c9395eac4020bad.png)

**Result:** The selected branch's edit record is open.

With the record open, first identify the fields and conditional areas, then make
the required branch or logo changes.

## Understand the branch screen

The branch screen is a form for one existing branch. Its upper area contains the
main branch information and the logo actions; its lower area contains contact
information and saved-record review tabs. The screen has 29 controls, two
containers, one validation group, and 40 actions. Work from form fields and tabs;
this screen does not present a data grid.

| Area | What to use it for |
|---|---|
| Branch information form | Maintain identity, company, tax, financial-year, currency, and address values. |
| Logo actions | Upload a logo or remove the current logo when the corresponding branch value exists. |
| **Contact Information** | Maintain the branch's repeated contact values. |
| **Default** tab | Review the saved branch's default-margin area. |
| **Last Modifications** tab | Read the branch's recorded changes. |
| **Save** | Save the changed record and remain on the record. |
| **Save and Close** | Save the changed record and return to the previous location. |

The lower review tabs appear for a saved branch with the branch identifier. The tabs
are **Default** and **Last Modifications**.

Use the field reference before moving to the conditional areas below it.

### Branch fields

Branch fields identify the branch and supply the company, tax, financial-year,
currency, and address information used by the record.

| Group | Field | Rule or option source |
|---|---|---|
| Identity | **Display Name** | Required only when the value is empty and the configuration makes it applicable. |
| Identity | **Full Name** | No required rule is named. |
| Identity | **Statement** | No required rule is named. |
| Company | **Managing Director** | No required rule is named. |
| Company | **Company Registration No.** | No required rule is named. |
| Tax | **VAT ID Number** | No required rule is named. |
| Tax | **VatRate** | Accepts values from `0` through `100`. |
| Financial year | **Financial Year Start** | The day and month are configurable when empty. |
| Currency | **Reference Currency** | Required; disabled when jobs exist. Options come from the returned company-currency records and display `Name` while storing `CurrencyCode`. |
| Currency | **Local currency** | Required. Options come from the returned company-currency records and display `Name` while storing `CurrencyCode`. |
| Address | **Street** | Appears when the branch has an address. |
| Address | **Zip Code** | Appears when the branch has an address. |
| Address | **Country** | Appears when the branch has an address. Options display `Name` and store `CountryCode`. |
| Address | **State** | Appears when the branch has an address. |
| Address | **City** | Appears when the branch has an address. |

For **Financial Year Start**, the day choices are `1` through `31`.

| Month choices |
|---|
| **January**, **February**, **March**, **April** |
| **May**, **June**, **July**, **August** |
| **September**, **October**, **November**, **December** |

### Tabs and conditional areas

The lower areas appear according to the saved branch and its values. The
**Default** tab is the default-margin review area, and **Last Modifications** is
the history area. Address fields require `branch.Address`; contact rows repeat
from `branch.ContactInfoList`.

| Area | When it appears |
|---|---|
| Address fields | When the branch has `Address`. |
| Contact rows | For the values in `ContactInfoList`. |
| Default-margin number box | For the fixed-percentage margin type. |
| Degressive margin area | For accumulative or decreased-percentage margin types. |
| Saved-record tabs | When the branch has the branch identifier and the page body has a branch with an included subscription. |

The active saved-record tab is **Default** for the default-margin area or **Last
Modifications** for the history area.

After checking which areas are present, continue to maintain the logo and branch
values.

## Maintain the logo and branch changes

Maintain the logo from the record context while updating branch values, so both
changes apply to the same branch.

**Prerequisites**

- Have the existing branch open.
- Have an image file ready if you are adding or replacing the logo.

**Steps**

1. Enter the branch values you need to change in the main form.
2. Choose one logo operation in [Add, replace, or remove the logo](#add-replace-or-remove-the-logo).

> **Note:** The **Upload Logo** surface accepts one image file. It provides **Attach** and
> **Browse** for the file choice. The delete action is available only when the branch has a
> logo identifier.

**Result:** The branch values remain in the open record, and the selected logo
operation is ready to complete or has completed.

Use the operation table below when you need a specific add, replace, or remove
path.

### Add, replace, or remove the logo

Use the logo operation that matches the state of the branch: attach an image to
add a logo, attach another image to replace the current one, or confirm deletion
to remove it.

**Prerequisites**

- Have the branch edit record open.
- Have one image file ready for an add or replace operation.

| If you need to… | Use this operation |
|---|---|
| Add a logo to a branch without one | In the logo area, select the control that opens the upload surface, then use **Attach** and **Browse** to choose one image file. |
| Replace the current logo | In the logo area, select the control that opens the upload surface, then attach the replacement image as one file. |
| Remove the current logo | Select the control immediately beside the current logo to open the removal confirmation. |

**Steps**

1. Choose one operation:

   | If you need to… | Do this |
   |---|---|
   | Add or replace the logo | In the logo area, select the control that opens the upload surface. |
   | Remove the logo | In the logo area, select **Delete item**. |

2. If you are adding or replacing the logo, select **Attach**.
3. If you are adding or replacing the logo, select **Browse**.
4. If you are adding or replacing the logo, choose one image file.
5. If you are removing the logo, read `Are you sure you want to delete this item?`.
6. If you are removing the logo, select **Yes** to confirm the removal.
7. If you are cancelling the removal, select **No**.

For a confirmed removal, the logo is removed and `Logo Deleted Successfully` appears.
Cancelling with **No** leaves the logo in place.

**Result:** The branch has the attached image, retains its existing logo, or has
the logo removed after the confirmation choice.

After the logo operation, continue to save the branch and contact changes.

### Save branch and contact changes

Saving commits the changed branch record, including branch fields, address,
currency, and contact information. The contact choices are **Phone**, **Fax**,
**Mobile**, **Email**, **Website**, and **Online Support**; phone, fax, and mobile
values have a maximum length of 20.

**Prerequisites**

- Complete the branch changes you want to keep.
- Resolve any logo confirmation before saving.

| If you need to… | Select |
|---|---|
| Save and continue working on this record | **Save** |
| Save and leave the record | **Save and Close** |

**Steps**

1. Select **Save** to remain on the branch record or **Save and Close** to leave it.
2. Read `Branch saved Successfully`.

**Result:** **Save** keeps you on the record. **Save and Close** returns you to
the previous location after the branch changes are saved.

After saving, review the **Default** margin area or **Last Modifications** history
as needed.

## Review the margin and history branches

The saved branch record has two review routes: **Default** for default-margin
settings and **Last Modifications** for recorded changes. Both routes belong to
the saved branch and are available through the lower tabs when the branch has
the branch identifier.

The saved-record tabs are **Default** and **Last Modifications**. A **Registration**
tab is declared in the source but is not available as a branch review area.

### Review default-margin settings

Default-margin settings describe the margin method used as the branch's default.
Select the margin type to see the controls associated with that method.

**Prerequisites**

- Have the branch saved.
- Open the **Default** tab.

| Margin type | Area available |
|---|---|
| **Fixed Percentage** | A default-margin number box. |
| **Descending Absolute** | The degressive margin area. |
| **Descending Accumulative** | The degressive margin area. |

The nominal commission and nominal margin controls are not part of the available
area. A cumulative-margin currency choice is also not part of the available area.

**Steps**

1. Select the margin type you need to review.
2. Read the number box for **Fixed Percentage**, or read the degressive margin
   area for **Descending Absolute** or **Descending Accumulative**.

**Result:** The default-margin controls for the selected margin type are visible.

Return to the review-area section to inspect the saved history when that is the
next task.

### Review history

History is the branch's recorded modification view. Open **Last Modifications**
to review the available audit-log entries and filters, then return to **Default**
when you need the margin area.

**Prerequisites**

- Have the branch saved with its branch identifier.

**Steps**

1. Select **Last Modifications**.
2. Read the audit-log entries and use the available audit-log filters.
3. Select **Default** to return to the default-margin area.

**Result:** The branch's Last Modifications history is open, or the default-margin
area is open again.

If a save or review action produces a message, use the correction table that
follows.

## Resolve validation and action failures

Use the message on screen to choose the correction. The table maps each message
to the next action. When default-margin data is saved, the message
`Data saved Successfully` appears.

| Message | Action |
|---|---|
| `Name is required` | Enter the required name value in **Display Name** and save again. |
| `Just '_' '-' And '.' Characters Accepted` | Correct the name so it uses the accepted characters, then save again. |
| `Please insert degressive margin list` | Add the required degressive margin list before saving the margin settings. |
| `Error: Server Error` | Check the branch values and repeat the action. |
| `Error while saving data  ` | Review the form and repeat **Save** or **Save and Close**. |
| `Branch saved Successfully` | Continue on the record after **Save**, or leave after **Save and Close**. |
| `Data saved Successfully` | Continue from the saved default-margin area. |

`Name is required` is the required-name validation message. The character message
is the corresponding accepted-character validation message. The degressive-margin
message appears when the required margin list is missing.

## Out of scope

`Branch does not exist` applies when the selected branch is missing, rather than to
the editing actions on this existing-branch page. Return to the branch list and open
an existing branch record when this message appears.

## Continue after branch editing

After saving, the branch record contains the changes you kept. **Save** leaves you
on the record for further review. **Save and Close** returns you to the previous
location. From there, continue with [Branches](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-company-branchs-view),
open [New branch](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-company-branchs-new) when a new branch is needed,
or use [Edit branch](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-company-branchs-edit-record) for the general
existing-branch editing task.
