Compiere 3.8 GA Quick Info Widgets 07/15/2012

Transcription

1 Compiere 3.8 GA Quick Info Widgets 07/15/2012 Quick Info Widget Quick Info Widget is a customizable side bar that can be attached to any window within Compiere. It appears on the right side of the window in the User Interface, with a look and feel similar to the current 'Recent Items' side bar. Within the side bar are links, which when followed, opens a second window and takes the user to the related detailed information. The purpose of Quick Info is to let users show useful information in various windows as their requirements dictate. Quick Info data is derived from SQLs, which can be based on tables other than that of the current window and can make use of all the current window's context variables. It is particularly helpful for transaction windows where it can be used for showing additional related information, assisting the user when entering and analyzing transactional data. Quick Hits on the Quick Info Window: 1. They are user definable, meaning an organization may add Info Widgets to their install as desired for their own business needs. 2. Quick info data will change on context when field changes. Example: If product number is changed from Elm tree to Azalea bush on the sales order entry line, quick info details for the product will change when the field is changed. The User does not have to save information to see the new quick info data. 3. They are delivered in Compiere 3.8 with various commonly used setups. NOTE: If you do not wish to use the delivered Quick Info Widgets in your implementation, they can be set to inactive in the Quick Info window (requires System Admin privileges). 4. They may be collapsed from the window view when not in use. Delivered Info Widgets Compiere 3.8 is delivered with the following Quick info Widgets: 1. Sales Order with drill-downs to: a. Price History

2 b. Cost History c. Vendors d. Inventory available e. Inventory on-hand f. Inventory on-order Sales Order Examples:

3 2. Purchase Order with drill-downs to: a. Vendor purchases to date b. Cost History c. Vendors g. Inventory available h. Inventory on-hand i. Inventory on-order

4 Purchase Order Example

5 3. Request for Quote (RFQ) a. Last Quote b. Open Quotes RFQ Example

6 Steps to create a Quick Info Widget Login as System Administrator and Navigate to > Quick Info window 1) Create a Quick Info Header Add a Name for the Quick Info. Optionally enter a Description for the Quick Info. 2) Add Quick Info lines to the Header Open the Quick Info Line sub tab. Enter a name for the Quick Info line. Optionally Enter a Description for the Quick Info line. The value shown in front of the Quick Info Line prompt is based on the SQL statement specified in the SQL field.

7 SQL setup for Quick Info lines a. SQL queries for Quick Info line should return a single value. In case the SQL query returns multiple columns and rows, only the first column of the first row from the result set will be considered for display. Other SQL clauses e.g. ORDER BY, GROUP BY should be strictly added to Other Sql Clause column The queries can use the context variables that are available in the window to which the Quick Info is attached. Context variables can be specified by using notation. Reference field specifies the reference type of the value returned by the SQL. If the value returned from the SQL is based on a database column, then it is recommended that a user specifies the same reference type as that of the database column. In the example shown below, the Reference is 'String' which is the same as the reference type of the column "SOCreditStatus". For reference type 'List ', the reference key also needs to be specified. There are restrictions on the format of the SQL query for the reference type URL, which will be discussed later. Nested queries and complex joins are not allowed directly. A view must be created for this. Since Quick Info fields are updated dynamically, care should be taken about performance of quick info queries.

8 b. Reference Type Table Direct and Zoom support Reference type of 'Table Direct ' is used for those database columns in which the corresponding table name can be derived by removing the '_ID ' post fix from the column name e.g. C_Order_ID. Window field specifies the target window in which the selected record ID opens up when the user clicks on the window link in the Quick Info widget. In addition to window, user should also specify the 'System Element' for the selected ID column in the query.

9

10 c. Drill down support: Window link allowing users to drill down on the detail information (e.g. drill down to 5 open requests related to the current business partner in the Sales Order window). Drill downs are limited to header level tables. Set up required for Drill down is as follows: Open Requests: 5 SQL required in the example shown below: SELECT count (*) FROM R_Request WHERE C_BPartner_ID=@C_BPartner_ID@ SQL for Drill down should be written strictly in simple SELECT - FROM - WHERE format SELECT should specify the information that needs to shown in the UI. FROM should specify a single table. Joins with multiple tables and sub queries in the WHERE clause are not supported. Alias should not be used for the table name. WHERE should specify the conditions on the table specified in the FROM clause. Reference should be selected as URL. User should specify the target Zoom window in which the corresponding records should open on clicking on the window link.

11 Note in the example below the selected window is based on the table selected in the FROM clause of the SQL.

12 3) Attach the newly created Quick Info to a Window Navigate to > Window, Tab and Fields window Search for Sales Order window and open the Sales Order Header tab. Select the newly created Quick Info from the drop down list in the Quick Info field. Save.

13 Output for the above Quick Info setup will look as follows This concludes the documentation for Quick Info Widgets