Log

From UG

(Difference between revisions)
Jump to: navigation, search
(→Objects: renamed to Sub-Components)
(→Parent Mantis)
 
(63 intermediate revisions not shown)
Line 1: Line 1:
-
[[Category:OpsAdmin]]
+
[[Category:OpsMisc]]
-
== General Info and Scope ==
+
==Info==
 +
===Parent Mantis===
-
* Classified As: (small) (large) [[component]] / common [[feature]] / [[misc]]
+
* mantis: [http://ct.jaguarfreight.com/mantis/view.php?id=2570 0002570]
-
* Parent Mantis: [http://mantis.jaguarfreight.com/mantis/view.php?id=2397 2397]
+
-
=== Scope ===
+
===Scope of this wiki===
-
This is a [[CRUD]] component for CT2 Admin Update Log.
+
This wiki covers the logging of CT2 user's activities which make the changes to system,'' including system's actions''.
-
=== Related articles ===
+
==Glossary==
-
== Business Requirements ==
+
==Core Business Need==
-
''(copied from [http://mantis.jaguarfreight.com/mantis/view.php?id=2397 mantis #2397])''
+
This is a report on all user activity in the system.  
-
All changes to Admin should be reflected in special Log.
+
==Business Requirements==
-
Info to show: When change happened, Who changed, What was changed, Admin Component where change happened
+
You can search by date or/and component and see who and when set or changed any value in the system.
-
Easy way to search/filter by fields above.
+
-
Discuss w/ developer
+
-
Most important: Jag/Non-Jag users, Users Access Admin
+
-
Note: we have similar task for Acc
+
-
== Design ==
+
:1) System Logs
-
=== Summary ===
+
:2) Admin Logs
-
Admin Update Log should reflected all changes in Admin part of CT2.
+
:3) Acc Logs
 +
:4) Operation Logs
 +
:5) Shipment Logs
 +
