Archive (Feature)

From UG

(Difference between revisions)
Jump to: navigation, search
(→Summary)
 
(31 intermediate revisions not shown)
Line 1: Line 1:
-
[[Category:Ops]]
+
[[Category:Ops Common]]
 +
== Info ==
 +
* parent mantis - http://mantis.jaguarfreight.com/mantis/view.php?id=458
 +
'''Scope:''' 
-
== Parent Mantis ==
+
This covers "Archive/Restore feature" of CyberTrax.
-
[http://mantis.jaguarfreight.com/mantis/view.php?id=458 458]
+
== Business Needs and Requirements ==
== Business Needs and Requirements ==
-
== Technical Specification ==
+
== Design Ideas ==
 +
 
 +
== SA Notes ==
=== Summary ===
=== Summary ===
Line 17: Line 21:
* All Addresses *
* All Addresses *
-
* Clients *
+
* Client Companies *
 +
* Client Companies Groups *
-
* Client Groups *
+
* All users (internal/external) *
-
 
+
* User groups *
-
* All users (internal/external), user groups *
+
* Geography:
* Geography:
Line 36: Line 40:
=== User Interface and Functionality ===
=== User Interface and Functionality ===
 +
 +
Once the object of CT2 becomes '''archived''' then it should be not accessed for new actions. In other words it should become '''hidden'''. However in some cases to avoid a loss of information upon displaying of other objects that are linked with "archived", "hiding" is unacceptable. Then "archived" objects stay "visible" but should be '''marked''' as "archived" with image of trash can ''(or other obvious way)''.
==== How to flag as archived ====
==== How to flag as archived ====
Line 44: Line 50:
=== Entities and Attributes ===
=== Entities and Attributes ===
 +
 +
==== Client Companies ====
 +
'''1) Objects to HIDE:'''
 +
 +
*OPS
 +
:*Create ShipmentMain Client dropdown
 +
:*Create Shipment - Client dropdown in Template table
 +
:*Virtual Group - Client Companies dropdown
 +
:*Shipment Groups > Add Shipment Group window - Client Company dropdown
 +
 +
*ADMIN
 +
:*Client Companies > Client Companies Groups > Add Client Companies Group window - Client Company dropdown
 +
:*Users and Offices > Jaguar Users > Add Jaguar User window - Dashboard configuration - E0. Client Company dropdown
 +
:*Users and Offices > Non-Jaguar Users > Add Non-Jaguar User window - E0. Client Company dropdown
 +
::''(Please note that this for both Client and Shipper roles)''
 +
:*Automated Estimated Delivery Dates > Create New Estimated Transit Time section - Client dropdown
 +
 +
*ACC
 +
:*Currencies and Exchange Rates - Client Company Exchange Rates - Add Client Company Exchange Rate window - Client Company dropdown
 +
 +
*REPORTS
 +
:*Saved/Scheduled > Add Report window - Report For Client Company dropdown
 +
:*Saved/Scheduled > Add Report window > General Filters Tab (or Virtual Group Tab) - Client Companies filter dropdown
 +
 +
'''2) Objects to MARK as "archived" (with trash can):'''
 +
 +
*OPS
 +
:*Show Lists > List Shipments - Client Company filter dropdown
 +
 +
*ADMIN
 +
:*Client Companies - Client Companies table
 +
:*Client Companies - Top Client Companies table
 +
:*Client Companies > Client Companies Groups - Edit Client Companies Group window - Client Companies listbox
 +
:*Create CT Admin - CT1 vs CT2 Client Companies table
 +
:*Users and Offices > Jaguar Users > Edit Jaguar User window - Dashboard configuration - E0. Client Company listbox
 +
:*Automated Estimated Delivery Dates > Automated Estimated Delivery Dates table - Client column
 +
 +
*ACC
 +
:*Reports > Profit/Loss for Multiple CTs - Client Companies filter dropdown
 +
 +
*REPORTS
 +
:*Operational > Main > General Filters Tab - Client Companies filter dropdown
 +
:*Operational > In Transit (and all other excluding TDS) > Virtual Group Filters Tab - Client Companies filter dropdown
 +
 +
'''3) Saved Objects (HIDE and MARK):'''
 +
 +
We should show and mark as "archived" previously entered and saved Client Companies and hide all other in dropdowns.
 +
 +
*OPS
 +
:*Shipment Groups > Edit Shipment Group window - Client Company dropdown
 +
 +
*ADMIN
 +
:*Client Companies > Client Companies Groups > Edit Client Companies Group window - Client Company dropdown
 +
:*Users and Offices > Jaguar Users > Edit Jaguar User window - Dashboard configuration - E0. Client Company dropdown
 +
:*Users and Offices > Non-Jaguar Users > Edit Non-Jaguar User window - E0. Client Company dropdown
 +
::''(Please note that this for both Client and Shipper roles)''
 +
:*Automated Estimated Delivery Dates > Create New Estimated Transit Time section - Client dropdown for saved records
 +
 +
*ACC
 +
:*Currencies and Exchange Rates > Client Company Exchange Rates > Edit Client Company Exchange Rate window - Client Company dropdown
 +
 +
*REPORTS
 +
:*Saved/Scheduled > Edit Report window - Report For Client Company dropdown
 +
:*Saved/Scheduled > Edit Report window - General Filters Tab (or Virtual Group Tab) - Client Companies filter dropdown
 +
 +
*LIST CTs (List Shipments)
 +
:*CT > GenTab - E0. Client Company dropdown
 +
:*CT > GenTab - E1. Visibility 1 dropdown
 +
:*CT > GenTab - E2. Visibility 2 dropdown
 +
:*CT > GenTab - E3. Visibility 3 dropdown
 +
 +
==== Jaguar/Non-Jaguar Users ====
 +
 +
'''1) Objects to HIDE:'''
 +
 +
*OPS
 +
:*Virtual Group > Operations > Comment - "Recipients:" dropdown
 +
 +
*ADMIN
 +
:*Client App Admin > BCC List - Jaguar Users dropdown
 +
 +
*LIST CTs (List Shipments)
 +
:*Edit CT > IComTab - "Jaguar users" dropdown
 +
:*Edit CT > ComTab - "Jaguar users" dropdowns
 +
:*Edit CT > ComTab - "Client users" dropdowns
 +
:*Edit CT > QueryTab - "Jaguar CC:" dropdown
 +
 +
*LIST Ms (List Of All Masters)
 +
:*Edit Master > CommentsTab - "Jaguar Users" list
 +
:*Edit Master > CommentsTab - "Client Users" list
 +
 +
*CLIENT Application
 +
:* Shipment Details > Communication Center Tab - "Jaguar CC:" dropdown
 +
:* Shipment Details > Communication Center Tab - "Client CC:" dropdown
 +
 +
'''2) Objects to MARK as "archived" (with trash can):'''
 +
 +
*ADMIN
 +
:*Users and Offices > Jaguar Users and Non-Jaguar Users tables
 +
::*NOTE:
 +
:::1) Active users and Archived users should be listed on this admin table, but for archived user, it should show the archived symbol (trash can).
 +
