Difference between revisions of "ManPageW TableandColumn"
(→Contributions) |
(→Contributions) |
||
Line 160: | Line 160: | ||
[[Category:Manual|W T]] | [[Category:Manual|W T]] | ||
− | [[ | + | [[Enable Changelog]] |
Latest revision as of 14:54, 2 June 2010
Enjoy it, and help to fill it! But please, always respecting copyright.
Please write your contributions under the Contributions Section
Contents
Window: Table and Column
Description : Maintain Tables and Columns
Help : The Table and Column Window defines all tables with their columns
Tab: Table
Description : Table definitions
Help : Table (header) definition - Note that the name of most tables is automatically syncronized.
Table Name : AD_Table
Fields
Name | Description | Help | Technical Data |
---|---|---|---|
Client | Client/Tenant for this installation. | A Client is a company or a legal entity. You cannot share data between Clients. Tenant is a synonym for Client. | AD_Client_ID
NUMBER(10) TableDir |
Organization | Organizational entity within client | An organization is a unit of your client or legal entity - examples are store, department. You can share data between organizations. | AD_Org_ID
NUMBER(10) TableDir |
DB Table Name | Name of the table in the database | The DB Table Name indicates the name of the table in database. | TableName
VARCHAR2 String |
Name | Alphanumeric identifier of the entity | The name of an entity (record) is used as an default search option in addition to the search key. The name is up to 60 characters in length. | Name
NVARCHAR2(60) String |
Description | Optional short description of the record | A description is limited to 255 characters. | Description
NVARCHAR2(255) String |
Comment/Help | Comment or Hint | The Help field contains a hint, comment or help about the use of this item. | Help
NVARCHAR2(2000) Text |
Active | The record is active in the system | There are two methods of making records unavailable in the system: One is to delete the record, the other is to de-activate the record. A de-activated record is not available for selection, but available for reports.
There are two reasons for de-activating and not deleting records: (1) The system requires the record for audit purposes. (2) The record is referenced by other records. E.g., you cannot delete a Business Partner, if there are invoices for this partner record existing. You de-activate the Business Partner and prevent that this record is used for future entries. |
IsActive
CHAR(1) YesNo |
View | This is a view | This is a view rather than a table. A view is always treated as read only in the system. | IsView
CHAR(1) YesNo |
Data Access Level | Access Level required | Indicates the access level required for this record or process. | AccessLevel
CHAR(1) List |
Maintain Change Log | Maintain a log of changes | If selected, a log of all changes is maintained. | IsChangeLog
CHAR(1) YesNo |
Replication Type | Type of Data Replication | The Type of data Replication determines the directon of the data replication. Reference means that the data in this system is read only -> |
ReplicationType
CHAR(1) List |
Window | Data entry or display window | The Window field identifies a unique Window in the system. | AD_Window_ID
NUMBER(10) TableDir |
PO Window | Purchase Order Window | Window for Purchase Order (AP) Zooms | PO_Window_ID
NUMBER(10) Table |
Records deleteable | Indicates if records can be deleted from the database | The Records Deleteable checkbox indicates if a record can be deleted from the database. If records cannot be deleted, you can only deselect the Active flag | IsDeleteable
CHAR(1) YesNo |
High Volume | Use Search instead of Pick list | The High Volume Checkbox indicates if a search screen will display as opposed to a pick list for selecting records from this table. | IsHighVolume
CHAR(1) YesNo |
Entity Type | Dictionary Entity Type; Determines ownership and synchronization | The Entity Types "Dictionary", "Adempiere" and "Application" might be automatically synchronized and customizations deleted or overwritten.
For customizations, copy the entity and select "User"! |
EntityType
VARCHAR2 Table |
Create Columns from DB | Create Dictionary Columns of Table not existing as a Column but in the Database | If you have added columns in the database to this table, this procedure creates the Column records in the Dictionary. Please be aware, that they may deleted, if the entity type is not set to User. | ImportTable
CHAR(1) Button |
Copy Columns from Table | Create Dictionary Columns for a Table taking another as base | CopyColumnsFromTable
NVARCHAR2(1) Button |
Tab: Table Translation
Description : Table Translation
Help : Note that many Table names will be overwritten / translated automatically
Table Name : AD_Table_Trl
Fields
Name | Description | Help | Technical Data |
---|---|---|---|
Client | Client/Tenant for this installation. | A Client is a company or a legal entity. You cannot share data between Clients. Tenant is a synonym for Client. | AD_Client_ID
NUMBER(10) TableDir |
Organization | Organizational entity within client | An organization is a unit of your client or legal entity - examples are store, department. You can share data between organizations. | AD_Org_ID
NUMBER(10) TableDir |
Table | Database Table information | The Database Table provides the information of the table definition | AD_Table_ID
NUMBER(10) TableDir |
Language | Language for this entity | The Language identifies the language to use for display and formatting | AD_Language
VARCHAR2 Table |
Name | Alphanumeric identifier of the entity | The name of an entity (record) is used as an default search option in addition to the search key. The name is up to 60 characters in length. | Name
NVARCHAR2(60) String |
Active | The record is active in the system | There are two methods of making records unavailable in the system: One is to delete the record, the other is to de-activate the record. A de-activated record is not available for selection, but available for reports.
There are two reasons for de-activating and not deleting records: (1) The system requires the record for audit purposes. (2) The record is referenced by other records. E.g., you cannot delete a Business Partner, if there are invoices for this partner record existing. You de-activate the Business Partner and prevent that this record is used for future entries. |
IsActive
CHAR(1) YesNo |
Translated | This column is translated | The Translated checkbox indicates if this column is translated. | IsTranslated
CHAR(1) YesNo |
Tab: Column
Description : Table Column definitions
Help : Defines the columns of a table. Note thet the name of the column is automatically syncronized.
Table Name : AD_Column
Fields
Name | Description | Help | Technical Data |
---|---|---|---|
Client | Client/Tenant for this installation. | A Client is a company or a legal entity. You cannot share data between Clients. Tenant is a synonym for Client. | AD_Client_ID
NUMBER(10) TableDir |
Organization | Organizational entity within client | An organization is a unit of your client or legal entity - examples are store, department. You can share data between organizations. | AD_Org_ID
NUMBER(10) TableDir |
Table | Database Table information | The Database Table provides the information of the table definition | AD_Table_ID
NUMBER(10) TableDir |
DB Column Name | Name of the column in the database | The Column Name indicates the name of a column on a table as defined in the database. | ColumnName
VARCHAR2 String |
Column SQL | Virtual Column (r/o) | 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 |
ColumnSQL
NVARCHAR2(2000) String |
System Element | System Element enables the central maintenance of column description and help. | The System Element allows for the central maintenance of help, descriptions and terminology for a database column. | AD_Element_ID
NUMBER(10) Search |
Name | Alphanumeric identifier of the entity | The name of an entity (record) is used as an default search option in addition to the search key. The name is up to 60 characters in length. | Name
NVARCHAR2(60) String |
Description | Optional short description of the record | A description is limited to 255 characters. | Description
NVARCHAR2(255) String |
Comment/Help | Comment or Hint | The Help field contains a hint, comment or help about the use of this item. | Help
NVARCHAR2(2000) Text |
Active | The record is active in the system | There are two methods of making records unavailable in the system: One is to delete the record, the other is to de-activate the record. A de-activated record is not available for selection, but available for reports.
There are two reasons for de-activating and not deleting records: (1) The system requires the record for audit purposes. (2) The record is referenced by other records. E.g., you cannot delete a Business Partner, if there are invoices for this partner record existing. You de-activate the Business Partner and prevent that this record is used for future entries. |
IsActive
CHAR(1) YesNo |
Version | Version of the table definition | The Version indicates the version of this table definition. | Version
NUMBER Amount |
Length | Length of the column in the database | The Length indicates the length of a column as defined in the database. | FieldLength
NUMBER(10) Integer |
Reference | System Reference and Validation | The Reference could be a display type, list or table validation. | AD_Reference_ID
NUMBER(10) Table |
Dynamic Validation | Dynamic Validation Rule | These rules define how an entry is determined to valid. You can use variables for dynamic (context sensitive) validation. | AD_Val_Rule_ID
NUMBER(10) TableDir |
Value Format | Format of the value; Can contain fixed format elements, Variables: "_lLoOaAcCa09" | Validation elements:
(Space) any character _ Space (fixed character) l any Letter a..Z NO space L any Letter a..Z NO space converted to upper case o any Letter a..Z or space O any Letter a..Z or space converted to upper case a any Letters & Digits NO space A any Letters & Digits NO space converted to upper case c any Letters & Digits or space C any Letters & Digits or space converted to upper case 0 Digits 0..9 NO space 9 Digits 0..9 or space Example of format "(000)_000-0000" |
VFormat
NVARCHAR2(60) String |
Process | Process or Report | The Process field identifies a unique Process or Report in the system. | AD_Process_ID
NUMBER(10) TableDir |
Reference Key | Required to specify, if data type is Table or List | The Reference Value indicates where the reference values are stored. It must be specified if the data type is Table or List. | AD_Reference_Value_ID
NUMBER(10) Table |
Info Factory Class | Fully qualified class name that implements the InfoFactory interface | Fully qualified class name that implements the InfoFactory interface. This can be use to provide custom Info class for column. | InfoFactoryClass
NVARCHAR2(255) String |
Min. Value | Minimum Value for a field | The Minimum Value indicates the lowest allowable value for a field. | ValueMin
NVARCHAR2(20) String |
Max. Value | Maximum Value for a field | The Maximum Value indicates the highest allowable value for a field | ValueMax
NVARCHAR2(20) String |
Default Logic | Default value hierarchy, separated by ; | The defaults are evaluated in the order of definition, the first not null value becomes the default value of the column. The values are separated by comma or semicolon. a) Literals:. 'Text' or 123 b) Variables - in format @Variable@ - Login e.g. #Date, #AD_Org_ID, #AD_Client_ID - Accounting Schema: e.g. $C_AcctSchema_ID, $C_Calendar_ID - Global defaults: e.g. DateFormat - Window values (all Picks, CheckBoxes, RadioButtons, and DateDoc/DateAcct) c) SQL code with the tag: @SQL=SELECT something AS DefaultValue FROM ... The SQL statement can contain variables. There can be no other value other than the SQL statement. The default is only evaluated, if no user preference is defined. Default definitions are ignored for record columns as Key, Parent, Client as well as Buttons. | DefaultValue
NVARCHAR2(2000) Text |
Key column | This column is the key in this table | The key column must also be display sequence 0 in the field definition and may be hidden. | IsKey
CHAR(1) YesNo |
Parent link column | This column is a link to the parent table (e.g. header from lines) - incl. Association key columns | The Parent checkbox indicates if this column is a link to the parent table. | IsParent
CHAR(1) YesNo |
Mandatory | Data entry is required in this column | The field must have a value for the record to be saved to the database. | IsMandatory
CHAR(1) YesNo |
Updateable | Determines, if the field can be updated | The Updateable checkbox indicates if a field can be updated by the user. | IsUpdateable
CHAR(1) YesNo |
Column Encryption | Test and enable Column Encryption | To enable storage encryption or remove encryption is dangerous as you may loose data. You need to verify that the column is big enough to hold the encrypted value. You can provide your own encryption method, but cannot change it once enabled. The default implementation supports US ASCII String conversion (not Unicode, Numbers, Dates) |
IsEncrypted
CHAR(1) Button |
Always Updateable | The column is always updateable, even if the record is not active or processed | If selected and if the winow / tab is not read only, you can always update the column. This might be useful for comments, etc. | IsAlwaysUpdateable
CHAR(1) YesNo |
Read Only Logic | Logic to determine if field is read only (applies only when field is read-write) | format := {expression} [{logic} {expression}] expression := @{context}@{operand}{value} or @{context}@{operand}{value} |
ReadOnlyLogic
NVARCHAR2(2000) Text |
Mandatory Logic | MandatoryLogic
NVARCHAR2(2000) Text | ||
Identifier | This column is part of the record identifier | The Identifier checkbox indicates that this column is part of the identifier or key for this table. | IsIdentifier
CHAR(1) YesNo |
Sequence | Method of ordering records; lowest number comes first | The Sequence indicates the order of records | SeqNo
NUMBER(10) Integer |
Callout | Fully qualified class names and method - separated by semicolons | A Callout allow you to create Java extensions to perform certain tasks always after a value changed. Callouts should not be used for validation but consquences of a user selecting a certain value.
The callout is a Java class implementing org.compiere.model.Callout and a method name to call. Example: "org.compiere.model.CalloutRequest.copyText" instanciates the class "CalloutRequest" and calls the method "copyText". You can have multiple callouts by separating them via a semicolon |
Callout
NVARCHAR2(255) String |
Selection Column | Is this column used for finding rows in windows | If selected, the column is listed in the first find window tab and in the selection part of the window | IsSelectionColumn
CHAR(1) YesNo |
Translated | This column is translated | The Translated checkbox indicates if this column is translated. | IsTranslated
CHAR(1) YesNo |
Entity Type | Dictionary Entity Type; Determines ownership and synchronization | The Entity Types "Dictionary", "Adempiere" and "Application" might be automatically synchronized and customizations deleted or overwritten.
For customizations, copy the entity and select "User"! |
EntityType
VARCHAR2 Table |
Synchronize Column | Change database table definition from application dictionary | When selected, the database column definition is updated based on your entries in the Column definition of the Application Dictionary. Note that not all changes are supported by the database and may result in an error. | IsSyncDatabase
CHAR(1) Button |
Tab: Column Translation
Description : Column Translation
Help : Do not translate - overwritten / translated automatically
Table Name : AD_Column_Trl
Fields
Name | Description | Help | Technical Data |
---|---|---|---|
Client | Client/Tenant for this installation. | A Client is a company or a legal entity. You cannot share data between Clients. Tenant is a synonym for Client. | AD_Client_ID
NUMBER(10) TableDir |
Organization | Organizational entity within client | An organization is a unit of your client or legal entity - examples are store, department. You can share data between organizations. | AD_Org_ID
NUMBER(10) TableDir |
Column | Column in the table | Link to the database column of the table | AD_Column_ID
NUMBER(10) TableDir |
Language | Language for this entity | The Language identifies the language to use for display and formatting | AD_Language
VARCHAR2 Table |
Name | Alphanumeric identifier of the entity | The name of an entity (record) is used as an default search option in addition to the search key. The name is up to 60 characters in length. | Name
NVARCHAR2(60) String |
Active | The record is active in the system | There are two methods of making records unavailable in the system: One is to delete the record, the other is to de-activate the record. A de-activated record is not available for selection, but available for reports.
There are two reasons for de-activating and not deleting records: (1) The system requires the record for audit purposes. (2) The record is referenced by other records. E.g., you cannot delete a Business Partner, if there are invoices for this partner record existing. You de-activate the Business Partner and prevent that this record is used for future entries. |
IsActive
CHAR(1) YesNo |
Translated | This column is translated | The Translated checkbox indicates if this column is translated. | IsTranslated
CHAR(1) YesNo |
Tab: Table Script Validator
Description :
Help :
Table Name : AD_Table_ScriptValidator
Fields
Name | Description | Help | Technical Data |
---|---|---|---|
Client | Client/Tenant for this installation. | A Client is a company or a legal entity. You cannot share data between Clients. Tenant is a synonym for Client. | AD_Client_ID
NUMBER(10) TableDir |
Organization | Organizational entity within client | An organization is a unit of your client or legal entity - examples are store, department. You can share data between organizations. | AD_Org_ID
NUMBER(10) TableDir |
Table | Database Table information | The Database Table provides the information of the table definition | AD_Table_ID
NUMBER(10) TableDir |
Event Model Validator | EventModelValidator
VARCHAR2 List | ||
Rule | AD_Rule_ID
NUMBER(10) TableDir | ||
Sequence | Method of ordering records; lowest number comes first | The Sequence indicates the order of records | SeqNo
NUMBER(10) Integer |
Active | The record is active in the system | There are two methods of making records unavailable in the system: One is to delete the record, the other is to de-activate the record. A de-activated record is not available for selection, but available for reports.
There are two reasons for de-activating and not deleting records: (1) The system requires the record for audit purposes. (2) The record is referenced by other records. E.g., you cannot delete a Business Partner, if there are invoices for this partner record existing. You de-activate the Business Partner and prevent that this record is used for future entries. |
IsActive
CHAR(1) YesNo |
Contributions
Column Reference vs DB Type
Column Reference | Column Name | Field Length | Oracle DB Type | PostgreSQL DB Type |
---|---|---|---|---|
EntityType | n | VARCHAR2(n) | VARCHAR(n) | |
AD_Language | n | VARCHAR2(n) | VARCHAR(n) | |
Image | BinaryData | BLOB | BYTEA | |
Record Identifier = ID Table Table Direct Search Location (Address) Locator Account Assignment Product Attribute Image Color |
*_ID *tedBy *_Acct |
NUMBER(10) | NUMERIC(10) | |
Record Identifier | n<4 | CHAR(n) | CHAR(n) | |
Record Identifier | n>=4 | VARCHAR2(n) | VARCHAR(n) | |
Integer | NUMBER(10) | NUMERIC(10) | ||
DateDate+TimeTime | DATE | TIMESTAMP | ||
Amount Number Costs+Prices Quantity |
NUMBER | NUMERIC | ||
Binary | BLOB | BYTEA | ||
Text Long | CLOB | TEXT | ||
Text | n>=4000 | CLOB | TEXT | |
Yes-No | CHAR(1) | CHAR(1) | ||
List | n=1 | CHAR(1) | CHAR(1) | |
List | n>1 | NVARCHAR2(n) | VARCHAR(n) | |
Button | *_ID | NUMBER(10) | NUMERIC(10) | |
Button | n | CHAR(n) | CHAR(n) | |
String Text Memo FilePath FileName URL Printer Name |
n | NVARCHAR2(n) | VARCHAR(n) | |
RowID | ERROR: Unhandled Data Type | ERROR: Unhandled Data Type |