-
Notifications
You must be signed in to change notification settings - Fork 0
/
cold_reports.1.html
87 lines (85 loc) · 3.29 KB
/
cold_reports.1.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
<!DOCTYPE html>
<html lang="en">
<head>
<title>COLD (Controlled Object List and Datum (Concept))</title>
<link href='https://fonts.googleapis.com/css?family=Open+Sans' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="https://caltechlibrary.github.io/css/site.css">
</head>
<body>
<header>
<a href="http://library.caltech.edu" title="link to Caltech Library Homepage"><img src="https://caltechlibrary.github.io/assets/liblogo.gif" alt="Caltech Library logo"></a>
</header>
<nav>
<ul>
<li><a href="/">Home</a></li>
<li><a href="index.html">README</a></li>
<li><a href="LICENSE">LICENSE</a></li>
<li><a href="INSTALL.html">INSTALL</a></li>
<li><a href="user_manual.html">User Manual</a></li>
<li><a href="about.html">About</a></li>
<li><a href="https://github.com/caltechlibrary/cold">GitHub</a></li>
</ul>
</nav>
<section>
<h1 id="name">NAME</h1>
<p>cold_reports</p>
<h1 id="synopsis">SYNOPSIS</h1>
<p>cold_reports <a href="#options">OPTIONS</a> [REPORTS_YAML]</p>
<h1 id="description">DESCRIPTION</h1>
<p>cold_reports processes the report request queue. cold_reports is
expected to validate the report request, launch the report. The report
is responsible to writing it’s output to standard out which is read by
the cold_reports. cold_reports then renders the report to a known
location and updates the link data in the report request record.</p>
<p>REPORTS_YAML is the filename to read for configuring which reports
are allowed to run and what programs are executed as a result. If it is
not provided then “cold_reports.yaml” is looked for in the current
working directory.</p>
<p>cold_reports requires access to the COLD JSON API to manage report
requests.</p>
<p>Two example reports are provided in the COLD repository. Both are
written in Bash and require that dataset’s dsquery program are
available. The provided report examples are “run_people_csv.bash” and
“run_groups_csv.bash”.</p>
<p>Reports can be written in any langauge supported by the host system
or can be compiled programs. The primary requirement is that they write
their results to standard out so that the report runner can manage
making the reports available via the COLD web app.</p>
<p>cold_reports is designed as daemon suitable to run under systemd or
other service management system. Logging is written to standard output.
Included in the COLD repository is an example service file to use when
deploying cold_reports.</p>
<h1 id="options">OPTIONS</h1>
<dl>
<dt>help</dt>
<dd>
display help
</dd>
<dt>license</dt>
<dd>
display license
</dd>
<dt>version</dt>
<dd>
display version
</dd>
<dt>debug</dt>
<dd>
turn on debug logging
</dd>
</dl>
<h1 id="example">EXAMPLE</h1>
<p>Shown is starting cold_reports with an explicit configuration file,
“my_cold_reports.yaml” file, then run with the default configuration
file, “cold_reports.yaml” in the same working directory.</p>
<pre class="shell"><code>cold_reports my_cold_reports.yaml
cold_reports</code></pre>
</section>
<footer>
<span>© 2022 <a href="https://www.library.caltech.edu/copyright">Caltech Library</a></span>
<address>1200 E California Blvd, Mail Code 1-32, Pasadena, CA 91125-3200</address>
<span><a href="mailto:[email protected]">Email Us</a></span>
<span>Phone: <a href="tel:+1-626-395-3405">(626)395-3405</a></span>
</footer>
</body>
</html>