Integrating with Earthdata Feedback Module

Overview

The Feedback Module allows partner applications to easily add Kayako-backed feedback and support functionality to a web site. It provides JavaScript code that can be referenced in a client web page to add a "Feedback" icon on the side of the page. Clicking this icon opens a feedback form where the user can enter their name, email address, the subject of their feedback and any details. The Feedback module will also collect information about the current browser type, location and page/screen size, if it is available. When feedback is submitted, it is created as a new Kayako ticket with attributes configured for the client application (see below).

Use

Using the feedback module requires two steps. First, a client application needs to be created and configured by a Feedback Module administrator; then, the partner site needs to include the correct JavaScript on any page where the feedback functionality is desired.

Client Application

Client applications are created upon request by administrators of the Feedback module. In order to create a client application, the following information is required:

• Client Application Name (e.g. "Test App")
  Uniquely identifies the client application.
• Domain (e.g. "http://foo.example.com/")
  This is the domain name of the web site that will be displaying the feedback form. This is required in order for the partner site to be able to securely communicate with the feedback module via JavaScript.
• Kayako Ticket Details
  The following Kayako ticket attributes can be set in order to customize where and what kind of tickets are created:
  • Department
    The Kayako department in which the ticket will be created. This will most likely correspond to the partner application.
  • Status
    The initial status of the ticket (e.g. "Open", "Waiting", "In Progress").
  • Priority
    The default priority for a new ticket (e.g. "High", "Normal", "Low").
  • Type
    The type of ticket that will be created (will most likely be "Feedback").

Web Site

Once the client application has been created, the JavaScript to use the feedback module can be included in the partner site with a <script> tag as follows:

Feedback Module JS Reference

<script src="https://fbm.earthdata.nasa.gov/for/{your app name}/feedback.js" type="text/javascript"></script>

Replace {your app name} with the unique client application name.

On any page where the feedback icon should be displayed, include the following JavaScript code:

JS to show Feedback icon

<script type="text/javascript">
  feedback.init();
</script>

If you want to create a custom "Feedback" icon or link, use the following JavaScript code instead:

JS to initialize without Feedback icon

<script type="text/javascript">
  feedback.init({showIcon: false});
</script>

And then have your feedback link call feedback.showForm().

Notes

Browser Support

The feedback module has been tested and works in the following browsers:

• Internet Explorer 6.0 and higher
  Some layout and styling issues are present in IE6 and IE7. IE8 and higher has no issues.
• Firefox 3.0 and higher
  Some layout issues are present in Firefox 3.0. Firefox 3.6 and higher has no issues.
• Chrome 14.0 and higher
• Safari 4.0 and higher
• Opera 11.1 and higher