REQ 292887 ePOD Requirements

From Calidus HUB
Revision as of 12:44, 19 April 2012 by Anw (talk | contribs) (v1.0 - Added System Overview section, updated the references and issued.)





Aptean Logo.png







OBS Logistics Ltd

ePOD Requirements Guide


CALIDUS ePOD

19th April 2012 - 1.0
Reference: REQ 292887












































Introduction

This document is intended to drive the collection of information required to implement an new CALIDUS EPOD system.

Each section is designed as a reminder of existing functionality within the system, targeting specific areas for more information.

Ample space has been left for comments within the printed document.

System Overview

The CALIDUS ePOD system provides functionality to handle the process of Proof of Delivery electronically. The system aids this process by providing both a management interface and a client application for use completing tasks. The system supports three job types at this point which encompass the functionality to complete many more tasks with them. At this point the system can be used to complete and record Deliveries, Collections and Services.

The software is broken into the following main areas:

  • Admin
  • PDA Client
  • Import/Export
  • Database

EPOD-Overview-1.PNG

Server

The CALIDUS ePOD system is hosted on a Windows Server. The minimum configuration is as follows:

  • Dual Core 2.0+Ghz processor
  • 100Gb Hard Disk Space
  • 2Gb Memory
  • Gb Ethernet Network

The recommended configuration differs with the number of users on the system and the quantity of data maintained over time. However, the following is a good medium-sized solution:

  • Quad Core 2.0+Ghz processor
  • 500Gb 7200+ Hard Disk Space (local SCSI RAID or SAN)
  • 4Gb Memory
  • Gb Ethernet Network

Required Software:

  • Microsoft Windows Server 2008 R2
  • Microsoft IIS (Web Services)
  • Remote Support capability (Microsoft RDS over VPN recommended)
  • Microsoft .NET Framework 3.5/4.0
  • Database (MySQL, SQL Server, ORACLE)

Optional Software:

  • For emails to customers or exporting of data, an email server must be set up and the details provided.
  • For bespoke importing from Microsoft Excel, this program must be installed on the server.

Required software configuration:

  • Administrative user
  • 1-3 open ports for HTTP/SOAP traffic. More may be required for secure internet connections (HTTPS).
  • Internet access (or local file download capability)

Admin

The CALIDUS ePOD administration software is a web-based application that handles all of the administrative side of the CALIDUS ePOD system.

The purpose of the application can be broken down into the following sections:

  • To create and maintain users of the ePOD devices.
  • To create and maintain reference data for the system (e.g. Reason Codes, Vehicles, Customers).
  • To create Jobs of all types and group them together onto Loads.
  • To assign Loads to Users.
  • To view the Jobs and Loads created.
  • To print or email a POD.

The system is built using Microsoft ASP.NET and is hosted on a Microsoft web server running Internet Information Services (IIS), backed by .NET 3.5/4.0.

The system is accessed through a standard web browser.

The system requires JavaScript to be allowed in web pages.

The system has been tested on multiple versions of:

  • Microsoft Internet Explorer (8 and above)
  • Mozilla Firefox (3-11)
  • Google Chrome
  • Opera

The system is also confirmed externally as working with Apple Safari.

PDA Client

The CALIDUS ePOD PDA Client application is a Windows Mobile PDA-based application, that handles all of the operational functionality for the ePOD system.

The PDA client allows users to connect and receive load data, consisting of a load and a series of associated jobs. It provides the functionality to process and complete these jobs electronically in the field. The PDA Client allows processing of Services, Collections and Deliveries. The PDA Client is reliant on a network connection either GPRS or Wi-Fi to retrieve load data, but is not reliant on a connection to complete them, as once jobs are complete, data will be stored on the device until the next time the device has a connection and the application is running. Static data (such as site information) will be stored locally – this is downloaded once during the login process, if a connection is present and the data requires updating.

The system is written in Microsoft .NET Compact Framework, with the intended device configuration of Microsoft Windows Mobile 6.x, and multiple screen resolutions, from 320*240 pixels (QVGA) upwards, in portrait mode only.

