]> git.evergreen-ils.org Git - Evergreen.git/blob - docs-antora/modules/reports/pages/reporter_daemon.adoc
LP#1848524: Docs: Fix sections for Antora: "reports"
[Evergreen.git] / docs-antora / modules / reports / pages / reporter_daemon.adoc
1 = Starting and Stopping the Reporter Daemon =
2 :toc:
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 indexterm:[reporter, starting]
17
18 To start the reporter daemon, run the following command as the opensrf user:
19
20 ----
21 clark-kent.pl --daemon
22 ----
23
24 You can also specify other options:
25
26 * *sleep=interval*: number of seconds to sleep between checks for new reports to 
27 run; defaults to 10
28 * *lockfile=filename*: where to place the lockfile for the process; defaults to 
29 /tmp/reporter-LOCK
30 * *concurrency=integer*: number of reporter daemon processes to run; defaults to 
31 1
32 * *bootstrap=filename*: OpenSRF bootstrap configuration file; defaults to 
33 /openils/conf/opensrf_core.xml
34
35
36 [NOTE]
37 =============
38 The open-ils.reporter process must be running and enabled on the gateway before 
39 the reporter daemon can be started.
40
41 Remember that if the server is restarted, the reporter daemon will need to be 
42 restarted before you can view reports unless you have configured your server to 
43 start the daemon automatically at start up time. 
44 =============
45
46 == Stopping the Reporter Daemon ==
47
48 indexterm:[reports, stopping server application]
49
50 indexterm:[reporter, stopping daemon]
51
52 To stop the reporter daemon, you have to kill the process and remove the 
53 lockfile. Assuming you're running just a single process and that the 
54 lockfile is in the default location, perform the following commands as the 
55 opensrf user:
56
57 ----
58 kill `ps wax | grep "Clark Kent" | grep -v grep | cut -b1-6`
59
60 rm /tmp/reporter-LOCK
61 ----
62