httemplate/docs/upgrade8.html

   1 <head>
   2   <title>Upgrading to 1.4.0</title>
   3 </head>
   4 <body>
   5 <h1>Upgrading to 1.4.0 from 1.3.1</h1>
   6 <ul>
   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&nbsp;<a href="http://www.ca.postgresql.org/devel-corner/docs/postgres/backup.html">PostgreSQL</a>) (with&nbsp;<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>
  13 </ul>
  14 <table>
  15   <tr>
  16     <th>Apache::ASP</th><th>Mason</th>
  17   </tr>
  18   <tr>
  19     <td><ul>
  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:
  25 <font size="-1"><pre>
  26 &lt;Directory /usr/local/apache/htdocs/freeside-asp&gt;
  27 &lt;Files ~ (\.cgi)&gt;
  28 AddHandler perl-script .cgi
  29 PerlHandler Apache::ASP
  30 &lt;/Files&gt;
  31 &lt;Perl&gt;
  32 $MLDBM::RemoveTaint = 1;
  33 &lt;/Perl&gt;
  34 PerlSetVar Global /usr/local/etc/freeside/asp-global/
  35 &lt;/Directory&gt;
  36 </pre></font>
  37     </ul></td>
  38     <td><ul>
  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:
  44 <font size="-1"><pre>
  45 &lt;Directory /usr/local/apache/htdocs/freeside-mason&gt;
  46 &lt;Files ~ (\.cgi)&gt;
  47 AddHandler perl-script .cgi
  48 PerlHandler HTML::Mason
  49 &lt;/Files&gt;
  50 &lt;Perl&gt;
  51 require "/usr/local/apache/conf/handler.pl";
  52 &lt;/Perl&gt;
  53 &lt;/Directory&gt;
  54 </pre></font>
  55     </ul></td>
  56   </tr>
  57 </table>
  58 <ul>
  59   <li>Build and install the Perl modules:
  60     <pre>
  61 $ su
  62 # make install-perl-modules</pre>
  63    <li>Apply the following changes to your database:
  64 <pre>
  65 CREATE TABLE svc_forward (
  66   svcnum int NOT NULL,
  67   srcsvc int NOT NULL,
  68   dstsvc int NOT NULL,
  69   dst varchar(80),
  70   PRIMARY KEY (svcnum)
  71 );
  72
  73 CREATE TABLE cust_credit_bill (
  74   creditbillnum int primary key,
  75   crednum int not null,
  76   invnum int not null,
  77   _date int not null,
  78   amount decimal(10,2) not null
  79 );
  80
  81 CREATE TABLE cust_bill_pay (
  82   billpaynum int primary key,
  83   invnum int not null,
  84   paynum int not null,
  85   _date int not null,
  86   amount decimal(10,2) not null
  87 );
  88
  89 CREATE TABLE cust_credit_refund (
  90   creditrefundnum int primary key,
  91   crednum int not null,
  92   refundnum int not null,
  93   _date int not null,
  94   amount decimal(10,2) not null
  95 );
  96
  97 CREATE TABLE part_svc_column (
  98   columnnum int primary key,
  99   svcpart int not null,
 100   columnname varchar(64) not null,
 101   columnvalue varchar(80) null,
 102   columnflag char(1) null
 103 );
 104
 105 CREATE TABLE queue (
 106   jobnum int primary key,
 107   job text not null,
 108   _date int not null,
 109   status varchar(80) not null,
 110   statustext text null,
 111   svcnum int null
 112 );
 113 CREATE INDEX queue1 ON queue ( svcnum );
 114 CREATE INDEX queue2 ON queue ( status );
 115
 116 CREATE TABLE queue_arg (
 117   argnum int primary key,
 118   jobnum int not null,
 119   arg text null
 120 );
 121 CREATE INDEX queue_arg1 ON queue_arg ( jobnum );
 122
 123 CREATE TABLE part_pop_local (
 124   localnum int primary key,
 125   popnum int not null,
 126   city varchar(80) null,
 127   state char(2) null,
 128   npa char(3) not null,
 129   nxx char(3) not null
 130 );
 131 CREATE UNIQUE INDEX part_pop_local1 ON part_pop_local ( npa, nxx );
 132
 133 CREATE TABLE cust_bill_event (
 134   eventnum int primary key,
 135   invnum int not null,
 136   eventpart int not null,
 137   _date int not null
 138 );
 139 CREATE UNIQUE INDEX cust_bill_event1 ON cust_bill_event ( eventpart, invnum );
 140 CREATE INDEX cust_bill_event2 ON cust_bill_event ( invnum );
 141
 142 CREATE TABLE part_bill_event (
 143   eventpart int primary key,
 144   payby char(4) not null,
 145   event varchar(80) not null,
 146   eventcode text null,
 147   seconds int null,
 148   weight int not null,
 149   plan varchar(80) null,
 150   plandata text null,
 151   disabled char(1) null
 152 );
 153 CREATE INDEX part_bill_event1 ON part_bill_event ( payby );
 154
 155 CREATE TABLE export_svc (
 156   exportsvcnum int primary key,
 157   exportnum int not null,
 158   svcpart int not null
 159 );
 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 );
 163
 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
 169 );
 170 CREATE INDEX part_export1 ON part_export ( machine );
 171 CREATE INDEX part_export2 ON part_export ( exporttype );
 172
 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
 178 );
 179 CREATE INDEX part_export_option1 ON part_export_option ( exportnum );
 180 CREATE INDEX part_export_option2 ON part_export_option ( optionname );
 181
 182 CREATE TABLE radius_usergroup (
 183   usergroupnum int primary key,
 184   svcnum int not null,
 185   groupname varchar(80) not null
 186 );
 187 CREATE INDEX radius_usergroup1 ON radius_usergroup ( svcnum );
 188 CREATE INDEX radius_usergroup2 ON radius_usergroup ( groupname );
 189
 190 CREATE TABLE msgcat (
 191   msgnum int primary key,
 192   msgcode varchar(80) not null,
 193   locale varchar(16) not null,
 194   msg text not null
 195 );
 196 CREATE INDEX msgcat1 ON msgcat ( msgcode, locale );
 197
 198 CREATE TABLE cust_tax_exempt (
 199   exemptnum int primary key,
 200   custnum int not null,
 201   taxnum int not null,
 202   year int not null,
 203   month int not null,
 204   amount decimal(10,2)
 205 );
 206 CREATE UNIQUE INDEX cust_tax_exempt1 ON cust_tax_exempt ( taxnum, year, month );
 207
 208 ALTER TABLE svc_acct ADD domsvc integer NOT NULL;
 209 ALTER TABLE svc_domain ADD catchall integer NULL;
 210 ALTER TABLE cust_main ADD referral_custnum integer NULL;
 211 ALTER TABLE cust_pay ADD custnum integer;
 212 ALTER TABLE cust_pay_batch ADD paybatchnum integer;
 213 ALTER TABLE cust_refund ADD custnum integer;
 214 ALTER TABLE cust_pkg ADD manual_flag char(1) NULL;
 215 ALTER TABLE part_pkg ADD plan varchar(80) NULL;
 216 ALTER TABLE part_pkg ADD plandata text NULL;
 217 ALTER TABLE part_pkg ADD setuptax char(1) NULL;
 218 ALTER TABLE part_pkg ADD recurtax char(1) NULL;
 219 ALTER TABLE part_pkg ADD disabled char(1) NULL;
 220 ALTER TABLE part_svc ADD disabled char(1) NULL;
 221 ALTER TABLE cust_bill ADD closed char(1) NULL;
 222 ALTER TABLE cust_pay ADD closed char(1) NULL;
 223 ALTER TABLE cust_credit ADD closed char(1) NULL;
 224 ALTER TABLE cust_refund ADD closed char(1) NULL;
 225 ALTER TABLE cust_bill_event ADD status varchar(80);
 226 ALTER TABLE cust_bill_event ADD statustext text NULL;
 227 ALTER TABLE svc_acct ADD sec_phrase varchar(80) NULL;
 228 ALTER TABLE part_pkg ADD taxclass varchar(80) NULL;
 229 ALTER TABLE cust_main_county ADD taxclass varchar(80) NULL;
 230 ALTER TABLE cust_main_county ADD exempt_amount decimal(10,2);
 231 CREATE INDEX cust_main3 ON cust_main ( referral_custnum );
 232 CREATE INDEX cust_credit_bill1 ON cust_credit_bill ( crednum );
 233 CREATE INDEX cust_credit_bill2 ON cust_credit_bill ( invnum );
 234 CREATE INDEX cust_bill_pay1 ON cust_bill_pay ( invnum );
 235 CREATE INDEX cust_bill_pay2 ON cust_bill_pay ( paynum );
 236 CREATE INDEX cust_credit_refund1 ON cust_credit_refund ( crednum );
 237 CREATE INDEX cust_credit_refund2 ON cust_credit_refund ( refundnum );
 238 CREATE UNIQUE INDEX cust_pay_batch_pkey ON cust_pay_batch ( paybatchnum );
 239 CREATE UNIQUE INDEX part_svc_column1 ON part_svc_column ( svcpart, columnname );
 240 CREATE INDEX cust_pay2 ON cust_pay ( paynum );
 241 CREATE INDEX cust_pay3 ON cust_pay ( custnum );
 242 CREATE INDEX cust_pay4 ON cust_pay ( paybatch );
 243 </pre>
 244
 245   <li>If you are using PostgreSQL, apply the following changes to your database:
 246 <pre>
 247 CREATE UNIQUE INDEX agent_pkey ON agent ( agentnum );
 248 CREATE UNIQUE INDEX agent_type_pkey ON agent_type ( typenum );
 249 CREATE UNIQUE INDEX cust_bill_pkey ON cust_bill ( invnum );
 250 CREATE UNIQUE INDEX cust_credit_pkey ON cust_credit ( crednum );
 251 CREATE UNIQUE INDEX cust_main_pkey ON cust_main ( custnum );
 252 CREATE UNIQUE INDEX cust_main_county_pkey ON cust_main_county ( taxnum );
 253 CREATE UNIQUE INDEX cust_main_invoice_pkey ON cust_main_invoice ( destnum );
 254 CREATE UNIQUE INDEX cust_pay_pkey ON cust_pay ( paynum );
 255 CREATE UNIQUE INDEX cust_pkg_pkey ON cust_pkg ( pkgnum );
 256 CREATE UNIQUE INDEX cust_refund_pkey ON cust_refund ( refundnum );
 257 CREATE UNIQUE INDEX cust_svc_pkey ON cust_svc ( svcnum );
 258 CREATE UNIQUE INDEX domain_record_pkey ON domain_record ( recnum );
 259 CREATE UNIQUE INDEX nas_pkey ON nas ( nasnum );
 260 CREATE UNIQUE INDEX part_pkg_pkey ON part_pkg ( pkgpart );
 261 CREATE UNIQUE INDEX part_referral_pkey ON part_referral ( refnum );
 262 CREATE UNIQUE INDEX part_svc_pkey ON part_svc ( svcpart );
 263 CREATE UNIQUE INDEX port_pkey ON port ( portnum );
 264 CREATE UNIQUE INDEX prepay_credit_pkey ON prepay_credit ( prepaynum );
 265 CREATE UNIQUE INDEX session_pkey ON session ( sessionnum );
 266 CREATE UNIQUE INDEX svc_acct_pkey ON svc_acct ( svcnum );
 267 CREATE UNIQUE INDEX svc_acct_pop_pkey ON svc_acct_pop ( popnum );
 268 CREATE UNIQUE INDEX svc_acct_sm_pkey ON svc_acct_sm ( svcnum );
 269 CREATE UNIQUE INDEX svc_domain_pkey ON svc_domain ( svcnum );
 270 CREATE UNIQUE INDEX svc_www_pkey ON svc_www ( svcnum );
 271 CREATE UNIQUE INDEX type_pkgs_pkey ON type_pkgs ( typenum );
 272 </pre>
 273   <li>If you wish to enable service/shipping addresses, apply the following
 274       changes to your database:
 275 <pre>
 276 ALTER TABLE cust_main ADD COLUMN ship_last varchar(80) NULL;
 277 ALTER TABLE cust_main ADD COLUMN ship_first varchar(80) NULL;
 278 ALTER TABLE cust_main ADD COLUMN ship_company varchar(80) NULL;
 279 ALTER TABLE cust_main ADD COLUMN ship_address1 varchar(80) NULL;
 280 ALTER TABLE cust_main ADD COLUMN ship_address2 varchar(80) NULL;
 281 ALTER TABLE cust_main ADD COLUMN ship_city varchar(80) NULL;
 282 ALTER TABLE cust_main ADD COLUMN ship_county varchar(80) NULL;
 283 ALTER TABLE cust_main ADD COLUMN ship_state varchar(80) NULL;
 284 ALTER TABLE cust_main ADD COLUMN ship_zip varchar(10) NULL;
 285 ALTER TABLE cust_main ADD COLUMN ship_country char(2) NULL;
 286 ALTER TABLE cust_main ADD COLUMN ship_daytime varchar(20) NULL;
 287 ALTER TABLE cust_main ADD COLUMN ship_night varchar(20) NULL;
 288 ALTER TABLE cust_main ADD COLUMN ship_fax varchar(12) NULL;
 289 CREATE INDEX cust_main1 ON cust_main ( ship_last );
 290 CREATE INDEX cust_main2 ON cust_main ( ship_company );
 291 </pre>
 292   <li>If you wish to enable customer comments, apply the following change to
 293       your database:
 294 <pre>
 295 ALTER TABLE cust_main ADD COLUMN comments text NULL;
 296 </pre>
 297   <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.
 298   <li>Run bin/dbdef-create.
 299   <li>If you have svc_acct_sm records or service definitions:
 300     <ul>
 301       <li>Create a service definition with table svc_forward
 302       <li>Run bin/fs-migrate-svc_acct_sm
 303     </ul>
 304   <li>Run bin/fs-migrate-payref
 305   <li>Run bin/fs-migrate-part_svc
 306   <li><b>After running bin/fs-migrate-payref</b>, apply the following changes to your database:
 307   <table border><tr><th>PostgreSQL</th><th>MySQL, others</th></tr>
 308 <tr><td>
 309 <font size=-1><pre>
 310 CREATE TABLE cust_pay_temp (
 311   paynum int primary key,
 312   custnum int not null,
 313   paid decimal(10,2) not null,
 314   _date int null,
 315   payby char(4) not null,
 316   payinfo varchar(16) null,
 317   paybatch varchar(80) null
 318 );
 319 INSERT INTO cust_pay_temp SELECT * from cust_pay;
 320 DROP TABLE cust_pay;
 321 ALTER TABLE cust_pay_temp RENAME TO cust_pay;
 322 CREATE UNIQUE INDEX cust_pay1 ON cust_pay (paynum);
 323 CREATE TABLE cust_refund_temp (
 324   refundnum int primary key,
 325   custnum int not null,
 326   _date int null,
 327   refund decimal(10,2) not null,
 328   otaker varchar(8) not null,
 329   reason varchar(80) not null,
 330   payby char(4) not null,
 331   payinfo varchar(16) null,
 332   paybatch varchar(80) null
 333 );
 334 INSERT INTO cust_refund_temp SELECT * from cust_refund;
 335 DROP TABLE cust_refund;
 336 ALTER TABLE cust_refund_temp RENAME TO cust_refund;
 337 CREATE UNIQUE INDEX cust_refund1 ON cust_refund (refundnum);
 338 </pre></font>
 339 </td><td>
 340 <font size=-1><pre>
 341 ALTER TABLE cust_pay DROP COLUMN invnum;
 342 ALTER TABLE cust_refund DROP COLUMN crednum;
 343 </pre></font>
 344 </td></tr></table>
 345   <li><b>IMPORTANT: After applying the second set of database changes</b>, run bin/dbdef-create again.
 346   <li><b>IMPORTANT</b>: run bin/create-history-tables
 347   <li><b>IMPORTANT: After running bin/create-history-tables</b>, run bin/dbdef-create again.
 348   <li>set the <a href="../config/config.cgi#username_policy">user_policy configuration value</a> as appropriate for your site.
 349   <li>set the <a href="../config/config.cgi#locale">locale configuration value</a> to en_US.
 350   <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.
 351   <li>Create the `/usr/local/etc/freeside/cache.<i>datasrc</i>' directory
 352       (owned by the freeside user).
 353   <li>freeside-queued was installed with the Perl modules.  Start it now and ensure that is run upon system startup.
 354   <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.
 355   <li>Use <a href="man/bin/freeside-daily.html">freeside-daily</a> instead of <a href="man/bin/freeside-bill.html">freeside-bill</a>.
 356   <li>If you would like Freeside to notify your customers when their credit
 357   cards and other billing arrangements are about to expire, arrange for
 358   <b>freeside-expiration-alerter</b> to be run daily by cron or similar
 359   facility.  The message it sends can be configured from the
 360   <u>Configuration</u> choice of the main menu as <u>alerter_template</u>.
 361   <li>Export has been rewritten.  If you were using the icradiusmachines,
 362   icradius_mysqldest, icradius_mysqlsource, or icradius_secrets files, add
 363   an appropriate "sqlradius" export to all relevant Service Definitions
 364   instead.  Use <a href="http://www.mysql.com/documentation/mysql/bychapter/manual_MySQL_Database_Administration.html#Replication">MySQL replication</a> or
 365   point the "sqlradius" export directly at your external ICRADIUS or FreeRADIUS
 366   database (or through an SSL-necrypting proxy...)
 367 </ul>
 368 </body>