Generic Pdf Template and Pdf (abstract)

From UG

(Difference between revisions)

Jump to: navigation, search

Current revision as of 12:28, 4 August 2011

[edit] Classified As and Parent Mantis

Classified As: (abstract) component
Parent Mantis: 1755

[edit] Business Requirements

[edit] BR: Validation feature

Main need: How to predict in advance if specific value can not fit on pdf and warn user

For example, warn user that "AIRMARK OCEAN & AIR LOGISTICS" value can not fit onto space allocated on pdf.

Ideally they want to see "as they type" when they exceeded space.

Module owner suggested to "approximate based on average character (by width) and number of characters"

[edit] Systems Design

[edit] Summary

Every pdf has a pdf template. See Introduction into Ops Pdfs Module#3 step process.

[edit] Classification of widgets on pdf template and How each widget must be defined in spec

Pdf Template serves several purposes (and have related classification of widgets). Respectively we have 3 cases of what should be specified in the design and how.

[edit] EXISTING system fields

(CT record mostly)

(Examples: Shipper, CBM)

Since these fields has been defined already in the system as a rule (with just minor number of exceptions) these fields are to be considered (by default) on template to be identical (UI control type, UI control attributes, etc.)

Example: Import Ref is a alphanumeric textbox, max length 30 chars defined on Gen Tab. On Pdf template where it appears it will be have same characteristics therefore on wiki spec we shall not repeat that it is alphanumeric textbox, max ....

Known exceptions:

- 1a) value from more complex UI control (combobox or date) is displayed inside more simple UI control (textbox)
- 2a) values from 2 controls are combined in one
  - in this case there must be a full definition

[edit] NEW fields

(that we do not have in the system) that would appear on pdf (Examples: pick up time; comments )

In this case there must be a full definition

[edit] Data manipulation

(Examples: convert CBM into CFT; insert new lines into "pdf commodity table"; move line up)

Full definition required

[edit] Look And Feel

Layout of fields on template should mimic same on pdf as much as possible.

[edit] SD: Validation feature

Options:

1) calculate the length of the string based on specific font and known width of each symbol and show warning as they type

2) evaluate pdf after they click on "generate report" and show warning (without showing pdf with value overflow). Then user can go back to template and edit. Or also showing pdf with highlighted overflow.

3) "approximate based on average character" - see #BR: Validation feature

[edit] History

[edit] m1756

http://mantis.jaguarfreight.com/mantis/view.php?id=1756

[edit] BA 1756

see #Validation feature

[edit] SA 1756

@@ Line 1: / Line 1: @@
-[[Category:OpsPdfs]]
+[[Category:OpsPdfsMisc]]
 == Classified As and Parent Mantis ==
@@ Line 6: / Line 6: @@
 * Parent Mantis: [http://mantis.jaguarfreight.com/mantis/view.php?id=1755 1755]
-== Business Needs and Requirements ==
+== Business Requirements ==
-=== Validation feature  ===
+=== BR: Validation feature ===
-Main goal: How to predict in advance if specific value can fit on pdf and warn user
+'''Main need:''' How to predict in advance if specific value can not fit on pdf and warn user
-To est' zadacha sostoit v tom chtob predupredit' usera chto skagem znachenie "AIRMARK OCEAN & AIR LOGISTICS" polya Trucker ne pomestitsya na pdf i kakim to obrazom dat' mehanizm chtob user mog podkorektirovat' i ponyat' skol'ko vlezet.
+For example, warn user that "AIRMARK OCEAN & AIR LOGISTICS" value can not fit onto space allocated on  pdf.
-This feature has not been implemented yet. See suggested designs below.
+Ideally they want to see "as they type" when they exceeded space.
-) this can not be predicted easily in advance (before pdf generation) because characters have different width. Or we can calculate this based on specific font and known width of each symbol?
+Module owner suggested to "approximate based on average character (by width) and number of characters"
-)  kogda poyavlyaetsya template, podsvetit' polya kotorye imeut znacheniya kotorye slishkom dlinnye i User by pri pomoshi Backspace udalyal odin za drugim chars s hvosta i v kakoi to moment pole by perestalo byt' podsvechenym oznachaya chto ono uge vlazit i togda user by ostanovilsya.
+== Systems Design ==
-) Eshe odno reshenie, veroyatno bolee prostoe sostoit v tom chtob podsvetit' nepomestivshiesya polya odin raz (kagdyi raz) posle togo kak uzer nagal "genrate report" - togda user znaet kakie polya ne vlezli i podpravit
-== Technical Specification ==
 === Summary ===
 Every pdf has a [[pdf template]]. See [[Introduction into Ops Pdfs Module#3 step process]].
-See Figure ...
@@ Line 67: / Line 58: @@
 Full definition required
+=== Look And Feel ===
+Layout of fields on template should mimic same on pdf as much as possible.
-=== User Interface and Functionality ===
+=== SD: Validation feature ===
-=== Entities and Attributes ===
-=== Special Cases and Misc ===
+Options:
-=== Look And Feel ===
+) calculate the length of the string based on specific font and known width of each symbol and show warning as they type
-Layout of fields on template should mimic same on pdf as much as possible.
-=== Figures ===
+) evaluate pdf after they click on "generate report" and show warning (without showing pdf with value overflow). Then user can go back to template and edit. Or also showing pdf with highlighted overflow.
-==== Figure: XXX ====
+) "approximate based on average character" - see [[#BR: Validation feature]]
 == History ==
@@ Line 87: / Line 77: @@
 * http://mantis.jaguarfreight.com/mantis/view.php?id=1756
-=== BA ===
+==== BA 1756 ====
 see [[#Validation feature]]
-== SA ==
+==== SA 1756 ====