develop
Entering Data - Fields and Buttons
Each window, form and process uses fields and buttons to display and gather data. This page describes how to use the various types.
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 and Search.
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.
Unless noted in the field notes, most fields will accept and lose the focus as the <Tab> key is typed on the keyboard. When buttons have the focus, the buttons can be activated by typing the <Space> key. Each field also controls the pop-up menu that appears when the mouse is right-clicked over the field.
Data entered into a field is not processed until the field loses focus or, unless noted in the field notes, the <Enter> key s typed.
The fields and buttons are similar between the Web Application and the Java Client.
Color
A Color element provides a way to set a color in the database. The Color control appears as a button. Clicking the button will open a color dialog where the color properties can be set. Colors can be selected using the java swing JColorChooser tool.
The Date control maintains data as a time stamp in a format consistent with the locale and language of the user's system. The format definitions follow the Java class SimpleDateFormat. If no default format is found, the JDBC standard will be used "yyyy-MM-dd". Local formats will be converted to contain at least "dd" and "MM" numbers in the format code. Year codes will be increased to at least four digits.
The Date control operates like a text field where data can be input by keyboard entry. The digit being entered is enclosed in blue square brackets and format characters are ignored - just type the numbers.
The pop-up menu displays the following options:
Date with time control is similar to the Date control but includes the time component with the full timestamp format of yyyy-MM-dd HH:mm:ss. The text field can't be edited directly so you have to click the button to open the Calendar Tool to enter the values.
The FileName control is intended to hold a file name that can be found in the local default directories. Clicking the button will open the File Chooser dialog where you can select the file of interest. You can also enter the file name in the text field directly.
Local File Path control is similar to the FileName control but is restricted to a directory path only - no file names. Clicking the button will open the File Chooser dialog where you can select the directory of interest. You can also enter the file path in the text field directly.
The ID control identifies a specific record in a table using the *_ID field. The control uses a lookup/search to identify the record. What appears in the ID control is determined by the Identifier field selection in the Column Tab of the Table And Column Window where the *_ID field is the key. For example, the Value can be Identifier 1 and Name Identifier 2, appearing as Value_Name. References (see the Reference Window) can also be used to control what is displayed in particular windows/fields.
For most ID columns, the ID control will present a combo box with a list of available values. As you type text in the control, the combo box will drop down and the most likely choice will be selected. Typing <Enter> of selecting the entry with a mouse click will save the data in the field.
If there is an Info window associated with the target table, the icon in the button will change to (​
​). Text entered in the field will be compared with common columns in the table to find a match. If no match is found, more than one match is found or the button is clicked, the associated Info window will appear. Selecting and confirming a record in the info window will cause the ID field to be filled with the associated ID. Canceling the Info window will clear the ID field. Closing the Info window will have no effect. See Functionality for a list that includes the info windows.
The following ID fields behave slightly differently:
- Product ID (​​): text typed into the field will be matched with the Name, Value or Search Key and SKU. If a single match is found, the ID field will be filled with that Product ID. If more than one match is found, no matches are found or the text is a wild card "%", then the Product Info dialog will be opened. The ID field will be filled by the selected and confirmed value in the Product Info dialog. Canceling the Product Info dialog will clear the ID field. See Product Info for more information.
The pop-up menu in a Product ID field will display the following entries:
- Business Partner ID (​​): text typed into the field will be matched with the Name, Value or Search Key. The search will be limited to customers or vendors depending on the nature of the transaction (IsSOTrx?) of window on which the ID is found. If a single match is found, the ID field will be filled with that Business Partner ID. If more than one match is found, no matches are found or the text is a wild card "%", then the Business Partner Info dialog will be opened. The ID field will be filled by the selected and confirmed value in the Business Partner Info dialog. Canceling the Business Partner Info dialog will clear the ID field. See Business Partner Info for more information.
The pop-up menu in a Business Partner ID field will display the following entries:
Image
Image fields can be used to display images that are stored in the database as binary data or linked to a URL. When the Image field is initially displayed, it will appear as a button with the text "-" displayed. Clicking on this button will open an Image dialog which appears as a small window as shown below.
The dialog has three buttons: the standard Cancel and Confirm, and a small button "-" labeled Select File. Clicking this last button will open a file chooser where you can select an image from the file system. When the image is selected and opened, it will appear in the Image dialog and the button will hold the file name. Clicking Confirm will save the image to the database. Clicking Cancel will delete any image saved in the database and close the window. Closing the window will have no effect.
Once an image is saved in the database, it will appear in the window/tab in place of the button. The image will be sized to fit within a box defined by the column width set for that column in that tab.
Clicking the image again will re-open the Image dialog with the image loaded. To delete the image, click the Cancel button. Clicking the button with the file path/name will open the file chooser where you can select another image. Click Confirm to save that image to the database.
Integer
The Integer field is a numeric field with no fractional part and a maximum of 10 digits. See Number for more information.
List
A List appears as a combo box pre-filled with values that you can select. As you type in the box, the combo box will expand to show the best choice based on what you have typed. Type <Enter> to select it, or use the mouse to select the list entry. To set the List field to null, select the blank entry in the list.
See also
The Location control provides a way to attach an address to a record. The Location control does not accept text directly but the button can receive the focus and can be activated from the keyboard by typing <Space>. You can also click on the button (​
​). This will open the Location Dialog where you can specify the full address.
When the Location Dialog is closed, the Location control will display a summary of the address information entered.
There is no way to fully clear the Location control once data has been entered. The pop-up menu item Delete will delete the record by clearing the entry and will open the Location Dialog. Canceling the dialog will only clear some of the information, leaving defaults in place.
The pop-up menu (right-click) provides options to:
The Warehouse Locator field displays the key field of a warehouse location. Both the field and the button will accept the focus.
Text typed into the Locator field will be compared to valid locations already defined. If the window already references a warehouse or a product, the locator entries will be limited to valid values for these references. If a single match is found, it will be used. If the text consists of a single percent symbol (wildcard %), no results are returned or more than one result is found, then the Locator Dialog is opened as shown below.
The Locator Dialog can be used to select an existing Locator reference or define a new one. If a new entry is defined, the Key value will be used to identify it in the Locator field.
The pop-up menu (right-click) provides options to:
Memo
The Memo field will accept character strings up to 2000 characters. It is similar to the Text and String fields with the exception that it uses a text area with 80 columns width and a height of 50 rows and can't be encrypted. If the text in the field exceeds the size of the text area on the screen, scroll bars will appear.
The memo field will accept the focus but <Tab> characters will be entered as text. Use <Ctrl><Tab> or <Ctrl><Shift><Tab> to change the focus.
Typing <Escape> will reset the text to its previous value.
Printer Name
The Product Attribute field or Product Attribute Instance is a field dedicated to selecting or displaying a specific instance of Product Attributes. It appears as a text field with an icon/button (​
​). The text field will not accept the focus but the button will. You can double click the field or click the button to activate the helper function and open the Product Attribute Dialog.
The dialog displays the details of the product attribute instance. There are two controls:
- New Record (or Edit Record) - New is used when adding items to inventory. Edit is used to modify attributes on an order.
- Select an Existing Record - Used to select an existing attribute instance from inventory.
The pop-up menu for the field will have entries to
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
The Row ID Data Type is currently not active in the database.
A Search Field is used to look up data. The Search field appears as a combo box with a list of available values. The text field will accept the focus but the button can only be operated by the mouse.
As you type text in the control, the combo box will drop down and the most likely choice will be selected. Typing <Enter> of selecting the entry with a mouse click will save the data in the field.
Text entered in the field will be compared with common columns in the table to find a match. If no match is found, more than one match is found or the button is clicked, the associated Info window will appear. Selecting and confirming a record in the info window will cause the ID field to be filled with the associated ID. Canceling the Info window will clear the ID field. Closing the Info window will have no effect.
There are a few special cases:
- If there is an Info window associated with the column name, that info window will be used to perform the search. See Functionality for a list that includes the info windows.
The pop-up menu (mouse right-click) will have the following options:
See also
String
String fields are one of the most common types of fields in the database. A String is simply a sequence of up to 2000 characters but it is intended for shorter amounts of information.
The String field appears as a simple text field. It can accept and lose the focus with the <Tab> key. The <Escape> key will reset the value. It can be encrypted, like a password, if necessary and can have an "auto complete" feature enabled. It can also have special formatting applied.
The pop-up menu (right-click) provides options to:
Table
Table Direct
Text
The Text data field is used for character strings up to 2000 characters long. It appears as a text area. It will be 2 rows high if the field length is less than 300 and three rows high otherwise. It is very similar to the Memo field.
The pop-up menu includes the following options:
- ​​​ Script Editor - if the column name is "Script" or ends with "_Script". This will open the Script Editor Tool​
See also
Text Long
The Text (Long) field is intended for Text > 2000 characters in length. It is interpreted and presented as HTML text.
The pop-up control includes the following items:
See also:
The Time control is similar to the Date control but only shows the time component in the local format similar to h:mm:ss z or HH:mm:ss z. The text field can't be edited directly so you have to click the button to open the Calendar Tool to enter the values.
The pop-up menu (right-click) provides options to access:
Yes-No
Checking the box is equivalent to Yes. Deselecting the box is equivalent to No. The data is saved in the database as the corresponding letter "Y" or "N".
The pop-up menu (right-click) provides options to access:
Last modified 1yr ago