Projects:Alfresco Integration/Functional Specifications
Contents |
Overview
This project integrates Alfresco in Openbravo Attachment system.
Purpose
The purpose is to extend core to allow any CMS to integrate in Openbravo. Within this project it will also be delivered a module with the integration with Alfresco. The module upon proper configuration will enable the attachment system to store the documents in Alfresco.
Scope
The scope of this project is to modify core so it is possible to change how the attachments are stored in Openbravo. By default these are uploaded to Openbravo's server. With this project it is possible to change this location or use tools built to manage these kind of documents.
This project also includes a module to demonstrate this extension. The module integrates Alfresco in Openbravo. The module changes the storage point to Alfresco so all new attachments are uploaded to Alfresco. The module does not include any window or tab to review from Openbravo the files that are stored in Alfresco. This module will neither synchronize Openbravo's and Alfresco's users and roles. All upload and download processes are managed by a generic Alfresco's user.
This project adds the ability to define metadata, at tab level and attachment method level. The metadata can be any reference.
References
Design Considerations
Assumptions
Dependencies
Alfresco offers different connection APIs to upload/download files. It might be needed to include third party libraries in case we use some one that it is not already included in core.
Constraints
All the development must be done on top of core PR14Q2.6.
The Alfresco version to use is Alfresco 5.0
Glossary
Functional Requirements
Business process definition
In the application, in the 'Attachment Method Configuration' window, the active attachment method will be configured. When the toolbar button or the Add link on the Attachment section the file has to be uploaded to the store point defined in the 'Attachment Method Configuration'. When editing the attachment, the edition will use the same attachment method used when the attachment was done.In the case of alfresco, the file is stored in a folder with the Window Name.
The popup that is opened to upload or to edit the attachment, will include all the metadata defined for the tab where the attachment is being updated/edited.
The print and attach process must store the printed file using the attachment method defined in 'Attachment Method Configuration'(but it will not fulfill data in metadata fields).
Different clients in the same Openbravo instance could use different Alfresco instances.
User stories
Functional requirements based on business processes
| Id | Requirement | Importance |
| 1 | Add the ability to customize the upload, download, update and delete processes. | Must have |
| 2 | Add the ability to add additional attachment method and metada. | Must have |
| 3 | Modify the Print and Attach process to ensure that the attachment is stored using the new api. | Must have |
| 4 | Add CORE attachment method and its 'description' metadata | Must have |
| Id | Requirement | Importance |
| 1 | Implement the attachment base processes to use Alfresco as storage system. | Must have |
| 2 | Configuration window by Client | Must have |
| 3 | Add ALFRESCO attachment method | Must have |