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>.
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
112 CREATE TABLE queue_arg (
113 argnum int primary key,
117 CREATE INDEX queue_arg1 ON queue_arg ( jobnum );
119 CREATE TABLE part_pop_local (
120 localnum int primary key,
122 city varchar(80) null,
124 npa char(3) not null,
127 CREATE UNIQUE INDEX part_pop_local1 ON part_pop_local ( npa, nxx );
129 CREATE TABLE cust_bill_event (
130 eventnum int primary key,
132 eventpart int not null,
135 CREATE UNIQUE INDEX cust_bill_event1 ON cust_bill_event ( eventpart, invnum );
136 CREATE INDEX cust_bill_event2 ON cust_bill_event ( invnum );
138 CREATE TABLE part_bill_event (
139 eventpart int primary key,
140 payby char(4) not null,
141 event varchar(80) not null,
145 plan varchar(80) null,
147 disabled char(1) null
149 CREATE INDEX part_bill_event1 ON part_bill_event ( payby );
151 CREATE TABLE part_export (
152 exportnum int primary key,
153 svcpart int not null,
154 machine varchar(80) not null,
155 exporttype varchar(80) not null,
156 nodomain char(1) NULL
158 CREATE INDEX part_export1 ON part_export ( machine );
159 CREATE INDEX part_export2 ON part_export ( exporttype );
161 CREATE INDEX part_export_option (
162 optionnum int primary key,
163 exportnum int not null,
164 option varchar(80) not null,
165 optionvalue text NULL
167 CREATE INDEX part_export_option1 ON part_export_option ( exportnum );
168 CREATE INDEX part_export_option2 ON part_export_option ( option );
170 ALTER TABLE svc_acct ADD domsvc integer NOT NULL;
171 ALTER TABLE svc_domain ADD catchall integer NULL;
172 ALTER TABLE cust_main ADD referral_custnum integer NULL;
173 ALTER TABLE cust_pay ADD custnum integer;
174 ALTER TABLE cust_pay_batch ADD paybatchnum integer;
175 ALTER TABLE cust_refund ADD custnum integer;
176 ALTER TABLE cust_pkg ADD manual_flag char(1) NULL;
177 ALTER TABLE part_pkg ADD plan varchar(80) NULL;
178 ALTER TABLE part_pkg ADD plandata text NULL;
179 ALTER TABLE part_pkg ADD setuptax char(1) NULL;
180 ALTER TABLE part_pkg ADD recurtax char(1) NULL;
181 ALTER TABLE part_pkg ADD disabled char(1) NULL;
182 ALTER TABLE part_svc ADD disabled char(1) NULL;
183 ALTER TABLE cust_bill ADD closed char(1) NULL;
184 ALTER TABLE cust_pay ADD closed char(1) NULL;
185 ALTER TABLE cust_credit ADD closed char(1) NULL;
186 ALTER TABLE cust_refund ADD closed char(1) NULL;
187 CREATE INDEX cust_main3 ON cust_main ( referral_custnum );
188 CREATE INDEX cust_credit_bill1 ON cust_credit_bill ( crednum );
189 CREATE INDEX cust_credit_bill2 ON cust_credit_bill ( invnum );
190 CREATE INDEX cust_bill_pay1 ON cust_bill_pay ( invnum );
191 CREATE INDEX cust_bill_pay2 ON cust_bill_pay ( paynum );
192 CREATE INDEX cust_credit_refund1 ON cust_credit_refund ( crednum );
193 CREATE INDEX cust_credit_refund2 ON cust_credit_refund ( refundnum );
194 CREATE UNIQUE INDEX cust_pay_batch_pkey ON cust_pay_batch ( paybatchnum );
195 CREATE UNIQUE INDEX part_svc_column1 ON part_svc_column ( svcpart, columnname );
196 CREATE INDEX cust_pay2 ON cust_pay ( paynum );
197 CREATE INDEX cust_pay3 ON cust_pay ( custnum );
198 CREATE INDEX cust_pay4 ON cust_pay ( paybatch );
201 <li>If you are using PostgreSQL, apply the following changes to your database:
203 CREATE UNIQUE INDEX agent_pkey ON agent ( agentnum );
204 CREATE UNIQUE INDEX agent_type_pkey ON agent_type ( typenum );
205 CREATE UNIQUE INDEX cust_bill_pkey ON cust_bill ( invnum );
206 CREATE UNIQUE INDEX cust_credit_pkey ON cust_credit ( crednum );
207 CREATE UNIQUE INDEX cust_main_pkey ON cust_main ( custnum );
208 CREATE UNIQUE INDEX cust_main_county_pkey ON cust_main_county ( taxnum );
209 CREATE UNIQUE INDEX cust_main_invoice_pkey ON cust_main_invoice ( destnum );
210 CREATE UNIQUE INDEX cust_pay_pkey ON cust_pay ( paynum );
211 CREATE UNIQUE INDEX cust_pkg_pkey ON cust_pkg ( pkgnum );
212 CREATE UNIQUE INDEX cust_refund_pkey ON cust_refund ( refundnum );
213 CREATE UNIQUE INDEX cust_svc_pkey ON cust_svc ( svcnum );
214 CREATE UNIQUE INDEX domain_record_pkey ON domain_record ( recnum );
215 CREATE UNIQUE INDEX nas_pkey ON nas ( nasnum );
216 CREATE UNIQUE INDEX part_pkg_pkey ON part_pkg ( pkgpart );
217 CREATE UNIQUE INDEX part_referral_pkey ON part_referral ( refnum );
218 CREATE UNIQUE INDEX part_svc_pkey ON part_svc ( svcpart );
219 CREATE UNIQUE INDEX port_pkey ON port ( portnum );
220 CREATE UNIQUE INDEX prepay_credit_pkey ON prepay_credit ( prepaynum );
221 CREATE UNIQUE INDEX session_pkey ON session ( sessionnum );
222 CREATE UNIQUE INDEX svc_acct_pkey ON svc_acct ( svcnum );
223 CREATE UNIQUE INDEX svc_acct_pop_pkey ON svc_acct_pop ( popnum );
224 CREATE UNIQUE INDEX svc_acct_sm_pkey ON svc_acct_sm ( svcnum );
225 CREATE UNIQUE INDEX svc_domain_pkey ON svc_domain ( svcnum );
226 CREATE UNIQUE INDEX svc_www_pkey ON svc_www ( svcnum );
227 CREATE UNIQUE INDEX type_pkgs_pkey ON type_pkgs ( typenum );
229 <li>If you wish to enable service/shipping addresses, apply the following
230 changes to your database:
232 ALTER TABLE cust_main ADD COLUMN ship_last varchar(80) NULL;
233 ALTER TABLE cust_main ADD COLUMN ship_first varchar(80) NULL;
234 ALTER TABLE cust_main ADD COLUMN ship_company varchar(80) NULL;
235 ALTER TABLE cust_main ADD COLUMN ship_address1 varchar(80) NULL;
236 ALTER TABLE cust_main ADD COLUMN ship_address2 varchar(80) NULL;
237 ALTER TABLE cust_main ADD COLUMN ship_city varchar(80) NULL;
238 ALTER TABLE cust_main ADD COLUMN ship_county varchar(80) NULL;
239 ALTER TABLE cust_main ADD COLUMN ship_state varchar(80) NULL;
240 ALTER TABLE cust_main ADD COLUMN ship_zip varchar(10) NULL;
241 ALTER TABLE cust_main ADD COLUMN ship_country char(2) NULL;
242 ALTER TABLE cust_main ADD COLUMN ship_daytime varchar(20) NULL;
243 ALTER TABLE cust_main ADD COLUMN ship_night varchar(20) NULL;
244 ALTER TABLE cust_main ADD COLUMN ship_fax varchar(12) NULL;
245 CREATE INDEX cust_main1 ON cust_main ( ship_last );
246 CREATE INDEX cust_main2 ON cust_main ( ship_company );
248 <li>If you wish to enable customer comments, apply the following change to
251 ALTER TABLE cust_main ADD COLUMN comments text NULL;
253 <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.
254 <li>Run bin/dbdef-create.
255 <li>If you have svc_acct_sm records or service definitions:
257 <li>Create a service definition with table svc_forward
258 <li>Run bin/fs-migrate-svc_acct_sm
260 <li>Run bin/fs-migrate-payref
261 <li>Run bin/fs-migrate-part_svc
262 <li><b>After running bin/fs-migrate-payref</b>, apply the following changes to your database:
263 <table border><tr><th>PostgreSQL</th><th>MySQL, others</th></tr>
266 CREATE TABLE cust_pay_temp (
267 paynum int primary key,
268 custnum int not null,
269 paid decimal(10,2) not null,
271 payby char(4) not null,
272 payinfo varchar(16) null,
273 paybatch varchar(80) null
275 INSERT INTO cust_pay_temp SELECT * from cust_pay;
277 ALTER TABLE cust_pay_temp RENAME TO cust_pay;
278 CREATE UNIQUE INDEX cust_pay1 ON cust_pay (paynum);
279 CREATE TABLE cust_refund_temp (
280 refundnum int primary key,
281 custnum int not null,
283 refund decimal(10,2) not null,
284 otaker varchar(8) not null,
285 reason varchar(80) not null,
286 payby char(4) not null,
287 payinfo varchar(16) null,
288 paybatch varchar(80) null
290 INSERT INTO cust_refund_temp SELECT * from cust_refund;
291 DROP TABLE cust_refund;
292 ALTER TABLE cust_refund_temp RENAME TO cust_refund;
293 CREATE UNIQUE INDEX cust_refund1 ON cust_refund (refundnum);
297 ALTER TABLE cust_pay DROP COLUMN invnum;
298 ALTER TABLE cust_refund DROP COLUMN crednum;
301 <li><b>IMPORTANT: After applying the second set of database changes</b>, run bin/dbdef-create again.
302 <li>set the <a href="../config/config.cgi#username_policy">user_policy configuration value</a> as appropriate for your site.
303 <li>Create the `/usr/local/etc/freeside/cache.<i>datasrc</i>' directory
304 (ownded by the freeside user).
305 <li>freeside-queued was installed with the Perl modules. Start it now and ensure that is run upon system startup.
306 <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.
307 <li>Use <a href="man/bin/freeside-daily.html">freeside-daily</a> instead of <a href="man/bin/freeside-bill.html">freeside-bill</a>.