The PDA communicates with the main system through Web Services, hosted by the main server. These Web Services are written in C#.NET.

Import/Export

Import of data into the system can be through two mechanisms:

  • Web Services standard interface
  • Bespoke manual file upload

The Web Services are hosted as part of the main CALIDUS ePOD server, are written in Microsoft C#.NET and run as SOAP or HTML Web Services. Data is formatted in a strongly-typed XML file, validated by a full XSD. Data can be passed either as a string or as an XML object.

The data defined in this XSD can be modified by development for customers who require additional data sent to and from the CALIDUS ePOD system.

The Bespoke manual file upload is written on demand for customers who require it.

Export of data from the system can be through several mechanisms:

  • Request of data from a Web Service
  • Auto-export of data

Web Services are supplied for external systems to request information on Loads and Jobs, by ID or Date Since. The Web Services are hosted as part of the main CALIDUS ePOD server, are written in Microsoft C#.NET and run as SOAP or HTML Web Services. Response Data is formatted in a strongly-typed XML file, validated by a full XSD.

Auto-export of data can be configured to push the XML data automatically to the client system, via 2 mechanisms:

  • Web Service
  • Email

If configured as a Web Service, the Auto-Export process will connect to the defined web service and push the data to it in the XML format defined above. If configured as an Email address, the XML file will be emailed to the defined address.

This process can also (if configured) automatically produce and email Completion Documents (defined POD, POC or Service reports) to customers, on successful completion of a job.

The Auto-Export process is run as a scheduled task on the main CALIDUS ePOD server and are written in Microsoft C#.NET as a Windows Executable Application.

Database

The CALIDUS ePOD database holds:

  • Load and Job data for the jobs in progress and completed
  • Captured signature data for completed loads
  • Image data for cancelled or amended lines
  • Image data for document capture
  • Standing Data (configuration and system data)

The system is largely database type agnostic, and has been confirmed to run without issues on:

  • Microsoft SQL Server 2005/2008/2012 Full and Express editions (native database)
  • Oracle MySQL 5.1 community and enterprise editions

Further, the database is compatible with Oracle 11g databases.

Customer Overview

What is the total number of users?

What is the total number of Loads per day?

What is the total number of Jobs (Separate Collection, Delivery and Service) per Load?

What is the total number of Containers per Job?

What is the total number of Products per Container?

Add any other pertinent information here.

General

The system allows for multiple Sites to be served completely separately within the system. You cannot plan Jobs for 2 different sites onto the same Load.

Jobs can be Grouped together - this allows the system to apply different settings to Jobs being processed in Group 1 as opposed to jobs in group 2. For example, group 1 may require a different Completion document (i.e. POD) format to group 2.

How many sites will there be?

How many Job Groups will there be?

Customers

Will the jobs require defined Customer Codes (i.e. re-used)?

Will the jobs require only Free Entry Addresses (not reused)?

Will the system need to support both (i.e. a customer address and a different delivery address)?

Products

Are Product Weights required to be held?

  • Per Unit?
  • Total?

Are product Prices required?

  • Per Unit?
  • Total?

Is there a pre-defined product list?

Are product quantities to be stored and monitored?

  • Vehicle Product Quantities?
  • Site Product Quantities?

What are the number and size of the descriptive product fields?

  • Description 1
  • Long Description
  • UOM

Loads

A Load consists of a collection of jobs assigned to a driver to complete.

Is there a need to have several Loads assigned to one driver? The system allows this - each load is sent to the user as the previous load is complete.

There are 3 types of Jobs. Which are required?

  • Collection
  • Delivery
  • Service

When starting a Load on a vehicle, the system will check and display a number of vehicle checks required before the user can begin.

Are vehicle checks required?

Information is displayed about each job when it is started:

  • Job Address
  • Contact information
  • Job Instructions

Is any other information required?

The user can make a call the customer.

The user can Navigate to the customer's address.


Add any other pertinent information here.

Collections

There are several types of collection. Which are in use?

  • Containers only (i.e. identifying Pallets only)
  • Containers and Products (i.e. identifying containers, then identifying the product within, and confirming the quantity)
  • Products Only
  • Ad Hoc collection of Products

