Initial data in Stock Allocation Form

[AmitEMV]

Hi,

In Allocate Stock modal today, the default selection of an item doesn't happen unless it's the only element in the dropdown. This specific section of code in SalesOrderForms.tsx currently has -

return useCreateApiFormModal({
    ...
    initialData: {
        items: lineItems.map((item) => {
          return {
            line_item: item.pk,
            quantity:  0,
            stock_item: null
          };
        })
      }
  });

A change here can allow the items to be pre-selected in any specific way we want it. We can pass in the items which are oldest, newest or any other business rules that might make sense. The resulting code would be -

return useCreateApiFormModal({
    ...
    initialData: {
        items: lineItems.map((item) => {
          return {
            line_item: item.pk,
            quantity: item.quantity ?? 0,
            stock_item: item.stock_item ?? null
          };
        })
      }
  });

And we would do this to show this modal -

const allocateStock = useAllocateToSalesOrderForm({
    ...
    lineItems : initData.items,
    onFormSuccess,
  });

where initData has this shape

{
    available_quantity: string;
    // any more fields if needed

   // these 3 are expected/current
    pk: number;
    stock_item: number | null;
    quantity: number;
  }

Would this change be something that can be accepted here or any suggestions if not?

Thanks!

[SchrodingersGat]

@AmitEMV how do you suggest that the actual initial data is determined, via the calling function?

Overall this makes sense, happy for you to submit a working PR and we can discuss further there

[gunstr]

The current implementation has the advantage that the user is forced to do an active selection if there are more than one stockitem. It's not clear how you intend to implement the pre-selection logic but I belevie there are many use cases to handle. If the pre-selection logic is not very flexible and configurable I would appreciate at least a setting to keep the currrent functionality.

[AmitEMV]

@SchrodingersGat Yes, the calling function determines what data has to be sent - the allocation modal just displays the data and auto-selects if there'a any.

@gunstr Yes, there can be a System Setting to enable/disable this behaviour. Also, even if it's enabled, this does not prevent the user from unselecting the set item in the dropdown, and to select any other item.

[gunstr]

Yes, there can be a System Setting to enable/disable this behaviour. Also, even if it's enabled, this does not prevent the user from unselecting the set item in the dropdown, and to select any other item.

Another option would be to add a clear indication in the modal that there are multiple stock items and the system has made a decision.

I do not know what options you have in mind for the pre-selection, but in our case the most common is to pick the stock item with the oldest batch code (we use YYWW, i.e Year/Week). However - we also have cases when a specific batch has to be be used for an assembly.

If most parts have just one single stock item it would be important to highligt for the user that there are options that might require an active decision when that is not the case. I understand that with your suggestion the user can unselect and pick another item, but with the current solution the user is even forced to do that as the drop down is empty if there is more than one stock item.

[AmitEMV]

@gunstr Got it, how do you know what's the oldest batch code today when selecting an item?

[gunstr]

@AmitEMV for each and every stock item we assign a batch code consisting of year (two digits) and week (two digits). The oldest item is simply the batch code with the lowest number - at least until we reach year 2100 :-)

A current deviation from using the oldest item is a connector where we ordered a new brand with a small difference in the dimensions. It was considered acceptable to be used for an existing part/IPN but it turned out that for one specific board it creates problems. So when allocating items for BOs for that board a later batch with a different brand has to be used. Definitely a deviation from our "first in first out" strategy and a temporary issue until that particular batch has been consumed by other boards but still a reality and might happen again...

[andersonvom]

@SchrodingersGat @gunstr what if we split this change in two: (1) make useAllocateToSalesOrderForm() a bit more generic, by accepting an optional function to calculate the initial data, and (2) possibly add a configuration/plugin with different implementations of said function. Something like:

const unselectedItem = (item) => ({line_item: item.pk, quantity: 0, stock_item: null});

export function useAllocateToSalesOrderForm({
  orderId,
  shipmentId,
  lineItems,
  onFormSuccess,
  getInitialData = (items) => items.map(unselectedItem),
}: {
  orderId: number;
  shipmentId?: number;
  lineItems: any[];
  onFormSuccess: (response: any) => void;
  getInitialData?: (lineItems: any[]) => FieldValues[];
}) {
  // ... 
  return useCreateApiFormModal({
    // ...
    initialData: getInitialData(lineItems),
  });}

This way, we can later make it so that a configuration or plugin can change the behavior of getInitialData() and change the way items are pre-selected in any appropriate way.