ManPageW WindowTabField

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: Window, Tab & Field

Description : Maintain Windows, Tabs & Fields

Help : The Window, Tab & Field Window defines the presentation of tables and columns within each window.



Tab: Window

Description : Window header definitions

Help : The Window Tab defines each window in the system. The default flag indicates that this window should be used as the default Zoom windows for the tables in this window.

Table Name  : AD_Window

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

Beta Functionality This functionality is considered Beta Beta functionality is not fully tested or completed. IsBetaFunctionality

CHAR(1)

YesNo

WindowType Type or classification of a Window The Window Type indicates the type of window being defined (Maintain, Transaction or Query) WindowType

CHAR(1)

List

Sales Transaction This is a Sales Transaction The Sales Transaction checkbox indicates if this item is a Sales Transaction. IsSOTrx

CHAR(1)

YesNo

System Color Color for backgrounds or indicators AD_Color_ID

NUMBER(10)

TableDir

Image Image or Icon Images and Icon can be used to display supported graphic formats (gif, jpg, png).

You can either load the image (in the database) or point to a graphic via a URI (i.e. it can point to a resource, http address)

AD_Image_ID

NUMBER(10)

TableDir

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

Default Default value The Default Checkbox indicates if this record will be used as a default value. IsDefault

CHAR(1)

YesNo

Window Width WinWidth

NUMBER(10)

Integer

Window Height WinHeight

NUMBER(10)

Integer

Copy Window Tabs Copy all Tabs and Fields from other Window Processing

CHAR(1)

Button


Tab: Window Translation

Description :

Help :

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

Window Data entry or display window The Window field identifies a unique Window in the system. AD_Window_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: Access

Description : Window Access

Help : The Window Access Tab defines the Roles which have access to this Window.

Table Name  : AD_Window_Access

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

Window Data entry or display window The Window field identifies a unique Window in the system. AD_Window_ID

NUMBER(10)

TableDir

Role Responsibility Role The Role determines security and access a user who has this Role will have in the System. AD_Role_ID

NUMBER(10)

TableDir

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

Read Write Field is read / write The Read Write indicates that this field may be read and updated. IsReadWrite

CHAR(1)

YesNo


Tab: Tab

Description : Tab definition within a window holds fields

Help : The Tab Tab defines each Tab within a Window. Each Tab contains a discrete selection of fields. Note that the display and read only logic is evaluated when loading the window.

Table Name  : AD_Tab

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

Window Data entry or display window The Window field identifies a unique Window in the system. AD_Window_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

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

NUMBER(10)

TableDir

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

Sequence Method of ordering records; lowest number comes first The Sequence indicates the order of records SeqNo

NUMBER(10)

Integer

Tab Level Hierarchical Tab Level (0 = top) Hierarchical level of the tab. If the level is 0, it is the top entity. Level 1 entries are dependent on level 0, etc. TabLevel

NUMBER(10)

Integer

Single Row Layout Default for toggle between Single- and Multi-Row (Grid) Layout The Single Row Layout checkbox indicates if the default display type for this window is a single row as opposed to multi row. IsSingleRow

CHAR(1)

YesNo

Advanced Tab This Tab contains advanced Functionality The tab with advanced functionality is only displayed, if enabled in Tools>Preference. IsAdvancedTab

CHAR(1)

YesNo

Has Tree Window has Tree Graph The Has Tree checkbox indicates if this window displays a tree metaphor. HasTree

CHAR(1)

YesNo

Accounting Tab This Tab contains accounting information The Accounting Tab checkbox indicates if this window contains accounting information. To display accounting information, enable this in Tools>Preference and Role. IsInfoTab

CHAR(1)

YesNo

Order Tab The Tab determines the Order IsSortTab

CHAR(1)

YesNo

TranslationTab This Tab contains translation information The Translation Tab checkbox indicate if a tab contains translation information. To display translation information, enable this in Tools>Preference. IsTranslationTab

CHAR(1)

YesNo

Order Column Column determining the order Integer Column of the table determining the order (display, sort, ..). If defined, the Order By replaces the default Order By clause. It should be fully qualified (i.e. "tablename.columnname"). AD_ColumnSortOrder_ID

NUMBER(10)

Table

Included Column Column determining if a Table Column is included in Ordering If a Included Column is defined, it decides, if a column is active in the ordering - otherwise it is determined that the Order Column has a value of one or greater AD_ColumnSortYesNo_ID

NUMBER(10)

Table

Link Column Link Column for Multi-Parent tables The Link Column indicates which column is the primary key for those situations where there is more than one parent. Only define it, if the table has more than one parent column (e.g. AD_User_Roles). AD_Column_ID

NUMBER(10)

TableDir

Process Process or Report The Process field identifies a unique Process or Report in the system. AD_Process_ID

NUMBER(10)

TableDir

Display Logic If the Field is displayed, the result determines if the field is actually displayed format := {expression} [{logic} {expression}]

expression := @{context}@{operand}{value} or @{context}@{operand}{value}
logic := {|}|{&}
context := any global or window context
value := strings or numbers
logic operators := AND or OR with the previous result from left to right
operand := eq{=}, gt{>}, le{<}, not{~^!}
Examples:
@AD_Table_ID@=14 | @Language@!GERGER
@PriceLimit@>10 | @PriceList@>@PriceActual@
@Name@>J
Strings may be in single quotes (optional)

DisplayLogic

NVARCHAR2(2000)

String

Read Only Field is read only The Read Only indicates that this field may only be Read. It may not be updated. IsReadOnly

CHAR(1)

YesNo

