System Overview: Difference between revisions

From EPOD
VisualWikitext
No edit summary
 
(47 intermediate revisions by 2 users not shown)
Line 2: Line 2:
The system consists of several key areas:
The system consists of several key areas:
===Database===
===Database===
This currently is configured for all installation on a SQL Server DB. Within the database we have several tables and a series of stored procedures to access and manipulate data. The stored procedures are called from the data access layer, no sql is manually executed from here.
This currently is configured for all installation on a SQL Server DB. Within the database we have several tables and a series of stored procedures to access and manipulate data. The stored procedures are called from the data access layer, no SQL is manually executed from here.
===Data Access Layer===
===Data Access Layer===
This is sometimes refered to as the server. In reality this is a series of C# classes that represent the database tables as objects and allow interaction with the stored procedures. Some business logic is excuted here in, moving forward more business logic should be included in here.
This is sometimes referred to as the server. In reality this is a series of C# classes that represent the database tables as objects and allow interaction with the stored procedures. Some business logic is executed here in, moving forward more business logic should be included in here.
===Web Application===
The web application provides a graphical user interface allows users to access and modify data within the database. This utilises ASP.Net, C# (for the code behind), CSS and Javascript (jQuery and jQuery UI).
===Web Services===
===Web Services===
The webservices are .Net asmx services. These act as both SOAP and Restful webservices and are accessible through a standardised URL. There are two sets of service:
The webservices are .Net asmx services. These act as both SOAP and Restful webservices and are accessible through a standardised URL. There are two sets of service:
Line 13: Line 11:
*DataServices
*DataServices
These are a set of services that allow clients to import data and request the export of data from the system
These are a set of services that allow clients to import data and request the export of data from the system
===Web Application===
The web application provides a graphical user interface allows users to access and modify data within the database. This utilises ASP.Net, C# (for the code behind), CSS and Javascript (jQuery and jQuery UI).
===ePOD Manager===
===ePOD Manager===
This windows application is still in the beta phases and has not been released. The purpose of this application is to allow administrative tasks such as archiving and clear downs to be run seperately from the Web Application.
This windows application is still in the beta phases and has not been released. The purpose of this application is to allow administrative tasks such as archiving and clear downs to be run separately from the Web Application.
===ePOD AutoExport===
===ePOD AutoExport===
This is a windows application that uses the data access layer to retrieve all records marked for export or POD emailing, and will process these records sending either xml data of jobs or loads via soap, post, or email, or POD html or PDF via email.
This is a windows application that uses the data access layer to retrieve all records marked for export or POD emailing, and will process these records sending either XML data of jobs or loads via soap, post, or email, or POD html or PDF via email.
===PDA Client===
===PDA Client===
The PDA client is used by drivers. This allows drivers to download their current workload, and complete/cancel any jobs assigned to it. The PDA has it's own local SQL Server Compact database which mirrors a subset of the data held in the main server database. All communications are performed via SOAP calls to the Calidus_ePOD.asmx update. There are two flavours of the ePOD PDA: Android and Windows Mobile 6.5.
The PDA client is used by drivers. This allows drivers to download their current workload, and complete/cancel any jobs assigned to it. The PDA has it's own local SQL Server Compact database which mirrors a subset of the data held in the main server database. All communications are performed via SOAP calls to the Calidus_ePOD.asmx update. There are two flavours of the ePOD PDA: Android and Windows Mobile 6.5.


==Database==
[[Category:WI 287575 EPOD Development and Release Process|015]]
The database is currently exclusive deployed on MS SQL Server and is support from 2005 upwards. Due to the nature of the Data Access Layers implementation, the system is to some extent database agnostic, and that simply rewritting the database table and packages to support another database should be all that is required to port over to MySQL or Oracle.
 
The database conists of a series of tables that are required to hold the needed data for the ePOD product. This data is manipulated through stored procedures which can be call from the data access layer.
 
Each table generally has four stored procedures:
*TABLE_NAME_INSERT
*TABLE_NAME_UPDATE
*TABLE_NAME_SELECT
*TABLE_NAME_DELETE
 
There may also be the following stored procedures:
*TABLE_NAME_GET_MAXID
*TABLE_NAME_CANCEL
*TABLE_NAME_SEARCH
*TABLE_NAME_SELECT_UPDATED_DATA - Not currenly used due to improvements needed in the PDA Client and the Webservices
 
