C-ePOD Interface: Difference between revisions

From CTMS
m (Minor formatting changes.)
m (Minor formatting changes.)
Line 81: Line 81:
{{Note}} Only MODE2 is recommended for customers, due to the additional configurability of the interface.
{{Note}} Only MODE2 is recommended for customers, due to the additional configurability of the interface.


<font size="1">
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|- bgcolor="silver"
|- bgcolor="silver"
Line 295: Line 296:
|EPL_PRODUCT_WEIGHT || N/A || soi.weight || soi.weight || gross_weight || =>
|EPL_PRODUCT_WEIGHT || N/A || soi.weight || soi.weight || gross_weight || =>
|}
|}
</font>

Revision as of 17:23, 6 February 2020

Modes

Mode Description
PARCEL Simple non-configurable interface for parcel delivery.
RETAIL Products within containers. Non-configurable.
BULK Bulk product delivery at a location.
MODE1 Configurable container delivery.
MODE2 Configurable container or product delivery.

System Parameters

Note Note: The majority of system parameters that affect Job or lower levels apply only to MODE1 and MODE2 - other modes are bespoke and unaffected.

Parameter Description Level
EPOD_COMPLETE_ON_RTD Complete Trip when RTD job sent back from epod COST_CENTRE
EPOD_CONCATENATE_JOB_INSTR Concatenate the special instructions and the order comments for the collection/delivery location as the job instructions (Y/N). COST_CENTRE
EPOD_CONSOLIDATION_LEVEL Level of job consolidation for epod COST_CENTRE
EPOD_CONTACT_DELIMITER EPOD contact delimiter COST_CENTRE
EPOD_CONTAINER_CODE1 What populates this field in EPOD DIMS for dimesions(default) or PARTS for the part numbers if present COST_CENTRE
EPOD_CONTAINER_CODE2 What populates this field in EPOD DIMS for dimesions or PARTS for the part numbers if present(defaut) COST_CENTRE
EPOD_CONTAINER_CODE3 What populates this field in EPOD DIMS for dimesions or PARTS (for the part numbers if present) default NULL COST_CENTRE
EPOD_CONTAINER_DESCRIPTION What populates this field in EPOD COMMODITY for the item commodity(default) DESCRIPTION for item desc or PROD_DESC for the prod AKA code and item desc COST_CENTRE
EPOD_ITEM_LEVEL Send containers or Products to epod SYSTEM
EPOD_JOB_GROUP_FORMAT Indicates whether the value passed in the EPL Job Group to EPOD is the Cost Centre (CC), Carried ID (CI), Customer Group (CG) or Customer (CU). SYSTEM
EPOD_OWNER_CONFIG Epod Owner Configuration COST_CENTRE
EPOD_PREVENT_ASSET_TRACK Prevents asset tracking through EPOD COST_CENTRE
EPOD_SEND_CLOSING_TIME Send Location closing time to epod SYSTEM
EPOD_SEND_CONTACT_INFO Send Contact infromation to epod COST_CENTRE
EPOD_SEND_EQUIPMENT Controls if equipment requirments are sent to EPOD SYSTEM
EPOD_SEND_LOADING_TYPE Send Loading Type to EPOD COST_CENTRE
EPOD_SET_ACTUAL_SIGNATORY_BLANK Set EPOD actual signatory to blank (Y/N)? SYSTEM
EPOD_SIGNATURE_STORAGE Store signature received from epod COST_CENTRE
EPOD_SITE_ID_FORMAT Indicates whether the value passed in the EPL Site ID to EPOD is the Database Name(DB), Cost Centre (CC) or Carrier ID (CI). SYSTEM
EPOD_VIEW_POD_URL URL for viewing EPOD Documents SYSTEM
EPOD_WS_ADDRESS EPOD Web Service End Point SYSTEM
EPOD_WS_ADDRESS_NHSPRD EPOD Web Service End Point SYSTEM
EPOD_WS_MESSAGE_FORMAT EPOD message format - can either be PARCEL or BULK to define where fields are sent in the web service message SYSTEM
EPOD_WS_PASSWORD EPOD Web Service Login Password SYSTEM
EPOD_WS_TIMEOUT Number of minutes before a WS message will be set to Held SYSTEM
EPOD_WS_USERNAME EPOD Web Service Login Username SYSTEM


Mode Mapping

Note Note: Only MODE2 is recommended for customers, due to the additional configurability of the interface.

