Receive Task Service
- Changelogic
- Changelogic API
- Receive Task
You can let your users send bug reports and feedback right from your application – here is a specification of the service on Changelogic's side.
Input
| Parameter | Required? | Explanation | On form | Example |
|---|---|---|---|---|
| URL | Yes | Base URL on Changelogic service | form action | https://changelogic.example.com/changelogic/service.php |
| event | Yes | Event of Changelogic service, it remains always the same | hidden input | event=Receive_task |
| user | Yes | Changelogic username to use when submitting the task. You can have a separate user for collecting all the feedback or even one user for every production environment, thus you can easily filter the tasks entered via feedback later | hidden input | user=feedback |
| auth | Yes | Authentication code for the user. You can generate new authentication code for a user from menu Project-> Authentication codes | hidden input | auth=l92ac4b7d77c76 |
| version | No | Version number of your project; you can get the current version of an application from its version.properties file | hidden input | version=1.29.8.1 |
| change_id | No | Change ID of your project; you can get the current change number of an application from its change.properties file | hidden input | change_id=3354 |
| short_desc | Yes | Short description of problem – user enters from form that you provide | text input | short_desc=Big problem |
| comment | No | Longer description of problem or just additional comments | text area | comment=Null Pointer Expection on front page |
| log | No | It is advisable to send all diagnostic context from application that can be helpful for dissecting problems, for example user names, actions log etc. Log may also be uploaded as a file. In order to protect privacy, you are expected to inform the user about diagnostic data sent along with his/her comment | hidden input | <input type="hidden" name="log" value="MailMode=1 SelectedProject=2 Cookies=0 UserAgent=~Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv\:1.7.12) Gecko/20050915 Firefox/1.0.7 Username=karla RealName=Karel Kravik EMail= Language=est"> |
| exception | No | Stack trace and/or other characteristics of problem experienced; this information may also be uploaded as a file | hidden input | <input type="hidden" name="exception" value="Faulting application helloworld32.exe, version 3.1.192, faulting module wldtime.dll, version 2.8.144, fault address 0x0001665d"> |
| human_readable | No | How Changelogic should respond: 1 – in human readable format, 0 – in property file format (default) | hidden input | human_readable=1 |
| task_type_id | No | Task type identifier according to task types in Changelogic. The task types are as follows:
| selection | task_type_id=1 |
| lang | No | Language to use for returned messages; currently, valid values are “est” and “eng” | hidden input | lang=eng |
Output
Format of the output depends on the value passed for “human_readable” parameter. For requests made with «human_readable=1”, a HTML page (character set: ISO-8859–13) explaining result of the action is returned. For requests made with setting «human_readable=0”, a property file is returned with the following properties in addition to the ones described in General Information:
| Property | Explanation |
|---|---|
| task.id | Identifier of the task that was added |