Description

The Shipping Dispatch Putaway Business Object will allow developers to replicate the functions of the mobile application (HTML5 Dispatch Bin Put Away (Ship TrackID)).

Parameters

The Business Object allows the following logic, which matches the existing mobile application (HTML5 Dispatch Bin Put Away (Ship TrackID)).

Business Object Post Properties

This Business Object does not require many properties as the application simply allows the Shipping TrackID to be scanned and moved into a specific bin location.

• ShippingTrackID—This is the Shipping TrackID to be moved when posting the Business Object.

• DispatchBin—This is the destination location the Shipping TrackID is to be moved into.

The following properties are applicable:

Main object definitions

• The Functional Area is defined within the Dispatch.cs class and doesn’t need to be created again. This new Business Object will be added to the existing class file.

• Within the existing Dispatch.cs file, a method was created, ShippingDispatchPutAway. This is the entry point definition for the Business Object.

public Response ShippingDispatchPutAway(string p_GUID)

• The return type will be Response; this is the standard response type for all Business Objects. The third party will use it to determine whether the process was a success or failure and display error messages.

• All Business Objects take a single parameter within the function called p_GUID. The GUID is obtained by calling the standard DATASCOPE WMS Logon Business Object.

• The core code will be encapsulated within a standard Try Catch block. The Catch section should return a Response with the exception passed as the parameter.

try
{
  // Core BO Logic here
}
catch (Exception ex)
{
  return new Response(ex);
}

• There are some Properties required for this Business Object. They are placed at the top of the class in a section called Properties and prefixed with a p. The following code will indicate which properties apply to the business object being called.

See the example lines.

#region Properties
  /// <summary>
  /// SYSPRO Sales Order Number
  /// </summary>
  public string pSalesOrder { get; set; } = ""; 

• As ALL Business Objects under the Dispatch.cs class (Functional Area) are contained within the same class, the above-mentioned properties(s) will 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.

/// <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., SHIP002.

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.

TODO – Validations

The following validations must be done, to move the Shipping TrackID to the destination bin.

• The ShippingTrackID must be a Shipping TrackID type (4), validated by the tblPallet.PalltTypeID field in the database table. If not, a message will return stating Not a Shipping TrackID.

• The ShippingTrackID must have an associated Waybill and/or MSN (Master Shipment Number). This is checked against the tblShippingTrackIDOrder table in the database. If it doesn’t exist, a message will return stating Shipping TrackID does not have an associated Waybill and/or MSN number.

• The DispatchBin must be validated whether it exist in the tblBin table in the database.

Posting

When posting the Business Object, the following updates will process.

• The line to be posted will be fetched, by calling the GetShippingTrackIDDetails() method within the DATASCOPE.SDK.ShippingBO class.

• The ShippingTrackID will be passed as the parameter for the above function.

• A Loop will be performed through each line that is returned from the query, performing the following:

o   Call the method UpdateBin() within the DATASCOPE.SDK.PalletBO class.

o   The tbPallet.Bin table will be updated in the database for the associated TrackIDs returned by the GetShippingTrackIDDetails() method.

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.