Insert Record The user can insert a new Record If not selected, the user cannot create a new Record. This is automatically disabled, if the Tab is Read Only. IsInsertRecord

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}
logic := {|}|{&}
context := any global or window context
value := strings or numbers
logic operators := AND or OR with the previous result from left to right
operand := eq{=}, gt{>}, le{<}, not{~^!}
Examples:
@AD_Table_ID@=14 | @Language@!GERGER
@PriceLimit@>10 | @PriceList@>@PriceActual@
@Name@>J
Strings may be in single quotes (optional)

ReadOnlyLogic

NVARCHAR2(2000)

String

Commit Warning Warning displayed when saving Warning or information displayed when committing the record CommitWarning

NVARCHAR2(2000)

Text

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)

String

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)

String

Image Image or Icon Images and Icon can be used to display supported graphic formats (gif, jpg, png).

You can either load the image (in the database) or point to a graphic via a URI (i.e. it can point to a resource, http address)

AD_Image_ID

NUMBER(10)

TableDir

Create Fields Create Field from Table Column, which do not exist in the Tab yet Based on the table columns of this Tab, this procedure creates the missing Fields ImportFields

CHAR(1)

Button

Copy Tab Fields Copy Fields from other Tab Processing

CHAR(1)

Button


Tab: Tab Translation

Description :

Help :

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

Tab Tab within a Window The Tab indicates a tab that displays within a window. AD_Tab_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

Commit Warning Warning displayed when saving Warning or information displayed when committing the record CommitWarning

NVARCHAR2(2000)

String


Tab: Field Sequence

Description : Sequence if the Fields in a Tab

Help :

Table Name  : AD_Field

Fields

Name Description Help Technical Data

Tab: Field

Description : Field definitions in tabs in windows

Help : The Field Tab defines the Fields displayed within a tab. Changes made to the Field Tab become visible after restart due to caching. If the Sequence is negative, the record are ordered descending. Note that the name, description and help is automatically synchronized if centrally maintained.

Table Name  : AD_Field

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

Tab Tab within a Window The Tab indicates a tab that displays within a window. AD_Tab_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

Included Tab Included Tab in this Tab (Master Dateail) You can include a Tab in a Tab. If displayed in single row record, the included tab is displayed as multi-row table. Included_Tab_ID

NUMBER(10)

Table

Column Column in the table Link to the database column of the table AD_Column_ID

NUMBER(10)

TableDir

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

Field Group Logical grouping of fields The Field Group indicates the logical group that this field belongs to (History, Amounts, Quantities) AD_FieldGroup_ID

NUMBER(10)

TableDir

Centrally maintained Information maintained in System Element table The Centrally Maintained checkbox indicates if the Name, Description and Help maintained in 'System Element' table or 'Window' table. IsCentrallyMaintained

CHAR(1)

YesNo

Displayed Determines, if this field is displayed If the field is displayed, the field Display Logic will determine at runtime, if it is actually displayed IsDisplayed

CHAR(1)

YesNo

Read Only Field is read only The Read Only indicates that this field may only be Read. It may not be updated. IsReadOnly

CHAR(1)

YesNo

Display Logic If the Field is displayed, the result determines if the field is actually displayed format := {expression} [{logic} {expression}]

expression := @{context}@{operand}{value} or @{context}@{operand}{value}
logic := {|}|{&}
context := any global or window context
value := strings or numbers
logic operators := AND or OR with the previous result from left to right
operand := eq{=}, gt{>}, le{<}, not{~^!}
Examples:
@AD_Table_ID@=14 | @Language@!GERGER
@PriceLimit@>10 | @PriceList@>@PriceActual@
@Name@>J
Strings may be in single quotes (optional)

DisplayLogic

NVARCHAR2(2000)

Text

Display Length Length of the display in characters The display length is mainly for String fields. The length has no impact, if the data type of the field is - Integer, Number, Amount (length determined by the system) - YesNo (Checkbox) - List, Table, TableDir (length of combo boxes are determined by their content at runtime) DisplayLength

NUMBER(10)

Integer

Encrypted Display or Storage is encrypted Display encryption (in Window/Tab/Field) - all characters are displayed as '*' - in the database it is stored in clear text. You will not be able to report on these columns.

Data storage encryption (in Table/Column) - data is stored encrypted in the database (dangerous!) and you will not be able to report on those columns. Independent from Display encryption.

IsEncrypted

CHAR(1)

YesNo

Sequence Method of ordering records; lowest number comes first The Sequence indicates the order of records SeqNo

NUMBER(10)

Integer

Same Line Displayed on same line as previous field The Same Line checkbox indicates that the field will display on the same line as the previous field. IsSameLine

CHAR(1)

YesNo

Record Sort No Determines in what order the records are displayed The Record Sort No indicates the ascending sort sequence of the records. If the number is negative, the records are sorted descending.

Example: A tab with C_DocType_ID (1), DocumentNo (-2) will be sorted ascending by document type and descending by document number (SQL: ORDER BY C_DocType, DocumentNo DESC)

SortNo

NUMBER(10)

Number

Obscure Type of obscuring the data (limiting the display) ObscureType

CHAR(3)

List

Heading only Field without Column - Only label is displayed The Heading Only checkbox indicates if just the label will display on the screen IsHeading

CHAR(1)

YesNo

Field Only Label is not displayed The Field Only checkbox indicates that the column will display without a label. IsFieldOnly

CHAR(1)

YesNo

Reference Overwrite System Reference - optional Overwrite You can overwrite the Display Type, but only use this if you aware of the consequences. 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

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

Mandatory Overwrite Overwrite Field Mandatory status The field must have a value for the record to be saved to the database. IsMandatory

CHAR(1)

List

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


Tab: Field Translation

Description : Menu Translation - May not need to be translated

Help : Fields are automatically translated, if centrally maintained. You only need to translate not centrally maintained Fields.

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

Field Field on a database table The Field identifies a field on a database table. AD_Field_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

Contributions

Personal tools