Docs Tab

From UG

(Difference between revisions)

Jump to: navigation, search

Current revision as of 17:42, 6 June 2010

[edit] General Info and Scope

Classified As: (large) component
Parent Mantis: 1686

[edit] Scope

This document covers:

overall design of Doc Tab
List of saved pdfs table
pdf selection dropdown

It does not cover:

pdf template generation
pdf generation

[edit] Business Needs and Requirements

...

[edit] Save Pdf Draft feature

Add ability for operator to "save work". Common case: operator selects pdf; clicks "show template"; edits some info; get's distracted; opens some other CT, etc; opens that CT again - all edits from pdf template is gone. We need to be able to save and keep last changes to template for every doc.

[edit] Show to client

This must be editable at any time

[edit] Technical Specification

[edit] Summary

[edit] 3 step process

There are 3 independent steps:

step 1) generate template based on CT record data
step 2) tweak template
step 3) generate pdf (based on template values) and print it

Important observation: generated pdf is defined only by template and not by default state of the template you get after step 1.

[edit] User Interface and Functionality

Please see #Figure 4: Edit Document
Docs Tab consists of
- Existing Documents For CT for shipment reports(pdfs)
  - See #Figure 1: Docs Tab, Default state Section 1
  - Shipment Report table displays saved existing documents with date issued, Issued by, Document# (name), show to client option
- View Document button
  - See #Figure 1: Docs Tab, Default state Section 2
  - This button allows user to view the saved document in pdf format
- Delete Document button
  - See #Figure 1: Docs Tab, Default state Section 2
  - This button allows user to delete the saved document file from the system
- Edit Document button
  - See #Figure 4: Edit Document Edit Document button
  - This button allows user to edit the last saved document template and re-generate a document in pdf format and save it as to replace the old one
- Document option dropdown
  - See #Figure 1: Docs Tab, Default state Section 3
  - This dropdown provides choices of document that user would like to generate
- Show template button
  - See #Figure 1: Docs Tab, Default state Section 3
  - This button is to show a new template for individual CT before generating a document, so user can enter info as he/she expect it to show on the pdf document
- Show template (for a group)
  - See #Figure 4: Edit Document show template (for a group) button
  - This button is to show a new template for a group CT before generating a document, so user can enter info as he/she expect it to show on the pdf document
- Show to client
  - Type: check box
  - Default: uncheck
  - Condition: enable and allow user to edit

[edit] Entities and Attributes

[edit] Special Cases and Misc

Show template (for a group) button is ONLY appeared when there is a group case.
Edit Document button is different than View and Delete Document

[edit] Steps

User clicks on a document name on shipment reports table
User clicks Edit Document button
The last saved template for that particular document is appeared
User can edit info on the template
User clicks generate report
Pdf document is generated
User clicks Save and open in a new tab (saved it as to replace the old one)

[edit] Look And Feel

[edit] Figures

[edit] Figure 1: Docs Tab, Default state

[edit] Figure 2: Pdf template example

[edit] Figure 3: Pdf preview

[edit] Figure 4: Edit Document

[edit] Questions and RFC

[edit] Known Non Critical Bugs

[edit] History

[edit] m1940

1940

[edit] BA

Need to have ability to edit the "Show to client" checkbox on the Shipment Reports table.
current revision

[edit] SA

Show to Client should be editable on Shipment Reports table
Show to client

Type: check box
Default: unchecked
Condition: enable and allow user to edit

Spec is updated: Y
Final version:10783

[edit] m1053

[edit] Add file counter

http://mantis.jaguarfreight.com/mantis/view.php?id=1053
for both Master and CT

[edit] DB