:::2) ''Suggestion:'' Status column (archived; trash can) should be sort able as same as other column. So in this case, it will be easy to view the archived users list.
 +
:* Client App Admin > BCC List - "Jaguar User Name" column
 +
 +
*ACC
 +
:* Reports > Profit/Loss for Multiple CTs - "Sales Persons:" dropdown ''(is not yet approved by MO)''.
 +
 +
*REPORTS
 +
:*Saved/Scheduled > Edit Report window-> "Recipients:"/"CC Recipients:"/"BCC Recipients:" listboxes
 +
 +
*LIST CTs (List Shipments)
 +
:*Edit CT > GenTab - G. Operator Of Last Change: textlabel
 +
:*Edit CT > IComTab - "Sent to:" line in text area of sent message
 +
:*Edit CT > ComTab - "Sent to:" line in text area of sent message
 +
:*Edit CT > QueryTab - Email query "To:" textlabel
 +
:*Edit CT > QueryTab - E-Mail Query Log (History) - "To" and "CC:" lines
 +
 +
*LIST Ms (List Of All Masters)
 +
:*Edit Master > CommentsTab - "Sent to:" line in text area of sent message
 +
 +
*CLIENT Application
 +
:* Shipment Details > Shipment Details Tab - "Authorised By" textlabel
 +
:* Shipment Details > Communication Center Tab - "To:" textline
 +
 +
'''3) Saved Objects (HIDE and MARK):'''
 +
 +
We should show and mark as "archived" previously entered and saved Users and hide all other in dropdowns.
 +
 +
*ADMIN
 +
:*Client Companies > Client Companies - "Sales Person:" dropdown
 +
 +
*REPORTS
 +
:*Saved/Scheduled > Edit Report window-> "Recipients:"/"CC Recipients:"/"BCC Recipients:" dropdowns
 +
 +
