Branches page
Estimated reading time:
The branches page is where the admin manages the branches, such as adding branch, deleting a branch, editing a branch, or viewing the branch information.
The branch is a part of an organization or a company, in which it will represent this organization or company for that point of place.
Page will contain the following:
1-Add new branch button:
the admin presses this button to add a new branch, a form will pop up for the admin to enter the new branch information, such as name, location, branch admins, and the branch devices.- Form pages links: this links can transfer the admin from a page of the form to another page, it could be used in terms of editing or changing some pre-entered information.
- Name of the branch field: in this field the admin enters the desired name of the branch, the branch name is required information and it should be unique (not duplicated with other branch name).
- Location map: the admin will need to pin the location of the new branch since that it's a required information for adding a new branch.
- Next and previous buttons: these buttons are used to travel between the pages of the branch adding form.
- Email field: here we enter the email of the branch admin, the branch admin needs to be added with the branch.
- Username field: this is where the system admin enters the username for the branch admin, this username must be unique.
- Branch admins list: this list will contain the added branch admins, so that the system admin knows how many admin he added.
- Add device check box: the admin checks this field in case he wanted to add a device for the branch.u00a0
- Device key field: the admin needs to enter the device key here, the device key is a unique identifier for the device each device and cannot be duplicated.
- Add button: this button will add the device to the list below, the admin can add devices as many as he wants, as long as they don't have the same key.
- Devices list: this list will contain the added devices information, so that the admin know what has been added and what's not.
- Finish button: by pressing this button the admin is committing on adding this branch with its admins and devices, the branch information will be added to the database and will be viewed from the list of the branch.
Add button: by pressing this button, the system will add the branch admin to the list below to show the number of branch admins that has been added yet.
Device status radio buttons: here the admin sets the status of the added device, it could be enabled, or disabled depending on the needs of the branch.
2-Show all branches in map button:
the admin can view all of the branches locations on the map together using this button, after pressing it, the map will pop up and it will show the location of each branch as pins on the map.
3-Number of branches drop down list:
you can control the number of branches viewed in the list using this drop down list, the default number of branches viewed will be 5 branches per page.
4-Search bar:
the admin can use this search bar to get to a particular branch he wants to view, the search helps if there were many branch added to the system.5- Branches export file:
these are the export options that the admin can use to take the data of the branchesu00a0in the table.6-Branches list:
this is the list where the branches and there information are viewed.7-Number of admins:
this number is the number of admins for the branch, the number is clickable, by clicking on the number a pop up form will display for the user, this form can be used to manage the admins of the branch.The branch admins form will contain the following:
- Number of admins drop down list: you can control the number of admins viewed in the list using this drop down list.
- Search bar: the admin can use this search bar to get to a particular admin he wants to view, the search helps if there were many admins added to this branch.
- Admins export file: these are the export options that the admin can use to take the data of the admins in the table.u00a0
- Branch admins list: this is the list where the branch admins and there information are viewed.
- Resend activation link: this link is to resend an activation link to the selected branch admin in case the admin couldnu2019t find the activation link from the first time.
- Branch admin edit button: this button will display a form with the admin information, this form allows you to edit the email and the status of this branch admin.
The branch admin edit form will contain the following:
- Email field: this field will show the selected branch admin email, this email will be editable by the system admin, and after changing this email an email message will be sent to the branch admin's email to confirm it.
- Status radio button: the admin can use these radio button to enable and disable this selected branch admin's account.
- Back button: this button will get you back to the branch admins page without saving any of the edited information.u00a0
- 4-Reset password button: the admin can use this button in case the branch admin forgot his account password, after pressing it an email will be sent to the branch admin's email that will contain a link, this link will transfer the him to a form for resetting the password.
- Update button: in case of editing the branch admin's information, the system admin will need to press this button to confirm on the edited information, after pressing this button the information of the branch admin will be edited on the database.
- Email field: here the system admin enters the branch admins email, this email should be correct and unique.
- Username field: the system admin will enter the branch admin username here, the username is also a unique attribute.
- Back button: this button return you to the branch admins form, no information will be added by pressing it.
- Add button: this button will confirm the request of adding a new admin to this branch, if the email and the username were correct and not duplicated, the admin will be added to the database, and an email will be sent to the branch admin's email to confirm his request.
- Number of devices drop down list: you can control the number of devices viewed in the list using this drop down list.
- Search bar: the admin can use this search bar to get to a particular device he wants to view, the search helps if there were many device added to this branch.
- Devices export file: these are the export options that the admin can use to take the data of the devices in the table.u00a0
- Branch devices list: this is the list where the branch devices and there information are viewed.
- Branch device edit button: this button will display a form with the admin information, this form allows you to edit the status of this branch device.
- Status radio button: the admin can enable and disable the device depending on the needs by using these buttons.
- Back button: this button is used to return to the devices form.
- Update button: this button will commit the changes made to the device status.
- Delete button: this button is used to remove the selected device from the branch.
- Add new device button: this button will display another pop up form for the user, this form will be used to add a new device to the selected branch.
- Device key field: here the system admin enters the branch device key, this key should be correct and unique.
- Back button: this button return you to the branch devices form, no information will be added by pressing it.
- Add button: this button will confirm the request of adding a new device to this branch, if the key were correct and not duplicated, the device will be added to the database.
- Map location: the admin can edit the location of the branch in case the branch changes its location.
- Update button: by pressing this button the admin is committing the changes he made to the branch, if there were a duplication with the name an error message will be displayed for the admin to inform him about it.
Add new admin button: this button will display another pop up form for the user, this form will be used to add a new branch admin to the selected branch.
This form will contain the following:u00a0
8-Number of devices:
this is the number of added devices for this particular branch, this number will be clickable for the user, by clicking on this number a form will pop up and will be displayed for the user, this form will contain the branch devices information.The form will contain the following:
This form will contain the following:
This form will contain the following:
9-Map pin button:
this button will display the map and locate the branch on it using a pin.10-Edit branch button:
this button will display an update form for the branch information.This form will contain the following:
Branch name field: here the admin can edit the name of the branch to the new desired name, but this name should be unique and not used before.