3d19906a7584add7844e31df6ce54b43e35cd0aa
[freeside.git] / httemplate / docs / upgrade10.html
1 <pre>
2 this is incomplete
3
4 install DBD::Pg 1.32 (or, if you're using a Perl version before 5.6, you could try installing DBD::Pg 1.22 with <a href="http://420.am/~ivan/DBD-Pg-1.22-fixvercmp.patch">this patch</a> and commenting out the "use DBD::Pg 1.32" at the top of DBIx/DBSchema/DBD/Pg.pm)
5 install DBIx::DBSchema 0.23
6 install Net::SSH 0.08
7 - If using Apache::ASP, add PerlSetVar RequestBinaryRead Off and PerlSetVar IncludesDir /your/freeside/document/root/ to your Apache configuration and make sure you are using Apache::ASP minimum version 2.55.
8 - In httpd.conf, change &lt;Files ~ \.cgi&gt; to  &lt;Files ~ (\.cgi|\.html)&gt;
9 - In httpd.conf, change <b>AddHandler perl-script .cgi</b> or <b>SetHandler perl-script</b> to <b>AddHandler perl-script .cgi .html</b>
10
11 install NetAddr::IP, Chart::Base, Locale::SubCountry, 
12 JavaScript::RPC (JavaScript::RPC::Server::CGI), Text::CSV_XS, 
13 Spreadsheet::WriteExcel, IO-stringy (IO::Scalar) and Frontier::RPC
14 <!-- and Crypt::YAPassGen-->
15
16 INSERT INTO msgcat ( msgnum, msgcode, locale, msg ) VALUES ( 20, 'svc_external-id', 'en_US', 'External ID' );
17 INSERT INTO msgcat ( msgnum, msgcode, locale, msg ) VALUES ( 21, 'svc_external-title', 'en_US', 'Title' );
18
19 CREATE TABLE cust_bill_pkg_detail (
20   detailnum serial,
21   pkgnum int NOT NULL,
22   invnum int NOT NULL,
23   detail varchar(80),
24   PRIMARY KEY (detailnum)
25 );
26 CREATE INDEX cust_bill_pkg_detail1 ON cust_bill_pkg_detail ( pkgnum, invnum );
27
28 CREATE TABLE part_virtual_field (
29   vfieldpart int NOT NULL,
30   dbtable varchar(32) NOT NULL,
31   name varchar(32) NOT NULL,
32   check_block text,
33   list_source text,
34   length integer,
35   label varchar(80),
36   PRIMARY KEY (vfieldpart)
37 );
38
39 CREATE TABLE virtual_field (
40   recnum integer NOT NULL,
41   vfieldpart integer NOT NULL,
42   value varchar(128) NOT NULL,
43   PRIMARY KEY (vfieldpart, recnum)
44 );
45
46 CREATE TABLE router (
47   routernum serial,
48   routername varchar(80),
49   svcnum int,
50   PRIMARY KEY (routernum)
51 );
52
53 CREATE TABLE part_svc_router (
54   svcpart int NOT NULL,
55   routernum int NOT NULL
56 );
57
58 CREATE TABLE addr_block (
59   blocknum serial,
60   routernum int NOT NULL,
61   ip_gateway varchar(15) NOT NULL,
62   ip_netmask int NOT NULL,
63   PRIMARY KEY (blocknum)
64 );
65 CREATE UNIQUE INDEX addr_block1 ON addr_block ( blocknum, routernum );
66
67 CREATE TABLE svc_broadband (
68   svcnum int NOT NULL,
69   blocknum int NOT NULL,
70   speed_up int NOT NULL,
71   speed_down int NOT NULL,
72   ip_addr varchar(15),
73   PRIMARY KEY (svcnum)
74 );
75
76 CREATE TABLE acct_snarf (
77   snarfnum serial,
78   svcnum int NOT NULL,
79   machine varchar(255) NULL,
80   protocol varchar(80) NULL,
81   username varchar(80) NULL,
82   _password varchar(80) NULL,
83   PRIMARY KEY (snarfnum)
84 );
85 CREATE INDEX acct_snarf1 ON acct_snarf ( svcnum );
86
87 CREATE TABLE svc_external (
88   svcnum int NOT NULL,
89   id int,
90   title varchar(80),
91   PRIMARY KEY (svcnum)
92 );
93
94 CREATE TABLE part_pkg_temp (
95     pkgpart serial NOT NULL,
96     pkg varchar(80) NOT NULL,
97     "comment" varchar(80) NOT NULL,
98     setup text NULL,
99     freq varchar(80) NOT NULL,
100     recur text NULL,
101     setuptax char(1) NULL,
102     recurtax char(1) NULL,
103     plan varchar(80) NULL,
104     plandata text NULL,
105     disabled char(1) NULL,
106     taxclass varchar(80) NULL,
107     PRIMARY KEY (pkgpart)
108 );
109 INSERT INTO part_pkg_temp SELECT * from part_pkg;
110 DROP TABLE part_pkg;
111 ALTER TABLE part_pkg_temp RENAME TO part_pkg;
112 CREATE INDEX part_pkg1 ON part_pkg(disabled);
113
114 On modern Pg:
115 ALTER TABLE part_pkg DROP CONSTRAINT part_pkg_temp_pkey;
116 ALTER TABLE part_pkg ADD PRIMARY KEY (pkgpart);
117 select setval('public.part_pkg_temp_pkgpart_seq', ( select max(pkgpart) from part_pkg) );
118
119 Or on Pg versions that don't support DROP CONSTRAINT and ADD PRIMARY KEY (tested on 7.1 and 7.2 so far):
120 DROP INDEX part_pkg_temp_pkey;
121 CREATE UNIQUE INDEX part_pkg_pkey ON part_pkg (pkgpart);
122 probably this one?: select setval('part_pkg_temp_pkgpart_seq', ( select max(pkgpart) from part_pkg) );
123 probably not this one?: select setval('part_pkg_pkgpart_seq', ( select max(pkgpart) from part_pkg) );
124
125 CREATE TABLE h_part_pkg_temp (
126     historynum serial NOT NULL,
127     history_date int,
128     history_user varchar(80) NOT NULL,
129     history_action varchar(80) NOT NULL,
130     pkgpart int NOT NULL,
131     pkg varchar(80) NOT NULL,
132     "comment" varchar(80) NOT NULL,
133     setup text NULL,
134     freq varchar(80) NOT NULL,
135     recur text NULL,
136     setuptax char(1) NULL,
137     recurtax char(1) NULL,
138     plan varchar(80) NULL,
139     plandata text NULL,
140     disabled char(1) NULL,
141     taxclass varchar(80) NULL,
142     PRIMARY KEY (historynum)
143 );
144 INSERT INTO h_part_pkg_temp SELECT * from h_part_pkg;
145 DROP TABLE h_part_pkg;
146 ALTER TABLE h_part_pkg_temp RENAME TO h_part_pkg;
147 CREATE INDEX h_part_pkg1 ON h_part_pkg(disabled);
148
149 On modern Pg:
150 ALTER TABLE h_part_pkg DROP CONSTRAINT h_part_pkg_temp_pkey;
151 ALTER TABLE h_part_pkg ADD PRIMARY KEY (historynum);
152 select setval('public.h_part_pkg_temp_historynum_seq', ( select max(historynum) from h_part_pkg) );
153
154 Or on Pg versions that don't support DROP CONSTRAINT and ADD PRIMARY KEY (tested on 7.1 and 7.2 so far):
155 DROP INDEX h_part_pkg_temp_pkey;
156 CREATE UNIQUE INDEX h_part_pkg_pkey ON h_part_pkg (historynum);
157 probably this one?: select setval('h_part_pkg_temp_historynum_seq', ( select max(historynum) from h_part_pkg) );
158 probably not this one?: select setval('h_part_pkg_historynum_seq', ( select max(historynum) from h_part_pkg) );
159
160 CREATE TABLE cust_pay_refund (
161     payrefundnum serial NOT NULL,
162     paynum int NOT NULL,
163     refundnum int NOT NULL,
164     _date int NOT NULL,
165     amount decimal(10,2) NOT NULL,
166     PRIMARY KEY (payrefundnum)
167 );
168 CREATE INDEX cust_pay_refund1 ON cust_pay_refund(paynum);
169 CREATE INDEX cust_pay_refund2 ON cust_pay_refund(refundnum);
170
171 CREATE TABLE cust_pay_void (
172   paynum int NOT NULL,
173   custnum int NOT NULL,
174   paid decimal(10,2) NOT NULL,
175   _date int,
176   payby char(4) NOT NULL,
177   payinfo varchar(80),
178   paybatch varchar(80),
179   closed char(1),
180   void_date int,
181   reason varchar(80),
182   otaker varchar(32) NOT NULL,
183   PRIMARY KEY (paynum)
184 );
185 CREATE INDEX cust_pay_void1 ON cust_pay_void(custnum);
186
187 CREATE TABLE part_pkg_option (
188   optionnum int primary key,
189   pkgpart int not null,
190   optionname varchar(80) not null,
191   optionvalue text NULL
192 );
193 CREATE INDEX part_pkg_option1 ON part_export_option ( pkgpart );
194 CREATE INDEX part_pkg_option2 ON part_export_option ( optionname );
195
196 CREATE TABLE rate (
197     ratenum serial NOT NULL,
198     reatename varchar(80) NOT NULL,
199     PRIMARY KEY (ratenum)
200 );
201
202 CREATE TABLE rate_detail (
203     ratenum int NOT NULL,
204     orig_regionnum int NULL,
205     dest_regionnum int NOT NULL,
206     min_included int NOT NULL,
207     min_charge decimal(10,2) NOT NULL,
208     sec_granularity int NOT NULL
209 );
210 CREATE UNIQUE INDEX rate_detail1 ON rate_detail ( ratenum, orig_regionnum, dest_regionnum );
211
212 CREATE TABLE rate_region (
213     regionnum serial NOT NULL,
214     regionname varchar(80) NOT NULL,
215     PRIMARY KEY (regionnum)
216 );
217
218 CREATE TABLE rate_prefix (
219     prefixnum serial NOT NULL,
220     regionnum int NOT NULL, 
221     countrycode varchar(3) NOT NULL,
222     npa varchar(6) NULL,
223     nxx varchar(3) NULL,
224     PRIMARY KEY (prefixnum)
225 );
226 CREATE INDEX rate_prefix1 ON rate_prefix ( countrycode );
227 CREATE INDEX rate_prefix2 ON rate_prefix ( regionnum );
228
229 CREATE TABLE reg_code (
230     codenum serial NOT NULL,
231     code varchar(80) NOT NULL,
232     agentnum int NOT NULL,
233     PRIMARY KEY (codenum)
234 );
235 CREATE UNIQUE INDEX reg_code1 ON reg_code ( agentnum, code );
236 CREATE INDEX reg_code2 ON reg_code ( agentnum );
237
238 CREATE TABLE reg_code_pkg (
239     codenum int NOT NULL,
240     pkgpart int NOT NULL
241 );
242 CREATE UNIQUE INDEX reg_code_pkg1 ON reg_code_pkg ( codenum, pkgpart );
243 CREATE INDEX reg_code_pkg2 ON reg_code_pkg ( codenum );
244
245 CREATE TABLE clientapi_session (
246     sessionnum serial NOT NULL,
247     sessionid varchar(80) NOT NULL,
248     namespace varchar(80) NOT NULL,
249     PRIMARY KEY (sessionnum)
250 );
251 CREATE UNIQUE INDEX clientapi_session1 ON clientapi_session ( sessionid, namespace );
252
253 CREATE TABLE clientapi_session_field (
254     fieldnum serial NOT NULL,
255     sessionnum int NOT NULL,
256     fieldname varchar(80) NOT NULL,
257     fieldvalue text NULL,
258     PRIMARY KEY (fieldnum)
259 );
260 CREATE UNIQUE INDEX clientapi_session_field1 ON clientapi_session_field ( sessionnum, fieldname );
261
262 DROP INDEX cust_bill_pkg1;
263
264 ALTER TABLE cust_bill_pkg ADD itemdesc varchar(80) NULL;
265 ALTER TABLE h_cust_bill_pkg ADD itemdesc varchar(80) NULL;
266 ALTER TABLE cust_main_county ADD taxname varchar(80) NULL;
267 ALTER TABLE h_cust_main_county ADD taxname varchar(80) NULL;
268 ALTER TABLE cust_main_county ADD setuptax char(1) NULL;
269 ALTER TABLE h_cust_main_county ADD setuptax char(1) NULL;
270 ALTER TABLE cust_main_county ADD recurtax char(1) NULL;
271 ALTER TABLE h_cust_main_county ADD recurtax char(1) NULL;
272 ALTER TABLE cust_pkg ADD last_bill int NULL;
273 ALTER TABLE h_cust_pkg ADD last_bill int NULL;
274 ALTER TABLE agent ADD disabled char(1) NULL;
275 ALTER TABLE h_agent ADD disabled char(1) NULL;
276 ALTER TABLE agent ADD username varchar(80) NULL;
277 ALTER TABLE h_agent ADD username varchar(80) NULL;
278 ALTER TABLE agent ADD _password varchar(80) NULL;
279 ALTER TABLE h_agent ADD _password varchar(80) NULL;
280 ALTER TABLE cust_main ADD paycvv varchar(4) NULL;
281 ALTER TABLE h_cust_main ADD paycvv varchar(4) NULL;
282 ALTER TABLE part_referral ADD disabled char(1) NULL;
283 ALTER TABLE h_part_referral ADD disabled char(1) NULL;
284 CREATE INDEX part_referral1 ON part_referral ( disabled );
285 ALTER TABLE pkg_svc ADD primary_svc char(1) NULL;
286 ALTER TABLE h_pkg_svc ADD primary_svc char(1) NULL;
287 ALTER TABLE svc_forward ADD src varchar(255) NULL;
288 ALTER TABLE h_svc_forward ADD src varchar(255) NULL;
289 ALTER TABLE part_pkg ADD promo_code varchar(80) NULL;
290 ALTER TABLE h_part_pkg ADD promo_code varchar(80) NULL;
291 CREATE INDEX part_pkg2 ON part_pkg ( promo_code );
292 CREATE INDEX h_part_pkg2 ON h_part_pkg ( promo_code );
293
294 On recent Pg versions:
295
296 ALTER TABLE svc_forward ALTER COLUMN srcsvc DROP NOT NULL;
297 ALTER TABLE h_svc_forward ALTER COLUMN srcsvc DROP NOT NULL;
298 ALTER TABLE svc_forward ALTER COLUMN dstsvc DROP NOT NULL;
299 ALTER TABLE h_svc_forward ALTER COLUMN dstsvc DROP NOT NULL;
300 ALTER TABLE cust_main ALTER COLUMN zip DROP NOT NULL;
301 ALTER TABLE h_cust_main ALTER COLUMN zip DROP NOT NULL;
302
303 Or on Pg versions that don't support DROP NOT NULL (tested on 7.1 and 7.2 so far):
304 UPDATE pg_attribute SET attnotnull = FALSE WHERE ( attname = 'srcsvc' OR attname = 'dstsvc' ) AND ( attrelid = ( SELECT oid FROM pg_class WHERE relname = 'svc_forward' ) OR attrelid = ( SELECT oid FROM pg_class WHERE relname = 'h_svc_forward' ) );
305 UPDATE pg_attribute SET attnotnull = FALSE WHERE ( attname = 'zip' ) AND ( attrelid = ( SELECT oid FROM pg_class WHERE relname = 'cust_main' ) OR attrelid = ( SELECT oid FROM pg_class WHERE relname = 'h_cust_main' ) );
306
307 If you created your database with a version before 1.4.2, dump database, edit:
308 - cust_main and h_cust_main: increase otaker from 8 to 32
309 - cust_main and h_cust_main: change ss from char(11) to varchar(11) ( "character(11)" to "character varying(11)" )
310 - cust_credit and h_cust_credit: increase otaker from 8 to 32
311 - cust_pkg and h_cust_pkg: increase otaker from 8 to 32
312 - cust_refund and h_cust_refund: increase otaker from 8 to 32
313 - domain_record and h_domain_record: increase reczone from 80 to 255
314 - domain_record and h_domain_record: change rectype from char to varchar ( "character(5)" to "character varying(5)" )
315 - domain_record and h_domain_record: increase recdata from 80 to 255
316 then reload
317
318 optionally:
319
320   CREATE INDEX cust_main6 ON cust_main ( daytime );
321   CREATE INDEX cust_main7 ON cust_main ( night );
322   CREATE INDEX cust_main8 ON cust_main ( fax );
323   CREATE INDEX cust_main9 ON cust_main ( ship_daytime );
324   CREATE INDEX cust_main10 ON cust_main ( ship_night );
325   CREATE INDEX cust_main11 ON cust_main ( ship_fax );
326   CREATE INDEX agent2 ON agent ( disabled );
327   CREATE INDEX part_bill_event2 ON part_bill_event ( disabled );
328   CREATE INDEX cust_pay4 ON cust_pay (_date);
329
330   serial columns
331
332 mandatory again:
333
334 dbdef-create username
335 create-history-tables username cust_bill_pkg_detail router part_svc_router addr_block svc_broadband acct_snarf svc_external cust_pay_refund cust_pay_void part_pkg_option rate rate_detail rate_region rate_prefix reg_code reg_code_pkg
336 dbdef-create username
337
338 apache - fix <Files> sections to include .html also
339
340 </pre>