FeedbackTechnical < Cargooffice

Tags: view all tags
---++ Feedback functionality: Technical descriptions

<br />%TOC{depth="6"}%
---+++ About
   * How to maintain, modify or create your own Feedback Templates.
   * [[TemplatesFeedback][Examples of other Feedback templates]].
---+++ Description of feedback templates
   * There are 2 templates: [[FeedbackTechnical#feedback_FormTemplate_htm][feedbackFormTemplate.htm]] and [[FeedbackTechnical#feedback_ReportTemplate_htm][feedbackReportTemplate.htm]]
   * Both will be placed in your FTP-environment: /data/templates/
---++++ feedbackFormTemplate.htm
   * In the header part there are:<br />
      * Javascript functions communicating with the Cargo Office Servers.<br /><i>Do leave these functions intact.</i>
      * You are free to add new Javascript functions.
   * In the body part there are:<br />
      * hidden field: _toEmail<br />In here you can add extra email addresses [[FeedbackDefault#Example_of_email_message][for receiving an email message]].
      * Fields you can fill with values from your shipment data set.<br />
         * *Note:* all these fields need a begin character ~ and a closing character ~, else it would not be recognized.
         * Some examples are:<br />
            * ~orderID~
            * ~SES_CUSTID~ (a session variable)
            * ~pickupName~
         * If you are looking for a specific field name out a shipment data set, use: [[EdiOrderInfo][EDI Order Info]].
      * Fields you can add new fields your self.<br />For example:<br />
         * &lt;textarea name="description" rows="10"&gt;&lt;/textarea&gt;
         * &lt;input type="text" name="customerContact"&gt;
         * &lt;input type="text" name="customerEmail" value="~SES_USEREMAIL~"&gt;
      * Names that can be used as translation values to other languages.<br />
         * The displayed language is chosen by the [[LanguageDisplay][user's browser settings]]. <br />If the language is not set by paramater, then by default the English language is displayed.
         * These fields are corresponding with translation parameters [[BackofficeSettingsDescription#feedbackForm_en][_feedbackForm_en]] and [[BackofficeSettingsDescription#feedbackForm_nl][_feedbackForm_nl]].<br />
            * 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: [[BackofficeSettingsDescription#feedbackForm_en][_feedbackForm_en]] and [[BackofficeSettingsDescription#feedbackForm_nl][_feedbackForm_nl]]) :<br />
            * ~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: <br />
      * Fields you can fill with values from your shipment data set.<br />
         * *Note:* all these fields need a begin character ~ and a closing character ~, else it would not be recognized.
         * Some examples are:<br />
            * ~orderID~
            * ~SES_CUSTID~ (a session variable)
            * ~feedbackType~
            * ~email~
      * Names that can be used as translation values to other languages.<br />
         * The displayed language is chosen by the [[LanguageDisplay][user's browser settings]].<br />If the language is not set by paramater, then by default the English language is displayed.
         * These fields are corresponding with translation parameters [[BackofficeSettingsDescription#feedbackReport_en][_feedbackReport_en]] and [[BackofficeSettingsDescription#feedbackReport_nl][_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: [[BackofficeSettingsDescription#feedbackReport_en][_feedbackReport_en]] and [[BackofficeSettingsDescription#feedbackReport_nl][_feedbackReport_nl]]) :<br />
            * ~Feedback Report~
            * ~About~
            * ~Attached files~
---+++ Description of feedback parameters

All feedback parameters can be found at the [[BackofficeSettingsDescription][Back Office Settings]]
   * Parameter: [[BackofficeSettingsDescription#feedbackForm_en][_feedbackForm_en]]
   * Parameter: [[BackofficeSettingsDescription#feedbackForm_nl][_feedbackForm_nl]]
   * Parameter: [[BackofficeSettingsDescription#feedbackReport_en][_feedbackReport_en]]
   * Parameter: [[BackofficeSettingsDescription#feedbackReport_nl][_feedbackReport_nl]]
Topic revision: r2 - 2018-10-17 - RutgerRutgers