Зарезервированные префиксы и правила именования таблиц базы данных

Втр, 06/07/2010 - 20:52 — rsashka

Каждая таблица в базе данных ADempiete имеет префикс. По этому префиксу определяется область использования таблицы и ее данных.

В настоящий момент используются следующие префиксы:

 AD_  : Application Dictionary       (например: AD_Element)
 A_   : Assets Management            (например: A_Asset_Group)
 ASP_ : Application Service Provider (например: ASP_Module)
 B_   : Marketplace                  (например: B_Buyer)
 C_   : Common or Core Functionality (например: C_AcctSchema)
 CM_  : Collaboration Management     (например: CM_WebProject)
 FACT_: Multi-Dimensional Cube       (например: Fact_Acct)
 GL_  : General Ledger               (например: GL_Journal)
 HR_  : Human Resource               (например: HR_Payroll) (Integration to Libero)
 I_   : Import                       (например: I_BPartner)
 K_   : Knowledge Management         (например: K_Category)
 M_   : Material Management          (например: M_Cost)
 PA_  : Performance Analysis         (например: PA_Report)
 PP_  : Production Planning          (например: PP_Order)  (Integration to Libero)
 R_   : Requests                     (например: R_Request)
 RV_  : Report View                  (например: RV_BPartner)
 S_   : Service                      (например: S_Resource)
 T_   : Temporary Tables             (например: T_Report)
 W_   : Web                          (например: W_Basket)
 WS_  : Web Service                  (например: WS_WebService)

Список префиксов объектов базы данных, зарезервированных для проектов локализации ADempiere:

 ABI_  : Automated Broker Interface (US Import and Export) SDGathman 18:00, 20 April 2007 (EDT)
 AWB_  : Air WayBill (US Import and Export - International Air Transportation) SDGathman
 LCO_  : Localization Colombia - Carlos Ruiz
 LBR_  : Localization Brazil - Fer_luck
 LMX_  : Localization Mexico - Victor Perez
 LVE_  : Localization Venezuela - Marcos Medina
 LRU_  : Localization Russia - Ryabikov Aleksand

Специальные суффиксы и префиксы имен столбцов.

_ID
- Тип данных: Number(10)
- Ключевой столбец или внешний ключ. Где это возможно, следует использовать шаблон TableName_ID Например: AD_User_ID ключевой столбец в таблице AD_User.
Is
- Тип данных: Char(1) Возможны значения Y/N
- Используется для значений Да/Нет, например: - IsApproved, IsActive, IsVendor, и т.д..

Некоторые советы о пользовательских таблицах

Наименование:
- Используйте префиксы - EXT_, CUST_
  - It's recommended to use custom prefixes with three or more letters. The model classes must be looked with prefix. I.e. if you have a table called XX_Invoice the model class must be looked as MInvoice and can conflict with the product model class, but if you have a table called CUS_Invoice, then the model class looked will be MCUSInvoice.
- Try to be descriptive.
- Use case conventions consistently.
Required Columns:
- AD_Client_ID, AD_Org_ID, IsActive, Created, CreatedBy, Updated, UpdatedBy
Suggested Columns:
- Value (the Key), Name, Description, Help
Very Important: The Column Names are case sensitive.

About References (Data Types)

TableDir
- Column Name without _ID is the Table Name
  - If Column: C_BPartner_ID ....Then Table is: C_BPartner
  - Don't forget: Case sensitive
Search
- Same as TableDir: displayed in Search and Info Window rather then ComboBox
Table
- Define Display Column and Key Column
- Column CreatedBy = Table: C_BPartner - Display: Name - Key: C_BPartner_ID
Dynamic Validation Rules
- The content is revaluated when change the Variable.
  - AD_Column.AD_Table_ID= @AD_Table_ID@

Некоторые специальные столбцы

Processed
- Data Type: CHAR(1) - Values: Y/N
  - Used for all Transaction Tables.
  - If Y then your record is Read-Only.
  - Fields marked as Always Updateable aren't read only
  - When the table has this column the History button is enabled on the toolbar

Posted
- Data Type: CHAR(1) - Values: Y/N
  - If Y then is displayed as Posting Button.

Processing
- Data Type: CHAR(1) - Values: Y/N
  - Lock for Batch processing.
  - Second use for starting any Process.

Record_ID
- Data Type: NUMBER(10)
  - With AD_Table_ID, system reference (Zoom)

Стандартные столбцы

AD_Client_ID
- Тип данных: Number(10) NOT NULL
AD_Org_ID
- Тип данных Number(10) NOT NULL
IsActive
- Тип данных: Char(1) - Значения: Y/N
Created
- Тип данных: Date NOT NULL
CreatedBy
- Тип данных: Number(10) NOT NULL
Updated
- Тип данных: Date NOT NULL
UpdatedBy
- Тип данных: Number(10) NOT NULL

Общепринятое наименования столбцов:

Value
- Тип данных: NVarchar2(40)
  - Ключ поиска или Код
Name
- Тип данных:: NVarchar2(60)
  - Имя для отображения
Description
- Тип данных:: NVarchar2(255)
  - Подробное описание
Help
- Тип данных: NVarchar2(2000)
  - Поле помощи или комментария

Virtual Columns

You can define virtual columns (not stored in the database). If defined, the Column name is the synonym of the SQL expression defined here. The SQL expression must be valid. Example: "Updated-Created" would list the age of the entry in days.

To create a Virtual Column you must go to Column Tab into Table and Column window and enter your Expression in the Column SQL Field.

In a Table, define calculated Columns (not stored).
- Updated-Created - Age in days
- More complex, as
  - (SELECT Value FROM M_Product p WHERE p.M_Product_ID=M_InventoryLine.M_Product_ID)
  - Complex Expressions in ()
  - Fully qualify base table

In Column, define valid SQL Expression
- Column Name: AgeInDays
- Column SQL: SysDate-Created
  - Creates SQL: SysDate-Created AS AgeInDays

Be careful: The virtual columns are not recalculated if you modify something on what is based the virtual column.

You can find some examples of Virtual Columns in the windows:

Tax Declaration: The Accounted Credit, Accounted Debit, Source Credit, Source Debit, Business Partner, Currency, Tax and Account Date are all Virtual Columns.

Product Costs: The Costing Method field used is a Virtual Column.

Note: in order to see the Columns definition, you must be logged as System Administrator Role.