Sort after pick

A store associate should be able to pick products in batches and later sort them into shipments appropriately.

Solution

The following section describes APIs, user exits, services, and other components.

When the Batches screen loads, the new and in-progress batches are displayed. Only the in-progress batches are retrieved from the database. However, the newly formed batches are only displayed, but batch records are not created in the database. The status of these batches is 1000, which indicates a draft batch.

From the Batches screen, a store associate can choose to Pick a new batch or Continue to pick an in-progress batch.

Pick new batch

On the Batches screen, when the store associate clicks Pick to pick products in a new batch, the createStoreBatch API is called to create a batch record, the batch status changes to 1100, which indicates open batch and the batch is assigned to the current store associate. All the shipment lines that were returned by the getStoreBatchList API for that batch are passed to the createStoreBatch API, which returns the BatchNo and StoreBatchKey attributes. If a shipment line is already being picked as part of another batch or being picked via single order picking, an appropriate error message is displayed.

Pick in-progress batch

On the Batches screen, a store associate can click Continue to pick products for an in-progress batch. If the store associate is not the person who began picking the batch, the application prompts the store associate to confirm whether to continue picking or not. If the store associate chooses to continue, then the manageStoreBatch API is called, which updates the AssignedToUserID of the batch to the current store associate.

For more information about the APIs and validations, see the Javadoc.

Products in the batch

The getStoreBatchDetails API is called to fetch the batch and products in the batch. The batch is fetched by using either the mandatory StoreBatchKey or BatchNo and OrganizationCode attributes. If these attributes are not passed, the API throws an error. If there is no record corresponding to the StoreBatchKey, the API throws an error.
  • The getStoreBatchDetails API internally calls the getShipmentLineList API to retrieve the shipment lines for StoreBatchKey attribute that is passed in the input. Therefore, the bundle parents are not fetched to form the batch line.
  • Once the shipment lines are fetched, the batch lines are formed for every unique product. If the ItemID and UnitOfMeasure are common for two shipment lines, then a single batch line is formed for the product.
  • If the PickLocationSeq attribute is set at the ShipmentLine level, then the getShipmentLineList API displays the products in the order in which they must be picked up. The sequence in which the products are displayed can be customized by implementing the YCDGetBatchPickPriorityUE user exit.
  • The store associate can refine the batch lines to display all the products in the batch or only the products to be picked. The BackroomPickComplete=N attribute is used to filter and display only the unpicked batch lines.
  • The product details, such as product image, product ID, pick location, department, and the quantity to be picked are returned by the API in the output. The - and + buttons along with the Record Shortage link are displayed for each product.
The store associate can either scan a product bar code to pick a product or manually pick the product.
Pick products in the SCAN mode: When the store associate scans a product, the picked quantity is incremented by the scanned quantity. The registerBatchPick API is called with the Mode attribute set to SCAN and the API uses the StoreBatchKey attribute to determine the BatchType attribute, which is SORT_AFTER_PICK. The following logic is executed internally:
  • The translateBarCode API is called with the BarCodeData and BarCodeType attribute set to "Item" to fetch the product information.
  • Shipment lines with the same ItemID and UnitOfMeasure and having the same BatchKey as that passed in the input are retrieved.
  • Only those shipment lines with the attributes BackroomPickComplete="N" and IsPickable="Y" are considered and the shipment line with the least BatchPickPriority is updated with the picked quantity.