:6) Master Logs
-
It is available from the main menu on the next path: "Admin -> Admin Update Log". See [[#Figure 0. Main Menu item | Figure 0]].
+
==SOW 0==
 +
 
 +
'''Mantis:''' [http://ct.jaguarfreight.com/mantis/view.php?id=2397 2397] (* Ops Admin Misc) Create log for Admin 
 +
 
 +
Core requirements:
This feature displayed in the table form which contains the next details of Admin changes:  
This feature displayed in the table form which contains the next details of Admin changes:  
Line 32: Line 35:
: 2) '''Who''' is made changes,  
: 2) '''Who''' is made changes,  
: 3) '''What''' was changed,  
: 3) '''What''' was changed,  
-
: 4) Admin Component '''where''' change happened.
+
: 4) Admin [[#Components |Component]] (and Sub-Component) '''where''' change happened.
 +
 
 +
Admin Update Log should reflect all changes in Admin part of CT2.
 +
 
 +
Admin Update log should provide a search feature. All [[#Columns |columns]] of Admin Update log should have an able to a sorting.
 +
 
 +
=== Solution ===
 +
 
 +
==== Components (and Sub-Components) ====
 +
* [http://ct.jaguarfreight.com/wiki/Addressbook_(component) Address Book]: Company-City List, Transportation, Vendors, Bill To Parties
 +
* [http://ct.jaguarfreight.com/wiki/Client_Companies_(component) Client Companies]: Client Companies, Client Companies Groups, Credit Limits, Credit Terms, Credit Statuses
 +
* [http://ct.jaguarfreight.com/wiki/Create_CT_(component) Create CT Admin]: Numbers, CT1 vs CT2 Client Companies
 +
* [http://ct.jaguarfreight.com/wiki/Category:Users_and_Offices Users and Offices]: Offices, Jaguar Users Groups, Jaguar Users, Non-Jaguar Users
 +
* [http://ct.jaguarfreight.com/wiki/Geography_(component) Geography]: Regions, Countries, Airports, Port/Terminals, Busiest Port/Terminals
 +
* [http://ct.jaguarfreight.com/wiki/Transportation_(component) Transportation]: Shipping Terms, Default Authorization Methods, Move Types/HBLs, Container Sizes, Container Types, Customs Statuses, FDA Statuses, Packaging Pallet Types, Delivery Date Types, PO Issued By
 +
* [http://ct.jaguarfreight.com/wiki/Category:Carriers Carriers]: Airlines, Steamshiplines
 +
* [http://ct.jaguarfreight.com/wiki/Automated_Estimated_Delivery_Dates_(component) Automated Estimated Delivery Dates]: Air, FCL AW, FCL MLB, LCL AW, LCL MLB
 +
* [http://ct.jaguarfreight.com/wiki/User_Access_Admin_(component) Users Access Admin]: Basic Ops, Super Ops, Basic Acc, Super Acc, Management, Sales etc
 +
* [http://ct.jaguarfreight.com/wiki/Client_App_Admin_(component) Client App Admin]: Manage RSS News Feeds, Testimonials, Mobile Providers, BCC List, TMS
 +
* [http://ct.jaguarfreight.com/wiki/Shipment_Invoices_Recovery_(component) Shipment Invoices Recovery]: Number of Invoice what was changed
 +
 
 +
'''Example:'''<br>
 +
[[File:System Update Log Menu.JPG]]
 +
 
 +
==== Columns ====
 +
* '''Date''': Date when change happened. Displayed in standard [http://mantis.jaguarfreight.com/wiki/Datatypes#CT2_date CT2 date] format.
 +
* '''Jaguar User / Office''': Name of Jaguar User who made changes (and User's Office).
 +
* '''Event''': Type of happened change: ''{ Add, Remove, Edit, Archive, Restore }''.
 +
* '''Component''': Name of the [[#Components |component]] where change happened.
 +
* '''Sub-Component''': Name of the [[#Sub-Components |sub-component]] where change happened.
 +
* '''Field''': Name of the field what was changed.
 +
* '''Change''': Old and new values of changed fields in format ''old value => new value''.
 +
 
 +
'''Example:'''
 +
 
 +
[[File:Admin System Update Log Recordings.JPG]]
 +
 
 +
==SOW 1==
 +
'''Mantis:''' [http://ct.jaguarfreight.com/mantis/view.php?id=3094 3094] (Main Log) Changes: 1) additional filters 2) downloads to xls 
 +
 
 +
Core requirements:
 +
 
 +
r1) add ability to download "log results" into excel
 +
 
 +
r2) add filters ([[Reports_Filters#Multiselect | Multiselect]]):
 +
 
 +
* Operator Name
 +
* Office
 +
* Internal Group
 +
* Client
 +
 
 +
=== Solution ===
 +
 
 +
Connection logic for filters (Operator, Client user, Office, User group):
 +
* Within multiselect filters use OR connection.
 +
* Connect above-mentioned filters each other by OR also.
 +
* Connect them to other filters by AND operator.
 +
 
 +
[[File:System_Log_Main_Menu.GIF]]
 +
 
 +
'''NOTE:'''
 +
"Show system logs" checkbox was added. This control object doesn't affect of an any result of query. It only controls the showing/hiding of system messages (have empty User/Office column) in report.
 +
 
 +
[[File:System_Log_Show_System_Logs.GIF]]
 +
 
 +
'''Example''' of report downloaded into Excel:
 +
 
 +
[[File:System_Log_Excel.GIF]]
 +
 
 +
==SOW 2 Create a better framework for logging Air Status EDI Messages ==
-
''Example'' of Admin Update Log see on [[#Figure 1. Admin Update Log |Figure 1]].
+
'''0003479''': Create a better framework for logging Air Status EDI Messages
-
=== Components ===
+
=== Timely processing===
-
* [http://mantis.jaguarfreight.com/wiki/Addressbook_(component) Address Book]
+
* Provide control the unbroken handling of received Freight Status Answer[http://www.iata.org/whatwedo/cargo/efreight/pages/glossary.aspx] (FSA) messages on airdescartes FTP.
-
* [http://mantis.jaguarfreight.com/wiki/Client_Companies_(component) Client Companies]
+
:* Accordingly to set "Air Status/EUAN updates frequency in seconds(s)" in Air Status/EUAN Admin section of CT2.
-
* [http://mantis.jaguarfreight.com/wiki/Create_CT_(component) Create CT Admin]
+
NOTE: This related also to mantis '''[http://ct.jaguarfreight.com/mantis/view.php?id=3523 3523]''' ''Rearchitect the interface: connect probl btw CT2 & FTP Server for TMS, Air Status & EUAN BP.''
-
* [http://mantis.jaguarfreight.com/wiki/Category:Users_and_Offices Users and Offices]
+
-
* [http://mantis.jaguarfreight.com/wiki/Geography_(component) Geography]
+
-
* [http://mantis.jaguarfreight.com/wiki/Transportation_(component) Transportation]
+
-
* [http://mantis.jaguarfreight.com/wiki/Category:Carriers Carriers]
+
-
* [http://mantis.jaguarfreight.com/wiki/Automated_Estimated_Delivery_Dates_(component) Automated Estimated Delivery Dates]
+
-
* [http://mantis.jaguarfreight.com/wiki/User_Access_Admin_(component) Users Access Admin]
+
-
* [http://mantis.jaguarfreight.com/wiki/Client_App_Admin_(component) Client App Admin]
+
-
* [http://mantis.jaguarfreight.com/wiki/Shipment_Invoices_Recovery_(component) Shipment Invoices Recovery]
+
-
=== Sub-Components ===
+
=== Complete handling ===
 +
* Handle the received files
 +
:* Valid files ''(update CT)''. Keep them on FTP after use in "Valid files" directory.
 +
:* Not valid files ''(don't update CT)''. Keep them on FTP in proper directories - "Not valid files", "Files with dates in future".
 +
:* We should keep messages for 1 year. Every 3 months compress all messages into a zip file and store them that way on ftp.
 +
* Record derived information of each Message
 +
:* If "<Status>" tag presented in Message use status details from [http://ct.jaguarfreight.com/wiki/Air_Status_EDI#Expanded_Consignment_Status_description Expanded Consignment Status description]
 +
:* If "<Status>" tag missed in Message use details from "<OtherServiceInformation>" tag
 +
::* "NO RECORD FOUND" should be ignored when MAWB is out of system.
 +
NOTE about Error.txt:
 +
* Log meaningful information (when available);
 +
* Line delimiter could be added.
-
'''Address Book'''
+
=== Increase performance ===
-
* Company-City List
+
''Taken from mantis, written in note (0012035) by Vlad:''  
-
* Transportation
+
:* 1) log error message instead of throwing an exception when incomingStatuses is null.
-
* Vendors
+
:* 2) remove unnecessary processing:
-
* Bill To Parties
+
::* Example: ''xmlEnvelope and messageTypeUnmarshaller (line 149) seems to be redundant as identical messageType can be found in IncomingAirEnvelope (line 153).<br>This can save (1) second ftp file download, (2) second XML file parsing.''
 +
:* 3) use FTP RENAME command instead deleting and re-uploading files;
 +
:* 4) attempt to create directories should be done at most once, immediately after internal application is deployed.
-
'''Client Companies'''
+
=== Extended description in System Log ===
-
* Client Companies
+
:* Display full description of received status
-
* Client Companies Groups
+
::* also display every status record in Update Log of related CT;
-
* Credit Limits
+
::* would be good to keep the last received status directly in shipment to be able to display it without request to CT Update Log.
-
* Credit Terms
+
:* Display additional information (not only Dates but Airports/Carriers or smth).
-
* Credit Statuses
+
-
'''Create CT Admin'''
+
=== Post-Implementation Notes ===
 +
* Features which were not implemented:
 +
** Handling of ''"Files with dates in future"'' isn't defined for AIR statuses but only for TMS. No need to implement.
 +
** Archiving/compressing ''(every 3 moths)'' of received messages. <span style="color:red">Separate task should be created.</span>
 +
** Status label in shipment. <span style="color:red">Separate task should be created.</span>
 +
* "<Status>" and "<OtherServiceInformation>" tags are handled separately.
 +
* ''"NO RECORD FOUND" should be ignored'' means '''not logged'''.
-
'''Users and Offices'''
+
== SOW 3 Improve user interface ==
-
* Offices
+
-
* Jaguar Users Groups
+
-
* Jaguar Users
+
-
* Non-Jaguar Users
+
-
'''Geography'''
+
mantis:
-
* Regions
+
-
* Countries
+
-
* Airports
+
-
* Port/Terminals
+
-
* Busiest Port/Terminals
+
-
'''Transportation'''
+
spec: below
-
* Shipping Terms
+
-
* Default Authorization Methods
+
-
* Move Types/HBLs
+
-
* Container Sizes
+
-
* Container Types
+
-
* Customs Statuses
+
-
* FDA Statuses
+
-
* Packaging Pallet Types
+
-
* Delivery Date Types
+
-
* PO Issued By
+
-
'''Carriers'''
+
=== SOW 3 Requirements ===
-
* Airlines
+
-
* Steamshiplines
+
-
'''Automated Estimated Delivery Dates'''
+
Per Marc:
-
* Air
+
-
* FCL AW
+
-
* FCL MLB
+
-
* LCL AW
+
-
* LCL MLB
+
-
'''Users Access Admin'''
+
* it is inconvenient that user needs to expand tree to see results. So by default it should be expanded
-
* Basic Ops
+
* to go futher we should possibly switch to table like front end (vs tree). This type of approach we had in [[Log v1]] and CT1
-
* Super Ops
+
-
* Basic Acc
+
-
* Super Acc
+
-
* Management
+
-
* Sales
+
-
* Blank1
+
-
* Blank2
+
-
'''''Fields:'''''
+
Per Alex/Roma:
-
* ''Ops Home''
+
-
* ''List CTs''
+
-
* ''List Ms''
+
-
* ''Create CT''
+
-
* ''Create M''
+
-
* ''Admin Home''
+
-
* ''Admin.Users''
+
-
* ''Admin.Geography''
+
-
* ''Admin.Transportation''
+
-
* ''Admin.Address Book''
+
-
* ''Admin.Client Companies''
+
-
* ''Admin.Carriers''
+
-
* ''Reports Home''
+
-
* ''Acc Home''
+
-
* ''CT Rights Administration''
+
-
* ''Delete saved documents''
+
-
* ''Edit/Delete Comments/Query''
+
-
* ''TMS''
+
-
'''Client App Admin'''
+
* Log missing filters section when called from CT Editor. Inconvenient for QA and Support and possibly end users
-
* Manage RSS News Feeds
+
-
* Testimonials
+
-
* Mobile Providers
+
-
* BCC List
+
-
* TMS
+
-
'''Shipment Invoices Recovery'''
+
=== SOW 3 Solution ===
-
=== Columns ===
+
TBD
-
* '''Date'''
+
-
:* Date when change happened. Displayed in standard [http://mantis.jaguarfreight.com/wiki/Datatypes#CT2_date CT2 date] format.
+
-
* '''Jaguar User / Office'''
+
-
:* Name of Jaguar User who made changes (and User's Office).
+
-
* '''Event'''
+
-
:* Type of happened change: ''{ Create, Remove, Edit }''.
+
-
* '''Summary'''
+
-
:* Detail description of changes with specifying of changed objects and their values.
+
-
* '''Component'''
+
-
:* Name of the [[#Components |component]] where change happened.
+
-
== Figures ==
+
== SOW 4 Add logging of purchase invoices ==
-
=== Figure 0. Main Menu item ===
+
mantis:
-
[[File:AdminUpdateLogMainMenuItem.gif]]
+
-
=== Figure 1. Admin Update Log ===
+
spec: below
-
[[File:AdminUpdateLogTableOfEvents.gif]]
+
-
== History ==
+
* log all events related to PIs: created, updated, deleted
 +
* log under Acc section

Current revision as of 00:11, 3 August 2013


Contents

[edit] Info

[edit] Parent Mantis

[edit] Scope of this wiki

This wiki covers the logging of CT2 user's activities which make the changes to system, including system's actions.

[edit] Glossary

[edit] Core Business Need

This is a report on all user activity in the system.

[edit] Business Requirements

You can search by date or/and component and see who and when set or changed any value in the system.

1) System Logs
2) Admin Logs
3) Acc Logs
4) Operation Logs
5) Shipment Logs
6) Master Logs

[edit] SOW 0

Mantis: 2397 (* Ops Admin Misc) Create log for Admin

Core requirements:

This feature displayed in the table form which contains the next details of Admin changes:

1) When change happened,
2) Who is made changes,
3) What was changed,
4) Admin Component (and Sub-Component) where change happened.

Admin Update Log should reflect all changes in Admin part of CT2.

Admin Update log should provide a search feature. All columns of Admin Update log should have an able to a sorting.

[edit] Solution

[edit] Components (and Sub-Components)

  • Address Book: Company-City List, Transportation, Vendors, Bill To Parties
  • Client Companies: Client Companies, Client Companies Groups, Credit Limits, Credit Terms, Credit Statuses
  • Create CT Admin: Numbers, CT1 vs CT2 Client Companies
  • Users and Offices: Offices, Jaguar Users Groups, Jaguar Users, Non-Jaguar Users
  • Geography: Regions, Countries, Airports, Port/Terminals, Busiest Port/Terminals
  • Transportation: Shipping Terms, Default Authorization Methods, Move Types/HBLs, Container Sizes, Container Types, Customs Statuses, FDA Statuses, Packaging Pallet Types, Delivery Date Types, PO Issued By
  • Carriers: Airlines, Steamshiplines
  • Automated Estimated Delivery Dates: Air, FCL AW, FCL MLB, LCL AW, LCL MLB
  • Users Access Admin: Basic Ops, Super Ops, Basic Acc, Super Acc, Management, Sales etc
  • Client App Admin: Manage RSS News Feeds, Testimonials, Mobile Providers, BCC List, TMS
  • Shipment Invoices Recovery: Number of Invoice what was changed

Example:
File:System Update Log Menu.JPG

[edit] Columns

  • Date: Date when change happened. Displayed in standard CT2 date format.
  • Jaguar User / Office: Name of Jaguar User who made changes (and User's Office).
  • Event: Type of happened change: { Add, Remove, Edit, Archive, Restore }.
  • Component: Name of the component where change happened.
  • Sub-Component: Name of the sub-component where change happened.
  • Field: Name of the field what was changed.
  • Change: Old and new values of changed fields in format old value => new value.

Example:

File:Admin System Update Log Recordings.JPG

[edit] SOW 1

Mantis: 3094 (Main Log) Changes: 1) additional filters 2) downloads to xls

Core requirements:

r1) add ability to download "log results" into excel

r2) add filters ( Multiselect):

  • Operator Name
  • Office
  • Internal Group
  • Client

[edit] Solution

Connection logic for filters (Operator, Client user, Office, User group):

  • Within multiselect filters use OR connection.
  • Connect above-mentioned filters each other by OR also.
  • Connect them to other filters by AND operator.

File:System_Log_Main_Menu.GIF

NOTE: "Show system logs" checkbox was added. This control object doesn't affect of an any result of query. It only controls the showing/hiding of system messages (have empty User/Office column) in report.

File:System_Log_Show_System_Logs.GIF

Example of report downloaded into Excel:

File:System_Log_Excel.GIF

[edit] SOW 2 Create a better framework for logging Air Status EDI Messages

0003479: Create a better framework for logging Air Status EDI Messages

[edit] Timely processing

  • Provide control the unbroken handling of received Freight Status Answer[1] (FSA) messages on airdescartes FTP.
  • Accordingly to set "Air Status/EUAN updates frequency in seconds(s)" in Air Status/EUAN Admin section of CT2.

NOTE: This related also to mantis 3523 Rearchitect the interface: connect probl btw CT2 & FTP Server for TMS, Air Status & EUAN BP.

[edit] Complete handling

  • Handle the received files
  • Valid files (update CT). Keep them on FTP after use in "Valid files" directory.
  • Not valid files (don't update CT). Keep them on FTP in proper directories - "Not valid files", "Files with dates in future".
  • We should keep messages for 1 year. Every 3 months compress all messages into a zip file and store them that way on ftp.
  • Record derived information of each Message
  • "NO RECORD FOUND" should be ignored when MAWB is out of system.

NOTE about Error.txt:

  • Log meaningful information (when available);
  • Line delimiter could be added.

[edit] Increase performance

Taken from mantis, written in note (0012035) by Vlad:

  • 1) log error message instead of throwing an exception when incomingStatuses is null.
  • 2) remove unnecessary processing:
  • Example: xmlEnvelope and messageTypeUnmarshaller (line 149) seems to be redundant as identical messageType can be found in IncomingAirEnvelope (line 153).
    This can save (1) second ftp file download, (2) second XML file parsing.
  • 3) use FTP RENAME command instead deleting and re-uploading files;
  • 4) attempt to create directories should be done at most once, immediately after internal application is deployed.

[edit] Extended description in System Log

  • Display full description of received status
  • also display every status record in Update Log of related CT;
  • would be good to keep the last received status directly in shipment to be able to display it without request to CT Update Log.
  • Display additional information (not only Dates but Airports/Carriers or smth).

[edit] Post-Implementation Notes

  • Features which were not implemented:
    • Handling of "Files with dates in future" isn't defined for AIR statuses but only for TMS. No need to implement.
    • Archiving/compressing (every 3 moths) of received messages. Separate task should be created.
    • Status label in shipment. Separate task should be created.
  • "<Status>" and "<OtherServiceInformation>" tags are handled separately.
  • "NO RECORD FOUND" should be ignored means not logged.

[edit] SOW 3 Improve user interface

mantis:

spec: below

[edit] SOW 3 Requirements

Per Marc:

  • it is inconvenient that user needs to expand tree to see results. So by default it should be expanded
  • to go futher we should possibly switch to table like front end (vs tree). This type of approach we had in Log v1 and CT1

Per Alex/Roma:

  • Log missing filters section when called from CT Editor. Inconvenient for QA and Support and possibly end users

[edit] SOW 3 Solution

TBD

[edit] SOW 4 Add logging of purchase invoices

mantis:

spec: below

  • log all events related to PIs: created, updated, deleted
  • log under Acc section
Retrieved from "https://wiki.jaguarfreight.com/Log"
Personal tools