Generic Docs Commodity Table (abstract)

From UG

(Difference between revisions)
Jump to: navigation, search
(Look And Feel)
 
(12 intermediate revisions not shown)
Line 1: Line 1:
-
[[Category: Ops Pdfs Common]]
+
[[Category:OpsPdfsMisc]]
== Parent Mantis ==
== Parent Mantis ==
-
[http://mantis.jaguarfreight.com/mantis/view.php?id=tbd tbd]
+
[http://mantis.jaguarfreight.com/mantis/view.php?id=1698 1698]
-
== Business Needs and Requirements ==
 
== Technical Specification ==
== Technical Specification ==
Line 11: Line 10:
This is a super class for all Docs Commodity Tables. It has most generic functionality that is inherited by more specific tables.
This is a super class for all Docs Commodity Tables. It has most generic functionality that is inherited by more specific tables.
 +
 +
Known sub-classes:
 +
 +
* [[Ocean Docs Commodity Table (feature)]]
 +
* [[Air Docs Commodity Table (feature)]]
=== User Interface and Functionality ===
=== User Interface and Functionality ===
Line 18: Line 22:
Pdf - see [[#Figure 2: Generic Docs Commodity Table Pdf]].
Pdf - see [[#Figure 2: Generic Docs Commodity Table Pdf]].
-
=== Buttons ===
+
=== Line Manipulations ===
 +
 
 +
==== Definition ====
 +
 
 +
'''Line''' here is a horizontal block in a table, for example see #2 or #3 on [[#Figure 1: Generic Docs Commodity Table Template]].
==== Line Up ====
==== Line Up ====
Line 46: Line 54:
* User can select lines and click "Clear". All data will be cleared.
* User can select lines and click "Clear". All data will be cleared.
 +
 +
==== Errors ====
 +
 +
If user selects more than one line and clicks Line Up, Line Down or Delete then system must display Error in modal window: "Select only one line please!"
=== Sections ===
=== Sections ===
Line 67: Line 79:
Inside of every cell on template we could have textbox, textarea, etc. Data type could be string, number, etc.
Inside of every cell on template we could have textbox, textarea, etc. Data type could be string, number, etc.
-
=== Rows ===
+
==== Rows ====
There could be any number of rows.
There could be any number of rows.
Line 75: Line 87:
Additional functionality could be included - see child types/classes.
Additional functionality could be included - see child types/classes.
-
=== Total ===
+
==== Totals ====
 +
See sec 4 on [#Figure 1: Generic Docs Commodity Table Template].
 +
If column contains data of numerical types then system must calculate and display read only total in [[textbox]].
 +
 +
See [[Precision]].
=== Special Cases: Multiple Pages ===
=== Special Cases: Multiple Pages ===
-
 
-
* Print totals on every page? Not generic. See specific doc.
 
 +
*
 +
* Print totals on every page??? TBD
 +
* see also [[Empty First Page (feature)]]
=== Look And Feel ===
=== Look And Feel ===
-
* TBD:
+
* See Figure 1,2.
-
** values left/right aligned?
+
 
-
** distance to vertical/horizontal lines
+
* Columns that contain alphanumeric data must be left aligned
-
** etc
+
 
 +
* Columns that contain numeric data must be right aligned (some include unit of measurement)
=== Figures ===
=== Figures ===

Current revision as of 12:21, 5 August 2011


Contents

[edit] Parent Mantis

1698

[edit] Technical Specification

[edit] Summary

This is a super class for all Docs Commodity Tables. It has most generic functionality that is inherited by more specific tables.

Known sub-classes:

[edit] User Interface and Functionality

Template - see #Figure 1: Generic Docs Commodity Table Template.

Pdf - see #Figure 2: Generic Docs Commodity Table Pdf.

[edit] Line Manipulations

[edit] Definition

Line here is a horizontal block in a table, for example see #2 or #3 on #Figure 1: Generic Docs Commodity Table Template.

[edit] Line Up

  • Line could be selected and then moved up the list until top is reached
  • At first no line is selected
  • Once some line is selected system should hold selection until template is refreshed

[edit] Line Down

  • Line could be selected and then moved down the list until bottom is reached
  • At first no line is selected
  • Once some line is selected system should hold selection until template is refreshed

[edit] Insert Line

  • User selects line, clicks "Insert Blank Line"
  • System must insert line above selected
  • Once a line is selected system should hold selection until template is refreshed. This is more convenient if user wants to insert several lines at a time

[edit] Delete line

  • User can select lines and click "Delete". System would delete selected line and move all lines below one line up.
  • As usual keep selected line selected

[edit] Clear

  • User can select lines and click "Clear". All data will be cleared.

[edit] Errors

If user selects more than one line and clicks Line Up, Line Down or Delete then system must display Error in modal window: "Select only one line please!"

[edit] Sections

[edit] Header

  • See sec 1 on [#Figure 1: Generic Docs Commodity Table Template].
  • Has a check box to select all rows.

[edit] Columns

There could be any number of columns.

Additional functionality could be included - see child types/classes.

First column contains checkboxes that are used for row manipulation.

[edit] Cells

Inside of every cell on template we could have textbox, textarea, etc. Data type could be string, number, etc.

[edit] Rows

There could be any number of rows.

See [#Buttons] section for various operations you can perform with rows.

Additional functionality could be included - see child types/classes.

[edit] Totals

See sec 4 on [#Figure 1: Generic Docs Commodity Table Template].

If column contains data of numerical types then system must calculate and display read only total in textbox.

See Precision.

[edit] Special Cases: Multiple Pages

[edit] Look And Feel

  • See Figure 1,2.
  • Columns that contain alphanumeric data must be left aligned
  • Columns that contain numeric data must be right aligned (some include unit of measurement)

[edit] Figures

[edit] Figure 1: Generic Docs Commodity Table Template

File:Generic Docs Commodity Table Template.JPG

[edit] Figure 2: Generic Docs Commodity Table Pdf

File:Generic Docs Commodity Table Pdf.JPG

[edit] RFC

[edit] Known Non Critical Bugs and Issues

  • Do we want to have bar only above totals or across entire table
  • What is the Insert logic for fixed lines document (like HAWB)?
    • option1) no Insert button
    • option2) insert up to max# of lines and then display warning pop-up

[edit] History

[edit] Old spec

See Commodity Table for Pdfs

[edit] DB

Personal tools