Cybertrax 2.1 Client (data dictionary)

From UG

(Difference between revisions)
Jump to: navigation, search
(Created page with 'Category:ClientEtc')
Line 1: Line 1:
[[Category:ClientEtc]]
[[Category:ClientEtc]]
 +
 +
== Appendix. Shipment fields  ==
 +
 +
For each CT field we define the following information:
 +
 +
* ''Meaning:'' - description of this field
 +
* ''Default value:'' - value assigned by system to this field for new record
 +
* ''Required field?'' - system will check if this field has a value. If no value set it will produce error.
 +
* ''Format/Datatype:'' - describes constraints on data entered. For example "SKU is 6 characters long alphanumeric field"
 +
 +
=== Fields related to Shipper role ===
 +
 +
'''Pick up Location:'''
 +
* ''Description:'' This is the location of where the goods are actually shipping from.
 +
** This is an existing CT2 field, see [[CT#Export_Pick_Up]]
 +
* ''Default value:'' Shippers Address 
 +
* ''Required field?'' Y
 +
* ''Format/Datatype:'' see [[CT#Export_Pick_Up]]
 +
 +
 +
'''Ship to Location:'''
 +
* ''Description:'' This is where the goods are shipping to.
 +
** This is an existing CT2 field, see [[CT#Delivery To]]
 +
* ''Default value:''  Blank
 +
* ''Required field?'' Y
 +
* ''Format/Datatype:'' see [[CT#Delivery To]]
 +
 +
 +
'''PO Issued by:'''
 +
 +
{{#lst:CT_bo|POIssuedby}}
 +
 +
 +
 +
'''Pick up Instructions:'''
 +
* ''Meaning:'' This field is for the user to list any specific pick up instructions for the trucking company. This is an existing CT2 field, see [[CT#Pick Up Comments]]
 +
* ''Default:'' Blank
 +
* ''Required?'' N
 +
* ''Format/Datatype:'' see [[CT#Pick Up Comments]]
 +
 +
 +
'''Commodity Description:'''
 +
 +
* ''Meaning:'' This field is for the user to list a general description of the contents being shipped. This is an existing CT2 field, see [[CT#Commodity Description]] 
 +
* ''Default value:'' Blank 
 +
* ''Required field?'' Y
 +
* ''Format/Datatype:'' see [[CT#Commodity Description]]
 +
 +
 +
'''Cargo Available:'''
 +
 +
* ''Meaning:'' This is the date that the goods are available for pick up.  This is an existing CT2 field, see [[CT#Cargo Available]]
 +
* ''Default value:'' The date that the record is created
 +
* ''Required field?'' Y
 +
* ''Format/Datatype:'' see [[CT#Cargo Available]]
 +
 +
==== Commodity table ====
 +
 +
'''P.O.:'''
 +
 +
* ''Meaning:'' This is the purchase order number for the product shipping.  This is an existing CT2 field, see [[Commodity#PO]]
 +
* ''Default value:'' Blank 
 +
* ''Required field?'' Y
 +
* ''Format/Datatype:''Alphanumeric, see [[Commodity#PO]]
 +
 +
 +
'''SKU:'''
 +
 +
* ''Meaning:'' This is the sku number of the product shipping.  This is an existing CT2 field, see [[Commodity#SKU]]
 +
* ''Default value:''  Blank
 +
* ''Required field?'' Y
 +
* ''Format/Datatype:'' Alphanumeric, see [[Commodity#SKU]]
 +
 +
 +
'''Quantity:'''
 +
 +
* ''Meaning:'' These are the actual number of pieces for the product shipping.  This is an existing CT2 field, see [[Commodity#Qty]]
 +
* ''Default value:'' Blank
 +
* ''Required field?'' Y
 +
* ''Format/Datatype:'' Numeric, see [[Commodity#Qty]]
 +
 +
 +
'''Item Description:'''
 +
 +
* ''Meaning:'' This is the description of the PO and SKU that is shipping. This is an existing CT2 field, see [[Commodity#Description]]
 +
* ''Default value:'' Blank 
 +
* ''Required field?'' Y
 +
* ''Format/Datatype:'' Alpha, see [[Commodity#Description]]
 +
 +
 +
'''Number of Plts:'''
 +
 +
* ''Meaning:'' This is the number of pallets that are shipping.  This is an existing CT2 field, see [[Commodity#Plts]]
 +
* ''Default value:'' Blank 
 +
* ''Required field?'' Y
 +
* ''Format/Datatype:'' Numeric, see [[Commodity#Plts]]
 +
 +
 +
'''Pks on Plts:'''
 +
 +
* ''Meaning:'' This is the number of packages that are packed on the pallets shipping.  This is an existing CT2 field, see [[Commodity#Pkgs On Plts]] 
 +
* ''Default value:'' Blank 
 +
* ''Required field?'' Y
 +
* ''Format/Datatype:'' Numeric, see [[Commodity#Pkgs On Plts]]
 +
 +
 +
'''Loose Pkgs:'''
 +
 +
* ''Meaning:'' This is the number of loose packages that are shipping.  This is an existing CT2 field, see [[Commodity#Loose Pkgs]]
 +
* ''Default value:'' Blank 
 +
* ''Required field?'' Y
 +
* ''Format/Datatype:'' Numeric, see [[Commodity#Loose Pkgs]]
 +
 +
 +
'''GW:'''
 +
 +
* ''Meaning:''  This is the gross weight of the product that is shipping.  This is an existing CT2 field, see [[Commodity#Gross Lb]]
 +
* ''Default value:'' Blank
 +
* ''Required field?'' Y
 +
* ''Format/Datatype:'' Numeric, see [[Commodity#Gross Lb]]
 +
 +
 +
'''Piece price:'''
 +
 +
* ''Meaning:'' This is the unit price of each piece piece shipping for a PO/SKU.  This is a new CT2 field.
 +
* ''Default value:'' Blank 
 +
* ''Required field?'' Y
 +
* ''Format/Datatype:'' Currency - USD
 +
 +
 +
'''Total Value:'''
 +
 +
* ''Meaning:'' This is the total value of the unit piece price multiplied by the quantity of each PO/SKU that is shipping.
 +
* ''Default value:'' Blank
 +
* ''Required field?'' Y
 +
* ''Format/Datatype:'' [[Datatypes#ascii]]
 +
 +
 +
'''Haz/Non-Haz:'''
 +
 +
* ''Meaning:'' This is to advise if the product shipping is hazardous or not.  This is an existing CT2 field, see [[CT#Hazardous Yes No]]
 +
* ''Default value:''  No
 +
* ''Required field?'' Y
 +
* ''Format/Datatype:'' [[Listbox]] option [Yes][No]
 +
 +
 +
'''Stackable:'''
 +
 +
* ''Meaning:''  This is to advise if the pallets for the product shipping are stackable or not.  This is a new CT2 field.
 +
* ''Default value:'' Yes 
 +
* ''Required field?'' Y
 +
* ''Format/Datatype:'' [[Listbox]] option [Yes][No]
 +
 +
=== Jaguar role fields ===
 +
 +
'''Shipper:'''
 +
* ''Meaning:'' This is the company's name & address of who is placing the shipping request.  This company name and address can also be the pick up location.
 +
* ''Default value:''  The operator’s company name & address as this based upon the users login name.  Pre-filled.  This is an existing CT2 field, see [[CT#Shipper]]
 +
* ''Required field?'' Y
 +
* ''Format/Datatype:'' [[CT_profile#ComboBox]], see [[CT#Shipper]]
 +
 +
'''Pick Up Trucker'''
 +
* ''Meaning:'' This is the name of the trucker who will pick up the product once it is approved to ship.  This is an existing CT2 field, see [[CT#Pick Up Trucker]]
 +
* ''Default value:'' Blank 
 +
* ''Required field?'' N
 +
* ''Format/Datatype:'' [[CT_profile#ComboBox]], see [[CT#Pick Up Trucker]]
 +
 +
'''Delivery Trucker'''
 +
* ''Meaning:'' This is the trucker who will deliver the product to the [[CT#Delivery To]] party.
 +
* ''Default value:'' Blank 
 +
* ''Required field?'' N
 +
* ''Format/Datatype:'' [[CT_profile#ComboBox]], see [[CT#Delivery Trucker]]
 +
 +
'''Estimated Pick up date'''
 +
* ''Meaning:''  This is an estimated date of when the pick up trucker is going to pick up the product from the shipper or pick up location.  This is an existing CT2 field, see [[CT#Estimated Pick Up]]
 +
* ''Default value:'' Blank 
 +
* ''Required field?'' N
 +
* ''Format/Datatype:'' [[Datebox]], see [[CT#Estimated Pick Up]]
 +
 +
'''Actual Pick up date'''
 +
* ''Meaning:'' This is actual date of when the pick up trucker picked up the product from the [[CT#Shipper]] or [[CT#Pick Up]] location.  This is an existing CT2 field, see [[CT#Actual Pick Up]]
 +
* ''Default value:'' Blank 
 +
* ''Required field?'' N
 +
* ''Format/Datatype:'' [[Datebox]], see [[CT#Actual Pick Up]]
 +
 +
'''Estimated Delivery date'''.
 +
* ''Meaning:''  This is an estimated date of when the delivery trucker is going to deliver the product to the [[CT#Delivery To]] location.  This is an existing CT2 field, see [[#Estimated_Delivery_Date]]
 +
* ''Default value:'' Blank 
 +
* ''Required field?'' N
 +
* ''Format/Datatype:'' [[Datebox]], see [[#Estimated_Delivery_Date]]
 +
 +
'''Actual Delivery date'''
 +
* ''Meaning:'' This is actual date of when the delivery trucker delivered the product to the  location.  This is an existing CT2 field, see [[#Actual_Delivery_Date]]
 +
* ''Default value:'' Blank 
 +
* ''Required field?'' N
 +
* ''Format/Datatype:'' [[Datebox]], see [[#Actual_Delivery_Date]]
 +
 +
==== Read only properties ====
 +
 +
* [a] Fields above are editable only by ''jaguar operator''s.
 +
** [a1] They are editable any time.
 +
 +
=== Planner role fields ===
 +
 +
'''CT Authorization status'''
 +
 +
* ''Meaning:''  It allows a planner to set a status (approve, reject, or hold) to any shipments created by a supplier. 
 +
* ''Default value:'' Blank 
 +
* ''Required field?''  Y
 +
* ''Format/Datatype:'' [[Listbox]] with option to choose one of three choices
 +
 +
'''Approved For Date'''
 +
* "Approved for" date feature acts as a ‘hold to ship date’ – meaning hold until (IE 05/24/10) before scheduling the pick up. 
 +
 +
* ''Meaning:''  It allows a planner to place a shipment on hold until a particular date. System will automatically approve on the date selected at 12:01 AM. This field can be updated anytime until 3 days before the date selected
 +
* ''Default value:'' Blank 
 +
* ''Required field?'' N
 +
* ''Format/Datatype:'' [[Datebox]] with a clear button
 +
 +
'''Approval Info'''
 +
* (with name of person who approved, including the date & time)
 +
 +
* ''Meaning:'' Shipment was approved for transportation by whom and when
 +
* ''Default value:'' Read only - First and last name of the approval user(planner) and date timestamps with (EST) calculated time zone
 +
* ''Required field?'' Y - when status is approved 
 +
* ''Format/Datatype:''Read only [[Textarea]]
 +
 +
'''Hold Info'''
 +
* Name of person who placed on hold, including the date & time)
 +
 +
* ''Meaning:'' Shipment was placed on hold for transportation by whom and when. It also allows a planner to come back to update the status to approve, reject, or hold with a date. This field will record any updates made by a planner in the history log and will display the last update recorded on the shipment record.
 +
* ''Default value:'' Read only - First and last name of the approval user(planner) and date timestamps with (EST) calculated time zone 
 +
* ''Required field?'' Y - when status is placed on hold
 +
* ''Format/Datatype:'' Read only [[Textarea]] with history log button
 +
* ''Additional Info:'' Comment pop-up window will appear once a planner clicks ''Apply''
 +
 +
'''Rejected Info'''
 +
* Name of person who rejected it, including the date & time)
 +
 +
* ''Meaning:'' Shipment was rejected for transportation by whom and when 
 +
* ''Default value:'' Read only - First and last name of the approval user(planner) and date timestamps with (EST) calculated time zone   
 +
* ''Required field?'' Y - when status is rejected
 +
* ''Format/Datatype:'' Read only [[Textarea]]
 +
* ''Additional Info:'' Comment pop-up window will appear once a planner clicks ''Apply''
 +
 +
'''Comment Info'''
 +
* Reason for placing a shipment on hold or rejecting a shipment
 +
 +
* ''Meaning:'' It allows a planner to note to the supplier why they are holding or rejecting a shipment.
 +
* ''Default value:'' Blank
 +
* ''Required field?'' N
 +
* ''Format/Datatape:'' [[textarea]]
 +
* ''Addition Info:'' It is a field on a shipment record that records status, reason, by whom and when. Last updated info will be on the top.
 +
 +
'''History Log Info'''
 +
* Keeps a record of all status events
 +
 +
* ''Meaning:'' It is a field of recorded status events shown on a shipment record. 
 +
* ''Default value:'' blank
 +
* ''Required field?'' Y - when there is an updated info
 +
* ''Format/Datatype: a button to a history log screen
 +
* ''Additional Info:'' Event status, name of the planner, and date and timestamps.
 +
:* Example: 9-Jun-2010  Put on hold  Alex Doe
 +
 +
 +
 +
==== Read only properties of Planner role fields ====
 +
 +
* [a] ...

Revision as of 18:29, 18 June 2010


Contents

Appendix. Shipment fields

For each CT field we define the following information:

  • Meaning: - description of this field
  • Default value: - value assigned by system to this field for new record
  • Required field? - system will check if this field has a value. If no value set it will produce error.
  • Format/Datatype: - describes constraints on data entered. For example "SKU is 6 characters long alphanumeric field"

Fields related to Shipper role

Pick up Location:

  • Description: This is the location of where the goods are actually shipping from.
  • Default value: Shippers Address
  • Required field? Y
  • Format/Datatype: see CT#Export_Pick_Up


Ship to Location:

  • Description: This is where the goods are shipping to.
  • Default value: Blank
  • Required field? Y
  • Format/Datatype: see CT#Delivery To


PO Issued by:




Pick up Instructions:

  • Meaning: This field is for the user to list any specific pick up instructions for the trucking company. This is an existing CT2 field, see CT#Pick Up Comments
  • Default: Blank
  • Required? N
  • Format/Datatype: see CT#Pick Up Comments


Commodity Description:

  • Meaning: This field is for the user to list a general description of the contents being shipped. This is an existing CT2 field, see CT#Commodity Description
  • Default value: Blank
  • Required field? Y
  • Format/Datatype: see CT#Commodity Description


Cargo Available:

  • Meaning: This is the date that the goods are available for pick up. This is an existing CT2 field, see CT#Cargo Available
  • Default value: The date that the record is created
  • Required field? Y
  • Format/Datatype: see CT#Cargo Available

Commodity table

P.O.:

  • Meaning: This is the purchase order number for the product shipping. This is an existing CT2 field, see Commodity#PO
  • Default value: Blank
  • Required field? Y
  • Format/Datatype:Alphanumeric, see Commodity#PO


SKU:

  • Meaning: This is the sku number of the product shipping. This is an existing CT2 field, see Commodity#SKU
  • Default value: Blank
  • Required field? Y
  • Format/Datatype: Alphanumeric, see Commodity#SKU


Quantity:

  • Meaning: These are the actual number of pieces for the product shipping. This is an existing CT2 field, see Commodity#Qty
  • Default value: Blank
  • Required field? Y
  • Format/Datatype: Numeric, see Commodity#Qty


Item Description:

  • Meaning: This is the description of the PO and SKU that is shipping. This is an existing CT2 field, see Commodity#Description
  • Default value: Blank
  • Required field? Y
  • Format/Datatype: Alpha, see Commodity#Description


Number of Plts:

  • Meaning: This is the number of pallets that are shipping. This is an existing CT2 field, see Commodity#Plts
  • Default value: Blank
  • Required field? Y
  • Format/Datatype: Numeric, see Commodity#Plts


Pks on Plts:

  • Meaning: This is the number of packages that are packed on the pallets shipping. This is an existing CT2 field, see Commodity#Pkgs On Plts
  • Default value: Blank
  • Required field? Y
  • Format/Datatype: Numeric, see Commodity#Pkgs On Plts


Loose Pkgs:

  • Meaning: This is the number of loose packages that are shipping. This is an existing CT2 field, see Commodity#Loose Pkgs
  • Default value: Blank
  • Required field? Y
  • Format/Datatype: Numeric, see Commodity#Loose Pkgs


GW:

  • Meaning: This is the gross weight of the product that is shipping. This is an existing CT2 field, see Commodity#Gross Lb
  • Default value: Blank
  • Required field? Y
  • Format/Datatype: Numeric, see Commodity#Gross Lb


Piece price:

  • Meaning: This is the unit price of each piece piece shipping for a PO/SKU. This is a new CT2 field.
  • Default value: Blank
  • Required field? Y
  • Format/Datatype: Currency - USD


Total Value:

  • Meaning: This is the total value of the unit piece price multiplied by the quantity of each PO/SKU that is shipping.
  • Default value: Blank
  • Required field? Y
  • Format/Datatype: Datatypes#ascii


Haz/Non-Haz:

  • Meaning: This is to advise if the product shipping is hazardous or not. This is an existing CT2 field, see CT#Hazardous Yes No
  • Default value: No
  • Required field? Y
  • Format/Datatype: Listbox option [Yes][No]


Stackable:

  • Meaning: This is to advise if the pallets for the product shipping are stackable or not. This is a new CT2 field.
  • Default value: Yes
  • Required field? Y
  • Format/Datatype: Listbox option [Yes][No]

Jaguar role fields

Shipper:

  • Meaning: This is the company's name & address of who is placing the shipping request. This company name and address can also be the pick up location.
  • Default value: The operator’s company name & address as this based upon the users login name. Pre-filled. This is an existing CT2 field, see CT#Shipper
  • Required field? Y
  • Format/Datatype: CT_profile#ComboBox, see CT#Shipper

Pick Up Trucker

Delivery Trucker

Estimated Pick up date

  • Meaning: This is an estimated date of when the pick up trucker is going to pick up the product from the shipper or pick up location. This is an existing CT2 field, see CT#Estimated Pick Up
  • Default value: Blank
  • Required field? N
  • Format/Datatype: Datebox, see CT#Estimated Pick Up

Actual Pick up date

Estimated Delivery date.

Actual Delivery date

  • Meaning: This is actual date of when the delivery trucker delivered the product to the location. This is an existing CT2 field, see #Actual_Delivery_Date
  • Default value: Blank
  • Required field? N
  • Format/Datatype: Datebox, see #Actual_Delivery_Date

Read only properties

  • [a] Fields above are editable only by jaguar operators.
    • [a1] They are editable any time.

Planner role fields

CT Authorization status

  • Meaning: It allows a planner to set a status (approve, reject, or hold) to any shipments created by a supplier.
  • Default value: Blank
  • Required field? Y
  • Format/Datatype: Listbox with option to choose one of three choices

Approved For Date

  • "Approved for" date feature acts as a ‘hold to ship date’ – meaning hold until (IE 05/24/10) before scheduling the pick up.
  • Meaning: It allows a planner to place a shipment on hold until a particular date. System will automatically approve on the date selected at 12:01 AM. This field can be updated anytime until 3 days before the date selected
  • Default value: Blank
  • Required field? N
  • Format/Datatype: Datebox with a clear button

Approval Info

  • (with name of person who approved, including the date & time)
  • Meaning: Shipment was approved for transportation by whom and when
  • Default value: Read only - First and last name of the approval user(planner) and date timestamps with (EST) calculated time zone
  • Required field? Y - when status is approved
  • Format/Datatype:Read only Textarea

Hold Info

  • Name of person who placed on hold, including the date & time)
  • Meaning: Shipment was placed on hold for transportation by whom and when. It also allows a planner to come back to update the status to approve, reject, or hold with a date. This field will record any updates made by a planner in the history log and will display the last update recorded on the shipment record.
  • Default value: Read only - First and last name of the approval user(planner) and date timestamps with (EST) calculated time zone
  • Required field? Y - when status is placed on hold
  • Format/Datatype: Read only Textarea with history log button
  • Additional Info: Comment pop-up window will appear once a planner clicks Apply

Rejected Info

  • Name of person who rejected it, including the date & time)
  • Meaning: Shipment was rejected for transportation by whom and when
  • Default value: Read only - First and last name of the approval user(planner) and date timestamps with (EST) calculated time zone
  • Required field? Y - when status is rejected
  • Format/Datatype: Read only Textarea
  • Additional Info: Comment pop-up window will appear once a planner clicks Apply

Comment Info

  • Reason for placing a shipment on hold or rejecting a shipment
  • Meaning: It allows a planner to note to the supplier why they are holding or rejecting a shipment.
  • Default value: Blank
  • Required field? N
  • Format/Datatape: textarea
  • Addition Info: It is a field on a shipment record that records status, reason, by whom and when. Last updated info will be on the top.

History Log Info

  • Keeps a record of all status events
  • Meaning: It is a field of recorded status events shown on a shipment record.
  • Default value: blank
  • Required field? Y - when there is an updated info
  • Format/Datatype: a button to a history log screen
  • Additional Info: Event status, name of the planner, and date and timestamps.
  • Example: 9-Jun-2010 Put on hold Alex Doe


Read only properties of Planner role fields

  • [a] ...
Retrieved from "https://wiki.jaguarfreight.com/Cybertrax_2.1_Client_(data_dictionary)"
Personal tools