Pick products in the MANUAL mode: If a scanner is not integrated with the system, the store associate can use the manual pick options to pick products. When the store associate clicks either the + or - button to increment or decrement the picked quantity, the registerBatchPick API is called with the Mode attribute set to MANUALPICK and the API uses the StoreBatchKey attribute to determine the BatchType attribute, which is SORT_AFTER_PICK. The following logic is executed internally:
  • The registerBatchPick API reads the Action attribute in the mandatory Item element from the input. If the store associate clicks the + button, the Action attribute is PICK and if the store associate clicks the - button, the Action attribute is UNDOPICK. If the Action attribute is not sent from the UI, then the value is defaulted to PICK
    • If the Action attribute is PICK in the input to the API, the following logic is executed:
      • Shipment lines with the same ItemID and UnitOfMeasure and having the same BatchKey as that passed in the input are retrieved.
      • Only those shipment lines with the attributes BackroomPickComplete="N" and IsPickable="Y" are considered and the shipment line with the lowest value for BatchPickPriority is updated with the pick quantity.
      • The changeShipment API is called to update the AssignedToUserId attribute and the BackroomPickedQuantity attribute for the shipment line.
    • If the Action attribute is UNDOPICK in the input to the API, the following logic is executed:
      • The getShipmentLineList API is called to retrieve the shipment lines that have the same ItemID and UnitOfMeasure in the batch, by using the StoreBatchKey attribute.
      • The picked quantity is first reduced for a shipment line with the highest BatchPickPriority and BackroomPickedQty greater than 0. Once the quantity of the shipment line with the least SLA becomes 0, then the quantity is reduced from the shipment line of the next lowest SLA .
      • The changeShipment API is called to reduce the BackroomPickedQty attribute for the shipment line.

Record Shortage

During the picking process, the store associate can select a product and click Record Shortage if there are insufficient quantities to fulfill the batch. The quantity of the product that the store associate marks short is displayed.

When a store associate clicks Record Shortage, the getCommonCodeList API is called with the CodeType as YCD_PICK_SHORT_RESOL to fetch shortage reasons. By default, the only shortage reason is Inventory Shortage. When a store associate applies Inventory Shortage as the shortage reason, products are back ordered based on default implementation. However, if you want to implement a custom logic and handle custom shortage reasons, you can use the handleShortageForBatchLineUE user exit.

The recordShortageForBatchPick API is called to determine the shipment and shipment line that need to be marked as short. The store associate picks the available products, and the remaining value is marked as short. The default shortage reason, Inventory Shortage, is marked.
  • When the store associate chooses to save the shortage, the shorted quantity is updated on the shipment line.
  • The API cancels the batch if all of the products in a batch are marked as short. In addition to canceling the batch, the shipment is also canceled if all of the products in the shipment are marked short.
The following validations are performed by the recordShortageForBatchPick API:
  • The StoreBatchKey and ShortageReason attributes, along with the Item element are mandatory inputs to the API. If the mandatory inputs are not passed, then the appropriate error messages are displayed.
  • If the shortage reason is not valid, the appropriate error message is displayed. Once the store associate clicks OK, the shortage is applied and the user is taken to the original screen.
  • The getStoreBatchDetails API is called to refresh the products. The Product Scan screen displays the shorted quantity.

The getStoreBatchDetails API is called to refresh the screen and display all the products or only the products to be picked based on the filter selected.

After a shipment is updated, the registerBatchPick API determines whether the picking process is complete and updates the status of the batch to either 2000 or 3000 where 2000 indicates 'picking is complete and not staged' whereas 3000 indicates 'batch picking is complete'.

Note: Products that have preferred substitutes cannot be fulfilled by using the Sterling Store Engagement (Legacy) application.
Once a batch is completely picked, then the changeShipmentStatus API is called. Multiple validations are performed to change the status of shipments, some of them are as follows:
  • If the shipment corresponding to a given shipment line is not already in Backroom Pick in Progress status, the changeShipmentStatus API is called to change the shipment status from Ready for Backroom Pick to Backroom Pick in Progress.
  • If the shipment in completely picked, then the changeShipmentStatus API is additionally called to update the status to Ready for Customer Pickup in case of Pickup in Store orders and Ready for Packing in case of Ship from Store orders.

Assigning a staging location

