[1744] | 1 | <!-- $Id$ --> |
---|
| 2 | |
---|
| 3 | <chapter> |
---|
| 4 | <title>Export datas to other software with dumppykota</title> |
---|
| 5 | <para>Last modified on $Date$</para> |
---|
| 6 | |
---|
| 7 | <para> |
---|
| 8 | If you want to reuse <application>PyKota</application> datas in another |
---|
| 9 | software, but don't want to modify your existing application to |
---|
| 10 | have it connect to <application>PyKota</application>'s database, your |
---|
| 11 | best option is the new <application>dumpykota</application> command. |
---|
| 12 | </para> |
---|
| 13 | |
---|
| 14 | <para> |
---|
| 15 | <application>dumpykota</application> can export <application>PyKota</application> |
---|
[1783] | 16 | datas in a number of formats. The supported output formats are |
---|
| 17 | comma separated values, semicolon separated values, tab separated values, and <acronym>XML</acronym>. |
---|
| 18 | More formats may be added in the future. In particular, |
---|
| 19 | <acronym>SQL</acronym> and <acronym>LDIF</acronym> are planned, but |
---|
| 20 | are currently not implemented. |
---|
[1744] | 21 | </para> |
---|
| 22 | |
---|
| 23 | <para> |
---|
| 24 | <application>dumpykota</application> can't dump all datas at once though, you have |
---|
| 25 | to specify which type of datas you want. The possible types are : |
---|
| 26 | <itemizedlist> |
---|
| 27 | <listitem><para>Users</para></listitem> |
---|
| 28 | <listitem><para>Users groups</para></listitem> |
---|
| 29 | <listitem><para>Printers</para></listitem> |
---|
| 30 | <listitem><para>Printers groups membership</para></listitem> |
---|
| 31 | <listitem><para>Users groups membership</para></listitem> |
---|
| 32 | <listitem><para>Users print quota entries</para></listitem> |
---|
| 33 | <listitem><para>Users groups print quota entries</para></listitem> |
---|
| 34 | <listitem><para>History of payments</para></listitem> |
---|
| 35 | <listitem><para>History of print jobs</para></listitem> |
---|
| 36 | </itemizedlist> |
---|
| 37 | </para> |
---|
| 38 | |
---|
| 39 | <para> |
---|
| 40 | You can then import the dumped datas into a spreadsheet for example, |
---|
| 41 | if you want to create complex reports with nice looking graphs and |
---|
| 42 | the like. |
---|
| 43 | </para> |
---|
| 44 | |
---|
| 45 | <para> |
---|
| 46 | This command could also be used if you plan to write your own management |
---|
| 47 | tools : just write wrappers around the <application>pkprinters</application>, |
---|
| 48 | <application>edpykota</application>, and <application>dumpykota</application> |
---|
| 49 | tools, and your own tools will automatically benefit from <application>PyKota</application> |
---|
| 50 | database backend independance layer. |
---|
| 51 | </para> |
---|
| 52 | |
---|
| 53 | <warning> |
---|
| 54 | <title>Warning</title> |
---|
| 55 | <para> |
---|
[1783] | 56 | Only <application>PyKota</application> administrators can dump PyKota's datas. |
---|
[1744] | 57 | </para> |
---|
| 58 | </warning> |
---|
| 59 | |
---|
| 60 | <sect1> |
---|
| 61 | <title>Reference</title> |
---|
| 62 | <para> |
---|
| 63 | <cmdsynopsis> |
---|
| 64 | <command>dumpykota</command> |
---|
| 65 | <group choice="opt"><arg>-v</arg><arg>--version</arg></group> |
---|
| 66 | <group choice="opt"><arg>-h</arg><arg>--help</arg></group> |
---|
| 67 | <group choice="opt"> |
---|
| 68 | <arg>-f <replaceable>outputformat</replaceable></arg> |
---|
| 69 | <arg>--format <replaceable>outputformat</replaceable></arg> |
---|
| 70 | </group> |
---|
[1783] | 71 | <group choice="opt"> |
---|
| 72 | <arg>-o <replaceable>filename</replaceable></arg> |
---|
| 73 | <arg>--output <replaceable>filename</replaceable></arg> |
---|
| 74 | </group> |
---|
[1744] | 75 | <group choice="req"> |
---|
| 76 | <arg>-d <replaceable>datatype</replaceable></arg> |
---|
| 77 | <arg>--data <replaceable>datatype</replaceable></arg> |
---|
| 78 | </group> |
---|
| 79 | </cmdsynopsis> |
---|
| 80 | </para> |
---|
| 81 | </sect1> |
---|
| 82 | </chapter> |
---|
| 83 | |
---|
| 84 | <!-- |
---|
| 85 | |
---|
| 86 | $Log$ |
---|
[1783] | 87 | Revision 1.2 2004/10/06 10:03:16 jalet |
---|
| 88 | Improved documentation |
---|
| 89 | |
---|
[1744] | 90 | Revision 1.1 2004/09/27 08:19:14 jalet |
---|
| 91 | Wrote some doc for dumpykota |
---|
| 92 | |
---|
| 93 | --> |
---|