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