Projects:Image Reference/Functional Specifications

Contents 1 Image Reference - Functional Specifications 1.1 Overview 1.1.1 Purpose 1.1.2 Scope 1.2 Functional Requirements 1.2.1 User roles & profiles 1.2.2 Business process definition 1.2.2.1 Definition 1.2.2.2 Usage 1.2.3 User stories 1.2.4 Functional requirements based on business processes 1.2.5 User Interface Mockups 1.3 Closed Discussion Items

Image Reference - Functional Specifications

Overview

Currently Openbravo ERP image support is a bit weird.

For example: it's possible to add an image to a product, the way to do it is in two steps:

1. Insert the image: the first step is to make the image accessible
   1. Copy in the server web/images directory the image to be used in the application
   2. Login as system administrator
   3. Go to General Setup || Application || Application Image and create a new record
   4. In this new record write a significant name in the name field and the image file name in the URL field and save
2. Use the image: once the image is accessible it can be used
   1. Login as a user with privileges to edit products
   2. Go to Master Data Management || Product and select the product to edit
   3. Click in the empty image icon, a pop-up will be opened
   4. In this pop-up it is possible to select one of the images accessible as described in the 1st step.

The implementation of all this consists on a single table where references to all images are stored and a reference to this table in each table that is going to use images.

Purpose

The purpose of this project is to create a new image reference which will make easier image management.

Scope

This project will affect to image reference and the columns that use it.

Functional Requirements

User roles & profiles

Consultant

This type of users have a high level of professional education, have a deep knowledge of the business processes. Without need to know about programming they are able to add to existent tables the ability of containing images.

Final user

Final user with write permission to tables with images is able to add/modify images in a simple manner.

Business process definition

Definition

Consultant user creates a new column to store images in database for the table he wants, this column is added to application dictionary using the new image reference a field for this column is added to the tab where it is going to be shown and that window is compiled.

When the field is associated to the column it is possible to define the size the images will be displayed with.

Usage

Final user will see in the tab the image added by the consultant (in case there is no image a default one) and next to it a small edit icon that will open the image selector. Clicking the edit icon a selector will pop-up and will allow to upload one or more images for the current record.

User stories

Cristina, a consultant, is asked to add an image to a business partner tab in order to be able to add a photo of business partners. She creates a new column in C_BPartner to hold the image, adds it to the application dictionary and creates a new field in the tab.

Mike, a final user, creates a new business partner and has an icon in the tab to insert an image, clicking on it he can upload a new image which will be automatically assigned to the business partner.

Functional requirements based on business processes

Num	Requirement	Importance	Status	Estimated time	Comments
1.1	Add to database model and application dictionary the new infrastructure needed to support the new reference	Must have	To be started	1d
1.2	WAD support for this new reference	Must have	To be started	5d
1.3	Java class to manage images and galleries	Should have	To be started	3d
1.4	Selector user interface development	Must have	To be started	15d

User Interface Mockups

In the image tab user interface a new icon to edit has been added, clicking on this icon has the same effect that doing it on the image itself.

The gallery selector interface allows to add and edit images from a gallery.

Closed Discussion Items

• ALO: Once an image is uploaded, should it be shareable among different records in the same tab or in other ones, or each time the same image is going to be used must be uploaded (being usable only for one record)? The second approach is the one used in attachments.
  • ALO:NO
• ALO: Apart of the described image reference a new reference type image gallery could be used to define more than one image for a single record. This would require to have a default image in each gallery to be shown in the tab user interface.
  • Three references:
    • System image: The current one files are shareable and stored in web/images
    • Image: A single image
    • Gallery: A gallery of images
• ALO: Should the current implementation be maintained for backwards compatibility?
  • Yes: system image reference