NOTE: Because the lists of recipients in "Saved/Scheduled" can contains "Archived" users, system should show the warning message to user that under “To:” recipient is archived. And make sure that user selects some new recipient(s) under CC. In the same case with “To:” textline in Client Communication Center Tab the system should prevent email sending.
=== Special Cases and Misc ===
=== Special Cases and Misc ===
Line 51: Line 192:
=== Figures ===
=== Figures ===
==== Figure: XXX ====
==== Figure: XXX ====
-
== History ==
+
 
-
== Non Critical Bugs and RFC ==
+
== New 2012 standard ==
-
== DB ==
+
 
 +
[[File:Archive standard.JPG]]
 +
 
 +
=== Core Requirements ===
 +
 
 +
At times some ''Entity items'' of CT2 should be excluded from System (temporarily or permanently).
 +
Also they should be able to be restored for reuse.
 +
Example: '''''Entity''''' - Region, ''Entity items'' - Africa, Antarctica, Asia etc.
 +
 
 +
Archiving feature is applicable for selected ''items'' of '''''Entity''''' table.<br>
 +
Archiving feature provided through following action buttons by using of their appropriate functionality ''(see above)'':
 +
 
 +
* '''Archive''' button: get user confirm, mark as archived with image
 +
* '''Restore''' button: get user confirm, remove "archived" mark
 +
* '''Replace''' button: get user confirm, "merge" two ''items'' into one
 +
* '''Hide archived''' checkbox:
 +
** if checked then don't display archived ''items'' in table,
 +
** if unchecked then display all
 +
 
 +
NOTE: every table of '''''Entity''''' has additional column with a garbage can to mark archived ''items'' in the table.
 +
 
 +
=== Related Functionality ===
 +
 
 +
* Provide recording (and displaying) of all archive-related actions with ''Entity items'' in System Log
 +
* For every place in the System where '''''Entity''''' is appearing:
 +
** if ''Entity item'' is tagged as archived then it should not appear on the list
 +
 
 +
== Change Requests ==
 +
 
 +
=== SOW 0 ===
 +
