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=Time-Duration">Time-Duration</a>, <a href="http://search.cpan.org/search?dist=Tie-IxHash">Tie-IxHash</a> and <a href="http://search.cpan.org/search?dist=HTML-Widgets-SelectLayers">HTML-Widgets-SelectLayers</a>.
11 <li>Install <a href="http://www.apache-asp.org/">Apache::ASP</a> or <a href="http://www.masonhq.com/">HTML::Mason</a>.
12 <li>Install <a href="http://rsync.samba.org/">rsync</a>
16 <th>Apache::ASP</th><th>Mason</th>
20 <li>Run <tt>make aspdocs</tt>
21 <li>Copy <tt>aspdocs/</tt> to your web server's document space.
22 <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>
23 <li>Copy <tt>htetc/global.asa</tt> to the Global directory.
24 <li>Configure Apache for the Global directory and to execute .cgi files using Apache::ASP. For example:
26 <Directory /usr/local/apache/htdocs/freeside-asp>
27 <Files ~ (\.cgi)>
28 AddHandler perl-script .cgi
29 PerlHandler Apache::ASP
32 $MLDBM::RemoveTaint = 1;
34 PerlSetVar Global /usr/local/etc/freeside/asp-global/
39 <li>Run <tt>make masondocs</tt>
40 <li>Copy <tt>masondocs/</tt> to your web server's document space.
41 <li>Copy <tt>htetc/handler.pl</tt> to your web server's configuration directory.
42 <li>Edit <tt>handler.pl</tt> and set an appropriate <tt>data_dir</tt>, such as <tt>/usr/local/etc/freeside/mason-data</tt>
43 <li>Configure Apache to use the <tt>handler.pl</tt> file and to execute .cgi files using HTML::Mason. For example:
45 <Directory /usr/local/apache/htdocs/freeside-mason>
46 <Files ~ (\.cgi)>
47 AddHandler perl-script .cgi
48 PerlHandler HTML::Mason
51 require "/usr/local/apache/conf/handler.pl";
59 <li>Build and install the Perl modules:
62 # make install-perl-modules</pre>
63 <li>Apply the following changes to your database:
65 CREATE TABLE svc_forward (
73 CREATE TABLE cust_credit_bill (
74 creditbillnum int primary key,
78 amount decimal(10,2) not null
81 CREATE TABLE cust_bill_pay (
82 billpaynum int primary key,
86 amount decimal(10,2) not null
89 CREATE TABLE cust_credit_refund (
90 creditrefundnum int primary key,
92 refundnum int not null,
94 amount decimal(10,2) not null
97 CREATE TABLE part_svc_column (
98 columnnum int primary key,
100 columnname varchar(64) not null,
101 columnvalue varchar(80) null,
102 columnflag char(1) null
106 jobnum int primary key,
109 status varchar(80) not null,
110 statustext text null,
113 CREATE INDEX queue1 ON queue ( svcnum );
114 CREATE INDEX queue2 ON queue ( status );
116 CREATE TABLE queue_arg (
117 argnum int primary key,
121 CREATE INDEX queue_arg1 ON queue_arg ( jobnum );
123 CREATE TABLE part_pop_local (
124 localnum int primary key,
126 city varchar(80) null,
128 npa char(3) not null,
131 CREATE UNIQUE INDEX part_pop_local1 ON part_pop_local ( npa, nxx );
133 CREATE TABLE cust_bill_event (
134 eventnum int primary key,
136 eventpart int not null,
139 CREATE UNIQUE INDEX cust_bill_event1 ON cust_bill_event ( eventpart, invnum );
140 CREATE INDEX cust_bill_event2 ON cust_bill_event ( invnum );
142 CREATE TABLE part_bill_event (
143 eventpart int primary key,
144 payby char(4) not null,
145 event varchar(80) not null,
149 plan varchar(80) null,
151 disabled char(1) null
153 CREATE INDEX part_bill_event1 ON part_bill_event ( payby );
155 CREATE TABLE export_svc (
156 exportsvcnum int primary key,
157 exportnum int not null,
160 CREATE UNIQUE INDEX export_svc1 ON export_svc ( exportnum, svcpart );
161 CREATE INDEX export_svc2 ON export_svc ( exportnum );
162 CREATE INDEX export_svc3 ON export_svc ( svcpart );
164 CREATE TABLE part_export (
165 exportnum int primary key,
166 machine varchar(80) not null,
167 exporttype varchar(80) not null,
168 nodomain char(1) NULL
170 CREATE INDEX part_export1 ON part_export ( machine );
171 CREATE INDEX part_export2 ON part_export ( exporttype );
173 CREATE TABLE part_export_option (
174 optionnum int primary key,
175 exportnum int not null,
176 optionname varchar(80) not null,
177 optionvalue text NULL
179 CREATE INDEX part_export_option1 ON part_export_option ( exportnum );
180 CREATE INDEX part_export_option2 ON part_export_option ( optionname );
182 CREATE TABLE radius_usergroup (
183 usergroupnum int primary key,
185 groupname varchar(80) not null
187 CREATE INDEX radius_usergroup1 ON radius_usergroup ( svcnum );
188 CREATE INDEX radius_usergroup2 ON radius_usergroup ( groupname );
190 CREATE TABLE msgcat (
191 msgnum int primary key,
192 msgcode varchar(80) not null,
193 locale varchar(16) not null,
196 CREATE INDEX msgcat1 ON msgcat ( msgcode, locale );
198 ALTER TABLE svc_acct ADD domsvc integer NOT NULL;
199 ALTER TABLE svc_domain ADD catchall integer NULL;
200 ALTER TABLE cust_main ADD referral_custnum integer NULL;
201 ALTER TABLE cust_pay ADD custnum integer;
202 ALTER TABLE cust_pay_batch ADD paybatchnum integer;
203 ALTER TABLE cust_refund ADD custnum integer;
204 ALTER TABLE cust_pkg ADD manual_flag char(1) NULL;
205 ALTER TABLE part_pkg ADD plan varchar(80) NULL;
206 ALTER TABLE part_pkg ADD plandata text NULL;
207 ALTER TABLE part_pkg ADD setuptax char(1) NULL;
208 ALTER TABLE part_pkg ADD recurtax char(1) NULL;
209 ALTER TABLE part_pkg ADD disabled char(1) NULL;
210 ALTER TABLE part_svc ADD disabled char(1) NULL;
211 ALTER TABLE cust_bill ADD closed char(1) NULL;
212 ALTER TABLE cust_pay ADD closed char(1) NULL;
213 ALTER TABLE cust_credit ADD closed char(1) NULL;
214 ALTER TABLE cust_refund ADD closed char(1) NULL;
215 ALTER TABLE cust_bill_event ADD status varchar(80);
216 ALTER TABLE cust_bill_event ADD statustext text NULL;
217 ALTER TABLE svc_acct ADD sec_phrase varchar(80) NULL;
218 CREATE INDEX cust_main3 ON cust_main ( referral_custnum );
219 CREATE INDEX cust_credit_bill1 ON cust_credit_bill ( crednum );
220 CREATE INDEX cust_credit_bill2 ON cust_credit_bill ( invnum );
221 CREATE INDEX cust_bill_pay1 ON cust_bill_pay ( invnum );
222 CREATE INDEX cust_bill_pay2 ON cust_bill_pay ( paynum );
223 CREATE INDEX cust_credit_refund1 ON cust_credit_refund ( crednum );
224 CREATE INDEX cust_credit_refund2 ON cust_credit_refund ( refundnum );
225 CREATE UNIQUE INDEX cust_pay_batch_pkey ON cust_pay_batch ( paybatchnum );
226 CREATE UNIQUE INDEX part_svc_column1 ON part_svc_column ( svcpart, columnname );
227 CREATE INDEX cust_pay2 ON cust_pay ( paynum );
228 CREATE INDEX cust_pay3 ON cust_pay ( custnum );
229 CREATE INDEX cust_pay4 ON cust_pay ( paybatch );
232 <li>If you are using PostgreSQL, apply the following changes to your database:
234 CREATE UNIQUE INDEX agent_pkey ON agent ( agentnum );
235 CREATE UNIQUE INDEX agent_type_pkey ON agent_type ( typenum );
236 CREATE UNIQUE INDEX cust_bill_pkey ON cust_bill ( invnum );
237 CREATE UNIQUE INDEX cust_credit_pkey ON cust_credit ( crednum );
238 CREATE UNIQUE INDEX cust_main_pkey ON cust_main ( custnum );
239 CREATE UNIQUE INDEX cust_main_county_pkey ON cust_main_county ( taxnum );
240 CREATE UNIQUE INDEX cust_main_invoice_pkey ON cust_main_invoice ( destnum );
241 CREATE UNIQUE INDEX cust_pay_pkey ON cust_pay ( paynum );
242 CREATE UNIQUE INDEX cust_pkg_pkey ON cust_pkg ( pkgnum );
243 CREATE UNIQUE INDEX cust_refund_pkey ON cust_refund ( refundnum );
244 CREATE UNIQUE INDEX cust_svc_pkey ON cust_svc ( svcnum );
245 CREATE UNIQUE INDEX domain_record_pkey ON domain_record ( recnum );
246 CREATE UNIQUE INDEX nas_pkey ON nas ( nasnum );
247 CREATE UNIQUE INDEX part_pkg_pkey ON part_pkg ( pkgpart );
248 CREATE UNIQUE INDEX part_referral_pkey ON part_referral ( refnum );
249 CREATE UNIQUE INDEX part_svc_pkey ON part_svc ( svcpart );
250 CREATE UNIQUE INDEX port_pkey ON port ( portnum );
251 CREATE UNIQUE INDEX prepay_credit_pkey ON prepay_credit ( prepaynum );
252 CREATE UNIQUE INDEX session_pkey ON session ( sessionnum );
253 CREATE UNIQUE INDEX svc_acct_pkey ON svc_acct ( svcnum );
254 CREATE UNIQUE INDEX svc_acct_pop_pkey ON svc_acct_pop ( popnum );
255 CREATE UNIQUE INDEX svc_acct_sm_pkey ON svc_acct_sm ( svcnum );
256 CREATE UNIQUE INDEX svc_domain_pkey ON svc_domain ( svcnum );
257 CREATE UNIQUE INDEX svc_www_pkey ON svc_www ( svcnum );
258 CREATE UNIQUE INDEX type_pkgs_pkey ON type_pkgs ( typenum );
260 <li>If you wish to enable service/shipping addresses, apply the following
261 changes to your database:
263 ALTER TABLE cust_main ADD COLUMN ship_last varchar(80) NULL;
264 ALTER TABLE cust_main ADD COLUMN ship_first varchar(80) NULL;
265 ALTER TABLE cust_main ADD COLUMN ship_company varchar(80) NULL;
266 ALTER TABLE cust_main ADD COLUMN ship_address1 varchar(80) NULL;
267 ALTER TABLE cust_main ADD COLUMN ship_address2 varchar(80) NULL;
268 ALTER TABLE cust_main ADD COLUMN ship_city varchar(80) NULL;
269 ALTER TABLE cust_main ADD COLUMN ship_county varchar(80) NULL;
270 ALTER TABLE cust_main ADD COLUMN ship_state varchar(80) NULL;
271 ALTER TABLE cust_main ADD COLUMN ship_zip varchar(10) NULL;
272 ALTER TABLE cust_main ADD COLUMN ship_country char(2) NULL;
273 ALTER TABLE cust_main ADD COLUMN ship_daytime varchar(20) NULL;
274 ALTER TABLE cust_main ADD COLUMN ship_night varchar(20) NULL;
275 ALTER TABLE cust_main ADD COLUMN ship_fax varchar(12) NULL;
276 CREATE INDEX cust_main1 ON cust_main ( ship_last );
277 CREATE INDEX cust_main2 ON cust_main ( ship_company );
279 <li>If you wish to enable customer comments, apply the following change to
282 ALTER TABLE cust_main ADD COLUMN comments text NULL;
284 <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.
285 <li>Run bin/dbdef-create.
286 <li>If you have svc_acct_sm records or service definitions:
288 <li>Create a service definition with table svc_forward
289 <li>Run bin/fs-migrate-svc_acct_sm
291 <li>Run bin/fs-migrate-payref
292 <li>Run bin/fs-migrate-part_svc
293 <li><b>After running bin/fs-migrate-payref</b>, apply the following changes to your database:
294 <table border><tr><th>PostgreSQL</th><th>MySQL, others</th></tr>
297 CREATE TABLE cust_pay_temp (
298 paynum int primary key,
299 custnum int not null,
300 paid decimal(10,2) not null,
302 payby char(4) not null,
303 payinfo varchar(16) null,
304 paybatch varchar(80) null
306 INSERT INTO cust_pay_temp SELECT * from cust_pay;
308 ALTER TABLE cust_pay_temp RENAME TO cust_pay;
309 CREATE UNIQUE INDEX cust_pay1 ON cust_pay (paynum);
310 CREATE TABLE cust_refund_temp (
311 refundnum int primary key,
312 custnum int not null,
314 refund decimal(10,2) not null,
315 otaker varchar(8) not null,
316 reason varchar(80) not null,
317 payby char(4) not null,
318 payinfo varchar(16) null,
319 paybatch varchar(80) null
321 INSERT INTO cust_refund_temp SELECT * from cust_refund;
322 DROP TABLE cust_refund;
323 ALTER TABLE cust_refund_temp RENAME TO cust_refund;
324 CREATE UNIQUE INDEX cust_refund1 ON cust_refund (refundnum);
328 ALTER TABLE cust_pay DROP COLUMN invnum;
329 ALTER TABLE cust_refund DROP COLUMN crednum;
332 <li><b>IMPORTANT: After applying the second set of database changes</b>, run bin/dbdef-create again.
333 <li><b>IMPORTANT</b>: run bin/create-history-tables
334 <li><b>IMPORTANT: After running bin/create-history-tables</b>, run bin/dbdef-create again.
335 <li>set the <a href="../config/config.cgi#username_policy">user_policy configuration value</a> as appropriate for your site.
336 <li>set the <a href="../config/config.cgi#locale">locale configuration value</a> to en_US.
337 <li>the mxmachines, nsmachines, arecords and cnamerecords configuration values have been deprecated. Set the <a href="../config/config.cgi#defaultrecords">defaultrecords configuration value</a> instead.
338 <li>Create the `/usr/local/etc/freeside/cache.<i>datasrc</i>' directory
339 (owned by the freeside user).
340 <li>freeside-queued was installed with the Perl modules. Start it now and ensure that is run upon system startup.
341 <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.
342 <li>Use <a href="man/bin/freeside-daily.html">freeside-daily</a> instead of <a href="man/bin/freeside-bill.html">freeside-bill</a>.
343 <li>If you would like Freeside to notify your customers when their credit
344 cards and other billing arrangements are about to expire, arrange for
345 <b>freeside-expiration-alerter</b> to be run daily by cron or similar
346 facility. The message it sends can be configured from the
347 <u>Configuration</u> choice of the main menu as <u>alerter_template</u>.
348 <li>Export has been rewritten. If you were using the icradiusmachines,
349 icradius_mysqldest, icradius_mysqlsource, or icradius_secrets files, add
350 an appropriate "sqlradius" export to all relevant Service Definitions
351 instead. Use <a href="http://www.mysql.com/documentation/mysql/bychapter/manual_MySQL_Database_Administration.html#Replication">MySQL replication</a> or
352 point the "sqlradius" export directly at your external ICRADIUS or FreeRADIUS
353 database (or through an SSL-necrypting proxy...)