Commission item origin id

From RPM Wiki

Table of contents
1 Summary
2 Origin

2.1 Display

3 Imports
4 Item view filter
5 Item details
6 Security

6.1 Staff users
6.2 Agent users

7 History
[edit]

Summary

This is the spec of a commission import related feature.

Each import has a unique ID per run. This id can be used as a view filter for items from a certain import.

  • One important goal of this feature is to allow a user to delete all the items from a specific import. The actual delete functionality is part of the view, but this feature introduces the filter to get that view.
[edit]

Origin

This ID is referred to as the "Origin". Each origin also remembers the date & time of the import and the supplier.

  • The integer indicates an import "Finish"
  • If the "Finish all" link is used, all the resulting items will have a different origin depending on their supplier. Use the alphabetical order of the supplier names to determine the origin number order. In other words, treat it as if each supplier in the buffer had been "Finished" on their own, in alphabetical order.
  • Items added manually fall into a special null origin called "Manual". Unlike the import origins, this origin may have items from more than one supplier.
[edit]

Display

An origin is described by a combination of supplier & date time, or as "Manual". There are two ways this is shown:

  • Columns: A separate column for supplier and date time (full date with year).
    • Used on the imports list page
  • Combined: The supplier & date time together. Example: "Qwest import (12:01PM Sep 5)" or "Manual".
    • Used on the item details, edit view (filter value), and select an item (temporary view name) pages.
    • This is an exception to the date display rules because a year is not shown. We can get away with it because the relationship to a commission run makes the year usually obvious.
[edit]

Imports

This page displays the list of origins in a given run.

  • Columns:
    • Task column "View items"
    • "Origin"
      • "Import" or "Manual"
    • Supplier
      • Will likely be "(multiple)" for the "Manual" origin. However, if all manual items are from the same supplier, display that supplier name
      • "gridLink" style link to the supplier details page
    • Items
      • Count & link to a temporary view of items, "gridLink" style
      • This is the current number of items including split items. Example, if all the items for an origin are then deleted, this will show 0. Matches the view.
    • Rows
      • The number of rows originally imported. Matches the excel file, not affected by splits or deletions
      • Show "n/a" for manual origin
    • Date
      • Date & time of the import.
      • For the "Manual" origin, use "n/a"
  • This page is accessed from a link on the "Import data" page.
  • Default sorting is by date according to the user's date sorting setting
  • If the run was started before this feature, show "none" in place of the grid and hide the link to this page on the "Import data" page.
[edit]

Item view filter

The origin filter allows a commission item view to limit to items from a certain origin

  • Like the "matched to form" filter for commission items, the origin id is not a filter that can be added manually or edited. It is only created by temporary views. The temporary view can be edited and it will contain the filter, but the only option is to keep it as is or remove it.
  • Display
    • Method: "Limit to"
    • Name: "Origin"
    • Value: The combined origin (see above)
  • Since the origin id refers to an import in a specific run, using the filter on another run will come back with no items. The one exception is a value of "Manual" since any run may have manual and that id is common.
  • If the run was started before this feature, this filter will always result in no items regardless of manual or not.
[edit]

Item details

The origin id is displayed using the existing label "Origin". Instead of the old values of simply "Imported" and "Manual", display the combined origin (see above).

  • If the item is in a run started before this feature, show an origin of "n/a"
[edit]

Security

[edit]

Staff users

  • Viewing commission imports and items requires a "Commission run data" privilege of at least "Read only".
[edit]

Agent users

  • n/a
[edit]

History

Retrieved from "http://rpmsoftware.com/wiki/index.php/Commission_item_origin_id"
  • This page was last modified 16:17, 26 Sep 2006.
  • This page has been accessed 1079 times.