INTRODUCTION TO THE WEB APPLICATION
The Compiere Web Application provides an alternate method for accessing all of the rich features and functionality of the Compiere ERP & CRM product. This chapter is dedicated to User Interface features and navigation in Compiere's Web Application.
To open Compiere using the Web UI enter compiere.com/apps/Compiere.html in your browser. This is prefixed by the server hosting the application.
Similar to the Java Client, enter your User ID, password, and select a language.
Select the Select Role check box if you want to change the role to be used. If the role is not updated, Compiere will use the Role you last logged in with. Your Role determines which windows, processes, reports, and such that you can access within Compiere.
Click the OK button to be brought to the Main window.
The window is divided into 3 mains sections, Left Pane, Upper Pane, and Main Window Pane.
The Upper Pane displays the UserName entered when logging into Compiere. If you click on the User the Tenant, Organization and Role selected will be displayed.
If you click Select Role you will be brought to the Role selection window where you can select a different Role.
Log off will log you off of Compiere and display the Log In window.
In the center are the four dashboard icons.
These icons are displayed for the web session and allow for easy navigation to specific areas of the system.
My Applications will display all data entry windows available to the user.
My Reports will display all reports available to the user.
My Views will display any saved views or queries.
My Dashboard will display Alerts and Notices for this user.
The Left Pane is divided into four sections, Menu, Create New, Favorites and Recent Items. Create New and Favorites are user configured.
Selecting Home will return you to the Home Page.
You can access the Menu items in two ways. You can select Main Menu and the Menu tree will display. You can select a specific folder and its children will display.
If you select a menu item that is not a folder the selected window, process, or report will display.
Each menu item has an icon which indicates the type of function the window performs.
The Window icon represents a Window. A window is where a record is defined or data is entered such as Sales Order or Tax Category.
The Report icon represents a Report. A report will generate an on-screen report which can be modified and printed such as Invoice Summary.
The Process icon indicates a Process. A process can be thought of as a job or task that runs in the database or on the server such as Generate Invoices.
The Folder Icon indicates a grouping of other folders, windows, reports or processes.
The second method is to enter a string of characters in the search box and a list of menu items which meet the search criteria will display. The search is not case sensitive and will return all items which match the string wherever that string resides. In effect, leading and trailing wild-cards are used so entering order will display Open Orders, Purchase Order, and Sales Order.
The search process will display only executable items in the menu. Folders are not included in the results.
The Create New section allows you to provide a list of menu items where, when selecting the window will be displayed in new record mode. This is a quick way to create new entities. The other option is to search for the window, open it and select New Record. This list is user configurable and items are added or removed from the list by selecting the New Record Button.
The following form displays which allows for the selection and removal or items from the list.
Select an item or multiple items (using Ctrl Click) and use the right or left arrows to move items from the Excluded Items list to the Included Items list and vice versa. Use the Up and Down arrows to move the position of the selected item in the Included Items list.
Click OK to save the changes and Close the window.
When there are items defined in the Create New list, they can be selected from the drop down list box.
Selecting one of the items in the list will open that window for entry of a new record.
Selecting the Collapse button will display the drop down list box.
Selecting the Expand button will hide the drop down list box.
Similarly, the Favorites list allows for the definition of those windows, reports and processes that are used on a regular basis. This list is also user configurable and items are added or removed from the list by selecting the New Record Button.
Select an item or multiple items (using Ctrl + Click) and use the right or left arrows to move items from the Excluded Items list to the Included Items list and vice versa. Use the Up and Down arrows to move the position of the selected item in the Included Items list.
Click OK to save the changes and Close the window.
When there are items defined in the Favorites list, they will be displayed in the left pane.
Selecting any item in the Favorites list will open that window, retrieving any appropriate records.
Selecting the Collapse button will display the Favorites list.
Selecting the Expand button will hide the Favorites list.
The Recent Items list displays the windows that have been accessed and updated. If a record is not modified or added, then the window will not be listed in the Recent Items list. For example, if the Product Window is queried but no updates are made, the Product Search results would not be added to the Recent Items List. If a new Product was added, then the product window specific to the new Product entered would be included. Selecting that item in the Recent Items list would open the Product window with the new record selected. Similarly, if a Sales Order is updated by adding a new Sales Order line, the Recent Items list would be updated. Selecting that item in the Recent Items list opens the Sales Order window (header tab not the line tab).
Selecting the Collapse button will display the Recent Items list.
Selecting the Expand button will hide the Recent Items list.
The Recent Items list will contain the 10 most recently updated windows.
The Left Pane can be hidden by selecting the Hide button.
The Left Pane can be displayed by selecting the Show button.
Note: When the Left Pane is hidden, the Home and Menu tab will still display.
Main Window Pane
The Main Window Pane is where all data entry and update will occur. It is also where reports and processes will be initiated.
When no data windows are displayed, the four dashboard icons will display. Selecting any one of the icons will return the same data as selecting the smaller icon at the top of the window. These were discussed in a previous section.
The following chart documents the icons used and their function within the Web User Interface.
The Main Window Pane contains three tabs in the upper right corner.
View allows you to access the Info windows. These include Business Partner, Product, Invoice, Payment, Order, Shipment and Asset.
Click on View to access the list of Info Windows available.
Click on the desired entry in the list to display the search window for the selected entity.
The search functionality is the same as in the java client.
For additional information on Searching in Compiere, refer to the Common Functions and Commands Chapter.
Preferences allow you to set or change you user preferences.
Click on Preferences to access the options.
Select a different UI Theme to change the look and feel of the application.
Enter a Printer Name to be used as the default printer when printing documents or reports.
Select the Auto Commit check box to indicate that you do not want a confirmation message returned on the save of a record.
Select the Show Advanced Tabs to display advanced informational tabs in the appropriate windows.
Note: UI Theme and Show Advanced Tabs may not be implemented in the initial release.
For additional information on Advanced Tabs, refer to the Common Functions and Commands Chapter.
Click OK to save the preferences. These preferences are effective immediately.
Help will access window help defined in Compiere. The Help window displayed is dependent upon the current window that is active. For example, clicking on Help while the Product window is displayed would result in the following pop up window.
Click OK to close the Help window.
The Main Window Pane will change based on the item that has been selected. For example, if Sales Order has been selected, the window will display all Sales Order that have been created or updated on the current day or that are not in a completed status. If a Generate Invoices is selected then the window will display the parameters for the process.
The grid view displays as a result of a search on Product. While the records are displayed in grid mode, the bottom scroll bar can be used to display additional fields for each record.
The record count for this page and the total record count are displayed at the top and bottom of the grid. If more than 20 records are returned the Next and Previous buttons will display. These can be used to navigate through the pages.
When the Main Window pane is in grid mode the Search box appears at the top of the window.
The Search in the Web User Interface functions in the same manner as the java client. You can search on any field that is defined for the Business Partner window. You can enter a full or partial Search Key, Name, Name2 and/or Description. If more than on field is populated, and logic is used.
To search on field values other than the initial four search fields, click on the Advanced Search tab.
Select the desired Column to search on, Operator and Value (from and to) as appropriate.
You can add additional columns and criteria by selecting Add Criteria.
When all criteria have been entered select the Search button.
Optionally enter a value in Save as View field to save the query search criteria for future use and select the Save button.
Click the My Views tab to execute the search using queries you have saved.
Select the desired query from the My Views drop down list box and click the Search button.
Select the History to view records that have been created or updated in a particular time period. This is most often used with transaction windows (Orders, Invoices, Shipments, etc.).
Select a Time View of All, Today, Week, Month, or Year.
Select the Created check box to indicate the query should return records created in that time frame. Leaving the box unselected would return records created or updated in the selected time frame.
When in grid mode you have the following options.
Select one or more records and then select an Action of Report Records, Export Records or Delete Records.
When Report Records is selected the following dialog is displayed.
Select an existing Print Format from the drop down list box.
Select a File Format of pdf or csv.
Click OK to execute the report.
To modify an existing Print Format click on the Print Format field label and select Zoom.
Note: Reports and Zoom will result in a new browser being opened to display the report or to display the zoom target window.
Click on any field for a row in grid mode to execute the following options:
Select Edit Record to edit the selected record in Grid mode.
Select Delete Record to delete the selected record (all integrity constraints enforced)
Select Copy Record to create a copy of the existing record to be edited in Grid Mode.
To edit a record in Single Record mode select the Edit button.
In single record mode the focus tab is displayed in single record mode and the dependent tab(s) are shown in grid mode.
The record count next to the window name allows navigation through the records that were contained in the search results set.
The toolbar at the top of the window is applicable to the parent record.
The toolbar above the grid View is applicable to the dependent tab (in this example Customer Tab of Business Partner).
Select any of the tabs displayed to see the records defined.
To see any of the dependant records of a tab (for example Interest Areas for a Contact (User)), select that tab and then open the desired record in edit mode.
To return back to the Search results click the 'Search' link next to the window name.
Note: These 'bread crumbs' will be present each time you move from a search to a single record or from a parent to dependent record. For example, if a Sales Order is created and then the lines are entered, to return to the Sales Order header to complete the document, click on the Order bread crumb that is displayed next to the window name.
The Keyboard shortcuts for Compiere in the Web User Interface are listed as follows:
F10 or Ctrl-Alt-M
Focus on the main auto-completion menu
Focus on the parent region; if already in parent region, focus on the child tab region (only works in window/tab/field windows)
Focus on the grid when focus on the child tab region
F1 or Ctrl-Alt-H
Toggle the display of performance metrics
Go to parent tab; equivalent to clicking on the parent breadcrumb
Ctrl-1 - Ctrl-9
Go to child tab 1 through 9, respectively
Go to previous page
Go to next page
Go to first page
Go to last page
New record (parent record when focus in grid)
Open New (grid mode only)
Inline New (grid mode only)
Toggle between single record and multi record view
Delete (single record mode only)
Refresh or Requery
Report (single record mode only)
Export All (grid mode only)
Report All (grid mode only), or Report (single record mode only)
Print (single record mode only)
Zoom Across (single record mode only)
When the focus is in the grid:
Move record selection up and down the grid
Edit in single record mode
Edit field without over-writing existing value
Edit field over-writing existing value
When the focus is in an info window or dialog box:
OK Button on the info window or dialog box
Close the info window or dialog box (Cancel button in the info window)
Clear the selection (Clear button in the info Window)
Execute Search in the info window
Open the Price History info window
Open the Product Attribute info window
Open the Locator Details info window
Zoom to the selected record from an info window
Hints and Tips
WEB APPLICATION HINTS AND TIPS
- Do not use the forward and back buttons on the browser. They will result in an error message or being returned to the Home page.
- Do not use the refresh button on the browser. It will result in an error message or being returned to the Home page.
- Reports will open a new browser with the report displayed as a PDF.
- If you want to select a print format other than the default print format, invoke the report from the grid view and select an Action of Report.
- Zoom targets (Zoom where used and Zoom where defined) will open a new browser with the target record(s) displayed.
- Zoom and Re-query for a field in a window are invoked by clicking on the field label.
- When you are in a date field, you can use the + and - keys to increase or decrease the date.
- When you are in a numeric field you can use the key operands (+, -, * and /) to perform calculations.
- To select or deselect a check box in grid mode either tab to the field and use the space bar to select or deselect the check box, or using the mouse double click outside the check box (but inside the column).