TEST: Difference between revisions

From Calidus HUB
VisualWikitext
No edit summary
(#tagtest)
 
(24 intermediate revisions by the same user not shown)
Line 1: Line 1:
<div class="noprint">
= 325145 Device Audit Log Improvements =
{{#vardefine:Client|OBS}}
{{#vardefine:ClientName|OBS Logistics Ltd}}
{{#vardefine:System|''CALIDUS'' WMS}}
{{#vardefine:Doc_Title|Release Notes}}
{{#vardefine:Version|1.0}}
{{#vardefine:Date|8th May 2016}}
{{#vardefine:Reference|091}}
{{#vardefine:Year|2016}}
</div>
{{Doc_Title
|Client={{#var:ClientName}}
|System={{#var:System}}
|Title={{#var:Doc_Title}}
|Reference=P{{#var:Reference}}
|Version={{#var:Version}}
|Date={{#var:Date}}
|Year={{#var:Year}}
}}
<!-- TOC -->
<div class="noprint">


= SUMMARY INTRODUCTION =
== Requirements ==
== INTRODUCTION ==
* Send the device audit log through a new web service method, rather than through email.
The main aim of this document is to provide {{#var:System}} users with the level of detail required to accurately test all software included in the patch. The document also contains set-up and configuration details to enable the user to configure the system correctly for the new functionality to work.
* Request that the device send through the audit log by making a setting on the server.
* Allow configuration of the audit log:
** Per device and default for the system.
** What is to be audited (types of audit log messages).
** Number of records to store on the audit log.
* Admin screen available to OBSL users only, to configure audit logs and request them to be sent (Devices screen).




=== GLOSSARY OF TERMS ===
== Overview of Solution ==
C-TMS - Transport Management System
=== Device Audit Log Web Service Method ===
The PDA Audit Log screen will be modified to build a message onto the pending queue, containing all the logged data.


CR - Change Request
A new message request will be created for this (AUDIT_LOG).


C-WCS - Warehouse Control System
Structure to be defined, but it is assumed this will follow the structure of the existing XF_AUDIT device table.


C-ePOD - Electronic Proof of Delivery
The server PDA web service will be modified to receive this message and save this to a file in a server-side folder. The folder will be defined as a system web configuration parameter. The name to be confirmed, but will likely comprise:
* "AUDIT_LOG_"
* device_id
* date
* time
* ".XML"


C-MCS - Mobile Control System


C-TTM - Track and Trace Management
=== Request Device Audit Log ===
The EPOD_DEVICE table will be modified to add the following fields:
* EPD_AUDIT_LOG_REQUESTED_IND - int default 0
* EPD_LAST_AUDIT_LOG_REQUESTED_DATE - int default 0
* EPD_LAST_AUDIT_LOG_REQUESTED_TIME - int default 0
* EPD_LAST_AUDIT_LOG_RECEIVED_DATE - int default 0
* EPD_LAST_AUDIT_LOG_RECEIVED_TIME - int default 0
* EPD_LAST_AUDIT_LOG_RECEIVED - nvarchar(100) NULL


EDI - Electronic Data Interchange
The server PDA web service will be modified to recognise this flag on the following existing web service methods:
* LOGON_REQUEST
* AUTO_UPDATE_REQUEST


TID - Testing Issue Development, or Log
The device will be extracted and, if EPD_AUDIT_LOG_REQUESTED_IND is set to 1, the following additional information will be returned on the message:
* EPD_AUDIT_LOG_REQUESTED_IND - int default 0
* EPD_LAST_AUDIT_LOG_REQUESTED_DATE - int default 0
* EPD_LAST_AUDIT_LOG_REQUESTED_TIME - int default 0


Structure to be defined, but it is assumed this will follow the structure of the existing EPOD_DEVICE table.


<!-- NEW PAGE -->
== TESTING PROCESS ==


===TIDs AND RESOLUTION===
The device will be modified to check the responses to these messages (including a grace logon) and check the value of the indicator. If the flag is set to 1, the process will check the last requested date and time is different to the last request received. If so, the device will call the same code as the Audit screen i.e. generate a new AUDIT_LOG web service call.
If there are any areas of the functionality that are not acceptable or do not meet the requirement specified in the Change Request then these should be expressed by raising a TID.




=== FINAL 'END TO END' TESTING ===
The server PDA web service AUDIT_LOG method will be modified to extract the device from the message and update the following fields:
Prior to release to a production database, a full 'End to End' test is required on the test system by all sites using the database. Once this is signed off, a release date can be arranged.
* EPD_AUDIT_LOG_REQUESTED_IND - set to 0
* EPD_LAST_AUDIT_LOG_RECEIVED_DATE - set to sysdate
* EPD_LAST_AUDIT_LOG_RECEIVED_TIME - set to systime
* EPD_LAST_AUDIT_LOG_RECEIVED - set to the name of the audit log file created.




=== AUTHORISATION ===
=== Device Audit Log Configuration ===
Authorisation from nominated release personnel only will be required when requesting a release to a production environment
{{Note}} This supersedes the Audit Logging configuration on the device.


The EPOD_DEVICE table will be modified to add the following fields:
* EPD_AUDIT_LOGGING_IND - int, default 0
* EPD_AUDIT_LOG_TYPES - nvarchar(MAX) -
* EPD_AUDIT_LOG_LIMIT - int, default 2000


= CHANGE REQUESTS =
Defaults for the system will be set to be:
<!--
* EPD_AUDIT_LOGGING_IND - 0
== CR REF:  ==
* EPD_AUDIT_LOG_TYPES - "{}"
=== Reporter ===
* EPD_AUDIT_LOG_LIMIT - 2000


=== OBS Log Number ===
The server PDA web service will be modified for the LOGON_REQUEST method to return the content of the EPD_DEVICE table for the device.


=== Summary of request ===


=== Release notes ===
The device will be modified to check the LOGON_RESPONSE message and store the devices flags. The value of EPD_AUDIT_LOG_TYPES will be stored as a JSON object or as a delimited list of areas.


=== Set-up and configuration ===
{{Note}} This list of all areas is defined as a list of all calls to logAudit or funLogMessage in the mobile device application.
-->
== CR REF: AR-A6LBE3 ==
=== Reporter ===
Andrew Rowe
=== OBS Log Number ===
333070
=== Summary of request ===
RTB report has zero quantities when failure is at stop level 329671 is a program bug that doesn’t calculate the quantities correctly if multiple failure reasons are captured against a delivery. The fix involves checking the quantities recorded against each reason code.


Log 331450 is a problem with the data coming in from Microlise which was exposed by the fix for 329671; the fixed report looks for the quantity against the failure reason, but Microlise isn’t passing it in.
The device will store the log indicator and limit (EPD_AUDIT_LOGGING_IND and EPD_AUDIT_LOG_LIMIT) as new global variables or system properties.


There is a solution, which is to amend the interface to check if a zero quantity is passed for a failure reason and assume that the quantity failed is the to-deliver quantity when updating the database. The data on the database will then be right and will appear correctly on the report.
The device audit logging process (XF_AUDIT) will be modified to use the limit (EPD_AUDIT_LOG_LIMIT) instead of the fixed limit (2000). If the limit has changed, all messages will be removed from the table.


=== Release notes ===
The device logging process will be modified to check whether the area exists in EPD_AUDIT_LOG_TYPES. If so, and audit logging is enabled (EPD_AUDIT_LOGGING_IND = 1), the device will write the debug message to the audit log.
A new system parameter called 'MIC_CALC_REASON_QTY' will need to be set to 'Y' for the appropriate cost centre.


If 'MIC_CALC_REASON_QTY' is 'Y' and the reason code is a type of 'FAILURE' and a non-zero quantity has not been provided, the quantity will be calculated as the despatched quantity of the item multiplied by -1 for a negative adjustment (with the assumption that only one reason code will be provided).


If 'MIC_CALC_REASON_QTY' is 'N', the quantity from the file will be used.
=== Devices Maintenance Screen ===
The EPOD_DEVICE table will be modified to add the following fields:
* EPD_NAME - nvarchar(50)


=== Set-up and configuration ===
EPOD_LISTS and EPOD_LIST_ITEMS records will be created with all logging areas.
Path & Name: MIC_CALC_REASON_QTY


Setting Value: Y
{{Note}} This list of all areas is defined as a list of all calls to logAudit or funLogMessage in the mobile device application.


Result: Sets the item reason quantity to the despatched quantity if a reason code is provided with a quantity of 0 instead of an accurate quantity and the type of reason code is ‘FAILURE’


Path & Name: MIC_CALC_REASON_QTY
A new Devices screen will be created to maintain the device table, including the new logging functionality.


Setting Value: N
This screen is available to OBSL users only, to configure audit logs and request them to be sent. This screen will not be added to any menus.


Result: Existing functionality will set the item reason quantity to 0
This will be created as a new MVC screen. This requires the existing EPOD_DEVICE and EPOD_DEVICE_TYPE DAL classes to be converted to the new models.


The screen will allow work similarly to existing screens, for finding and editing data.


<!-- NEW PAGE -->
New devices cannot be created from this screen.
== CR REF: JB-A3GDS9 ==


=== Reporter ===
The screen will allow searching for devices using the following criteria:
Jeremy Brooks
* ''Device ID'' - text box with fuzzy match.
=== OBS Log Number ===
* ''Device Name'' - text box with fuzzy match.
330895
* ''Date Type'' selector, one of:
=== Summary of request ===
** ''Last Used''.
Review capability to provide web service access into Unison 414 has an MS Access database called DAVE that currently relies on manually run quiz reports. We are looking to replace this with a SQL backend and .net frontend and to remove the manually triggered reports and move to web services , if this is not possible or too expensive then need to understand any other options.
** ''Audit Requested''.
** ''Audit Received''.
* ''Date Range'' - a date range from/to, defaulting to the last week.
* ''User'' - textbox.
* ''Site'' - textbox, defaulting to the logged-on site.
* ''Audit Logging'' - a checkbox, defaulting to unchecked.


Suggested data required : o    Order line status…. Picker ref/Loader ref…. The intent here is to combine resource info and line detail to facilitate better status updates and productivity visibility.
The results will be displayed in a jQuery datatable-enabled gridview.


Order Ref, Product code, Picker ID, Pick volume, Pick completion DTM, Loader ref, Loaded vol, Load completion DTM
The columns will be:
* ''Device ID''.
* ''Device Name''.
* ''Last Used'' (Date/Time).
* ''User''.
* ''Site''.


=== Release notes ===
Clicking on a row will display the actions:
Add TEMP_CTRL to TRIP_DETAIL and ORDER_HEADER sections for LOTS records
* '''Show Audit Logs''' - optional, allowing showing all logs associated to that device ID. This requires opening a folder on the IIS web server for browsing, like the PDAUpdates folder on the server.
=== Set-up and configuration ===
* '''Select'''.
No set-up or configuration required


Pressing '''Select''' shows the details of the device:
* ''Device ID'' - read only
* ''Device Name'' - textbox.
* ''Last Used Date/Time'' - read only
* ''User'' - read only
* ''Site'' - read only
* ''Audit Logging'' section:
** ''Last Requested Date/Time'' - read only
** ''Last Received Date/Time'' - read only
** ''Last Audit Log'' - read only
** ''Enable Audit Logging'' - checkbox.
** ''Audit Log Types'' - a multi-select list. This is disabled if audit logging is disabled. This list will be populated from EPOD_LIST_ITEMS for the requisite list.
** '''Request Audit Log''' button - clicking this button enables the EPD_AUDIT_LOG_REQUESTED_IND field. This button is disabled if the indicator is already 1. This button is disabled if audit logging is disabled on the device.


<!-- NEW PAGE -->
== CR REF: DS-A76DXR ==


=== Reporter ===
A '''Save''' and '''Cancel''' button will also be provided.
Denis Starodubov
=== OBS Log Number ===
333530
=== Summary of request ===
External Carriers pre-advice to be sent via EDI every few hours. At the moment external carriers such as Polarspeed get a pre-advice EDI message sent over every time trip set to En-route in CTMS, however this is end of day procedure at which point sometime it can be too late and therefore deliveries have to be moved to the next day by the carrier. The requirement is to have ability to send an EDI pre-advice (what orders are on the trip) at trip status such as Planned & Tendered utilising existing flows. Also, perhaps this can be manipulated by the carrier and how often the pre-advice sent over by CTMS, so this is fully automated process that can be tailored to our needs and developed as a blanket solution for all external carriers.
 
Benefits: External carriers get order detail pre-advice messages much sooner or as often as they require. That gives them ability to plan pickup and deliveries on time. This will improve delivery process and should eliminate late deliveries overall.
=== Release notes ===
The following changes will need to be made to the EDI process to produce an electronic manifest, for example:
 
Triggers:
 
Type = STATUS
 
Value = TENDERED (and/or ACCEPTED)
 
Parameters:
 
Param = PROCESS_INTERVAL
 
Value = 60
 
N.B. Changed to a parameter from a report value in FS.
 
The electronic manifest will be triggered as at present when the trip is updated to EN-ROUTE.
 
The electronic manifest will also be triggered when the trip is updated to a status listed for the EDI trigger and when an order is assigned to, or removed from, a trip that is EN-ROUTE or listed for the EDI trigger.
 
The EDI parameter for the interval will be used to only send a new electronic manifest when a previous file has been sent for the trip when the interval has elapsed.
 
The EDI parameter will not be used when the trip is EN-ROUTE so that the external carrier is informed immediately of any changes at that status.
=== Set-up and configuration ===
No set-up or configuration required
 
 
 
= SUPPORT INCIDENTS =
<!--
== Customer Ref:  ==
=== OBS Log Number ===
=== Reporter ===
=== Summary of Call ===
=== Detail of Fix ===
=== Set-up and configuration ===
-->
== Customer Ref: INC11247922 ==
=== OBS Log Number ===
330656
=== Reporter ===
=== Summary of Call ===
Inconsistency in the column count, extra column "lifts" in database
=== Detail of Fix ===
Change extract to always include lifts
=== Set-up and configuration ===
A WCS change is required with this call
 
 
== Customer Ref: INC11277761 ==
=== OBS Log Number ===
330751
=== Reporter ===
Suzie Maskery
=== Summary of Call ===
Exports not running correctly
=== Detail of Fix ===
Data fixes to the following three reports for search criteria issues:
* Outbound Shortage
* Receipt Scanning
* Driver Scanning
=== Set-up and configuration ===
An EPOD change is required with this call
 
 
= TID CHANGES =
<!--
== OBS Log Number: 331329 ==
=== Reporter ===
=== Summary of Call ===
=== Detail of Fix ===
=== Set-up and configuration ===
-->
== OBS Log Number: 331329 ==
 
=== Reporter ===
Andy Rowe
=== Summary of Call ===
Blank pages on BS RTB report
=== Detail of Fix ===
Stop collection orders being selected even when a delivery failure reason code has been used against it.
=== Set-up and configuration ===
No set-up or configuration is required
 
 
== OBS Log Number: 332187 ==
 
=== Reporter ===
Michelle Naumovski
=== Summary of Call ===
Change to remove job swap validation
=== Detail of Fix ===
Add fix to epod functionality to resolve job swapping issues.  This fix relates to both the following logs: 332187 & 332188
=== Set-up and configuration ===
A WCS change is required with the log
 
 
 
= OBSL PRODUCT DEVELOPMENT =
<!--
== OBS Log Number:  ==
=== Reporter ===
=== Summary of Call ===
=== Detail of Fix ===
=== Set-up and configuration ===
-->
== OBS Log Number: 334960 ==
=== Reporter ===
Paul Roscoe
=== Summary of Call ===
Main version of branched version 334939
=== Detail of Fix ===
This log has been raised to incorporate a branched version for log 334939 into the main version of the database package for export files.
=== Set-up and configuration ===
No set-up or configuration required
 
 
 
= ADDITIONAL CHANGES =
== WCS ==
 
A WCS change is required for the following logs:
* 330656
* 332187
 
== EPOD/T2A ==
 
An EPOD/T2A change is required for the following logs:
* 330751
 
== MCS ==
 
There are no MCS changes required.
 
== PORTAL/TTM ==
 
There are no Portal/TTM changes required.
 
== EDI ==
 
There are no EDI changes required.
 
 
</div>
[[Category:{{#var:Client}} PATCH]]

Latest revision as of 17:13, 25 April 2019

325145 Device Audit Log Improvements

Requirements

  • Send the device audit log through a new web service method, rather than through email.
  • Request that the device send through the audit log by making a setting on the server.
  • Allow configuration of the audit log:
    • Per device and default for the system.
    • What is to be audited (types of audit log messages).
    • Number of records to store on the audit log.
  • Admin screen available to OBSL users only, to configure audit logs and request them to be sent (Devices screen).


Overview of Solution

Device Audit Log Web Service Method

The PDA Audit Log screen will be modified to build a message onto the pending queue, containing all the logged data.

A new message request will be created for this (AUDIT_LOG).

Structure to be defined, but it is assumed this will follow the structure of the existing XF_AUDIT device table.

The server PDA web service will be modified to receive this message and save this to a file in a server-side folder. The folder will be defined as a system web configuration parameter. The name to be confirmed, but will likely comprise:

  • "AUDIT_LOG_"
  • device_id
  • date
  • time
  • ".XML"


Request Device Audit Log

The EPOD_DEVICE table will be modified to add the following fields:

  • EPD_AUDIT_LOG_REQUESTED_IND - int default 0
  • EPD_LAST_AUDIT_LOG_REQUESTED_DATE - int default 0
  • EPD_LAST_AUDIT_LOG_REQUESTED_TIME - int default 0
  • EPD_LAST_AUDIT_LOG_RECEIVED_DATE - int default 0
  • EPD_LAST_AUDIT_LOG_RECEIVED_TIME - int default 0
  • EPD_LAST_AUDIT_LOG_RECEIVED - nvarchar(100) NULL

The server PDA web service will be modified to recognise this flag on the following existing web service methods:

  • LOGON_REQUEST
  • AUTO_UPDATE_REQUEST

The device will be extracted and, if EPD_AUDIT_LOG_REQUESTED_IND is set to 1, the following additional information will be returned on the message:

  • EPD_AUDIT_LOG_REQUESTED_IND - int default 0
  • EPD_LAST_AUDIT_LOG_REQUESTED_DATE - int default 0
  • EPD_LAST_AUDIT_LOG_REQUESTED_TIME - int default 0

Structure to be defined, but it is assumed this will follow the structure of the existing EPOD_DEVICE table.


The device will be modified to check the responses to these messages (including a grace logon) and check the value of the indicator. If the flag is set to 1, the process will check the last requested date and time is different to the last request received. If so, the device will call the same code as the Audit screen i.e. generate a new AUDIT_LOG web service call.


The server PDA web service AUDIT_LOG method will be modified to extract the device from the message and update the following fields:

  • EPD_AUDIT_LOG_REQUESTED_IND - set to 0
  • EPD_LAST_AUDIT_LOG_RECEIVED_DATE - set to sysdate
  • EPD_LAST_AUDIT_LOG_RECEIVED_TIME - set to systime
  • EPD_LAST_AUDIT_LOG_RECEIVED - set to the name of the audit log file created.


Device Audit Log Configuration

Note Note: This supersedes the Audit Logging configuration on the device.

The EPOD_DEVICE table will be modified to add the following fields:

  • EPD_AUDIT_LOGGING_IND - int, default 0
  • EPD_AUDIT_LOG_TYPES - nvarchar(MAX) -
  • EPD_AUDIT_LOG_LIMIT - int, default 2000

Defaults for the system will be set to be:

  • EPD_AUDIT_LOGGING_IND - 0
  • EPD_AUDIT_LOG_TYPES - "{}"
  • EPD_AUDIT_LOG_LIMIT - 2000

The server PDA web service will be modified for the LOGON_REQUEST method to return the content of the EPD_DEVICE table for the device.


The device will be modified to check the LOGON_RESPONSE message and store the devices flags. The value of EPD_AUDIT_LOG_TYPES will be stored as a JSON object or as a delimited list of areas.

Note Note: This list of all areas is defined as a list of all calls to logAudit or funLogMessage in the mobile device application.

The device will store the log indicator and limit (EPD_AUDIT_LOGGING_IND and EPD_AUDIT_LOG_LIMIT) as new global variables or system properties.

The device audit logging process (XF_AUDIT) will be modified to use the limit (EPD_AUDIT_LOG_LIMIT) instead of the fixed limit (2000). If the limit has changed, all messages will be removed from the table.

The device logging process will be modified to check whether the area exists in EPD_AUDIT_LOG_TYPES. If so, and audit logging is enabled (EPD_AUDIT_LOGGING_IND = 1), the device will write the debug message to the audit log.


Devices Maintenance Screen

The EPOD_DEVICE table will be modified to add the following fields:

  • EPD_NAME - nvarchar(50)

EPOD_LISTS and EPOD_LIST_ITEMS records will be created with all logging areas.

Note Note: This list of all areas is defined as a list of all calls to logAudit or funLogMessage in the mobile device application.


A new Devices screen will be created to maintain the device table, including the new logging functionality.

This screen is available to OBSL users only, to configure audit logs and request them to be sent. This screen will not be added to any menus.

This will be created as a new MVC screen. This requires the existing EPOD_DEVICE and EPOD_DEVICE_TYPE DAL classes to be converted to the new models.

The screen will allow work similarly to existing screens, for finding and editing data.

New devices cannot be created from this screen.

The screen will allow searching for devices using the following criteria:

  • Device ID - text box with fuzzy match.
  • Device Name - text box with fuzzy match.
  • Date Type selector, one of:
    • Last Used.
    • Audit Requested.
    • Audit Received.
  • Date Range - a date range from/to, defaulting to the last week.
  • User - textbox.
  • Site - textbox, defaulting to the logged-on site.
  • Audit Logging - a checkbox, defaulting to unchecked.

The results will be displayed in a jQuery datatable-enabled gridview.

The columns will be:

  • Device ID.
  • Device Name.
  • Last Used (Date/Time).
  • User.
  • Site.

Clicking on a row will display the actions:

  • Show Audit Logs - optional, allowing showing all logs associated to that device ID. This requires opening a folder on the IIS web server for browsing, like the PDAUpdates folder on the server.
  • Select.

Pressing Select shows the details of the device:

  • Device ID - read only
  • Device Name - textbox.
  • Last Used Date/Time - read only
  • User - read only
  • Site - read only
  • Audit Logging section:
    • Last Requested Date/Time - read only
    • Last Received Date/Time - read only
    • Last Audit Log - read only
    • Enable Audit Logging - checkbox.
    • Audit Log Types - a multi-select list. This is disabled if audit logging is disabled. This list will be populated from EPOD_LIST_ITEMS for the requisite list.
    • Request Audit Log button - clicking this button enables the EPD_AUDIT_LOG_REQUESTED_IND field. This button is disabled if the indicator is already 1. This button is disabled if audit logging is disabled on the device.


A Save and Cancel button will also be provided.

Retrieved from ‘https://calidusassist.adcservices.apteancloud.com/calidus-assist/OBS/index.php?title=TEST&oldid=7320’