===Tables===
*EPOD_DEVICE_TYPE
Holds a list of models of devices that have logged on to the calidus_epod.asmx webservice and configuration flags such as barcode scanning and camera capture capabilities. The intention is to use this data to restrict functionality on devices where there may be a issue using the functionality, for example no camera on the device.
*EPOD_CONTAINER
Holds container level information this is linked through primary key to the job record. Container 0000000000 is always the loose product container.
*EPOD_CUSTOMER
Holds customer level information.
*EPOD_JOB_ADDRESS
Holds address and contact information similar to a customer record but is used in the scenario of a different delivery location being provided for the customer.
*EPOD_JOB
Holds Job information such as type, customer, and times.
*EPOD_LOAD
Holds load level informatiom, representing a drivers workload (a set of jobs).
*EPOD_DEVICE
Holds device specific identification details such as Unique ID, Type, OS and the last User. This is updated with every relavant communcations message from the PDA.
*EPOD_JOB_GROUPS
Holds the configuration details for a job group
*EPOD_LOTS_STATUS
This table is not currently used, but was part of the initial design for LOTS intergration.
*EPOD_PRODUCT
Holds product level information associated to the Container and Job.
*EPOD_PHOTO
Holds photo information against job, container and products, this is held as a base64 encoded jpg file.
*EPOD_REASON_CODE
Holds the static reason code information.
*EPOD_USER_AUDIT
Holds a audit of all communcations between the PDA and the server, identifying the type of communication and the GPS location.
*EPOD_SERVICE_ACTIVITY_MASTER
Holds the static activity data.
*EPOD_SERVICE
Holds the service job information, this will be linked to a job record.
*EPOD_SERVICE_PRODUCT
This table holds all products used as part of a service.
*EPOD_SERVICE_PRODUCT_MASTER
This table holds static product information.
*EPOD_SERVICE_VEHICLE_PRODUCT
This table holds a list of service products that are held in each vehicle.
*EPOD_SITE
This table is at the top of the heirarchy, allowing multiple sites to be hosted on the same database. This holds high level configuration.
*EPOD_USER_ACCESS_GROUPS
This table holds the association between users and jobs groups allow users to view jobs of a particular group within the system.
*EPOD_USER
This table contains the users details.
*EPOD_VEHICLE_CHECK
This table holds the raw xml returned from vehicle checks performed on the device.
*EPOD_VEHICLE
The vehicles within the system are held here.
*EPOD_XF_AUDIT_HEADER
This table contains all the export audit information.
*EPOD_XF_AUDIT_DETAIL
This table has not been implemented within the system, and will be used if the Audits need expanding.
*EPOD_XF_CONFIG
This holds the configuration for the system exports.
 
==Data Access Layer==
The data access layer (EPOD Server project) provides a series of classes for interacting with the database. These classes are mapped out as follows:
Class
  Private Members
  Public Members
  Public Constructor
  Private Constructor
  Public Methods
  Private Methods
 
===Private and Public Members===
The private members represent columns within the data rows. These are all C# data types. This should not be manipulated manually and should be accessed via the public members which provide Get and Set methods to access them, implying various rules, for example maximum length.
 
===Public Constructor===
This is used to create

Latest revision as of 15:42, 6 June 2013

Overview

The system consists of several key areas:

Database

This currently is configured for all installation on a SQL Server DB. Within the database we have several tables and a series of stored procedures to access and manipulate data. The stored procedures are called from the data access layer, no SQL is manually executed from here.

Data Access Layer

This is sometimes referred to as the server. In reality this is a series of C# classes that represent the database tables as objects and allow interaction with the stored procedures. Some business logic is executed here in, moving forward more business logic should be included in here.

Web Services

The webservices are .Net asmx services. These act as both SOAP and Restful webservices and are accessible through a standardised URL. There are two sets of service:

  • Calidus_ePOD.asmx

This is used exclusively by the PDA Clients for communications with the server.

  • DataServices

These are a set of services that allow clients to import data and request the export of data from the system

Web Application

The web application provides a graphical user interface allows users to access and modify data within the database. This utilises ASP.Net, C# (for the code behind), CSS and Javascript (jQuery and jQuery UI).

ePOD Manager

This windows application is still in the beta phases and has not been released. The purpose of this application is to allow administrative tasks such as archiving and clear downs to be run separately from the Web Application.

ePOD AutoExport

This is a windows application that uses the data access layer to retrieve all records marked for export or POD emailing, and will process these records sending either XML data of jobs or loads via soap, post, or email, or POD html or PDF via email.

PDA Client

The PDA client is used by drivers. This allows drivers to download their current workload, and complete/cancel any jobs assigned to it. The PDA has it's own local SQL Server Compact database which mirrors a subset of the data held in the main server database. All communications are performed via SOAP calls to the Calidus_ePOD.asmx update. There are two flavours of the ePOD PDA: Android and Windows Mobile 6.5.

Retrieved from "https://calidusassist.adcservices.apteancloud.com/calidus-assist/EPOD/index.php?title=System_Overview&oldid=712"