What details must be visible against the Container? The system currently displays the ID and Description. A long press can be used to view any container weight.

What details must be visible against the Product? The system currently displays the Product, Description and Quantity. A long press can be used to view references and product type.

Add any other pertinent information here.

Deliveries

There are several types of collection. Which are in use?

  • Containers
  • Containers and Products
  • Products Only

What details must be visible against the Container? The system currently displays the ID and Description. A long press can be used to view any container weight.

What details must be visible against the Product? The system currently displays the Product, Description and Quantity. A long press can be used to view references and product type.

Add any other pertinent information here.

Services

What steps are required as part of the Service?

  • Pre-work Checks
  • Vehicle Info
  • Installed Products
  • Returned Products
  • MC References
  • Diagnosis
  • Post-work Checks

Add any other pertinent information here.

Confirmation of a Job

When a job is completed:

  • Is the Driver Signature required?
  • Is the Customer Signature required?
  • Is a different contact to that advised required?
  • Is Document Image Capture required?
  • Is COD required? (Captures only whether the cash was collected, not the amount)
  • Is a receipt required? (New development)

Add any other pertinent information here.

Exceptions

What exceptions are captured?

  • Job Cancellation
  • Container not delivered
  • Product Quantity Change

Are specific reason codes used?

Are images required?

Add any other pertinent information here.

Data Transfer

Import

How will jobs be interfaced?

  • OBS Web Service
  • Other Web Service
  • File Upload (CSV, XLS, etc)

What data needs importing?

  • Customers
  • Products
  • Jobs
  • Loads
  • Other

Export

How will jobs be interfaced back to you?

  • OBS Web Service (ERP Pull)
  • Web Service (Push)
  • Other Web Service (Bespoke Format)
  • Email

What data needs exporting?

  • Jobs
  • Loads
  • Completion Documents

Add any other pertinent information here.

Completion Documents

There are several types of Completion documents that can be crea5ted by the system. Which are required?

  • Delivery (POD)
  • Collection (POC)
  • Service (Work Report)

Are there different formats per Job Group?

Do the documents go over a single page?

Are any of the subsequent pages in a different format?

Please provide examples for each format, annotated with requirements. Any required images should be provided.

What format should they be produced in?

  • HTML
  • PDF

Should these documents be automatically emailed to the customers?

This space should be used to list all new fields required for the Completion documents.

Admin Features

Is the Admin system going to be used?

What for?

  • Entering Jobs
  • Entering Containers
  • Entering Products
  • Changing quantities
  • Entering Customers
  • Assigning Jobs to Loads
  • Assigning Loads to Users
  • Maintaining Product Quantities
  • Maintaining Users
  • Viewing Loads
  • Viewing Jobs
  • Viewing Containers
  • Viewing Products
  • Viewing/Printing/Emailing Completion Documents

If new fields are required on Completion documents, must they be viewable/editable?

Indicate these below.

Technical Details

Is the system hosted by the Client or by OBSL?

Windows Server:

  • Memory
  • HD
  • O/S

In order to effectively support the system, OBSL must connectivity to the system.

  • Remote connectivity to the server [ RDC ] [ VPN ] [ VNC ] [ Other ] ____________
  • File Transfer details

The server requires Microsoft IIS to be installed for the application to function.

For emails, an email server must be set up and the details provided.

For importing from Microsoft Excel, this program must be installed on the server.

Hosting

The data passed to and from the PDA units is open and unencrypted. This contains details of the delivery address and product information. If this is to be encrypted, the whole message must be encrypted through Secure Socket Layering.

[ SSL ] or [ Open ]

Minimum Database Requirements

  • SQL Server 2005/2008 Express Edition

PDA unit requirements

  • Windows Mobile 6+
  • Screen size required?


Appendix A: Document References

A.1 References

Ref NoDocument Title & IDVersionDate
1UG 291094 EPOD Admin User Guide2.04/04/2012
2UG 291097 EPOD Client User Guide2.04/04/2012


A.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.


A.3 Authorised By


Tony Walker

OBS Consultant
_____________________________