Search Service Request
**********************

.. versionadded:: 4.0

Introduction
============

This type of service request is auto-generated internally when an item missing
exception is raised during a pick or put service request execution, and if this
feature is enabled.

Once a search service request is created, it can be started from the Butler
Manager Dashboard. Once started, all possible locations where the missing
item(s) might be found are brought to PPS stations in "Search" mode. This
happens until either the item(s) are found, or all potential locations are
exhausted.

Search Service Request Object
=============================


.. gm:data:: searchServiceRequest

   .. gm:data:: type

      The type of a search service request object is ``SEARCH``.

   .. gm:data:: attributes

      This is a dictionary containing key-value pairs having details about the
      service request.

      .. gm:data:: originalServiceRequestId

         This key contains the original service request id against which missing
         item(s) were marked, which resulted in creation of this request.

      .. gm:data:: slot_list

         This is a list of slots where the missing item(s) might potentially be
         found.

   .. gm:data:: state

      This denotes the state of the service request.

   .. gm:data:: actuals

      The actuals object contains the list of each slot actually searched, and
      it's results.

      This object is of the form ``{ "containers": [``
      :gm:data:`searchActualContainer` ``]}``

.. gm:data:: searchActualContainer

   .. gm:data:: state

      This denotes the state of the search. It can either be ``complete``,
      ``excess``, or ``missing``.

   .. gm:data:: products[]

      This is a list with one object containing the product details.

   .. gm:data:: containerAttributes

      This is an object containing details about the search

      .. gm:data:: user_name

         This is the username of the operator who performed the search.

      .. gm:data:: location

         Location id of the search

      .. gm:data:: productQuantity

         This is the quantity of missing item(s) found at this location.

      .. gm:data:: slotAdjustedQuantity

         This is the quantity of missing item(s) found and subsequently allowed
         to be kept back in the location.

      .. gm:data:: irtQuantity

         This is the quantity of missing or extra item(s) which had to be
         removed from the slot and kept in IRT bin.

         The system may not allow to keep the inventory back into the slot due
         to space constraints or COG restrictions.

      .. gm:data:: irt_serial

         This is an optional field which contains the serial / barcode of the
         IRT bin, if recorded in the process flow.


Search Service Request Complete Notification
============================================

A notification is generated when the search service request is complete.

.. sourcecode:: json

   {
       "notification_type": "search_information",
       "version_number": "1.5.0",
       "notification_id": "butler_core:fa2aec6d-2b91-4e0c-8f82-80f13c117ca8",
       "notification_data": {
           "id": 9,
           "externalServiceRequestId": "search1",
           "type": "SEARCH",
           "attributes": {
               "originalServiceRequestId": "Ord1",
               "slot_list": [
                   "014.1.E.01-02",
                   "014.1.E.03-04"
               ]
           },
           "expectations": {
               "containers": []
           },
           "state": "complete",
           "actuals": {
               "containers": [
                   {
                       "state": "complete",
                       "containerAttributes": {
                           "user_name": "default_user_name",
                           "location": "014.1.E.03-04",
                           "productQuantity": 2,
                           "slotAdjustedQuantity": 2,
                           "irtQuantity": 0
                       },
                       "products": [
                           {
                               "uid": "131",
                               "productQuantity": 2,
                               "productAttributes": {
                                   "pdfa_values": {
                                       "product_sku": "mac3"
                                   }
                               }
                           }
                       ]
                   },
                   {
                       "state": "excess",
                       "containerAttributes": {
                           "user_name": "default_user_name",
                           "location": "014.1.E.03-04",
                           "productQuantity": 4,
                           "slotAdjustedQuantity": 3,
                           "irtQuantity": 1,
                           "irt_serial": "IRT1"
                       },
                       "products": [
                           {
                               "uid": "131",
                               "productQuantity": 4,
                               "productAttributes": {
                                   "pdfa_values": {
                                       "product_sku": "mac3"
                                   }
                               }
                           }
                       ]
                   },
                   {
                       "state": "complete",
                       "containerAttributes": {
                           "user_name": "default_user_name",
                           "location": "014.1.E.01-02",
                           "productQuantity": 2,
                           "slotAdjustedQuantity": 2,
                           "irtQuantity": 0
                       },
                       "products": [
                           {
                               "uid": "131",
                               "productQuantity": 2,
                               "productAttributes": {
                                   "pdfa_values": {
                                       "product_sku": "mac3"
                                   }
                               }
                           }
                       ]
                   }
               ]
           }
       }
   }