Commit 5b6ddeb6 authored by Timmer, Marius's avatar Timmer, Marius

Bugfix: Readme explains (a bit better) how to use and install this plugin

parent edd2f499
......@@ -2,19 +2,20 @@
## What this plugin does
OTRS by itself is able to print single tickets to single pdf files. This plugin allows the admin of the system to print all tickets of a queue into one pdf document using the console.
OTRS by itself is able to print single tickets to single pdf files. This plugin uses this function to export all tickets of a queue into separated files for each ticket.
## Installation
You can simply install this plugin via the package manager in OTRS. You may need to build the package from it sources. If you have the package (_OPM-File_) available you can upload it into the package manager and click on install to proceed. After following the instructions on the screen you can use it.
To install this plugin you just need to build the OPM file from the sources in this repository. [Package Build](https://otrs.github.io/doc/manual/developer/5.0/en/html/package-building.html#package-build "Documentation") After that you can simply install the OPM file using the package manager in your admin menu or the command line.
## How it works
In order to build the pdf document the administrator has to use the console. After installing a new option (`Admin::Queue::TicketExport`) will appear. It takes the following arguments:
To export the tickets of a queue you need to use the command line. The otrs.Console will offer you the new option `Admin::Queue::TicketExport` which is the plugin. You can use the following arguments:
* `queue`: Name of the queue whose tickets should be printed
* `filename`: Name of the new pdf document
After running a command (e.g. `bin/otrs.Console.pl Admin::Queue::TicketExport --queue Raw --filename ~/Tickets_of_queue_Raw.pdf`) the program will inform you if the given queue was found in the system. If so it will print the number of tickets in the queue. If everything works well it will tell you that the file _xyz_ was written.
If there is no queue with the wanted name the user will be informed about that and the execution will abort. It will also abort if it is not able to write the file. Please hold in mind that all tickets of a queue will be printed to the pdf document. That means even old and locked tickets will be included.
\ No newline at end of file
Keep in mind that only the requested queue will be exported. SubQueues will be ignored, but you can use something like `Queue::SubQueue`.
Exporting all queues could take a while. We need 23 hours to export about 40.000 tickets (~11G).
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment