Generic Pdf Template and Pdf (abstract)
From UG
(→Technical Specification) |
(→BR: Validation feature) |
||
| (35 intermediate revisions not shown) | |||
| Line 4: | Line 4: | ||
* Classified As: (abstract) component | * Classified As: (abstract) component | ||
| - | * Parent Mantis: [http://mantis.jaguarfreight.com/mantis/view.php?id= | + | * Parent Mantis: [http://mantis.jaguarfreight.com/mantis/view.php?id=1755 1755] |
| - | |||
== Business Requirements == | == Business Requirements == | ||
| - | == | + | |
| + | === 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" | ||
| + | |||
| + | == Systems Design == | ||
=== Summary === | === Summary === | ||
| Line 14: | Line 24: | ||
Every pdf has a [[pdf template]]. See [[Introduction into Ops Pdfs Module#3 step process]]. | Every pdf has a [[pdf template]]. See [[Introduction into Ops Pdfs Module#3 step process]]. | ||
| - | |||
| + | === 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. | ||
| - | + | ==== 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 | ||
| - | + | ==== 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 |
| + | |||
| + | ==== Data manipulation ==== | ||
| + | |||
| + | (Examples: convert CBM into CFT; insert new lines into "pdf commodity table"; move line up) | ||
| + | |||
| + | Full definition required | ||
=== Look And Feel === | === Look And Feel === | ||
| - | + | Layout of fields on template should mimic same on pdf as much as possible. | |
| - | + | ||
| - | == | + | === 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]] | ||
== History == | == History == | ||
| - | == | + | === m1756 === |
| + | * http://mantis.jaguarfreight.com/mantis/view.php?id=1756 | ||
| + | |||
| + | ==== BA 1756 ==== | ||
| + | |||
| + | see [[#Validation feature]] | ||
| + | |||
| + | ==== SA 1756 ==== | ||
Current revision as of 12:28, 4 August 2011
Contents |
[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