Once all the products are completely picked, an appropriate confirmation message is displayed and the store associate can choose to either assign a staging location or finish the batch pick process.
If the store associate clicks Assign Staging Location, the products are displayed with the Assign option for each product. Depending upon the option chosen in the Refine menu, either all the products or only the products that are yet to be staged are displayed.
Note: Assigning a staging location to the products in a batch is driven by the "Staging location required" rule. If the rule is enabled, only then the store associate can perform this task.
The store associate can either scan the product to assign a staging location or click Assign against the product. The Selected Item screen is displayed along with an the Existing Staging Location, if any. On the Selected Item screen, the store associate can either scan the staging location bar code or manually enter the staging location ID and click Save to assign the staging location and return to the earlier screen.
  • When the store associate scans the product, the translateBarCode API is called to translate the barcode to product information. If the store associate clicks Assign, the product information is retrieved from the UI. The ItemID and UnitOfMeasure attributes are passed to the getStoreBatchDetails API to retrieve shipment lines corresponding to the batch line.
  • When the store associate either scans or manually enters a staging location, the following logic is executed:
    • If the staging location is scanned, the translateBarCode API is called with the BarCodeType attribute set to "HoldLocation" to fetch the staging location ID. However, if the Staging location translation required rule is disabled, the translateBarCode API call is skipped and the value in the Place in Staging Location field is directly updated in the database without any translation. The YCD_Translate_Bar_Code_HoldLocation service is used to implement bar code translations for staging locations and the service can be overridden.
    • When a staging location is manually entered and the store associate clicks Save, the changeShipment API is called to update the HoldLocation and StagedQuantity for the shipment line.
    • After the products are staged, the getStoreBatchDetails API is called to display the updated information.
User exits:
  • Custom logic can be implemented by using the com.yantra.pca.ycd.japi.ue.YCDSortBatchLinesUE user exit for the getStoreBatchDetails API to sort the products with a custom implementation.
  • Custom logic can be implemented by using the yantra.pca.ycd.jap.ue.YCDGetBatchPickPriorityUE user exit for the createStoreBatch API to calculate the batch pick priority.
  • Custom logic can be implemented to update the inventory by using the com.yantra.pca.ycd.japi.ue.YCDInvokeUpdateInventoryUE user exit, which is called by the registerBatchPick API after each update of the BackroomPickedQuantity attribute on the shipment line.
  • The application behavior on selecting a custom shortage reason can be implemented by using the YCDhandleShortageForBatchLineUE user exit, which is invoked by the recordShortageForBatchPick API.

For more information about the APIs, see the JavadocJavadoc.

Device Specific Details

None.

Implementation

The following information describes the rules that must be configured for the feature:

  • A store associate must have the following resource permissions to perform batch picking:
    • Batch Pick Orders
    • Manually update quantity while picking
    For more information about administering user group permissions, see Administering User Group Permissions.
  • Configure the Backroom Pick Shortage Resolutions appropriately. By default, a shortage resolution named All Inventory Shortage is available for the default organization. If you want to use the same shortage resolution for a new enterprise, you must either inherit the default organization's properties or use the following values to create the shortage resolution by using the Sterling Business Center.
    • Shortage Resolution: AllInventoryShortage
    • Shortage Resolution Name: Inventory Shortage

    For more information, see Manage backroom pick shortage resolutions. To inherit default organization's properties, see Defining an enterprise's primary information. If you create custom shortage resolutions, then you must have corresponding implementation as well. For more information, see Implementing custom shortage reasons.

  • The "Assign Staging Location" button is visible only if the "Staging location required" rule is enabled at the store level in the Sterling Business Center.
  • To enable a store associate scan the barcode of a staging location, you must enable the "Staging location translation required" rule at the store level in the Sterling Business Center. If this rule is enabled, the store associate can see the barcode icon on the staging location text field, which indicates the support for barcode translation.

    For more information, see Configuring backroom pick rules.

  • You must configure barcode types for your enterprise and set up the required services. The following barcode types are used in the application:
    • Item for product translations
    • Hold Location for staging location translations
    Barcode types must be defined at the enterprise level in the Applications Manager. By default, barcode types are provided for the default organization. When you on-board a new enterprise, these barcode types must be created again or copied from the Default organization.
  • To enable barcode translations for Staging Locations, you must configure the barcode translation preferences appropriately. For more information, see Setting up barcode translation preferences.