Projects:Configurable System logos
Make the System Logos configurable without modifying the Core Module - Functional Specifications
Overview
Purpose
The purpose of this project is to make the System logos (like the "Your Company", or "Your IT service" logos) configurable through the Openbravo User Interface, without the need to modify the Core module.
This project will leverage the functionality provided by the new Image BLOB reference, which allows a user to directly upload an image through the Openbravo user interface into the database.
References
Functional Requirements
Business process definition
- The System logos will be stored in the database. The application needs to retrieve the information from the database instead of from files when displaying the windows.
- The build process will insert the standard logos in the database
- Initial Client Setup will copy the standard system images to the client table. Initial Organization Setup will copy the standard client images to the organization table
- The user will be able to upload images to replace the both standard system logos and each client logos through a window in Openbravo
- Documents such as the purchase/sales invoice, or the purchase/sales order, will be modified so that they use this new way to obtain and show the logos. The logos they will use will be the one for their organization.
Functional requirements based on business processes
Num | Requirement | Importance | Status |
1.1 | Columns need to be added to the application to store the reference to the images, and modifications need to be done to the application so that the logos are retrieved from the database instead of from files when the windows are shown | Must Have | |
1.2 | The build process will insert the standard logos in the database | Must Have | |
1.3 | Initial Client Setup will copy the standard client images to the client table | Must Have | |
1.4 | Reports need to be modified so that they get their logo from the database instead of from files. | Nice to Have |
User Interface Mockups
The logos that can be configurable through the application are the following ones:
The "Your Company" and "Your IT Service" ones in the login window.
The "Your Company" one in the top section of the menu, and the big Openbravo one in the main frame section.
And finally, the one in some printed reports.
Open Discussion Items
- None
Closed Discussion Items
- None
Testcases
Execute new install.source and check logos
Steps to execute:
- Use install.source to install a new instance
- Go to the login page
- Check that the 'yourcompany' and the 'yourit-service' logos are both displayed and that they do not only show an empty white space
- Login into the application
- Check that the 'yourcompany' logo is displayed above the main menu to the left
- Check that the 'openbravo logo' in big is displayed in the right area, when no window has been opened yet
Update from previous version and check logos
Steps to execute:
- Update your system from a version previous to the one supporting the new configurable system logos (i.e. update from 2.50MP5 to current pi)
- Go to the login page
- Check that the 'yourcompany' and the 'yourit-service' logos are both displayed and that they do not only show an empty white space
- Login into the application
- Check that the 'yourcompany' logo is displayed above the main menu to the left
- Check that the 'openbravo logo' in big is displayed in the right area, when no window has been opened yet
Test priority of client image and system image
Steps to execute:
- Login as admin user for one client (i.e. Openbravo Admin for client smallbazaar)
- Goto General Setup -> Client
- Navigate to the clients entry (smallbazaar)
- Goto the Information tab
- Upload a new 'Your company menu image' (Click on the 'no image' present picture and use the image selector popup to upload a new different logo image
- Reload the menu by opening the role switch popup and clicking OK
- Check that the logo displayed above the menu is the newly just uploaded image
- Switch role/client to another client (i.e. Accounting Test Admin role and Accounting test client)
- Check that the logo displayed above the menu is not the newly uploaded image but the default image (specified in ad_system_info)
Test initial client setup image copying
Steps to execute:
- Switch role to System Administrator
- Go to General Setup -> Client -> InitialClientSetup
- Enter needed info (Client,Client Username, Currency) i.e. (test,testAdmin,Euro)
- Click OK to start the process
- Switch role/client to the newly created client
- Go to General Setup -> Client
- Navigate to the clients record
- Go to the Information tab
- Check that the three logos (Your Company menu image, Your Compnay Big Image, Your Company Document Image) do not show the 'no image' picture, but have the default images copied into this newly created client.
Test deletion of an image in a newly created client
Steps to execute:
- Switch role/client to the newly created client from the last testcase
- Go to General Setup -> Client
- Navigate to the clients record
- Go to the Information tab
- Use the image selector popup to delete the 'Company menu image'
- Save the modified record
- Use the role popup to reload the menu (open it and click ok)
- The logo above the image should not change as it will display the default image from ad_system_info as the client no longer as a specific image for this logo.
Comments: This test verifies that the copied images have been created with the proper client and organization and can be modified/deleted in the newly created client.
Test initial org setup image copying
- Switch role/client to the newly created client from the last testcase
- Go to General Setup -> Enterprise -> Initial Organisation setup
- Enter the needed fields (Organisation,Organisation username)
- click OK to created the new organisation
- Go to General Setup -> Enterprise -> Organisation
- Navigate to the newly created organisation record
- Go to the information tab
- The 'Your company document image' should not display the 'no image' picture but instead the default 'document image' as it has been copied over in the creation
Test deletion of an image in a newly created organisation
Steps to execute:
- Switch role/client to the newly created client from the last testcase
- Go to General Setup -> Enterprise -> Organisation
- Navigate to the organisation record
- Go to the Information tab
- Use the image selector popup to delete the 'Your company document image'
- Save the modified record
Comments: This test verifies that the copied images have been created with the proper client and organization and can be modified/deleted in the newly created organisation.