FS 340161 PROD-70 Compartmentalised Auto-Export

From Calidus HUB





Aptean Logo.png







OBS Logistics

Compartmentalised Auto-Export

CALIDUS EPOD

19th December 2016 - 0.1
Reference: FS 340161 PROD-70











































Functional Overview

Client Requirement

Auto-Export has in the last struggled with the volume of data being exported. Additionally, there have been requests in the past to delay the sending of emails or POD reports until later in the day. This must be supported.


Solution Overview

Auto-Export should be modified so that the operation mode can be defined in the parameters of the call from the scheduler if required.

By default, this would be ALL modes as now.

The application scheduler command can be configured to be called with the parameters delimited with vertical bar. For example:

  • "ALL"
  • "TOMTOM"
  • "POD|TTM"
  • "JOB|LOAD|SWAP|CHECK|EMAIL"

Only the mode selected will be run.


This will allow the different elements of the export to be run at different intervals, allowing for a more control of what runs at what time, and also reducing the amount of work completed by each instance of the application, reducing the problems linked to dealing with volume of data.


Scope

Set-up

Pre-requisites

Menu Structure

Data

The application should be called with the parameters delimited with vertical bar. For example:

  • "ALL"
  • "TOMTOM"
  • "POD|TTM"
  • "JOB|LOAD|SWAP|CHECK|EMAIL

Note: Now that the application can be run several times concurrently, certain portions of the exporting system will overlap. Care should be taken when configuring the application that the application is not configured to run twice in the same mode.


Functional Description

Auto-Export

The file EPOD_UTILS.cs will be modified. The existing class EPODAutoExport will be modified to add all the modes for the application, as follows: 

   public static class EPODAutoExport
   {
       public static class OperationMode
       {
           public const string TomTom = "TOMTOM";
           public const string All = "ALL";
           public const string POD = "POD";
           public const string TTM = "TTM";
           public const string Emails = "EMAIL";
           public const string JobSwap = "SWAP";
           public const string Jobs = "JOB";
           public const string Loads= "LOAD";
           public const string VehicleChecks = "CHECK";
       }
   }


The file AutoExport.cs will be modified to use these modes.

The mode will be predefined to be "ALL" if the mode is not set. 

   if (strOption.Trim() == "")
   {
       strOption = EPODAutoExport.OperationMode.All;
   }

.... The call to each export option will be modified to check the mode: 

   if (strOption.IndexOf(EPODAutoExport.OperationMode.JobSwap) > -1 || strOption == EPODAutoExport.OperationMode.All)
   {
   ...
   }


The application should be called with the parameters delimited with vertical bar. For example:

  • "ALL"
  • "TOMTOM"
  • "POD|TTM"
  • "JOB|LOAD|SWAP|CHECK|EMAIL


Note Note: Now that the application can be run several times concurrently, certain portions of the exporting system will overlap. Care should be taken when configuring the application that the application is not configured to run twice in the same mode. This is also true of having the application running in mode ALL and any other mode.


However, certain portions of the code also use temporary areas to store files when they are produced, for example, producing POD formats or emailing POD documents. As these modes could be running concurrently, the temporary areas used by the modes should be different, to ensure that one instance of the program does not overwrite the temporary files created by another instance. This is best achieved by ensuring the temporary areas used are specific to the mode. For example, send POD files should use a different area than emailing POD files, even though the code is technically the same. A sub-folder of the existing folder should be used per mode.


Appendix A: TEST PLAN

Test Script / Scenario ReferenceCompartmentalised Auto-ExportCall Number(s): 340161 PROD-70
Test Script / Scenario DescriptionTesting the compartmentalisation of Auto-ExportPASS / ISSUES / FAIL
Menu AccessN/A 
Pre-requisitesEnsure the system is configured for all export types.Tested By:
 
Test ObjectiveTo test that each area of the Auto-Export program may be configured separately or together if required.Date:
 



Step Action Result Remarks P/F
1 Auto-Export      
  N/A.      
1.01 Configure a shortcut to run the Autoexport with no command-line parameters. Run the shortcut. Check the log. All areas of the auto-export are run in this mode.    
1.02 Change the shortcut to have a command-line parameter indicating TomTom only. Run the shortcut. Check the log. Only the TomTom export is run.    
1.03 Repeat the test, modifying the shortcut for each mode in sequence. Only the expected mode is run.    
1.04 Repeat the test, modifying the shortcut so that several modes are included in a single parameter e.g. "JOB Only the expected modes are run.    


Appendix B: Quote & Document References

Cost Details
Activity Estimate
No. of Days		 No. of Days Rate per Day (£) Cost (£ Exc. VAT)
Requirements 0.00 0.00 0 £0.00
Change Request Evaluation 0.00 0.00 0 £0.00
Functional Specification 0.50 0.50 0 £0.00
Technical Specification 0.00 0.00 0 £0.00
Development 2.00 2.00 0 £0.00
Testing and Release 0.50 0.50 0 £0.00
Implementation 0.50 0.50 0 £0.00
Project Management 0.25 0.25 0 £0.00
 
TOTAL 3.75 3.75   £0.00
Estimate excludes training, release to live and go live support.

B.1 References

Ref NoDocument Title & IDVersionDate
1   


B.2 Glossary

Term Definition
EPOD Electronic Proof of Delivery. The OBS EPOD system is CALIDUS ePOD.
CALIDUS eSERV The OBS mobile system to complete Service functionality in the field. This is part of the CALIDUS ePOD system.
PDA The mobile device on which the C-ePOD system will run in the field. This can be a Phone, EDA or industrial PDA, running Android.
DAL Data Access Layer. A mechanism for accessing data by the system that is removed from the application, allowing for simplified access and providing protection to the data, as only approved DAL methods can be used to modify it.
GPS Global Positioning System. A mechanism of retrieving accurate positioning information in the form of Latitude and Longitude (Lat-Long) co-ordinates from a device.
GPRS, 3G, HSDPA, Data Service All terms referring to mobile device network connectivity, and the speed at which the device connects to the internet.


B.3 Authorised By


Murray Middleton
OBSL Development Manager		_____________________________
Retrieved from ‘https://calidusassist.adcservices.apteancloud.com/calidus-assist/OBS/index.php?title=FS_340161_PROD-70_Compartmentalised_Auto-Export&oldid=3978’