PARCEL RETAIL BULK MODE1 MODE2
EPOD_LOAD Note: Populated this way in all modes Note: Populated this way in all modes Note: Populated this way in all modes Note: Populated this way in all modes Note: Populated this way in all modes
EPL_SITE_ID t_site_id (configurable through EPOD_SITE_ID_FORMAT) => => => =>
EPL_LOAD_ID st.trip_id => => => =>
EPL_DELETE_LOAD "Y" if st.trip_status = "DELETED" else omitted => => => =>
EPL_LOAD_START_PLANNED_DATE st.start_time => => => =>
EPL_LOAD_START_PLANNED_TIME st.start_time => => => =>
EPL_LOAD_END_PLANNED_DATE st.end_time => => => =>
EPL_LOAD_END_PLANNED_TIME st.end_time => => => =>
EPL_LOAD_DISTANCE_PLANNED st.distance => => => =>
EPL_VEHICLE_ID st.tractor_id => => => =>
EPL_USER_ID rp.epod_username => => => =>
EPL_LOAD_INFORMATION Package Types (dry/wet ice) if present, or Equipment/qty (configurable through EPOD_SEND_EQUIPMENT) => => => =>
EPL_TIMEZONE tzm.tz_name from sts and gl. => => => =>
EPOD_JOB Extra control over which jobs are sent and whether details are included based on location/location type flags. Extra control over which jobs are sent and whether details are included based on location/location type flags.

Also swap van functionality

EPL_SITE_ID t_site_id (configurable through EPOD_SITE_ID_FORMAT) => => => =>
EPL_LOAD_ID trip_id => => => =>
EPL_JOB_ID NULL epod_oms_code (oms_ref + C or D) stop_id NULL =>
EPL_JOB_CODE oms_ref N/A N/A oms_ref =>
EPL_JOB_TYPE v_job_details_parcel.job_type (based on sha.activity_name) => => stop_type =>
EPL_JOB_GROUP t_job_group (configurable through EPOD_JOB_GROUP_FORMAT) => => t_job_group (configurable through EPOD_JOB_GROUP_FORMAT) Also includes config for the location (epod_job_group_load/unload) =>
EPL_CUST_REF v_job_details_parcel.customer_ref (so.external_ref) => N/A external_ref external_ref
EPL_JOB_INSTRUCTION so.special_instructions, plus stop, order and cost-centre instructions => sts.stop_id so.special_instructions, plus stop, order and cost-centre instructions so.special_instructions, plus stop, order and cost-centre instructions

For swap van, special instructions for that linked job. If there are items that have not been correctly T2A scanned, includes warning for that. If there are no items correctly entered, includes warning for that.

EPL_START_PLANNED_DATE arrive_date (from sts.arrive) => => => =>
EPL_START_PLANNED_TIME arrive_time (from sts.arrive) => => => =>
EPL_END_PLANNED_DATE depart_date (from sts_depart) => => => =>
EPL_END_PLANNED_TIME depart_time (from sts_depart) => => => =>
EPL_DISTANCE_PLANNED sts.distance_from_prev_stop => => => =>
EPL_CUSTOMER_CODE location_id (from_loc if loading, to_loc if unloading) => => => =>
EPL_CUSTOMER_NAME location_name (from gl, linked by the location ID above) => => => =>
EPL_ADDRESS_1 address_line1 => => => =>
EPL_ADDRESS_2 address_line2 => => => =>
EPL_ADDRESS_3 address_line3 => => => =>
EPL_ADDRESS_4 town => => => =>
EPL_ADDRESS_5 N/A N/A N/A N/A N/A
EPL_POSTCODE postcode => => => =>
EPL_CONTACT from order contacts at that location, or location contacts for that location => => As before, but better coded =>
EPL_TELEPHONE from order contacts at that location, or location contacts for that location => => As before, but better coded =>
EPL_EMAIL from order contacts at that location, or location contacts for that location => => As before, but better coded =>
EPL_SO_NUMBER N/A N/A N/A booking_ref =>
EPL_EXT_REF N/A N/A N/A del_point_ref =>
EPL_SEQUENCE N/A N/A N/A stop_no =>
EPL_LINKED_ID N/A N/A N/A t_link_id (based on whether locations are linked in CTMS) EPOD_CONSOLIDATION_LEVEL =>
EPL_UDF_JOBSDETS N/A N/A N/A Summary of packaging on the job - Only if at FROM_LOC of order.

Summary of equipment on the job In UDF format.

Summary of packaging on the job - Only if at FROM_LOC of order.

Summary of equipment on the job In UDF format. Slightly different format to MODE1