See [[#Design Ideas]] and next.
 +
 
 +
=== SOW 1 ===
 +
'''[http://mantis.jaguarfreight.com/mantis/view.php?id=1639 0001639]: ''' [Archive Feature](*ph1)(Users / Offices) Implement archive feature for Jaguar users, non-Jaguar users
 +
 
 +
==== Core Requirements ====
 +
Implement this feature for Jaguar users, non-Jaguar users, Jaguar User groups ===
 +
 
 +
=== SOW 2 ===
 +
'''[http://mantis.jaguarfreight.com/mantis/view.php?id=1838 0001838]: ''' (Transportation) Delivery Date Types. Not implemented "Archive/Restore" feature.
 +
 
 +
==== Core Requirements ====
 +
 
 +
Archiving feature has the following on Delivery Date Types Tab in Transportation section of Admin:
 +
* add Archive/Restore and Replace buttons and "Hide archived" checkbox with appropriate functionality for [[#New 2012 standard | New 2012 standard]]
 +
** "Archive" button: get user confirm, mark as archived with image
 +
** "Restore" button: get user confirm, remove "archived" mark
 +
** "Replace" button: get user confirm, "merge" two items into one
 +
** "Hide archived" checkbox:
 +
*** if checked then don't display archived Delivery Date Types in table,
 +
*** if unchecked then display all
 +
* add column with a garbage can to mark archived items in table of Delivery Date Types
 +
 
 +
==== Related Functionality ====
 +
 
 +
* Provide recording (and displaying) of all archive-related actions with Delivery Date Types in System Log
 +
* For every place in the system where Delivery Date Type is appearing:
 +
** if Delivery Date Type is tagged as archived then it should not appear on the list

Current revision as of 17:30, 25 June 2012


Contents

[edit] Info

Scope:

This covers "Archive/Restore feature" of CyberTrax.

[edit] Business Needs and Requirements

[edit] Design Ideas

[edit] SA Notes

[edit] Summary

List of entity types in the system that must have this feature:

  • Accounting:
    • Charge Codes
  • All Addresses *
  • Client Companies *
  • Client Companies Groups *
  • All users (internal/external) *
  • User groups *
  • Geography:
    • Airports / Ports / Countries
  • Transportation:
    • ALL items
  • Carriers:
    • ALL items*


Note: (*) - means high priority

[edit] User Interface and Functionality

Once the object of CT2 becomes archived then it should be not accessed for new actions. In other words it should become hidden. However in some cases to avoid a loss of information upon displaying of other objects that are linked with "archived", "hiding" is unacceptable. Then "archived" objects stay "visible" but should be marked as "archived" with image of trash can (or other obvious way).

[edit] How to flag as archived

[edit] How to load objects linked to archived objects

[edit] How to list archived and non archived objects

[edit] Entities and Attributes

[edit] Client Companies

1) Objects to HIDE:

  • OPS
  • Create ShipmentMain Client dropdown
  • Create Shipment - Client dropdown in Template table
  • Virtual Group - Client Companies dropdown
  • Shipment Groups > Add Shipment Group window - Client Company dropdown
  • ADMIN
  • Client Companies > Client Companies Groups > Add Client Companies Group window - Client Company dropdown
  • Users and Offices > Jaguar Users > Add Jaguar User window - Dashboard configuration - E0. Client Company dropdown
  • Users and Offices > Non-Jaguar Users > Add Non-Jaguar User window - E0. Client Company dropdown
(Please note that this for both Client and Shipper roles)
  • Automated Estimated Delivery Dates > Create New Estimated Transit Time section - Client dropdown
  • ACC
  • Currencies and Exchange Rates - Client Company Exchange Rates - Add Client Company Exchange Rate window - Client Company dropdown
  • REPORTS
  • Saved/Scheduled > Add Report window - Report For Client Company dropdown
  • Saved/Scheduled > Add Report window > General Filters Tab (or Virtual Group Tab) - Client Companies filter dropdown

2) Objects to MARK as "archived" (with trash can):

  • OPS
  • Show Lists > List Shipments - Client Company filter dropdown
  • ADMIN
  • Client Companies - Client Companies table
  • Client Companies - Top Client Companies table
  • Client Companies > Client Companies Groups - Edit Client Companies Group window - Client Companies listbox
  • Create CT Admin - CT1 vs CT2 Client Companies table
  • Users and Offices > Jaguar Users > Edit Jaguar User window - Dashboard configuration - E0. Client Company listbox
  • Automated Estimated Delivery Dates > Automated Estimated Delivery Dates table - Client column
  • ACC
  • Reports > Profit/Loss for Multiple CTs - Client Companies filter dropdown
  • REPORTS
  • Operational > Main > General Filters Tab - Client Companies filter dropdown
  • Operational > In Transit (and all other excluding TDS) > Virtual Group Filters Tab - Client Companies filter dropdown

3) Saved Objects (HIDE and MARK):

We should show and mark as "archived" previously entered and saved Client Companies and hide all other in dropdowns.

  • OPS
  • Shipment Groups > Edit Shipment Group window - Client Company dropdown
  • ADMIN
  • Client Companies > Client Companies Groups > Edit Client Companies Group window - Client Company dropdown
  • Users and Offices > Jaguar Users > Edit Jaguar User window - Dashboard configuration - E0. Client Company dropdown
  • Users and Offices > Non-Jaguar Users > Edit Non-Jaguar User window - E0. Client Company dropdown
(Please note that this for both Client and Shipper roles)
  • Automated Estimated Delivery Dates > Create New Estimated Transit Time section - Client dropdown for saved records
  • ACC
  • Currencies and Exchange Rates > Client Company Exchange Rates > Edit Client Company Exchange Rate window - Client Company dropdown
  • REPORTS
  • Saved/Scheduled > Edit Report window - Report For Client Company dropdown
  • Saved/Scheduled > Edit Report window - General Filters Tab (or Virtual Group Tab) - Client Companies filter dropdown
  • LIST CTs (List Shipments)
  • CT > GenTab - E0. Client Company dropdown
  • CT > GenTab - E1. Visibility 1 dropdown
  • CT > GenTab - E2. Visibility 2 dropdown
  • CT > GenTab - E3. Visibility 3 dropdown

[edit] Jaguar/Non-Jaguar Users

1) Objects to HIDE:

  • OPS
  • Virtual Group > Operations > Comment - "Recipients:" dropdown
  • ADMIN
  • Client App Admin > BCC List - Jaguar Users dropdown
  • LIST CTs (List Shipments)
  • Edit CT > IComTab - "Jaguar users" dropdown
  • Edit CT > ComTab - "Jaguar users" dropdowns
  • Edit CT > ComTab - "Client users" dropdowns
  • Edit CT > QueryTab - "Jaguar CC:" dropdown
  • LIST Ms (List Of All Masters)
  • Edit Master > CommentsTab - "Jaguar Users" list
  • Edit Master > CommentsTab - "Client Users" list
  • CLIENT Application
  • Shipment Details > Communication Center Tab - "Jaguar CC:" dropdown
  • Shipment Details > Communication Center Tab - "Client CC:" dropdown

