Docs Tab

From UG

Revision as of 17:05, 30 March 2010 by Montira (Talk | contribs)
Jump to: navigation, search


Contents

General Info and Scope

  • Classified As: (large) component
  • Parent Mantis: 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.

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
    • Delete Document button
    • 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
    • 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

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 and saved it as to replace the old one

Look And Feel

Figures

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

Known Non Critical Bugs

History

Add file counter

DB

Personal tools