ManPageW Reference

From ADempiere ERP Wiki

Jump to: navigation, search

Return to Index

Enjoy it, and help to fill it! But please, always respecting copyright.

Please write your contributions under the Contributions Section



Contents

Window: Reference

Description : Maintain System References

Help : The Reference Window defines field/display types and validations. This window is for System Admin use only.



Tab: Reference

Description : Reference header definitions

Help : The Reference Tab defines the references that are used to validate data

Table Name  : AD_Reference

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

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

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

Validation type Different method of validating data The Validation Type indicates the validation method to use. These include list, table or data type validation. ValidationType

CHAR(1)

List

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(40)

String


Tab: Reference Translation

Description :

Help :

Table Name  : AD_Reference_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

Reference System Reference and Validation The Reference could be a display type, list or table validation. AD_Reference_ID

NUMBER(10)

TableDir

Language Language for this entity The Language identifies the language to use for display and formatting AD_Language

VARCHAR2

Table

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

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


Tab: List Validation

Description : Reference List

Help : The List Validation Tab defines lists to validate data

Table Name  : AD_Ref_List

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

Reference System Reference and Validation The Reference could be a display type, list or table validation. AD_Reference_ID

NUMBER(10)

TableDir

Search Key Search key for the record in the format required - must be unique A search key allows you a fast method of finding a particular record.

If you leave the search key empty, the system automatically creates a numeric number. The document sequence used for this fallback number is defined in the "Maintain Sequence" window with the name "DocumentNo_<TableName>", where TableName is the actual name of the table (e.g. C_Order).

Value

NVARCHAR2(60)

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

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

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

Valid from Valid from including this date (first day) The Valid From date indicates the first day of a date range ValidFrom

DATE

Date

Valid to Valid to including this date (last day) The Valid To date indicates the last day of a date range ValidTo

DATE

Date


Tab: List Translation

Description :

Help :

Table Name  : AD_Ref_List_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

Reference List Reference List based on Table The Reference List field indicates a list of reference values from a database tables. Reference lists populate drop down list boxes in data entry screens AD_Ref_List_ID

NUMBER(10)

TableDir

Language Language for this entity The Language identifies the language to use for display and formatting AD_Language

VARCHAR2

Table

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

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


Tab: Table Validation

Description : Table validation

Help : The Table Validation Tab defines tables to validate data

Table Name  : AD_Ref_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

Reference System Reference and Validation The Reference could be a display type, list or table validation. AD_Reference_ID

NUMBER(10)

TableDir

Table Database Table information The Database Table provides the information of the table definition AD_Table_ID

NUMBER(10)

TableDir

Key column Unique identifier of a record The Key Column indicates that this the unique identifier of a record on this table. AD_Key

NUMBER(10)

Table

Display column Column that will display The Display Column indicates the column that will display. AD_Display

NUMBER(10)

Table

Display Value Displays Value column with the Display column The Display Value checkbox indicates if the value column will display with the display column. IsValueDisplayed

CHAR(1)

YesNo

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

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

Sql WHERE Fully qualified SQL WHERE clause The Where Clause indicates the SQL WHERE clause to use for record selection. The WHERE clause is added to the query. Fully qualified means "tablename.columnname". WhereClause

NVARCHAR2(2000)

Text

Sql ORDER BY Fully qualified ORDER BY clause The ORDER BY Clause indicates the SQL ORDER BY clause to use for record selection OrderByClause

NVARCHAR2(2000)

Text


Tab: Used in Column

Description : Used in Column (Reference)

Help :

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

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

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

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

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

Contributions

Personal tools