root / pykota / trunk / docs / dumpykota.sgml @ 2146

Revision 2146, 4.3 kB (checked in by jerome, 19 years ago)

It seems that $Log$ is not implemented or doesn't work for some reason

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
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 from 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 <command>dumpykota</command> command.
12  </para>
13 
14  <para>
15    <command>dumpykota</command> can export <application>PyKota</application>
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  </para> 
19 
20  <para>
21    For the print job history's datas, a special format identical to <application>CUPS</application>' <literal>page_log</literal>
22    format is also supported.
23    This allows you to interface <application>PyKota</application> with third party tools like
24    <application>phpPrintAnalyzer</application> which is a logfile analyzer for <application>CUPS</application>,
25    even in the case where you use <application>LPRng</application> instead of <application>CUPS</application>.
26  </para> 
27 
28  <para>
29    More formats may be added in the future. In particular,
30    <acronym>SQL</acronym> and <acronym>LDIF</acronym> are planned, but
31    are currently not implemented.
32  </para>
33 
34  <para>
35    <command>dumpykota</command> can't dump all datas at once though, you have
36    to specify which type of datas you want. The possible types are :
37    <itemizedlist>
38      <listitem><para>Users</para></listitem>
39      <listitem><para>Users groups</para></listitem>
40      <listitem><para>Printers</para></listitem>
41      <listitem><para>Printers groups membership</para></listitem>
42      <listitem><para>Users groups membership</para></listitem>
43      <listitem><para>Users print quota entries</para></listitem>
44      <listitem><para>Users groups print quota entries</para></listitem>
45      <listitem><para>History of payments</para></listitem>
46      <listitem><para>History of print jobs</para></listitem>
47    </itemizedlist> 
48  </para>
49 
50  <para>
51    You can then import the dumped datas into a spreadsheet for example,
52    if you want to create complex reports with nice looking graphs and
53    the like.
54  </para>
55 
56  <para>
57    This command could also be used if you plan to write your own management
58    tools : just write wrappers around the <command>pkprinters</command>,
59    <command>edpykota</command>, and <command>dumpykota</command>
60    tools, and your own tools will automatically benefit from <application>PyKota</application>
61    database backend independance layer.
62    This is exactly what the third party software <application>phpPykotaAdmin</application> does.
63  </para>
64 
65  <para>
66    Finally, <command>dumpykota</command>'s functionnality is now also available remotely through
67    the use of the <filename>dumpykota.cgi</filename> <acronym>CGI</acronym> script.
68  </para>
69 
70  <warning>
71    <title>Warning</title>
72    <para>
73      Only <application>PyKota</application> administrators can dump PyKota's datas.
74    </para>
75  </warning> 
76       
77  <sect1>
78    <title>Reference</title>
79    <para>
80      <cmdsynopsis>
81        <command>dumpykota</command>
82        <group choice="opt"><arg>-v</arg><arg>--version</arg></group>
83        <group choice="opt"><arg>-h</arg><arg>--help</arg></group>
84        <group choice="opt">
85          <arg>-f <replaceable>outputformat</replaceable></arg>
86          <arg>--format <replaceable>outputformat</replaceable></arg>
87        </group>
88        <group choice="opt">
89          <arg>-o <replaceable>filename</replaceable></arg>
90          <arg>--output <replaceable>filename</replaceable></arg>
91        </group>
92        <group choice="req">
93          <arg>-d <replaceable>datatype</replaceable></arg>
94          <arg>--data <replaceable>datatype</replaceable></arg>
95        </group>
96      </cmdsynopsis>
97    </para>
98  </sect1>
99</chapter>
100
101<!--
102
103$Log$
104Revision 1.3  2005/02/28 00:07:37  jalet
105Added pkmail's doc.
106Used the <command> tag instead of <application> for commands.
107Fixed some typos.
108Added some missing command line options in the commands reference.
109
110Revision 1.2  2004/10/06 10:03:16  jalet
111Improved documentation
112
113Revision 1.1  2004/09/27 08:19:14  jalet
114Wrote some doc for dumpykota
115
116-->
Note: See TracBrowser for help on using the browser.