Generic Pdf Template and Pdf (abstract)
From UG
| Line 6: | Line 6: | ||
* Parent Mantis: [http://mantis.jaguarfreight.com/mantis/view.php?id=tbd tbd] | * Parent Mantis: [http://mantis.jaguarfreight.com/mantis/view.php?id=tbd tbd] | ||
| - | == Business Needs == | + | == Business Needs and Requirements == |
| - | == | + | |
| + | === Core Requirements === | ||
| + | |||
| + | ==== 3 step process ==== | ||
| + | |||
| + | There are 3 independent steps: | ||
| + | |||
| + | * generate template based on CT record data | ||
| + | * tweak template | ||
| + | * generate pdf based on template | ||
| + | |||
| + | === Additional Requirements === | ||
| + | |||
| + | |||
== Technical Specification == | == Technical Specification == | ||
Revision as of 20:50, 25 January 2010
Contents |
Classified As and Parent Mantis
- Classified As: (abstract) component
- Parent Mantis: tbd
Business Needs and Requirements
Core Requirements
3 step process
There are 3 independent steps:
- generate template based on CT record data
- tweak template
- generate pdf based on template
Additional Requirements
Technical Specification
Summary
Every pdf has a pdf template. See Introduction into Ops Pdfs Module#3 step process.
See Figure ...
Classification of fields and How each fields must be defined
Template serves several purposes:
- 1) to show EXISTING fields from the system (CT record mostly) that would appear on pdf (Examples: Shipper, CBM)
- 2) to let user create some NEW fields (that we do not have in the system) that would appear on pdf (Example: pick up time)
- 3) to manipulate data (Examples: convert CBM into CFT; insert new lines into "pdf commodity table")
Respectively to 3 cases above we have 3 cases of what should be specified in the design:
- 1) 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
- 2) in this case there must be a full definition
- 3) full definition required
How to predict in advance if specific value can 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.
This feature has not been implemented yet. See suggested designs below.
1) 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?
2) 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.
3) 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
User Interface and Functionality
Entities and Attributes
Special Cases and Misc
Look And Feel
Layout of fields on template should mimic same on pdf as much as possible.
