Download (spec)

From RPM Wiki

Table of contents
1 Summary

1.1 Excel auto-complete

2 Rules

2.1 Excel
2.2 Format
2.3 Filenames

3 Downloads

3.1 Process management
3.2 Commission management
3.3 Agent management
3.4 Customer management
3.5 Other

4 Need
5 Security
6 History
[edit]

Summary

Data

Data overview

Import Download

Data types View columns

This is the functional spec for the various Download features. Technically, a download is any time a format other than a web page file is passed to the user. So far we have downloads that are XML, Word, and Excel. The general functionality of a download is the user clicks a "Download" link and is given the option by IE to open or save the file. Download links should always include an icon that indicates the file type.

  • This page does not cover downloading file attachments. See File attachment
[edit]

Excel auto-complete

The Excel auto-complete feature adds some great functionality to the regular Excel downloads from some view and details pages.

[edit]

Rules

[edit]

Excel

  • Break data into additional worksheets when row count exceeds one worksheet
  • NULL values create an empty cell (not "n/a", "none", etc.)
  • If a download is using the same columns as the grid the download is launched from then the order of the columns in the excel file should be the same as they are on the grid.
[edit]

Format

  • The column that shows all the phone numbers through a phone icon becomes a separate column for each type of number as needed.
  • When RPM creates an Excel file, it does not explicitly specify the data type and formatting of the columns. RPM simply gives Excel text data and then Excel does some guessing on what the format is. It's as someone had typed the data into Excel.
[edit]

Filenames

  • Specific filename rules are listed below for each download
  • Filename extensions are always lower case
[edit]

Downloads

[edit]

Process management

Form

  • Filename: "{PROCESS} {FORM NUMBER}.xls"
    • Example: "Quote Q0004.xls"
  • First column is field name, second column is field value

Form history

  • Filename: "{PROCESS} {FORM NUMBER} History.xls"
    • Example: "Quote Q0004 History.xls"

Forms (view)

  • Filename: "{VIEW NAME} - {DATE}.xls"
    • Example: "My forms - Dec 3, 2003.xls"
  • Rows and columns defined by view.

Reconcile

  • Filename: "{PROCESS} Reconcile.xls"
    • Example: "My forms - Dec 3, 2003.xls"
  • Rows and columns defined by view.
  • Separate worksheet for each tab on the page.

Template

  • Filename: "{PROCESS}.xml"
    • Example: "Order.xml"
[edit]

Commission management

Commission items (view)

  • Filename: "{VIEW NAME} - {RUN}.xls"
    • Example: "Nice sales - Dec 2003.xls"
  • Rows and columns defined by view.

"Download all data" (from agency summary)

  • Filename: "{AGENCY} comm items - {RUN}.xls"
    • Example: "AAA Networks comm items - Dec 2003.xls"
  • Download link on agency summary page (same for staff and agency managers)
  • Columns: Supplier, Rep, Rep ID, Customer, Account, Product, Qty, Net billed, Agent comm., Referral deduction, Split, Type, Note, Custom item and product variables.

Commission items (from rep summary)

  • Filename: "{AGENCY} {REP} comm items - {RUN}.xls"
    • Example: "AAA Networks John Smith comm items - Dec 2003.xls"
  • Rows: All items sold by this rep
  • Columns: Supplier, Rep, Rep ID, Customer, Account, Product, Qty, Net billed, Agent comm., Referral deduction.

Commission items (from agent user "Select an item" page)

  • Filename: "{AGENCY} comm items - {RUN}.xls"
    • Example: "AAA Networks John Smith comm items - Dec 2003.xls"
  • Rows: All items in the grid (all pages)
  • Columns: Supplier, Rep, Rep ID, Customer, Account, Product, Qty, Net billed, Agent comm., Referral deduction.

Commission items (from agent user "Select a referral item" page)

  • Filename: "{AGENCY} referral items - {RUN}.xls"
    • Example: "AAA Networks John Smith referral items - Dec 2003.xls"
  • Rows: All items in the grid (all pages)
  • Columns: Supplier, Selling agency, Rep, Customer, Account, Product, Qty, Net billed, Referral comm.

