Configure the shipment file template

Description

As an implementer, I want to configure the shipment file template so that shipment files from the ERP are properly processed via FTP.

Looking forward: At some point we may want to create a shipment file template per facility in case programs source their data from different warehouses with different ERPs. We still need to research this and will stick to the current 2.0 functionality for now. Currently we will create one global shipment file template. However, please keep this in mind when designing and thinking about implementing this story.

Allows configuration of shipment files; however this feature requires additional work to make it functional at picking up shipment files via FTP from remote systems!

The shipment and receipt process when the order was filled outside of OpenLMIS

This ticket does not deal with UI, it is only the backend work. (Essentially CRUD of shipment file template)

Acceptance criteria

  • design of shipment file template and its columns

    • class diagram and update of RAML

  • an implementer can indicate to include or not include column headers (boolean) for the whole template

  • each column included should have name, isIncluded and position

  • These are the columns in the shipment file template:
    Order Number
    Product Code
    Quantity Shipped
    Cost
    Packed Date
    Shipped Date
    Replaced Product Code
    Facility Code
    Quantity Ordered
    Concatenated Order (e.g. ARV000001R)
    Program Code
    Substituted Product Code
    Substituted Product Name
    Substituted Product Quantity Shipped
    Pack Size

  • Order number, product code (product ID?) and quantity shipped are required in the template. The only editable value for these columns are its position

  • the position number must be a positive integer

  • for columns "Packed Date" and "Shipped Date" user is able to indicate date format options:
    dd/MM/yy
    dd/MM/yyyy
    MM/dd/yy
    MM/dd/yyyy
    yy/MM/dd
    yyyy/MM/dd
    dd-MM-yy
    dd-MM-yyyy
    MM-dd-yy
    MM-dd-yyyy
    yy-MM-dd
    yyyy-MM-dd
    ddMMyy
    ddMMyyyy
    MMddyy
    MMddyyyy
    yyMMdd
    yyyyMMdd

Open Questions:

  • Do we want to allow two columns to have the same position numbers? If so, how should parsing the file based on the template work?

Activity

Show:
Chongsun Ahn
December 16, 2016, 10:56 PM

The shipment corollary to OLMIS-965.

Assignee

Unassigned

Reporter

Jake Watson

Labels

Story Points

5

Epic Link

Components

Affects versions

Priority

Major