Documentation
Table of Content
Quick Start
- Install Redmine Free on your target website
- Add a Redmine Free New Ticket block to a page
- Configure the redmine backend in the edit dialog
- Publish the page
- That's it, users can now directly file tickets into your redmine server from that page
If you want to know more, then read the rest of this documentation.
Installation
Package installation
The recommended method to install Redmine Free, is simply using your target website marketplace page. However, if you wish not to use concrete5 internal feature, you can follow the next instructions :
- Download the zip archive
- Uncompress the zip archive into your packages/ directory
- Visit your page (located at http://yoursite.com/index.php/dashboard/extend/install )
- Click on the Redmine Free Install button
After installing Redmine Free (either through downloading or preferably directly through your concrete5 website interface), you will be provided with the Redmine Free New Ticket block.
redmine configuration
A complete installation guide of redmine is beyond this documentation. However, you can find the documentation on the redmine project page
This addon uses the redmine REST API, thus you must activate it in your redmine installation. To do this, enable REST API in ->->.
At the time of writing the redmine REST API is still incomplete and suffer a few issues regarding accessing to some data listings of the redmine tracker/project structure:
- It is currently impossible to know if a custom field is associated with a specific tracker
- It is currently impossible to list custom fields if the backend test user is not admin
Please understand that these are limitations of the redmine API, not the addon.
Creating tickets
New Ticket Block Usage
To allow your users to issue ticket from any page, add the Redmine Free New Ticket to the page.
You will first have to fill in the redmine server base URL in the redmine base URL field. This URL will be used to connect to the redmine server in order to create tickets but also in order to detect the ticket system structure.
- Ticket prompt: shows a text
- Show to Guest: make the report link available to non-logged-in users
- Use captcha: require captcha before submitting (spam protection)
Ticket Creation User interface
Tickets are directly filed into the redmine server. For this reason, users (that is, the actual visitor of your website) will need to be connected onto the redmine server directly. Those credentials will most likely differ from their website credentials.
If needed, the credentials will be asked directly to the user when he/she clicks on the report button :
After the first successful connection to the redmine server, those credentials will be stored into the user session. (Redmine Free stores all sensitive information ciphered, so no information can be retrieved from either side).
The next time the same user will attempt to file a ticket, if he/she already connected that specific backend (comparing the backend base URI), stored credentials will directly be used, and the user will not have to sign in again.
Once the user is connected to the redmine server, the user can then file a new ticket from the new ticket interface:
The actual content of the dialog is fully customizable, and will depend on your actual configuration in the Redmine Free New Ticket edit block dialog. Moreover, the actual interface depend on your choice (either using the AJAX overlay dialog, or using the single page, described in the next sub-section).
the New ticket interface contains the following tabs :
- : Containing the Summary, Reporter, and Description field
- : Containing all the fields detected on the redmine server
- : Managing the new tickets attachments
The tab shows all fields declared on the redmine ticket system:
Each field have the label defined in the redmine server, and can be filled using the appropriate input type (depending on the ticket type directly).
The tab shows future ticket attachments:
To preview a ticket attachment in this dialog tab, just click on the attachment summary:
To fold the attachment again, just click on the preview again.
Finally, the ticket is actually created when the reporter hits the button. once the ticket is created on the redmine server, a message will be shown to the user inviting him to directly visit the redmine server:
To modify this single page, use the (natively available from the menu of concrete5), and visit the > page. The message Invalid Block Request will be displayed in the page (this is normal since you are visiting directly instead of using the block ticket submission link)). Finally edit this page (in edit mode).
This single page provides the following areas where you can add blocks:
- Ticket Header displayed before the ticket form
- Ticket Block Not Found displayed in case of ticket error only
- Ticket Submission Success displayed after a ticket had been successfully submitted
- Ticket Footer displayed after the ticket form
Using the provided areas, you can easily customize the ticket submission page to your own need. The ticket submission interface described in the proceeding section will be displayed between the Ticket Header and Ticket Footer area. The ticket submission interface is still dependent on each block configuration, thus can still be fully customized for each need.
If the user wishes to log out from the redmine server, he/she can use the button present in the new ticket dialog. To do this, just click on the report issuing prompt in any page, and locate the button in the following dialog:
Once the user disconnect from the redmine server, he will be redirected to the login dialog.
Support
This addon is a free addon, and does not come with free support. If you have a problem, just post a support request, we will reply when we have some time to do so.