Commissions Report

From UG

Contents 1 Gen 2 Business Requirements 3 Preliminary Design 3.1 Summary 3.2 Template 3.3 Output 4 Figures 4.1 Figure 0. Commissions Report Menu Item 4.2 Figure 1. Commissions Report Form (Template) 4.3 Figure 2. Commissions Report HTML Output (Summary) 4.4 Figure 3. Commissions Report Spreadsheet Output (Summary) 5 History 5.1 m1878 5.2 m2057 5.2.1 BA 5.2.2 SA

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.
  • 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.
• 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

• Commissions Report displayed as one from two types which selected in the "Output Type" filter:
  • Summary - see Figure 2.
  • Detail - TBD.
• The report consists of Header and Body:
  • Header:
    • Report name
    • Criteria (list of filter(s) selected)
  • Body: (general info) consists of columns and rows grouped by Sales Persons:
    • Columns:
      • Sales Person / Salesman Accounts. This column shows a Sales Person with e-mail address at the first line of Salesman info.
        • Each next line contains a "Salesman Account" name in this column.
      • Month columns. Number of columns is equal of number of months that fit in the report's Time Frame filter.
        • All values in one line reflects monthly commissions' amounts for one Salesman Account.
      • Sum column. Reflects the total commissions for Salesman Account for the entire period (Time Frame).
    • Rows:
      • report headers row
      • Sales Persons group rows
      • Sales Persons group footer row
• After generating the report it can be downloaded to spreadsheet (f.e. Excel). See Figure 3 for Summary type of the report.
  • The report consists of Header and Body as described above, but additionally there is a Date Time Stamp and Jaguar Logo in header of report.

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

m2057

• http://64.115.223.3/mantis/view.php?id=2057

BA

See #Business Requirements

SA

see #Preliminary Design