| Info |
|---|
DATASCOPE.SDK.BusinessObjects.Shipping.WaybillDispatch.CreateWaybillShippingMassAndDims() |
Code
SHIP001
Name
CreateWaybill
Module
Waybill
Functional Area
This business object calls the CreateWaybill() method to create a new Waybill/BOL and returns the newly created Waybill Number
Returns:
Response - Success
Response Result set to True
Response Message - "Waybill Successfully Created"
Response Object - Waybill Number Created
Response - Failure
Response Result set to False
Response Message - Error generatedThe DATASCOPE PREMIUM WMS Shipping Dims and Mass module, which forms part of the Shipping module, allows an Operator to assign dimensions and mass values to a particular Shipping TrackID.
This is, typically, done after the stock has been picked and assigned a Waybill, but is not limited to the process and can be used multiple times during the life of the Shipping TrackID.
This Business Object will replicate the functions of the Shipping Dims and Mass screens found on the PC and HTML5.
| Info |
|---|
Note: This is only applicable to Shipping TrackIDs and not other types of TrackIDs. |
For a detailed overview on working with DATASCOPE PREMIUM WMS Business Objects, refer to E.Net Business Objects
| Info |
|---|
If you don’t like reading, you can watch the video. |
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
None No Specification |
Description
Business Object to create a new Waybill/BOL
004_premium_BUSINESS_OBJECTS_DIMS_AND_MASS_product_userguide_UG - v0.1.pdf |
RELEASE NOTES
Release notes 24R2 (Ticket # 8384) - ShippingMassAndDims Business Object development.
Description
The Shipping Dims and Mass business object can be used to replicate the HTML5 Shipping Dims and Massmobile screen and allow 3rd party vendors to automate the existing Waybill process. It can be beneficial if standard sizes are used or where specific logic can be applied to obtain the size. In these cases, the business object can be used to automate the process to allow the Operator to skip the process on the warehouse floor.
Code | SHIP008 |
|---|---|
Name | ShippingMassAndDims |
Module | Shipping |
Functional Area | Dispatch |
Name Space/Class | DATASCOPE.SDK.BusinessObjects.Shipping.Dispatch.WaybillShippingMassAndDims() |
Release Date | 01/04/2021Jul 2024 |
Release Version | v5.0.21.xv24.2 |
Prerequisites | None |
|---|---|
SYSPRO Objects | None |
Parameters
The Business Object properties consist of five properties. The validation of the TrackID field is somewhat complex. For more information, refer to TrackID Validation.
Business Object Post Properties
TrackingId - This field is the Tracking ID to apply the Dims and Mass. This is required to be a Shipping Track ID
Height - This is the Height to be applied to the Track ID.
Width - This is the Width to be applied to the Track ID.
Length - This is the Length to be applied to the Track ID.
Mass - This is the Mass/Weight to be applied to the Track ID.
| Info |
|---|
Note: The dimensions can be supplied in any denomination, e.g., centimeters, meters, feet, etc. |
The following properties are applicable:
Main object definitions
Name | Description | Mandatory field | Data Type | Default Value |
|---|---|---|---|---|
pWaybillType | Waybill Type FIXED or FLEXIBLE | YES | String - Enum.eWaybillType{FIXED,FLEXIBLE} | FIXED |
pShipper | Shipper Name setup in WMS Shipper Details | YES | String |
|
pIsShipperWaybill | Is an additional Shipper Waybill number required | YES | Boolean | FALSE |
pShipperWaybill | Only Mandatory if pIsShipperWaybill is set to True | NO | String |
|
pShipperContactName | Shipper Contact Name | NO | String |
|
pShipperContactEmail | Shipper Contact Email | NO | String |
|
pShipperContactPhone | Shipper Contact Phone Number | NO | String |
|
pShipmentRate | Shipper Rate (Defaults to 0) | NO | Decimal | 0 |
pShipDate | Ship Date yyyy/MM/dd hh:mm:ss (Defaults to Today) | NO | Date/Time | Today's Date |
pCustomerCode | Customer Number/Code from Syspro | NO | String |
|
pDeliveryName | Delivery Name | NO | String |
|
pDeliveryContactName | Delivery Contact Person Name | YES | String |
|
pDeliveryContactNumber | Delivery Contact Phone Number | NO | String |
|
pDeliveryContactEmail | Delivery Contact Email Address | NO | String |
|
pDeliveryAddress1 | Delivery Address Line 1 | NO | String |
|
pDeliveryAddress2 | Delivery Address Line 2 | NO | String |
|
pDeliveryAddress3 | Delivery Address Line 3 | NO | String |
|
pDeliveryAddress4 | Delivery Address Line 4 | NO | String |
|
pDeliveryAddress5 | Delivery Address Line 5 | NO | String |
|
pDeliveryPostalCode | Delivery Postal Code | NO | String |
|
pDeliveryDate | Delivery Date yyyy/MM/dd hh:mm:ss (Defaults to Today) | NO | Date/Time | Today's Date |
pComment | Free Text Comment | NO | String |
|
pRoute | Route Code from Syspro SorRouteMaster | YES | String |
|
pVehicle | Vehicle/Truck setup in WMS | YES | String |
|
Technical Specification
pTrackingID | This is the Shipping TrackID to apply the Dimensions and Mass to. Validation: It must be a Shipping TrackID, this is determined by the prefix S on the TrackID as well as a validation of the PalletTypeID=4 field on tblPallet. | YES | String | <blank> |
pHeight | This is the Height of the TrackID Validation is non-negative and non-Zero. | YES | Decimal | 0 |
pWidth | This is the Width of the TrackID Validation is non-negative and non-Zero. | YES | Decimal | 0 |
pLength | This is the length of the Track ID. Validation is non-negative and non-Zero. | YES | Decimal | 0 |
pMass | This is the Mass/Weight of the TrackID. Validation is non-negative and non-Zero. | YES | Decimal | 0 |
All business objects under the Dispatch.cs class (Functional Area) are in the same class. The above Properties will, therefore, be shared. The following code will indicate which properties apply to the business object being called.
See the example lines added as decoration to the method.
| Code Block |
|---|
/// <summary>
/// <Description1>
/// <para><Paremeter> - <Mandatory/Optional> </para>
/// <param name="p_GUID">WMS GUID, obtained from the Logon Business Object - Mandatory</param>
/// </summary>
[WMSBusinessObject("<Code>", "<Description>")]
[WMSBusinessObjectParameter("<Parameter1>", <Mandatory>, <Default>, "Description2")] |
<Description1> - This is a short description of the Object.
o <Parameter1> - This is the parameter's name, e.g., pTrackingId.
o <Mandatory/Options> - This indicates if the parameter is mandatory or optional.
o <Code> - This is the code of the business object, e.g., SHIP001.
o <Mandatory> - This is a Boolean if the parameter is mandatory (true) or optional (false)
o <Default> - This is the default value of the parameter.
o <Description2> - This is a short description of the parameter.
TrackID Validation
As per the table above, there are a number of validation steps for the TrackID field as follows.
The TrackID must be a Shipping TrackID. This is determined by the prefix S on the TrackID and validation of the PalletTypeID=4 field on tblPalThe “Normal” status that is allowed and typically, when a Shipping TrackID needs to have its Dims & Mass associated, is tblPallet.ShippingStatus = IN-PACKING. This should be allowed with no errors or warnings.
If the tblPallet.ShippingStatus = PACKED or ASSOCIATED and the logged-in user DOES NOT have permission to the Permission: MAY_PALLETIZE_PACKED_SHIPPING_PALLETS, then the Business Object should return an error as follows:
| Code Block |
|---|
This TrackID has already been PACKED or ASSOCIATED and completed, and permission MAY_PALLETIZE_PACKED_SHIPPING_PALLETS is required to override it. |
This TrackID has already been PACKED or ASSOCIATED and completed, and permission MAY_PALLETIZE_PACKED_SHIPPING_PALLETS is required to override it.
| Code Block |
|---|
The Shipping TrackID is in the incorrect status. |
Height is optional. This is the height applied to the TrackID.
Width is optional. This is the width applied to the TrackID.
Length is optional. This is the length applied to the TrackID.
Mass is optional. This is the mass/weight to be applied to the TrackID.
Testing the BO
The Business Object Harness application should be used to assist in troubleshooting and testing any of the DATASCOPE WMS Business Objects.
Ensure you followed the installation process to install and configure the Business Object Harness application.
To test the Business Object
o Open the Business Object Harness
o Enter the Company ID you would like to login to, followed by a valid Operator, along with its password and company password (if any). Clicking the Login button will then attempt to log in to the system using the WebAPI.
o The first step in posting an object is to select and add it to the main content window.
o Now you are ready to start testing the Business Object.