Administrator Guide

Setup

Ovyka OvSatisfaction plugin is delivered as a Java Archive (JAR file). To install OvSatisfaction, the steps are the following :

• Go to Add-ons administration by clicking on Add-ons in administration drop down menu (you may be asked your password to access and administration page);
  
  
  
• In the left menu bar, click on Manage Add-ons;
  
  
  
• Once the Manage Add-ons page is loaded, click on the Upload Add-on link on the right of the page;
  
  
  
• In the popup window, click on the file chooser button, navigate to the place you downloaded OvSatisfaction jar file and click the upload button.

Once the plugin is installed, you'll see Ovyka OvSatisfaction in the User-installed add-ons list.

Global Administration

In the administration area, in the left menu bar, you'll find a new section called OvSatisfaction containing one link : OvSatisfaction Administration. Clicking this link will open the administration page for the OvSatisfaction plugin.

OvSatisfaction plugin administration allows you to configure the global satisfaction survey fields available for project. The plugin comes with 4 preconfigured fields :

• Overall answer satisfaction
  • A rating field, where users can provide their global satisfaction about the resolution of their issues, by giving a rating from 1 to 5 stars.
  • This field cannot be deactivated or deleted.
• Time to answer satisfaction
  • A rating field where users can express their satisfaction about the time taken to resolve their issue, by giving a rating from 1 to 5 stars.
• Agent satisfaction
  • A rating field where users can express their feeling about the agent in charge of their issue, by giving a rating from 1 to 5 stars.
• Comment
  • A multi-line comment field where users can enter comments about the resolution of their issue.

The administration page presents these fields in a table, along with their description, their status (active or inactive), and action links.

Field actions

Change field name or description

When you hover your mouse over the name or description of a field, you'll see a small pen appear on the right of the field you're above. To change the field name or description, when your mouse is above the field you want to change, click on it, and the line will switch to Edit mode.

This will allow you to change the field name and/or description. Once you're done, click the Update button on the right of the line to save your changes. You are not allowed to enter empty field names and descriptions.

Deactivate field

Except for the first field (Overall answer satisfaction), all fields are can be deactivated. On the right of the field line, you'll see a Deactivate link. Click it to deactivate the field. Its status will change to Inactive and the link text will change to Activate. You can use this link again to reactivate the field.

Add field

Under the fields table, you'll find an Add new field button. If you want to add a new field, click on the Add new field button. It will open a popup window, where you can enter :

• the name of your field
• the description of your field
• the type of your field (rating (User evaluation) or comment (Multine user comment)).

All values are mandatory.

Once your field is created, it appears in the table above, and can be modified or deactivated like other fields.

Delete field

The fields preconfigured by the OvSatisfaction plugin when it's installed cannot be deleted (but may be deactivated, except for the Overall answer satisfaction field).

Fields created by administrators of your JIRA instance, on the other hand, can be deleted. For these fields, in the Action column, you'll see a Delete link. To delete your field, click on the Delete link. A warning popup will appear, explaining that deleting a field implies data losses, because all answers provided by users for this field will be deleted. If you click the Confirm popup link, your field and all its related data will disappear.

Administration sample view

Below is a screenshot of a sample configuration, where you'll see some features depicted :

• a field line in Edit mode;
• an administrator-added field (with a delete link);
• an inactive field;
• the Add new field button.

Project Administration

To administrate the OvSatisfaction plugin for a specific project, first go to the Browse Project page for the project you want to configure (top menu > Projects > your-project-key ), then clink on the Administration link. This will open the main project administration page, showing panels for administration sections. You'll see a new panel, dedicated to OvSatisfaction, looking like this :

This panel shows the current activation status of the plugin for the project (Active or Inactive), and provides a link to plugin configuration for the project. This link is also available in the left menu bar, and is called OvSatisfaction.

Click on either link, and you'll access the plugin configuration page for your project.

When the plugin is not activated for a project, this page only contains one tab, showing the activation status, and a button to activate/deactivate the plugin for the project. It will look like this :

To activate OvSatisfaction for the project, just click the Activate button. The activation status will change to Active, the button will change to Deactivate, and a new tab allowing to configure the plugin will appear, called Configuration.

Once the plugin is activated, click the Configuration tab, and you'll see a list of fields you can configure, like shown in the image below :

The fields shown here are fields that are active in the global plugin configuration. If you deactivate a field in the project configuration page, the field is deactivated for this project only. Other projects can continue to use this field, as long as it's active in the global plugin configuration.

You have not other action to take to configure OvSatisfaction for your project. You can even leave it as it is. Basically, clicking the Activate button in project administration is enough for your project to benefit from OvSatisfaction features.

Contact

Should you have any questions about the OvSatisfaction plugin, or should you encounter any problem using the OvSatisfaction plugin, feel free to contact us by dropping an email to this address : contact@ovyka.com