Laddawn.com : UI Spec - Checkout Shipment Bundling Comments

Created by User df0f1 on Feb 26, 2014

Shipment Bundle Comments

Overview:  Show the bundle comments by interfacing with the database.

 

Visual Design:

https://laddawn1.atlassian.net/wiki/display/web/2b.+Shipping+and+packaging+-+COMPLETE

 

Architecture Support:

  • Comments Entity
    • Properties
      • CommentType: Enum, (Need to add)
        • Field Name: COMMENT.TYPE
        • Enum Definition
          • Delivery - 1
          • Carrier Options – 2
          • Pallets – 3
          • CE – 4
      • Description / Purpose:
        • The visual design will show that the various comments are separated into sections.  This property dictates what section the comment belongs under.
    • ID: String,
      • Field Name: COMMENT.NBR
      • Description / Purpose:
        • The Number we’ve assigned to indicate this comment from the others.
    • Description: String,
      • Field Name: COMMENT.DESC
      • Description / Purpose:
        • This is the brief description of what the comment is for.  From a visual design aspect, it is the text that is attached to the checkbox on the popup.
    • SortIndex: Integer (Needs to be added)
      • Field Name: SORT.INDEX
      • Description / Purpose:
        • The database will control what order the checkboxes are displayed on the screen.  This property will be used to sort the comments into the correct order for their group.
    • Comment: String,
      • Field Name: COMMENT
      • Description / Purpose
        • This is the text that is going to go on the paperwork after the inputs have been swapped in.
    • ScreenPrompt1: String
      • Field Name: SCRN.PROMPT1
      • Description / Purpose:
        • Many Comments have up to 2 “fill in the blank” slots.  For example Receiving Hours are between ___ and ___.
    • ScreenPrompt2: String
      • Field Name: SCRN.PROMPT2
      • Description / Purpose:
        • Many Comments have up to 2 “fill in the blank” slots.  For example Receiving Hours are between ___ and ___.
    • InputFormat1: Enum, (Needs to be added)
      • Field Name: INPUT.FORMAT1
      • Description / Purpose:
        • We need to show different controls for the different types of Screen Prompts
      • Enum
        • Text Box – 1
        • Date – 2
        • Time – 3
        • Grid – 4
        • Phone Nbr – 5
        • Range – 6
    • InputFormat2: Enum, (Needs to be added)
      • Field Name: INPUT.FORMAT1
      • Description / Purpose:
        • We need to show different controls for the different types of Screen Prompts
      • Enum
        • Text Box – 1
        • Date – 2
        • Time – 3
        • Grid – 4
        • Phone Nbr – 5
        • Range – 6
    • ScreenPrompt1: String, (Needs to be added)
      • Field Name: SCRN.PROMPT1
      • Description / Purpose:
        • This is the text we want displayed for the input on the screen.
    • ScreenPrompt2: String, (Needs to be added)
      • Field Name: SCRN.PROMPT2
      • Description / Purpose:
        • This is the text we want displayed for the input on the screen.
        • CommentService
          • Methods:
            • GetByFilter: Reutrns CommentCollection
              • Input Parameters:
                • COMMENT.TYPE – ENUM matching CommentType property above.
                • COMPANY.ID – CurrentUser.CompanyID
                • BILLTO.NBR – Billto Customer Number (Not yet implemented on the database side, but I expect we will need it.
                • CUST.NBR – Ship to customer number.
                • Output Fields: Field Names defined above
                • UI Design:
                  • When the user clicks on the Change Comment link display popup
                    • _CheckoutInfoBundleComments
                    • Run CommentService.GetByFilter:
                      • Comment Type = “”
                      • This should return all the comments sorted by type then by display index.
                      • While looping through the returned comments, On each change of the comment type, we should render a partial that represent a group of comments.
                      • In each of the above partials, we need to render a sub-partial that is showing.
                        • This sub partial should render a checkbox, and yet another sub partial.
                          • This secondary sub partial will be based on the input type.
      • Clicking OK on this popup should do the following:
        • Find all selected comments and all entered prompts.
        • Replace Input1 and Input2 into the Comment.Comment