Projects:Label Clean Up/Technical Specification

Contents 1 Introduction 2 Overview 3 Scope 4 Ubiquitous Language 5 Technical Implementation 5.1 Reference Label Clean 5.2 Consistent Employee Label 5.3 Cashflow Report Label 5.4 General Label Cleanup 5.5 Client Label Consistency 6 Appendices 6.1 Appendix A. UML Diagrams

Introduction

The purpose of this document is to outline the steps to clean up the labelling of certain items used in Openbravo ERP. The goal is to provide clear, consistent labelling within the application that is relevant to the purpose or function of the application element.

Overview

Implementation of this project will cover the US English version of the application but will require communication to the community (in particular translators) of some of the changes taking place.

Two elements of this specification are still to be clarified and will be resolved or scoped during the build phase.

Scope

1. Reference Field Cleanup

2. Consistent Employee Label

3. Cashflow Report Label

4. General Label Cleanup

5. Client Label Consistency

Ubiquitous Language

Technical Implementation

Reference Label Clean

The query below shows 17 fields in the current application that have the term Order Reference as the label. Each of these should be checked and amended to reflect the correct terminology.

SELECT 
        window.ad_window_id, window.name, tab.AD_TAB_ID, tab."NAME", FIELD.AD_FIELD_ID, FIELD."NAME",
        colum.*
FROM
        "TADSVN"."AD_FIELD" FIELD
        INNER JOIN "TADSVN"."AD_COLUMN" colum
                ON FIELD.ad_column_id = colum.ad_column_id
        INNER JOIN "TADSVN"."AD_TAB" tab
                ON FIELD.ad_tab_id = tab.ad_tab_id
                        INNER JOIN "TADSVN"."AD_WINDOW" window
                                ON tab.ad_window_id = window.ad_window_id
WHERE
        FIELD.name LIKE 'Order Reference'
        AND window.isactive = 'Y'
        AND tab.isactive = 'Y'
        AND FIELD.isactive = 'Y'
ORDER BY 
        window.name, tab.name, FIELD.name

The following table outlines the window, tab, and field that should be amended:

Window	Tab	Field	Column	New Name
Accounting Dimension	Project Dimension	Order Reference	Order Reference
Business Partner	Customer	Order Reference	Order Reference
Business Partner Info	Partner Invoices	Order Reference	Order Reference
Business Partner Info	Partner Orders	Order Reference	Order Reference
Business Partner Info	Partner Shipments	Order Reference	Order Reference
Expense Invoice	Expense Invoice	Order Reference	Order Reference
Goods Receipt	Header	Order Reference	Order Reference
Goods Shipment	Header	Order Reference	Order Reference
Incoming Shipment	Shipment in	Order Reference	Order Reference
Multiphase Project	Multiphase Project	Order Reference	Order Reference
Purchase Invoice	Header	Order Reference	Order Reference
Purchase Order	Header	Order Reference	Order Reference
Sales Invoice	Header	Order Reference	Order Reference
Sales Order	Header	Order Reference	Order Reference
Service Project	Service Project	Order Reference	Order Reference
Simple Sales Order	Header	Order Reference	Order Reference
Vendor Expense Invoice	Header	Order Reference	Order Reference

Consistent Employee Label

The following query returns a listing of 88 instances of the term Business Partner within the current application. Of these there are two instances that use a validation rule to return specific types of business partners. Both these instances should be modified to a more appropriate naming.

select 
       window.ad_window_id, window.name, tab.AD_TAB_ID, tab."NAME", field.AD_FIELD_ID, field."NAME",
       colum.*, rule.*
from 
       "TADSVN"."AD_FIELD" field
       inner join "TADSVN"."AD_COLUMN" colum
               on field.ad_column_id = colum.ad_column_id
               left outer join ad_val_rule rule 
                       on colum.ad_val_rule_id = rule.ad_val_rule_id
       inner join "TADSVN"."AD_TAB" tab
               on field.ad_tab_id = tab.ad_tab_id
                       inner join "TADSVN"."AD_WINDOW" window
                               on tab.ad_window_id = window.ad_window_id
where
       field.name like 'Business Partner'
       and window.isactive = 'Y'
       and tab.isactive = 'Y'
       and field.isactive = 'Y'
order by
       window.name, tab.name, field.name

The two fields effected are:

• Production Management || Transactions || Maintenance Order || Order >> Worker
• Production Management || Transactions || Work Effort || Work Effort >> Employee

Both these fields should be relabeled as Operator.

Cashflow Report Label

In the file src/org/openbravo/erpCommon/ad_reports/ReportCashflowForecast.html change the term On the Bank to Bank Balance at lines 310 and 338.

General Label Cleanup

Requires clarification of scope. To be scheduled.

Client Label Consistency

All instances of 'Entity' to be changed to 'Client'.

Appendices

Appendix A. UML Diagrams