Transferring availability data

The availability data type is used to compute inventory performance cost, including estimating key factors like weeks of supply. This data set requires inventory availability data to be uploaded in the beginning of the day to see up-to-date cost estimates that influences the node selection. This data type is important for determining stockout possibilities.

About this task

The inventory data feed type uses various factors for determining stockout possibilities. While uploading inventory at node or item level, it is important to ensure that no duplicate item node combinations are added in the feed. The safety stock should not be considered when computing inventory availability.

Inventory availability = Inventory on hand supply - Allocated demand

In IBM® Sterling Intelligent Promising, availability data is managed by the Inventory service. If you are managing your data by using the Inventory Visibility you must ensure that you sync your demands and supplies to the Inventory service. For more information, see the Sync Supply and the Sync Demand APIs.

Alternatively, you can use the file transfer adapter to upload availability data by using files.
Note: To switch your data integration process between the Inventory service and the file transfer adapter, you must contact IBM Support to prepare the setup to ensnare that the correct data is transferred.

Procedure

  1. To create the availability.csv files, specify the following details.
    1. For the file name, use AVAILABILITY_[CUSTOMER NAME]_YYYYMMDDHHMISS.csv format.
    2. For the separator, use the comma (,).
    3. Upload multiple .csv files by compressing them into a tar.gz file.
  2. You must follow the order of the fields shown in the data type table by matching the same order for the fields in the column in the CSV file. For example, if Item ID is the first field that is defined in the data type table, it must follow the same order in the column in the CSV file. Review the following fields and descriptions for the availability data:
    Table 1. Availability data descriptions
    Sequence Field Name Required Type Description
    1. Item ID Yes STRING The item identifier for availability.
    2. Item UOM No STRING The unit of measure for an item. The valid values are Each, Pallet and Pound. The default unit of measure is Each.
    3. Item class No STRING The class of an item.
    4. Ship node Yes STRING A store or a distribution center (DC) where the item is available.
    5. Segment No STRING The specific segment under the segment type on which the item is categorized.
    6. Segment type No STRING The type of the item's segment based on which the item is categorized.
    7. Delivery method No STRING The delivery method for a node. The delivery method can be SHIP or PICK.
    8. Availability update date YES STRING The date timestamp on which the availability is updated for an item at a store or distribution center (DC). The timestamp uses the ISO 8601 standard format, YYYY-MM-DDTHH:MM:SS.000Z.
    9. Availability end date NO STRING The last date of item availability at a store or distribution center (DC). The timestamp uses the ISO 8601 standard format, YYYY-MM-DDTHH:MM:SS.000Z.
    10. On hand available quantity YES DOUBLE The on hand quantity. This number does not account for any demand.
    11. Available quantity YES DOUBLE The current available inventory quantity. This quantity is used by the stockout process. It is required to enable item-node cost update for influencing candidate node selection.
    Availability quantity= Supply (on hand quantity) - Demand (SFS or other online orders)
    12. Safety quantity NO DOUBLE The number of items in safety stock.
  3. Review the following sample .csv file:
    item_id,item_uom,item_class,ship_node,segment,segment_type,delivery_method,availability_update_ts,availability_expiry_ts,available_quantity,onhand_available_quantity,consumed_safety_qty
    I1,EACH,CLASS1,intNode1,MERCH,ONLINE,SHP,2024-07-17T15:43:27.589Z,2500-01-01T00:00:00.000Z,60.0,60.0,0.0
    I1,EACH,CLASS1,intNode1,MERCH,ONLINE,PICK,2024-07-17T15:43:27.620Z,2500-01-01T00:00:00.000Z,60.0,60.0,0.0
    I1,EACH,CLASS1,intNode1,MERCH,ONLINE,SHP,2024-07-17T15:43:27.589Z,2500-01-01T00:00:00.000Z,60.0,60.0,0.0
    I1,EACH,CLASS1,intNode1,MERCH,ONLINE,PICK,2024-07-17T15:43:27.620Z,2500-01-01T00:00:00.000Z,60.0,60.0,0.0
  4. Specifically for IBM Cloud® Object Storage only, complete one of the following steps:
    • Upload a single file to the <Input_Prefix>/UPLOAD/AVAILABILITY/ virtual folder on IBM Cloud Object Storage.
    • Upload all files from a local directory to the <Input_Prefix>/UPLOAD/AVAILABILITY/ virtual folder on IBM Cloud Object Storage.
  5. Familiarize yourself with the file format, for example:
    • If the original file is called 2024-01-01-10-59-00.0000-3423-Availability.csv, for simplicity, you might call this file <myfilename>.csv.
    • If the data row fails to process, you receive the following error row.csv and the error summary.txt files:
      <myfilename>_file_failed_row.csv. for the error rows only (all successful are not present here)
      <myfilename>_file_failure_reason.txt are the summary file which provides the error code. Sterling Intelligent Promising automatically creates a prefix to store processed files based on their current state which includes:
      The error row.csv file is the original ingestion record that can't be processed. The error summary.txt file provides the reason for the processing failure.
  6. Understand the prefix that is created automatically by Sterling Intelligent Promising to store processed files that are based on the following current states:
    /failed
    Any CSV row that fails to process is placed in a file for download and review. As part of the monitoring process, you should review any files that are placed in this prefix. Then, you must rectify the failure and resubmit the CSV rows for reprocessing in the input stream.
    /reprocessed
    Any files that are in a queue for reprocessing due to connectivity issues. No actions are required for this prefix. Any files that are stored in the reprocessing prefix temporarily are retired automatically in Sterling Intelligent Promising. More actions are not required to handle the data.
    /completed
    All files that completed processing. It is important to clean up the completed files routinely to minimize the storage requirements on IBM Cloud Object Storage.
    /summary
    A data ingestion summary file that describes the error that occurred during execution. This summary file can be used in conjunction with the files that failed to process to help to understand the error code and the reason for failure.

Example

The system generates the following sample of the prefix generated by the data ingestion system:
  • /failed/<Input_Prefix>/sip-availability/myinput
  • /completed/<Input_Prefix>/sip-availability/myinput
  • /reprocess/<Input_Prefix>/sip-availability/myinput
  • /summary/<Input_Prefix>/sip-availability/myinput