2) Objects to MARK as "archived" (with trash can):

  • ADMIN
  • Users and Offices > Jaguar Users and Non-Jaguar Users tables
  • NOTE:
1) Active users and Archived users should be listed on this admin table, but for archived user, it should show the archived symbol (trash can).
2) Suggestion: Status column (archived; trash can) should be sort able as same as other column. So in this case, it will be easy to view the archived users list.
  • Client App Admin > BCC List - "Jaguar User Name" column
  • ACC
  • Reports > Profit/Loss for Multiple CTs - "Sales Persons:" dropdown (is not yet approved by MO).
  • REPORTS
  • Saved/Scheduled > Edit Report window-> "Recipients:"/"CC Recipients:"/"BCC Recipients:" listboxes
  • LIST CTs (List Shipments)
  • Edit CT > GenTab - G. Operator Of Last Change: textlabel
  • Edit CT > IComTab - "Sent to:" line in text area of sent message
  • Edit CT > ComTab - "Sent to:" line in text area of sent message
  • Edit CT > QueryTab - Email query "To:" textlabel
  • Edit CT > QueryTab - E-Mail Query Log (History) - "To" and "CC:" lines
  • LIST Ms (List Of All Masters)
  • Edit Master > CommentsTab - "Sent to:" line in text area of sent message
  • CLIENT Application
  • Shipment Details > Shipment Details Tab - "Authorised By" textlabel
  • Shipment Details > Communication Center Tab - "To:" textline

3) Saved Objects (HIDE and MARK):

We should show and mark as "archived" previously entered and saved Users and hide all other in dropdowns.

  • ADMIN
  • Client Companies > Client Companies - "Sales Person:" dropdown
  • REPORTS
  • Saved/Scheduled > Edit Report window-> "Recipients:"/"CC Recipients:"/"BCC Recipients:" dropdowns

NOTE: Because the lists of recipients in "Saved/Scheduled" can contains "Archived" users, system should show the warning message to user that under “To:” recipient is archived. And make sure that user selects some new recipient(s) under CC. In the same case with “To:” textline in Client Communication Center Tab the system should prevent email sending.

[edit] Special Cases and Misc

[edit] Look And Feel

[edit] Figures

[edit] Figure: XXX

[edit] New 2012 standard

File:Archive standard.JPG

[edit] Core Requirements 

At times some Entity items of CT2 should be excluded from System (temporarily or permanently). 
Also they should be able to be restored for reuse. 
Example: Entity - Region, Entity items - Africa, Antarctica, Asia etc.

Archiving feature is applicable for selected items of Entity table.
Archiving feature provided through following action buttons by using of their appropriate functionality (see above):

  • Archive button: get user confirm, mark as archived with image
  • Restore button: get user confirm, remove "archived" mark
  • Replace button: get user confirm, "merge" two items into one
  • Hide archived checkbox:
    • if checked then don't display archived items in table,
    • if unchecked then display all

NOTE: every table of Entity has additional column with a garbage can to mark archived items in the table.

[edit] Related Functionality

  • Provide recording (and displaying) of all archive-related actions with Entity items in System Log
  • For every place in the System where Entity is appearing:
    • if Entity item is tagged as archived then it should not appear on the list

[edit] Change Requests

[edit] SOW 0

See #Design Ideas and next.

[edit] SOW 1

0001639: [Archive Feature](*ph1)(Users / Offices) Implement archive feature for Jaguar users, non-Jaguar users

[edit] Core Requirements

Implement this feature for Jaguar users, non-Jaguar users, Jaguar User groups ===

[edit] SOW 2

0001838: (Transportation) Delivery Date Types. Not implemented "Archive/Restore" feature.

[edit] Core Requirements

Archiving feature has the following on Delivery Date Types Tab in Transportation section of Admin:

  • add Archive/Restore and Replace buttons and "Hide archived" checkbox with appropriate functionality for New 2012 standard
    • "Archive" button: get user confirm, mark as archived with image
    • "Restore" button: get user confirm, remove "archived" mark
    • "Replace" button: get user confirm, "merge" two items into one
    • "Hide archived" checkbox:
      • if checked then don't display archived Delivery Date Types in table,
      • if unchecked then display all
  • add column with a garbage can to mark archived items in table of Delivery Date Types

[edit] Related Functionality

  • Provide recording (and displaying) of all archive-related actions with Delivery Date Types in System Log
  • For every place in the system where Delivery Date Type is appearing:
    • if Delivery Date Type is tagged as archived then it should not appear on the list
Retrieved from "https://wiki.jaguarfreight.com/Archive_(Feature)"
Personal tools