Commissions Report
From UG
(Difference between revisions)
(→Figures: added Commissions Report HTML Output (Summary)) |
(→Preliminary Design: Template Description) |
||
| Line 18: | Line 18: | ||
=== Template === | === Template === | ||
| - | * On the report template are filters to configure the report generation. See [[#Figure 1. Commissions Report Form (Template) | + | * On the report template are filters to configure the report generation. See [[#Figure 1. Commissions Report Form (Template) | Figure 1]]. These fields: |
| - | ** '''Time Frame''' - . It can be of two types: | + | ** '''Time Frame''' - Range of the report's time frame. It is set by two filters - "From" and "To" and can be of two types: |
| - | *** Month and Year - . | + | *** ''Month and Year'' <span style="color:#008000">(default)</span> - "Time Frame" is defined by two pairs "Month-Year" values of "From" and "To" filters. They are displayed on the template as two pairs of dropdown lists: |
| - | *** Date Range - . | + | **** "Month" dropdown what contains 12 months' names, "Year" dropdown with values from 2010 to current year. |
| - | ** '''Output Type''' - . | + | **** <span style="color:#008000">By default:</span> "From" pair set to first month of current year, "To" pair set to current month of current year. |
| + | *** ''Date Range'' - Range of the report's time frame is defined by two standard dateboxes, each of which corresponds to its filter. | ||
| + | **** <span style="color:#008000">By default:</span> "From" datebox set to first day of current year, "To" datebox set to today. | ||
| + | ** '''Output Type''' of the report displayed on the template as radiogroup and can take two values: | ||
| + | *** ''Summary'' <span style="color:#008000">(default)</span> - this type of the report contains the summary values of monthly commission amounts. These amounts are grouped by Sales Persons and displayed for each Salesman Account per each month from the "Time Frame" filter of the report. See [[#Figure 2. Commissions Report HTML Output (Summary) | Figure 2]]. | ||
| + | *** ''Details'' - this type of the report contains more detailed information about monthly commission amounts, [[TBD]]. | ||
** '''Currency''' - the currency in which the payment of commissions. It would depend upon the country in which the salesman is physically located. | ** '''Currency''' - the currency in which the payment of commissions. It would depend upon the country in which the salesman is physically located. | ||
| - | ** '''Sales Persons''' - . | + | *** It can take two values: "by Office" <span style="color:#008000">(default)</span> and "USD". In default case the commissions amounts should be shown in the currency what is set as default for Salesman's office. Otherwise, all amounts should be recalculated to USD. |
| - | ** '''Client Companies''' - . | + | ** '''Sales Persons''' - dropdown list which corresponds to the list of Jaguar Users who are Sales Persons. <span style="color:#008000">By default</span> is blank. |
| + | ** '''Client Companies''' - dropdown list which corresponds to the list of Client Companies that are Salesman Accounts. <span style="color:#008000">By default</span> is blank. | ||
* Every filter is connected by AND and sub selections inside each filter combo-box are connected by OR. | * Every filter is connected by AND and sub selections inside each filter combo-box are connected by OR. | ||
* If a filter is not set, that means "all". For example, if Salesman Persons filter is blank, then report will include all Salesman Persons info. | * If a filter is not set, that means "all". For example, if Salesman Persons filter is blank, then report will include all Salesman Persons info. | ||
| - | + | * There are two buttons on the template of the report: | |
| + | ** ''Reset Form'' - when click on this button, then all filters should be set to the default values. | ||
| + | ** ''Generate Result'' - when click on this button, then the report is generated in accordance with the filters. | ||
=== Output === | === Output === | ||
Revision as of 15:45, 1 July 2010
Contents |
Gen
- parent: [650]
Business Requirements
Commissions Report is required by Acc Dept.
Purpose of the report is to calculate commissions per Client Company in USD for specific Sales Person during specific time frame.
Preliminary Design
Summary
- Commissions Report is available from Main Menu on the next path ("Acc -> Reports -> Comissions Report"). See on Figure 0.
- Report should be contain monthly commission amounts. These amounts (commissions) are calculated per one or more Client Companies for specific Sales Person (Salesman) (or for list of Sales Persons) during specific time frame as described in #Business Requirements.
Template
- On the report template are filters to configure the report generation. See Figure 1. These fields:
- Time Frame - Range of the report's time frame. It is set by two filters - "From" and "To" and can be of two types:
- Month and Year (default) - "Time Frame" is defined by two pairs "Month-Year" values of "From" and "To" filters. They are displayed on the template as two pairs of dropdown lists:
- "Month" dropdown what contains 12 months' names, "Year" dropdown with values from 2010 to current year.
- By default: "From" pair set to first month of current year, "To" pair set to current month of current year.
- Date Range - Range of the report's time frame is defined by two standard dateboxes, each of which corresponds to its filter.
- By default: "From" datebox set to first day of current year, "To" datebox set to today.
- Month and Year (default) - "Time Frame" is defined by two pairs "Month-Year" values of "From" and "To" filters. They are displayed on the template as two pairs of dropdown lists:
- Output Type of the report displayed on the template as radiogroup and can take two values:
- Summary (default) - this type of the report contains the summary values of monthly commission amounts. These amounts are grouped by Sales Persons and displayed for each Salesman Account per each month from the "Time Frame" filter of the report. See Figure 2.
- Details - this type of the report contains more detailed information about monthly commission amounts, TBD.
- Currency - the currency in which the payment of commissions. It would depend upon the country in which the salesman is physically located.
- It can take two values: "by Office" (default) and "USD". In default case the commissions amounts should be shown in the currency what is set as default for Salesman's office. Otherwise, all amounts should be recalculated to USD.
- Sales Persons - dropdown list which corresponds to the list of Jaguar Users who are Sales Persons. By default is blank.
- Client Companies - dropdown list which corresponds to the list of Client Companies that are Salesman Accounts. By default is blank.
- Time Frame - Range of the report's time frame. It is set by two filters - "From" and "To" and can be of two types:
- Every filter is connected by AND and sub selections inside each filter combo-box are connected by OR.
- If a filter is not set, that means "all". For example, if Salesman Persons filter is blank, then report will include all Salesman Persons info.
- There are two buttons on the template of the report:
- Reset Form - when click on this button, then all filters should be set to the default values.
- Generate Result - when click on this button, then the report is generated in accordance with the filters.
Output
Figures
Figure 0. Commissions Report Menu Item
Figure 1. Commissions Report Form (Template)
Figure 2. Commissions Report HTML Output (Summary)
Figure 3. Commissions Report Spreadsheet Output (Summary)
History
m1878
- 0001878: (*ph1)(Sales Commission) Create this new report; Add "percentage" field into Client Company profile
- see #Solution
- link to this version: http://mantis.jaguarfreight.com/mediawiki-1.15.0/index.php?title=Commissions_Report&oldid=9616