Summary (from Agent summary page)

  • Filename: "{AGENCY} summary - {RUN}.xls"
    • Example: "AAA Networks - Dec 2003.xls"
  • Worksheets:
    • Summary
      • Columns: Net billed, Sales commission, Referral commission, Adjustment, Referral deduction
    • Reps
      • Columns: Name, Items, Net billed, Total commission
    • Supplier
      • Columns: Supplier, Items, Net billed, Total commission
    • Customer
      • Columns: Customer, Items, Net billed, Total commission
    • Product
      • Columns: Product, Supplier, Items, Net billed, Total commission
    • Adjustments
      • Columns: Note, Commission
    • Referrals
      • Columns: Customer name, Account, Referral



Products

  • Filename: "{SUPPLIER} products - {DATE}.xls"
    • Example: "Qwest products - Dec 3, 2003.xls"
  • Rows: All products currently in the grid (counting all pages)
  • Columns: The same columns shown in the grid

Adjustments (from adjustments pages, staff only)

  • Filename: "{Supplier OR Agency} adjustments - {RUN}.xls"
    • Example: "Agency adjustments - Dec 2003.xls"
  • Rows: All adjustments of that type from that run
  • Columns: Use the columns shown on the page

History (Staff and Agents)

  • Filename: "{THING} commission history.xls"
    • Example: "21st Century Trunk commission history.xls"
  • Rows and columns are those shown in the grid.
    • Download is for: Agency, Rep, Customer, Account, Account group, Product, Supplier

Deposits

  • Filename: "Deposits - {Run}.xls"
    • Example: "Deposits - Dec 2003.xls"
  • Rows: One row for each supplier that has deposits.
  • Columns: Supplier, Date, Deposit, Note

Items paying a referral

  • Filename: "{Run} - Referral Items.xls"
    • Example: "Dec 2003 - Referral Items.xls"
  • Rows: Rows and columns are those shown in the grid
[edit]

Agent management

Agencies (view)

  • Filename: "{VIEW NAME} - {DATE}.xls"
  • Rows and columns defined by view.

Reps (view)

  • Filename: "{VIEW NAME} - {DATE}.xls"
  • Rows and columns defined by view.

Rep IDs

  • Filename: "{SUPPLIER} rep IDs - {DATE}.xls"
    • Example: "Qwest rep IDs - Dec 3, 2003.xls"
  • Rows: All rep IDs currently in the grid (counting all pages)
  • Columns: Rep ID, Master ID, Agency, Rep, Rep email, Modified
[edit]

Customer management

Customers (view)

  • Filename: "{VIEW NAME} - {DATE}.xls"
  • Rows and columns defined by view.

Accounts (staff only)

  • Filename: "{VIEW NAME} - {DATE}.xls"
  • Rows and columns defined by view.
[edit]

Other

Staff (view)

  • Filename: "{VIEW NAME} - {DATE}.xls"
  • Rows and columns defined by view.
[edit]

Need

Common uses of downloads

  • Advanced reports in Excel.
    • Excel has great charting and formula features
    • This can be as simple as using Excel's supplier filtering functionality for looking at a lot of data.
  • Import into another application
  • Combined with RPM Import to make mass changes to data in RPM
  • Send information as an email attachment
  • Keep an off line backup
[edit]

Security

  • The ability to a download is determined by the security of the page the download link is on.
  • Also, there is an overall download privilege for staff roles and permission for agencies.
[edit]

History

  • Mercury & before: The commission system had some download functionality. This was completely replaced by the functionality introduced in Venus.
  • Venus: Views download
  • Mars: Form download, Process import/download
  • Deimos: Forms download for agent users
  • Rockefeller: Form history download
  • Pathfinder: Reconciliation download
  • Phoenix: Excel auto-complete (shells)
  • Jupiter: History download, Deposits download, Items paying a referral download
  • Callisto: "Download all data" includes referrals and adjustments in the same page as items.
  • Europa: Staff privilege and agency permission
Retrieved from "http://www.rpmsoftware.com/wiki/index.php/Download_%28spec%29"
  • This page was last modified 19:58, 27 Jun 2008.
  • This page has been accessed 3133 times.