summaryrefslogtreecommitdiff
path: root/httemplate/docs
diff options
context:
space:
mode:
Diffstat (limited to 'httemplate/docs')
-rw-r--r--httemplate/docs/install.html4
-rw-r--r--httemplate/docs/schema.html23
-rw-r--r--httemplate/docs/upgrade8.html19
3 files changed, 44 insertions, 2 deletions
diff --git a/httemplate/docs/install.html b/httemplate/docs/install.html
index 1529c648e..4bf7b44ea 100644
--- a/httemplate/docs/install.html
+++ b/httemplate/docs/install.html
@@ -109,9 +109,11 @@ require "/usr/local/apache/conf/handler.pl";
<ul>
<li>Restrict access to this web interface. (with <a href="http://httpd.apache.org/docs/misc/FAQ.html#user-authentication">Apache</a>)
<li>Create the necessary <a href="config.html">configuration files</a>.
-<li>Create the `/usr/local/etc/freeside/counters.<i>datasrc</i>', and
+<li>Create the `/usr/local/etc/freeside/counters.<i>datasrc</i>',
+ `/usr/local/etc/freeside/cache.<i>datasrc</i>', and
`/usr/local/etc/freeside/export.<i>datasrc</i>' directories for each <i>datasrc</i> (owned by the freeside user).
<li>As the freeside user, run bin/fs-setup to create the database tables.
+ <li>freeside-queued was installed with the Perl modules. Start it now and ensure that is run upon system startup.
<li>Now proceed to the initial <a href="admin.html">administration</a> of your installation.
</ul>
</body>
diff --git a/httemplate/docs/schema.html b/httemplate/docs/schema.html
index 32c365ec3..e3fe98096 100644
--- a/httemplate/docs/schema.html
+++ b/httemplate/docs/schema.html
@@ -43,6 +43,14 @@
<li>otaker - order taker
<li>reason
</ul>
+ <li><a name="cust_credit_bill" href="man/FS/cust_credit_bill.html">cust_credit_bill</a> - Credit invoice application. Links a credit to an invoice.
+ <ul>
+ <li>creditbillnum - primary key
+ <li>crednum - <a href="#cust_credit">credit</a> being applied
+ <li>invnum - <a href="#cust_bill">invoice</a> to which credit is applied
+ <li>amount - amount applied
+ <li>_date
+ </ul>
<li><a name="cust_main" href="man/FS/cust_main.html">cust_main</a> - Customers
<ul>
<li>custnum - primary key
@@ -81,6 +89,8 @@
<li>payname - billing name (name on card)
<li>tax - tax exempt, Y or null
<li>otaker - order taker
+ <li>referral_custnum
+ <li>comments
</ul>
(columns in <i>italics</i> are optional)
<li><a name="cust_main_invoice" href="man/FS/cust_main_invoice.html">cust_main_invoice</a> - Invoice destinations for email invoices. Note that a customer can have many email destinations for their invoice (either literal or via svcnum), but only one postal destination.
@@ -302,5 +312,18 @@
<li>typenum - <a href="#agent_type">agent type</a>
<li>pkgpart - <a href="#part_pkg">Package definition</a>
</ul>
+ <li><a name="queue" href="man/FS/queue.html">queue</a> - job queue
+ <ul>
+ <li>jobnum - primary key
+ <li>job
+ <li>_date
+ <li>status
+ </ul>
+ <li><a name="queue_arg" href="man/FS/queue_arg.html">queue_arg</a> - job arguments
+ <ul>
+ <li>argnum - primary key
+ <li>jobnum - <a href="#queue">job</a>
+ <li>arg - argument
+ </ul>
</ul>
</body>
diff --git a/httemplate/docs/upgrade8.html b/httemplate/docs/upgrade8.html
index 67b0e5fe1..d86adc046 100644
--- a/httemplate/docs/upgrade8.html
+++ b/httemplate/docs/upgrade8.html
@@ -103,6 +103,19 @@ CREATE TABLE part_svc_column (
columnflag char(1) null
);
+CREATE TABLE queue (
+ jobnum int primary key,
+ job varchar not null,
+ _date int not null,
+ status varchar(80) not null
+);
+
+CREATE TABLE queue_arg (
+ argnum int primary key,
+ jobnum int not null,
+ arg varchar null
+);
+CREATE INDEX queue_arg1 ON queue_arg ( jobnum );
ALTER TABLE svc_acct ADD domsvc integer NOT NULL;
ALTER TABLE svc_domain ADD catchall integer NULL;
@@ -217,5 +230,9 @@ ALTER TABLE cust_refund DROP COLUMN crednum;
</pre></font>
</td></tr></table>
<li><b>IMPORTANT: After applying the second set of database changes</b>, run bin/dbdef-create again.
- <li>create the conf.dbsrc/user_policy as appropriate for your site
+ <li>create the <a href="config.html#username_policy">user_policy configuration file</a> as appropriate for your site.
+ <li>Create the `/usr/local/etc/freeside/cache.<i>datasrc</i>' directory
+ (ownded by the freeside user).
+ <li>freeside-queued was installed with the Perl modules. Start it now and ensure that is run upon system startup.
+</ul>
</body>