Entering Data - Fields and Buttons

This Wiki is read-only for reference purposes to avoid broken links.

⇐ Table of Contents{{#if: | | [[{{{2}}}]] }}{{#if: | | [[{{{3}}}]] }}{{#if: | | [[{{{4}}}]] }}{{#if: | | [[{{{5}}}]] }} | Entering Data - Fields and Buttons{{#if: Functionality| | Functionality }} ⇒

Each window that you open in ADempiere will likely provide you with the opportunity to enter data. This article describes the types of fields, buttons and controls that you will come across, the type of data that they will accept and how each of them functions. All the controls are listed below. The most common ones are String, Number, Date.

Several of the fields have helper functions, indicated by an icon/button at the right side of the field. The helper functions can be opened by clicking this icon. They may also open if the entered data is not clear or complete. The helper functions include the Calendar Tool, Calculator Tool, Search and Info windows (See the Functionality list), and others.

Account

The Account Element control displays the details of a selected Accounting Dimension or combination. (See Accounting Dimensions for more info.) It is usually found on Accounting tabs which provide accounting information related to the parent tab.

 

 

Data can be typed into the field as text. The data that is entered will be assessed as follows:

• If the text is null, zero length or equals "%", the Account Dialog will be opened.
• If the text does not end with a percent sign "%", one is added as the last character.
• The software then looks for a valid combination where the alias or the combination string match the text
• If there is a single match, the field is filled with the valid combination.
• If there is no match or more than one match, the Account Dialog is opened.

The Account Icon () can also be pressed to activate the Account Dialog. A combination selected in the Account Dialog will be displayed once the dialog is confirmed and closed. If the Account Dialog is canceled, the Account field will be cleared.

(Software: client/src org.compiere.grid.ed.VAccount.java)

Amount

Amounts are numeric fields with a minimum precision of 2 decimal places and a maximum of 12. Amount fields are typically used for monetary values. See Number for more information.

Assignment

The Resource Assignment field provides a way to assign resources to schedule slots. If a resource assignment exists, the field will show the resource name, the date of the assignment and the number of slots used or it will display the resource assignment ID.

The Assignment field is typically found on the {{#if: Sales Order|Sales Order|SalesOrder }} Window on the {{#if: Order Line|Order Line|OrderLine }} Tab.

There is no way to enter data directly in the field. You have to use the helper functions. Clicking the Assignment helper function () will do the following:

• If the Assignment field is blank, it will open the Schedule Info window where you can double-click on a the starting schedule slot. The double-click will open the Resource Assignment dialog which displays information about the assignment.
• If the assignment already exists, the Resource Assignment dialog will open directly.

Confirming and closing the Resource Assignment dialog will save the assignment to the Assignment field. Canceling the Resource Assignment dialog will clear the Assignment field.

For more information see:

• Schedule Info
• Resource Info
• Resource Assignment

(Software: client/src org.compiere.grid.ed.VAssignment.java)

Binary

Binary Data fields can be used to store pretty much anything that can be found in a computer's file system. The binary data is stored as a BLOB or Binary Large OBject. The Binary field appears in ADempiere as a Button. Clicking the button will open the File Chooser and allow you select a BLOB (any file) and save it to the database. The button text will show the following:

• "-" if there is no data stored
• "#xyz" where xyz is the size of the data in bytes
• The name of the class object stored
• "?" if the data is not byte data and not a class.

If a blob is already saved, clicking the button will allow you to reverse the process and save the BLOB to the file system.

ADempiere does not make direct use of Binary fields in windows and tabs but they are used by the software for Attachments, Images, Migration scripts and class instances. However, nothing prevents you from using Binary fields in any custom windows and tabs you develop.

Note: PostgreSQL version 9 was recently released and is not backwards compatible with earier versions. One of the changes was in the manner that BLOBs were stored in the database. We recommend you use PostgreSQL version 8.4 or earlier until we fix this.

(Software: client/src org.compiere.grid.ed.VBinary.java)

Button

Buttons perform a command of some sort - starting a process, running a script or performing some other task.

The Button is defined as a field in the database, but data may not be stored there. Instead, the record in the Column definition includes information that determines how the Button is to function. There are a few special cases.

If the column name is:

• Record_ID (), then the button performs the Zoom function, going directly to the default window and tab for that record. This is useful in situations where the current window is reporting on the status of another record, such as in the Workflow windows. The Record_ID value is pulled from the context. There are a few special cases of this as well:
  • If the current tab does not have a Record_ID and the key column name is "AD_Language", the Record_ID is set to the AD_Language_ID value.
  • If the current tab does not have a Record_ID and the process associated with the Button is "Un-Do Changes" or "Re-Do Changes", then the Record_ID is set to the AD_Changelog_ID.
• PaymentRule (), clicking the Button will pop-up the Payment Dialog. If the invoice is not completed, the Payment Dialog will be limited to payments types. If the invoice is completed, the Payment Dialog will allow you to complete a full payment. This is very useful in POS applications when using POS Orders or Credit Orders with Invoice Indirect and immediate payment. The button text will reflect the payment method chosen.
• DocAction (), clicking the Button will open the Document Action Dialog. This dialog allows you to set the status (Drafted, In Progress, Completed, Closed, etc...) of the document. Changing the status will trigger the associated workflow process, if any, the document processing engine and the accounting engine. The button text will reflect the next document action in the normal workflow.
• CreateFrom () and there is no process associated with the Button, clicking the Button will open a Create From Dialog where a record from the same tab can be selected. The subordinate tabs of the selected record will be copied to those of the current record. This is useful for Invoices and GL Journals which often repeat the lines. If there is a process defined, the process may be started instead.
• Posted () and the User's role has Show Accounting in the {{#if: |{{{2}}}|Role }} Window, then if the document is processed and posted, clicking the button will open the Account Info dialog with the Select Document set to the current document. The accounting consequences or financial accounting details of the posting will be shown. Note that the Re-post button will be enabled. If the document has not been posted yet, clicking the button will open a dialog that asks "Post Immediate?". Confirming this dialog will cause the record to be posted. Typically, the Posted button is hidden and will only appear once the document has been completed, closed, reversed or voided. The label of the button will reflect the status of the posting.

If none of the above apply, the software checks to see if a process is defined for the Button and attempts to run that process or invoke a custom form.

Color

Color element

Costs+Prices

Costs + Prices are numeric fields with a minimum precision of 2 decimal places and a maximum of 12. Costs + Prices fields are typically used for monetary values. See Number for more information.

Date

Date mm/dd/yyyy

Date+Time

Date with time

FileName

Local File

FilePath

Local File Path

ID

10 Digit Identifier

Image

Binary Image Data

Integer

The Integer field is a numeric field with no fractional part and a maximum of 10 digits. See Number for more information.

List

Reference List

Location (Address)

Location/Address

Locator (WH)

Warehouse Locator Data type

Memo

Large Text Editor - Character String up to 2000 characters

Number

Number fields provide a way to enter and display numeric values. There are several types:

• Amounts
• Costs + Prices
• Integers and
• Quantities

The default number field has a maximum of 28 digits in the integer part and 12 digits in the fractional part. The default presentation is as a float number with one digit after the decimal. The number of digits in the presentation varies with the type of field.

All the numeric fields use the Calculator Tool as the helper function. To access the Calculator, click on the Calculator icon ().

The presentation of the field for all the numeric fields can be overridden by defining a number format in the {{#if: |{{{3}}}|Column }} Tab of the {{#if: Table and Column|Table and Column|TableandColumn }} Window.

(Software: client/src org.compiere.grid.ed.VNumber.java)

Product Attribute

Product Attribute

Quantity

The Quantity field is a numeric field with a maximum of 12 digits in the fractional part and 28 digits in the integer part. See Number for more information.

RowID

Row ID Data Type

Search

Search Field

String

Character String

Table

Table List

Table Direct

Direct Table Access

Text

Character String up to 2000 characters

Text Long

Text (Long) - Text > 2000 characters

Time

Time

URL

URL

Yes-No

CheckBox