Projects:Tree Extension/Specifications

Contents 1 Overview 1.1 Background 1.2 Purpose 1.3 Scope 1.4 References 2 Design Considerations 2.1 Assumptions 2.2 Dependencies 2.3 Constraints 3 Glossary 4 Functional Requirements 4.1 User roles & profiles 4.2 Business process definition 4.3 User stories 4.3.1 1. Simple Hierarchy Implementation 4.4 Functional requirements based on business processes 4.5 User Interface Mockups 5 Technical Requirements 6 Non-Functional Requirements 7 Open Discussion Items 8 Closed Discussion Items

Overview

Background

Openbravo has an existing implementation that provides a common approach to building trees. This consists of a tree definition capability within the AD, that is used in the core module in areas like chart of accounts, organization hierarchy, menu and a tree visualization and re-ordering capability, which is available for all trees rendered based on this infrastructure. Limitation of the tree definition capabilities are

1. adding this capability for new tree relationship require changes to the core module ( and this prevents extension of this capability even to other core entities like Product Categories where it is partially implemented )
2. this does not support multiple hierarchical relationships for the same entity - for example modules are related to themselves as dependencies and inclusions both of which could be looked at in a hierarchical fashion.

Purpose

The purpose of this project is to address these limitation of the tree implementation to cater to the present and future needs i.e

• Provide an extension module that enables defining one or more tree type relationships for an entity within Openbravo. The entity could be a part of the core Openbravo or be a custom entity built as part of an extension to Openbravo. The relationship so defined should be implementable in a separate module.

Scope

The scope of the project is as follows

1. Make it possible to define one or more tree relationships for an entity in a module
2. Implement 3.0 visualization widgets for tree relationships
3. Backport existing tree implementations

The initial focus would be on (1).

References

Forum threads on limitations of tree references.

Links from forum specific to product/business partner category limitations

1. http://forge.openbravo.com/plugins/espforum/view.php?group_id=100&forumid=808030&topicid=7022683&topid=7022916
2. http://forge.openbravo.com/plugins/espforum/view.php?group_id=100&forumid=549512&topicid=4955754
3. http://forge.openbravo.com/plugins/espforum/view.php?group_id=100&forumid=549512&topicid=7020948

Links from forum related to other or more generic limitations

1. http://forge.openbravo.com/plugins/espforum/view.php?group_id=100&forumid=549512&topicid=7014379
2. http://forge.openbravo.com/plugins/espforum/view.php?group_id=100&forumid=549512&topicid=7021502

Feature requests (issues ) around trees

1. Hierarchical projects
2. BOM graphical view
3. Modularity does not support trees
4. Refactor tree edition to make it to use ajax
5. Tree management

Useful Links about existing implementation

1. http://forge.openbravo.com/plugins/espforum/view.php?group_id=100&forumid=549512&topicid=5181340

Design Considerations

Assumptions

Dependencies

Constraints

Glossary

Functional Requirements

User roles & profiles

Business process definition

User stories

1. Simple Hierarchy Implementation

We will implement a concrete story and then abstract the capability - the abstraction should be a part of the story acceptance criteria

Requirement:As a OB implementor, I would like a capability of defining a tree relationship for Product Categories in an extension module.

Acceptance Criteria :

1. The hierarchy should be definable in a separate module
2. It should ensure that no recursive relationships are rendered
3. The hierarchy relationship should be visible through the existing rendering mechanism
4. The mechanism to provide this hierarchy should be impelementable for other relationships as well - to be tested for Product BOM relationship

Functional requirements based on business processes

User Interface Mockups

Technical Requirements

Non-Functional Requirements

Open Discussion Items

Closed Discussion Items

[[Category:Projects ERP]]

Category: Development ERP