Documentation: Migrate reports documentation from 2.1
[working/Evergreen.git] / docs / reports / reporter_daemon.txt
1 Starting and Stopping the Reporter Daemon\r
2 -----------------------------------------\r
3 \r
4 indexterm:[reports, starting server application]\r
5 \r
6 indexterm:[reporter, starting daemon]\r
7 \r
8 Before you can view reports, the Evergreen administrator must start \r
9 the reporter daemon from the command line of the Evergreen server.\r
10 \r
11 The reporter daemon periodically checks for requests for new reports or \r
12 scheduled reports and gets them running.\r
13 \r
14 Starting the Reporter Daemon\r
15 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
16 \r
17 indexterm:[reporter, starting]\r
18 \r
19 To start the reporter daemon, run the following command as the opensrf user:\r
20 \r
21 ----\r
22 clark-kent.pl --daemon\r
23 ----\r
24 \r
25 You can also specify other options:\r
26 \r
27 * *sleep=interval*: number of seconds to sleep between checks for new reports to \r
28 run; defaults to 10\r
29 * *lockfile=filename*: where to place the lockfile for the process; defaults to \r
30 /tmp/reporter-LOCK\r
31 * *concurrency=integer*: number of reporter daemon processes to run; defaults to \r
32 1\r
33 * *boostrap=filename*: OpenSRF bootstrap configuration file; defaults to \r
34 /openils/conf/opensrf_core.xml\r
35 \r
36 \r
37 [NOTE]\r
38 =============\r
39 The open-ils.reporter process must be running and enabled on the gateway before \r
40 the reporter daemon can be started.\r
41 \r
42 Remember that if the server is restarted, the reporter daemon will need to be \r
43 restarted before you can view reports unless you have configured your server to \r
44 start the daemonautomatically at start up time. \r
45 ==============\r
46 \r
47 Stopping the Reporter Daemon\r
48 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
49 \r
50 indexterm:[reports, stopping server application]\r
51 \r
52 indexterm:[reporter, stopping daemon]\r
53 \r
54 To stop the reporter daemon, you have to kill the process and remove the \r
55 lockfile. Assuming you're running just a single process and that the \r
56 lockfile is in the default location, perform the following commands as the \r
57 opensrf user:\r
58 \r
59 ----\r
60 kill `ps wax | grep "Clark Kent" | grep -v grep | cut -b1-6`\r
61 \r
62 rm /tmp/reporter-LOCK\r
63 ----\r
64 \r