@@ Line 1: / Line 1: @@
-[[Category:Dev]]
+[[Category:OpsPdfsMisc]]
-== Classified As and Parent Mantis ==
+== General Info and Scope ==
-* Classified As: (small) (large) component / common feature / ...
+* Classified As: (large) component
-* Parent Mantis: [http://mantis.jaguarfreight.com/mantis/view.php?id=tbd tbd]
+* Parent Mantis: [http://mantis.jaguarfreight.com/mantis/view.php?id=1686 1686]
+=== Scope ===
+This document covers:
+* overall design of Doc Tab
+* List of saved pdfs table
+* pdf selection dropdown
+It does not cover:
+* pdf template generation
+* pdf generation
+== Business Needs and Requirements ==
+...
+=== Save Pdf Draft feature ===
+Add ability for operator to "save work". Common case: operator selects pdf; clicks "show template"; edits some info; get's distracted; opens some other CT, etc; opens that CT again - all edits from pdf template is gone. We need to be able to save and keep last changes to template for every doc.
+=== Show to client ===
+This must be editable at any time
-== Business Needs ==
-== Business Requirements ==
 == Technical Specification ==
 === Summary ===
+==== 3 step process ====
+There are 3 independent steps:
+* step 1) generate template based on CT record data
+* step 2) tweak template
+* step 3) generate pdf (based on template values) and print it
+Important observation: generated pdf is defined '''only''' by template and not by default state of the template you get after step 1.
 === User Interface and Functionality ===
+* Please see [[#Figure 4: Edit Document]]
+* Docs Tab consists of
+** Existing Documents For CT for shipment reports(pdfs)
+*** See [[#Figure 1: Docs Tab, Default state]] Section 1
+*** Shipment Report table displays saved existing documents with date issued, Issued by, Document# (name), show to client option
+** View Document button
+*** See [[#Figure 1: Docs Tab, Default state]] Section 2
+*** This button allows user to view the saved document in pdf format
+** Delete Document button
+*** See [[#Figure 1: Docs Tab, Default state]] Section 2
+*** This button allows user to delete the saved document file from the system
+** Edit Document button
+*** See [[#Figure 4: Edit Document]] Edit Document button
+*** This button allows user to edit the last saved document template and re-generate a document in pdf format and save it as to replace the old one
+** Document option dropdown
+*** See [[#Figure 1: Docs Tab, Default state]] Section 3
+*** This dropdown provides choices of document that user would like to generate
+** Show template button
+*** See [[#Figure 1: Docs Tab, Default state]] Section 3
+*** This button is to show a new template for individual CT before generating a document, so user can enter info as he/she expect it to show on the pdf document
+** Show template (for a group)
+*** See [[#Figure 4: Edit Document]] show template (for a group) button
+*** This button is to show a new template for a group CT before generating a document, so user can enter info as he/she expect it to show on the pdf document
+** Show to client
+*** Type: check box
+*** Default: uncheck
+*** Condition: enable and allow user to edit
 === Entities and Attributes ===
 === Special Cases and Misc ===
+* Show template (for a group) button is ONLY appeared when there is a group case.
+* Edit Document button is different than View and Delete Document
+==== Steps ====
+:* User clicks on a document name on shipment reports table
+:* User clicks Edit Document button
+:* The last saved template for that particular document is appeared
+:* User can edit info on the template
+:* User clicks generate report
+:* Pdf document is generated
+:* User clicks Save and open in a new tab (saved it as to replace the old one)
 === Look And Feel ===
 === Figures ===
-==== Figure: XXX ====
+==== Figure 1: Docs Tab, Default state ====
+[[File:Docs Tab Default state No saved docs.JPG]]
+==== Figure 2: Pdf template example ====
+[[File:Pdf template example.JPG]]
+==== Figure 3: Pdf preview ====
+[[File:Pdf preview.JPG]]
+==== Figure 4: Edit Document ====
+[[File:EditTemplate3.JPG]]
 == Questions and RFC ==
@@ Line 25: / Line 112: @@
 == History ==
+=== m1940 ===
+* [http://mantis.jaguarfreight.com/mantis/view.php?id=1940 1940]
+==== BA ====
+* Need to have ability to edit the "Show to client" checkbox on the Shipment Reports table.
+* [http://mantis.jaguarfreight.com/mediawiki-1.15.0/index.php?title=Docs_Tab&oldid=9351 current revision]
+==== SA ====
+* Show to Client should be editable on Shipment Reports table
+* Show to client
+:* Type: check box
+:* Default: unchecked
+:* Condition: enable and allow user to edit
+* Spec is updated: Y
+* Final version:[http://mantis.jaguarfreight.com/mediawiki-1.15.0/index.php?title=Docs_Tab&oldid=10783 10783]
+=== m1053 ===
+=== Add file counter ===
+* http://mantis.jaguarfreight.com/mantis/view.php?id=1053
+* for both Master and CT
 == DB ==