OV 320722 CALIDUS MCS Build and Release Guide
From MCS
Aptean
C-MCS Vuild and Release Guide
CALIDUS MCS
7th February 2020 - 2.0
Reference: FS UG 320722
Contents
Build and Release Guide
Note: This is a developer guide.
Pre-Requisites
See Development Notes for details of development environment set-up.
Start with the QA TFS stream.
Create a new TFS branch for the new version.
Ensure that all code has been brought in or created in this stream.
Change the JavaScript and Build versions:
- app.js - change MCS.App.Version to the new version number.
- Web.config - change JSVersion to the new version number.
Ensure that the code builds.
Check in all code changes to the new TFS branch.
Build the Release
Right-click on WebSite.
Select Publish Web App.
- Connection:
- File System - specify a local target location.
- Settings:
- Configuration: Release.
Click Publish.
Prep for Release
Copy the local release folder and contents to \\spekefs2012\Projects\Releases\MCS\Release\.
Rename Web.config to Web.config.release.
Rename this copied folder to the version name e.g. MCS_v.vv.vv.vvv.
Zip the folder to the same name.
Release Documentation
Create a new release note in this Assist system:
- From the navigation menu, choose Help/Creating new documents from templates.
- Choose Create release note.
- Enter a release note name in the format "REL (System) (Version)", for example "REL C-MCS v2.00.00.000".
- Click Create Release note.
- In the page that opens, change the 4 lines here to reflect the release note details:
{{#vardefine:System|''CALIDUS'' Mobile/TTM/Vision/ePOD, etc}}
{{#vardefine:SystemCode|WCS/MCS/EPOD, etc}}
{{#vardefine:Version|Release version no}}
{{#vardefine:Date|7th February 2020}}
- For example:
{{#vardefine:System|''CALIDUS'' MCS}}
{{#vardefine:SystemCode|MCS}}
{{#vardefine:Version|2.00.00.000}}
{{#vardefine:Date|7th February 2020}}
- Update Platforms/Database section with any restrictions that the product has regarding releases, for example operating system, browser, etc.
- Update Related Documents section to note any controlled documents that might be of use here. For example, if there is an Assist page that identifies the functionality changes, reference that.
- Update User Notes section to update site, or remove this line if inapplicable.
- Update Released Incidents / Changes section to include a line for each change included in the release notes. Add a line with the log references and title of the log, plus a description of the functionality added. Describe in user terms, not technical terms. For example "Fixed a bug where printer cannot be selected at Pallet Build" is a good comment, whereas "Fixed a bug in ui103lt3b_001.cs to add onLoad event" is not.
- Update Setup section to include any configuration steps that are required by the user. Be detailed with the individual flags and parameters, identifying system if necessary.
- Update User Instructions section, explaining where process has changed because of the changes included in this release, including the log reference.
- Update Performance Notes section, to indicate where performance of the system or the operation might be impacted by the changes in this release.
- Update Related Releases section, to show related releases, for this system or any other system. For example, if an MCS release is dependent on a specific C-TMS release, reference that here.
- Update Technical Changes & Special Notes section, for any other technical information that the customer might need to know. For example, if the changes require specific hardware or hardware configuration, for example a scanner, a signature pad, a specific monitor size, list this here. Any system tasks or changes that must be made to the application that cannot be made by the customer should also be listed here.
Save the release note in \\spekefs2012\Projects\Releases\MCS\Release Notes\.
Update the release log in \\spekefs2012\Projects\Releases\MCS\.
Release
On the customer machine, locate the customer MCS installation to be updated.
Delete any prior back-ups if appropriate.
Back-up the existing folder and zip it.
Copy the new release into the MCS installation folder.
Extract the contents of the new release zip over the existing folder.
Check and compare Web.config to Web.config.release - make any changes to the customer MCS installation version to reflect new keys added to the file.
Restart the system through IIS.
Inform the customer through email with the release note attached.
Appendix A: Document History
A.1 References
| Ref No | Document Title & ID | Version | Date |
|---|---|---|---|
| 1 | |||
| 2 | |||
| 3 |
A.2 Glossary
| Term or Acronym | Meaning |
|---|---|
| AWB | Airway Bill; a receipt of goods required by airline carriers. It also serves as the carriage contract between the carrier and the shipper. |
| C-MCS | CALIDUS MCS, OBS Logistics Mobile Control System. See also MCS. |
| Carrier | The carrier completing the trip. Can comprise any carrier configured in the system, but normally Home Fleet (usually a carrier per depot), 3rd-party carriers, supplier-/customer-own transport, own collection, etc. |
| Consolidating Centre | A depot that takes delivery of goods from several origins and consolidates them for trunking to outbases (q.v.) or final delivery to destinations. See also Consolidation. |
| Consolidation | In execution terms, this is the act of taking several jobs and combining them into a single execution job. This can be by several criteria but is broadly defined as: Same Location consolidation, where the delivery/collection points are identical; Linked Location, where the deliver/collection points have been configured to be seen as the same point within C-TMS and; Manual (Ad Hoc) Consolidation, where the driver decides that two jobs should be delivered/collected at the same time.
In general transport terms, this is the act of taking like product from several sources (originating depots, warehouses, orders) going to the same destination or on the same vehicle and placing them on a transportable media. See also containerisation. |
| Containerisation | The action of taking items and placing them inside another item for tracking purposes. See also Asset. |
| Cost Centre | A part of an organisation to which costs may be charged for accounting purposes. For C-TMS, this is used for accounting purposes, and also to generally configure the system. |
| C-TMS | CALIDUS TMS, OBS Logistics' Transport Management System. |
| Cross-Dock | Also a specific location at which product is exchanged. |
| Customer | In 3PL terms, the customer on behalf of which the transport is being operated. |
| DDL | Drop-down list - a series of pre-designated answers to a particular question on a device, rather than requiring the user to key the answer in in full. |
| Debrief | Comprises 2 parts: Stop debrief, where actual arrival and departure times against a trip are entered; Order debrief, where actual product and item quantities are entered; Driver/Trip debrief, where additional information is captured from the driver relating to the trip. |
| Depot | Any location that schedules and controls transport. |
| Despatch | In transport terms, the process of loading and despatching items out of a depot. In this implementation, the process of loading and despatching is predominantly controlled by C-MCS (q.v.). See also Loading. |
| Driver | Comprising drivers and crew assigned to a trip. |
| DU | Distribution/Deliverable Unit - Pallet, Package, etc.; Also Asset, Asset Type. |
| Fixed Route | In transport terms, a fixed route is a trip comprised of a series of fixed stops that are typically always visited. A C-TMS fixed route template (q.v.) can be used to create these. |
| Item | A single item for delivery/collection. A general terms, distinct from the DU of the deliverable item e.g. Pallet, Package, etc. |
| Loading | In transport terms, the process of loading and despatching items out of a depot. In this implementation, the process of loading and despatching is predominantly controlled by C-MCS (q.v.). See also Despatch. |
| Location | In C-TMS terms, a trip comprises visits or drops to many locations. A location can be of many different types. |
| Location Types | Usually one of: Depot, Customer, Delivery/Collection Location, Store, etc. |
| MCS | Mobile Control System, an application to execute mobile tasks, as opposed to transport management tasks from a console. For OBS Logistics, transport depot mobile tasks are handles by CALIDUS MCS. |
| OMS Ref | A unique transport movement ID, referring to a single transport movement request. |
| Optimisation | Route building and optimisation of stops on a trip. |
| Order | Equiv: OMS Ref; a transport movement. |
| Order Status | The lifecycle of an order. |
| Outbase | A depot whose purpose is to deliver to final delivery destination within a geographically-restricted subsection of the whole catchment area; also ROC. |
| Reason Codes | Of many types: Adjustment, Non-conformance, Order. |
| Receipt | In transport terms, the process of receiving and uploading items into a depot. In this implementation, the process of receipt and unloading is predominantly controlled by C-MCS (q.v.). See also Unloading. |
| Region; Postal Region | Geographical Region. |
| Resources | Drivers, Crew, Tractors, Vehicles, Trailers (q.v.). |
| Route | A route is a fixed route that is repeated. A Trip is a unique trip, which may be created from a route. |
| ROC | Regional Operating Centre; a depot whose purpose is to deliver to final delivery destination within a geographically-restricted subsection of the whole catchment area; also Outbase. |
| RPE | Roll-pallet Equivalent - This is used to estimate volume and therefore capacity of vehicles within C-TMS. |
| Schedule | A day's plan, usually consisting of 24 hours, not necessarily from midnight to midnight. |
| Shunt | A trunk (q.v.) movement between depots using the trunk network, typically of a much shorter length than a trunk movement. |
| TLM | Transport Logistics Manager |
| Tractor | The driver cab, pulling the trailer. |
| Trailer | The trailer carrying the goods. Can be several types. |
| Trans-Ship | The process of receiving, cross-docking and despatching items within a depot, usually within a single transaction. In this implementation, this is the process at the ROC (q.v.). |
| Transport | Transport operations. |
| Trip | C-TMS: A selection of work to be completed, specifically a workload that lasts for an entire shift for a driver. |
| Trip Status | The lifecycle of a trip. |
| Trunk | A route between depots, transporting goods usually to be delivered from the destination depot, but any transfer of goods from the original receiving or originating depot in the network to the final delivery depot (the outbase). |
| Unloading | The process of receiving and uploading items into a depot. In this implementation, the process of receipt and unloading is predominantly controlled by C-MCS (q.v.). See also Receiving. |
| Vehicle | A generic term for the resource assigned to a trip. Can be tractor (q.v.), tractor plus trailer (q.v.), fixed vehicle (e.g. van). In C-TMS terms, the tractor ID is considered the vehicle ID, usually the registration. |
| Warehouse | This is a depot in C-TMS that is seen to be a warehouse, or origin and storage point for product for delivery. |
A.3 Document History
| Version | Date | Status | Reason | By |
|---|---|---|---|---|
| 1.0 | 23/12/2019 | Issue | Initial Version | ANW |
A.4 Authorised By
Julie Scott | OBS Manager | _____________________________ |
Tony Walker | OBS Consultant | _____________________________ |