EPL_OWNER_ID N/A N/A N/A N/A lots_installed (if present) else customer (if EPOD_OWNER_CONFIG="C") else N/A
EPL_OWNER_NAME oc.lots_installed => N/A oc.lots_installed oc.lots_installed ((if EPOD_OWNER_CONFIG<>"C") else customer_name
EPL_TRAILER_ID sts.trailer_id => => N/A trailer_id of swap van record if present, else N/A
EPL_TIMEZONE N/A N/A N/A t_job_tz_name =>
EPL_LOADING_TYPE N/A N/A N/A N/A v_loading_type (based off stop_type and location_id of stop is from_loc/to_loc of order)
EPL_SWAP_VEHICLE N/A N/A N/A N/A "Y" if swap van else ""
EPOD_JOB_ADDRESS N/A N/A N/A "D" address sent if at FROM_LOC of order.

"C" address sent if at TO_LOC of order.

=>
EPL_NAME N/A N/A N/A address_name =>
EPL_ADDRESS_1 N/A N/A N/A address_line_1 =>
EPL_ADDRESS_2 N/A N/A N/A address_line_2 =>
EPL_ADDRESS_3 N/A N/A N/A address_line_3 =>
EPL_ADDRESS_4 N/A N/A N/A town =>
EPL_ADDRESS_5 N/A N/A N/A county =>
EPL_POSTCODE N/A N/A N/A postcode =>
EPL_CONTACT N/A N/A N/A from order contacts at that location, or location contacts for that location =>
EPL_TELEPHONE N/A N/A N/A from order contacts at that location, or location contacts for that location =>
EPL_EMAIL N/A N/A N/A from order contacts at that location, or location contacts for that location =>
EPOD_CONTAINER Only sent if configured (epod_send_details_load/unload of stop location/location type

Configured by EPOD_ITEM_LEVEL - if IC, sending items as containers else, sending items as products - only site/job/container populated, container with value "000000000000000"

Only sent if configured (epod_send_details_load/unload of stop location/location type

Configured by EPOD_ITEM_LEVEL - if IC, sending items as containers else, sending items as products - only site/job/container populated, container with value ""000000000000000" Container not sent if not properly T2A scanned or no pallet ID

EPL_SITE_ID t_site_id (configurable through EPOD_SITE_ID_FORMAT) => => => =>
EPL_JOB_ID NULL epod_oms_code (oms_ref + C or D) sts.stop_id NULL =>
EPL_CONTAINER_ID soi.item_identifier container_id (sol.oms_ref * 1000+sol.line_no) container_id (sol.oms_ref * 1000+sol.line_no) item_identifier (with suffix removed if reusable asset) pallet_id
EPL_SEQUENCE I (a count) N/A N/A I (count) I (count)
EPL_CONTAINER_PACKAGE_CODE soi.prod_type_id package_code (sol.product_type) N/A du_type =>
EPL_CONTAINER_PACKAGE_DESC soi.item_description description (sol.quantity +sol.product_type + sol.du_type) N/A du_desc =>
EPL_GROSS_WEIGHT soi.gross_weight gross_weight (sol.weight) gross_weight (sol.weight) r_items.gross_weight v_gross_weight
EPL_CODE_1 dimension from soi.item_aka_code dimension (sol.dimension if present, otherwise max value from eoi.item_aka_code N/A Based on EPOD_CONTAINER_CODE1

DIMS - r_items.dims PART 0 v_part_no

=>
EPL_CODE_2 N/A N/A N/A Based on EPOD_CONTAINER_CODE2

DIMS - r_items.dims PART 0 v_part_no

=>
EPL_CODE_3 N/A N/A N/A Based on EPOD_CONTAINER_CODE3

DIMS - r_items.dims PART 0 v_part_no

=>
EPL_DESCRIPTION_LONG N/A N/A N/A Based on EPOD_CONTAINER_DESCRIPTION

COMMODITY - commodity DESCRIPTION - item_description PROD_DESC - dimension-item_description

=>
EPL_FLAGS Fields, including HAZARDOUS, GEL, DRY and RADIO. Note that all of this information is blanked in PARCEL mode) => N/A Fields, including HAZARDOUS, GEL, DRY and RADIO. =>
EPL_VALID_DATE N/A N/A N/A N/A v_validate_date
EPL_VALID_TIME N/A N/A N/A N/A v_validate_date
EPOD_PRODUCT N/A Per container Per container Configured by EPOD_ITEM_LEVEL -

if IC, sending items as containers else, sending items as products - only site/job/container populated, container with value "000000000000000"

=>
EPL_SITE_ID N/A t_site_id (configurable through EPOD_SITE_ID_FORMAT) => => =>
EPL_JOB_ID N/A epod_oms_code (oms_ref + C or D) stop_id oms_ref =>
EPL_CONTAINER_ID N/A container_id (sol.oms_ref * 1000+sol.line_no) container_id N/A =>
EPL_PRODUCT_CODE N/A soi.item_identifier soi.item_identifier du_type =>
EPL_SEQUENCE N/A 0001 => line_no =>
EPL_CUST_REF N/A cust_ref (item_aka_code) N/A N/A =>
EPL_DESCRIPTION N/A soi.item_description soi.item_description v_du_desc =>
EPL_PRODUCT_QTY_PLANNED N/A soi.qty_ordered soi.qty_ordered quantity =>
EPL_ITEM_TYPE N/A item_type (soi.du_type) N/A product_type =>
EPL_UNIT_TYPE N/A soi.prod_type_id soi.prod_type_id N/A =>
EPL_PRODUCT_WEIGHT N/A soi.weight soi.weight gross_weight =>