Feedback functionality: Technical descriptions

About

• How to maintain, modify or create your own Feedback Templates.
• Examples of other Feedback templates.

Description of feedback templates

• There are 2 templates: feedbackFormTemplate.htm and feedbackReportTemplate.htm
• Both will be placed in your FTP-environment: /data/templates/

feedbackFormTemplate.htm

• In the header part there are:
  
  • Javascript functions communicating with the Cargo Office Servers.
    Do leave these functions intact.
  • You are free to add new Javascript functions.
• In the body part there are:
  
  • hidden field: _toEmail
    In here you can add extra email addresses for receiving an email message.
  • Fields you can fill with values from your shipment data set.
    
    • Note: all these fields need a begin character ~ and a closing character ~, else it would not be recognized.
    • Some examples are:
      
      • ~orderID~
      • ~SES_CUSTID~ (a session variable)
      • ~pickupName~
    • If you are looking for a specific field name out a shipment data set, use: EDI Order Info.
  • Fields you can add new fields your self.
    For example:
    
    • <textarea name="description" rows="10"></textarea>
    • <input type="text" name="customerContact">
    • <input type="text" name="customerEmail" value="~SES_USEREMAIL~">
  • Names that can be used as translation values to other languages.
    
    • The displayed language is chosen by the user's browser settings.
      If the language is not set by paramater, then by default the English language is displayed.
    • These fields are corresponding with translation parameters _feedbackForm_en and _feedbackForm_nl.
      
      • en = translated into English
      • nl = translated into Dutch
      • ?? =any language implemented at your own choice
    • Note: all these fields need a begin character ~ and a closing character ~, else it would not be recognized.
    • For example (you can check these in parameters: _feedbackForm_en and _feedbackForm_nl) :
      
      • ~Feedback Form~
      • ~About~
      • ~Shipment~

feedbackReportTemplate.htm

• The programming codes of feedbackReportTemplate.htm are a repetition of feedbackFormTemplate.htm, but even more simplified.
• In the body part there are:
  
  • Fields you can fill with values from your shipment data set.
    
    • Note: all these fields need a begin character ~ and a closing character ~, else it would not be recognized.
    • Some examples are:
      
      • ~orderID~
      • ~SES_CUSTID~ (a session variable)
      • ~feedbackType~
      • ~email~
  • Names that can be used as translation values to other languages.
    
    • The displayed language is chosen by the user's browser settings.
      If the language is not set by paramater, then by default the English language is displayed.
    • These fields are corresponding with translation parameters _feedbackReport_en and _feedbackReport_nl.
    • Note: all these fields need a begin character ~ and a closing character ~, else it would not be recognized.
    • For example (you can check these in parameters: _feedbackReport_en and _feedbackReport_nl) :
      
      • ~Feedback Report~
      • ~About~
      • ~Attached files~

Description of feedback parameters

All feedback parameters can be found at the Back Office Settings

• Parameter: _feedbackForm_en
• Parameter: _feedbackForm_nl
• Parameter: _feedbackReport_en
• Parameter: _feedbackReport_nl