2 <title>Upgrading to 1.4.0</title>
5 <h1>Upgrading to 1.4.0 from 1.3.1</h1>
7 <li>If migrating from less than 1.3.1, see these <a href="upgrade7.html">instructions</a> first.
8 <li><font size="+2" color="#ff0000">Backup your database and current Freeside installation.</font> (with <a href="http://www.ca.postgresql.org/devel-corner/docs/postgres/backup.html">PostgreSQL</a>) (with <a href="http://www.mysql.com/documentation/mysql/bychapter/manual_MySQL_Database_Administration.html#Backup">MySQL</a>)
9 <li><a href="http://perl.apache.org/">mod_perl</a> is now required.
10 <li>Install <a href="http://search.cpan.org/search?dist=Archive-Tar">Archive-Tar</a>, <a href="http://search.cpan.org/search?dist=Time-Duration">Time-Duration</a>, and <a href="http://search.cpan.org/search?dist=Tie-IxHash">Tie-IxHash</a>
11 <li>Install <a href="http://www.apache-asp.org/">Apache::ASP</a> or <a href="http://www.masonhq.com/">HTML::Mason</a>.
15 <th>Apache::ASP</th><th>Mason</th>
19 <li>Run <tt>make aspdocs</tt>
20 <li>Copy <tt>aspdocs/</tt> to your web server's document space.
21 <li>Create a <a href="http://www.apache-asp.org/config.html#Global">Global</a> directory, such as <tt>/usr/local/etc/freeside/asp-global/</tt>
22 <li>Copy <tt>htetc/global.asa</tt> to the Global directory.
23 <li>Configure Apache for the Global directory and to execute .cgi files using Apache::ASP. For example:
25 <Directory /usr/local/apache/htdocs/freeside-asp>
26 <Files ~ (\.cgi)>
27 AddHandler perl-script .cgi
28 PerlHandler Apache::ASP
31 $MLDBM::RemoveTaint = 1;
33 PerlSetVar Global /usr/local/etc/freeside/asp-global/
38 <li>Run <tt>make masondocs</tt>
39 <li>Copy <tt>masondocs/</tt> to your web server's document space.
40 <li>Copy <tt>htetc/handler.pl</tt> to your web server's configuration directory.
41 <li>Edit <tt>handler.pl</tt> and set an appropriate <tt>data_dir</tt>, such as <tt>/usr/local/etc/freeside/mason-data</tt>
42 <li>Configure Apache to use the <tt>handler.pl</tt> file and to execute .cgi files using HTML::Mason. For example:
44 <Directory /usr/local/apache/htdocs/freeside-mason>
45 <Files ~ (\.cgi)>
46 AddHandler perl-script .cgi
47 PerlHandler HTML::Mason
50 require "/usr/local/apache/conf/handler.pl";
58 <li>Build and install the Perl modules:
61 # make install-perl-modules</pre>
62 <li>Apply the following changes to your database:
64 CREATE TABLE svc_forward (
72 CREATE TABLE cust_credit_bill (
73 creditbillnum int primary key,
77 amount decimal(10,2) not null
80 CREATE TABLE cust_bill_pay (
81 billpaynum int primary key,
85 amount decimal(10,2) not null
88 CREATE TABLE cust_credit_refund (
89 creditrefundnum int primary key,
91 refundnum int not null,
93 amount decimal(10,2) not null
96 CREATE TABLE part_svc_column (
97 columnnum int primary key,
99 columnname varchar(64) not null,
100 columnvalue varchar(80) null,
101 columnflag char(1) null
105 jobnum int primary key,
108 status varchar(80) not null
111 CREATE TABLE queue_arg (
112 argnum int primary key,
116 CREATE INDEX queue_arg1 ON queue_arg ( jobnum );
118 CREATE TABLE part_pop_local (
119 localnum int primary key,
121 city varchar(80) null,
123 npa char(3) not null,
126 CREATE UNIQUE INDEX part_pop_local1 ON part_pop_local ( npa, nxx );
128 CREATE TABLE cust_bill_event (
129 eventnum int primary key,
131 eventpart int not null,
134 CREATE UNIQUE INDEX cust_bill_event1 ON cust_bill_event ( eventpart, invnum );
135 CREATE INDEX cust_bill_event2 ON cust_bill_event ( invnum );
137 CREATE TABLE part_bill_event (
138 eventpart int primary key,
139 payby char(4) not null,
140 event varchar(80) not null,
144 plan varchar(80) null,
146 disabled char(1) null
148 CREATE INDEX part_bill_event1 ON part_bill_event ( payby );
150 CREATE TABLE part_export (
151 exportnum int primary key,
152 svcpart int not null,
153 machine varchar(80) not null,
154 exporttype varchar(80) not null,
155 nodomain char(1) NULL
157 CREATE INDEX part_export1 ON part_export ( machine );
158 CREATE INDEX part_export2 ON part_export ( exporttype );
160 CREATE INDEX part_export_option (
161 optionnum int primary key,
162 exportnum int not null,
163 option varchar(80) not null,
164 optionvalue text NULL
166 CREATE INDEX part_export_option1 ON part_export_option ( exportnum );
167 CREATE INDEX part_export_option2 ON part_export_option ( option );
169 ALTER TABLE svc_acct ADD domsvc integer NOT NULL;
170 ALTER TABLE svc_domain ADD catchall integer NULL;
171 ALTER TABLE cust_main ADD referral_custnum integer NULL;
172 ALTER TABLE cust_pay ADD custnum integer;
173 ALTER TABLE cust_pay_batch ADD paybatchnum integer;
174 ALTER TABLE cust_refund ADD custnum integer;
175 ALTER TABLE cust_pkg ADD manual_flag char(1) NULL;
176 ALTER TABLE part_pkg ADD plan varchar(80) NULL;
177 ALTER TABLE part_pkg ADD plandata text NULL;
178 ALTER TABLE part_pkg ADD setuptax char(1) NULL;
179 ALTER TABLE part_pkg ADD recurtax char(1) NULL;
180 ALTER TABLE part_pkg ADD disabled char(1) NULL;
181 ALTER TABLE part_svc ADD disabled char(1) NULL;
182 ALTER TABLE cust_bill ADD closed char(1) NULL;
183 ALTER TABLE cust_pay ADD closed char(1) NULL;
184 ALTER TABLE cust_credit ADD closed char(1) NULL;
185 ALTER TABLE cust_refund ADD closed char(1) NULL;
186 CREATE INDEX cust_main3 ON cust_main ( referral_custnum );
187 CREATE INDEX cust_credit_bill1 ON cust_credit_bill ( crednum );
188 CREATE INDEX cust_credit_bill2 ON cust_credit_bill ( invnum );
189 CREATE INDEX cust_bill_pay1 ON cust_bill_pay ( invnum );
190 CREATE INDEX cust_bill_pay2 ON cust_bill_pay ( paynum );
191 CREATE INDEX cust_credit_refund1 ON cust_credit_refund ( crednum );
192 CREATE INDEX cust_credit_refund2 ON cust_credit_refund ( refundnum );
193 CREATE UNIQUE INDEX cust_pay_batch_pkey ON cust_pay_batch ( paybatchnum );
194 CREATE UNIQUE INDEX part_svc_column1 ON part_svc_column ( svcpart, columnname );
195 CREATE INDEX cust_pay2 ON cust_pay ( paynum );
196 CREATE INDEX cust_pay3 ON cust_pay ( custnum );
197 CREATE INDEX cust_pay4 ON cust_pay ( paybatch );
200 <li>If you are using PostgreSQL, apply the following changes to your database:
202 CREATE UNIQUE INDEX agent_pkey ON agent ( agentnum );
203 CREATE UNIQUE INDEX agent_type_pkey ON agent_type ( typenum );
204 CREATE UNIQUE INDEX cust_bill_pkey ON cust_bill ( invnum );
205 CREATE UNIQUE INDEX cust_credit_pkey ON cust_credit ( crednum );
206 CREATE UNIQUE INDEX cust_main_pkey ON cust_main ( custnum );
207 CREATE UNIQUE INDEX cust_main_county_pkey ON cust_main_county ( taxnum );
208 CREATE UNIQUE INDEX cust_main_invoice_pkey ON cust_main_invoice ( destnum );
209 CREATE UNIQUE INDEX cust_pay_pkey ON cust_pay ( paynum );
210 CREATE UNIQUE INDEX cust_pkg_pkey ON cust_pkg ( pkgnum );
211 CREATE UNIQUE INDEX cust_refund_pkey ON cust_refund ( refundnum );
212 CREATE UNIQUE INDEX cust_svc_pkey ON cust_svc ( svcnum );
213 CREATE UNIQUE INDEX domain_record_pkey ON domain_record ( recnum );
214 CREATE UNIQUE INDEX nas_pkey ON nas ( nasnum );
215 CREATE UNIQUE INDEX part_pkg_pkey ON part_pkg ( pkgpart );
216 CREATE UNIQUE INDEX part_referral_pkey ON part_referral ( refnum );
217 CREATE UNIQUE INDEX part_svc_pkey ON part_svc ( svcpart );
218 CREATE UNIQUE INDEX port_pkey ON port ( portnum );
219 CREATE UNIQUE INDEX prepay_credit_pkey ON prepay_credit ( prepaynum );
220 CREATE UNIQUE INDEX session_pkey ON session ( sessionnum );
221 CREATE UNIQUE INDEX svc_acct_pkey ON svc_acct ( svcnum );
222 CREATE UNIQUE INDEX svc_acct_pop_pkey ON svc_acct_pop ( popnum );
223 CREATE UNIQUE INDEX svc_acct_sm_pkey ON svc_acct_sm ( svcnum );
224 CREATE UNIQUE INDEX svc_domain_pkey ON svc_domain ( svcnum );
225 CREATE UNIQUE INDEX svc_www_pkey ON svc_www ( svcnum );
226 CREATE UNIQUE INDEX type_pkgs_pkey ON type_pkgs ( typenum );
228 <li>If you wish to enable service/shipping addresses, apply the following
229 changes to your database:
231 ALTER TABLE cust_main ADD COLUMN ship_last varchar(80) NULL;
232 ALTER TABLE cust_main ADD COLUMN ship_first varchar(80) NULL;
233 ALTER TABLE cust_main ADD COLUMN ship_company varchar(80) NULL;
234 ALTER TABLE cust_main ADD COLUMN ship_address1 varchar(80) NULL;
235 ALTER TABLE cust_main ADD COLUMN ship_address2 varchar(80) NULL;
236 ALTER TABLE cust_main ADD COLUMN ship_city varchar(80) NULL;
237 ALTER TABLE cust_main ADD COLUMN ship_county varchar(80) NULL;
238 ALTER TABLE cust_main ADD COLUMN ship_state varchar(80) NULL;
239 ALTER TABLE cust_main ADD COLUMN ship_zip varchar(10) NULL;
240 ALTER TABLE cust_main ADD COLUMN ship_country char(2) NULL;
241 ALTER TABLE cust_main ADD COLUMN ship_daytime varchar(20) NULL;
242 ALTER TABLE cust_main ADD COLUMN ship_night varchar(20) NULL;
243 ALTER TABLE cust_main ADD COLUMN ship_fax varchar(12) NULL;
244 CREATE INDEX cust_main1 ON cust_main ( ship_last );
245 CREATE INDEX cust_main2 ON cust_main ( ship_company );
247 <li>If you wish to enable customer comments, apply the following change to
250 ALTER TABLE cust_main ADD COLUMN comments text NULL;
252 <li>If you are using the signup server, reinstall it according to the <a href="signup.html">instructions</a>. The 1.3.x signup server is not compatible with 1.4.x.
253 <li>Run bin/dbdef-create.
254 <li>If you have svc_acct_sm records or service definitions:
256 <li>Create a service definition with table svc_forward
257 <li>Run bin/fs-migrate-svc_acct_sm
259 <li>Run bin/fs-migrate-payref
260 <li>Run bin/fs-migrate-part_svc
261 <li><b>After running bin/fs-migrate-payref</b>, apply the following changes to your database:
262 <table border><tr><th>PostgreSQL</th><th>MySQL, others</th></tr>
265 CREATE TABLE cust_pay_temp (
266 paynum int primary key,
267 custnum int not null,
268 paid decimal(10,2) not null,
270 payby char(4) not null,
271 payinfo varchar(16) null,
272 paybatch varchar(80) null
274 INSERT INTO cust_pay_temp SELECT * from cust_pay;
276 ALTER TABLE cust_pay_temp RENAME TO cust_pay;
277 CREATE UNIQUE INDEX cust_pay1 ON cust_pay (paynum);
278 CREATE TABLE cust_refund_temp (
279 refundnum int primary key,
280 custnum int not null,
282 refund decimal(10,2) not null,
283 otaker varchar(8) not null,
284 reason varchar(80) not null,
285 payby char(4) not null,
286 payinfo varchar(16) null,
287 paybatch varchar(80) null
289 INSERT INTO cust_refund_temp SELECT * from cust_refund;
290 DROP TABLE cust_refund;
291 ALTER TABLE cust_refund_temp RENAME TO cust_refund;
292 CREATE UNIQUE INDEX cust_refund1 ON cust_refund (refundnum);
296 ALTER TABLE cust_pay DROP COLUMN invnum;
297 ALTER TABLE cust_refund DROP COLUMN crednum;
300 <li><b>IMPORTANT: After applying the second set of database changes</b>, run bin/dbdef-create again.
301 <li>set the <a href="../config/config.cgi#username_policy">user_policy configuration value</a> as appropriate for your site.
302 <li>Create the `/usr/local/etc/freeside/cache.<i>datasrc</i>' directory
303 (ownded by the freeside user).
304 <li>freeside-queued was installed with the Perl modules. Start it now and ensure that is run upon system startup.
305 <li>Set appropriate <a href="../browse/part_bill_event.cgi">invoice events</a> for your site. At the very least, you'll want to set some invoice events "<i>After 0 days</i>": a <i>BILL</i> invoice event to print invoices, a <i>CARD</i> invoice event to batch or run cards real-time, and a <i>COMP</i> invoice event to "pay" complimentary customers. If you were using the <i>-i</i> option to <a href="man/bin/freeside-bill.html">freeside-bill</a> it should be removed.
306 <li>Use <a href="man/bin/freeside-daily.html">freeside-daily</a> instead of <a href="man/bin/freeside-bill.html">freeside-bill</a>.