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 queue_depend (
 124   dependnum int primary key,
 125   jobnum int not null,
 126   depend_jobnum int not null
 127 );
 128 CREATE INDEX queue_depend1 ON queue_depend ( jobnum );
 129 CREATE INDEX queue_depend2 ON queue_depend ( depend_jobnum );
 130
 131 CREATE TABLE part_pop_local (
 132   localnum int primary key,
 133   popnum int not null,
 134   city varchar(80) null,
 135   state char(2) null,
 136   npa char(3) not null,
 137   nxx char(3) not null
 138 );
 139 CREATE UNIQUE INDEX part_pop_local1 ON part_pop_local ( npa, nxx );
 140
 141 CREATE TABLE cust_bill_event (
 142   eventnum int primary key,
 143   invnum int not null,
 144   eventpart int not null,
 145   _date int not null
 146 );
 147 CREATE UNIQUE INDEX cust_bill_event1 ON cust_bill_event ( eventpart, invnum );
 148 CREATE INDEX cust_bill_event2 ON cust_bill_event ( invnum );
 149
 150 CREATE TABLE part_bill_event (
 151   eventpart int primary key,
 152   payby char(4) not null,
 153   event varchar(80) not null,
 154   eventcode text null,
 155   seconds int null,
 156   weight int not null,
 157   plan varchar(80) null,
 158   plandata text null,
 159   disabled char(1) null
 160 );
 161 CREATE INDEX part_bill_event1 ON part_bill_event ( payby );
 162
 163 CREATE TABLE export_svc (
 164   exportsvcnum int primary key,
 165   exportnum int not null,
 166   svcpart int not null
 167 );
 168 CREATE UNIQUE INDEX export_svc1 ON export_svc ( exportnum, svcpart );
 169 CREATE INDEX export_svc2 ON export_svc ( exportnum );
 170 CREATE INDEX export_svc3 ON export_svc ( svcpart );
 171
 172 CREATE TABLE part_export (
 173   exportnum int primary key,
 174   machine varchar(80) not null,
 175   exporttype varchar(80) not null,
 176   nodomain char(1) NULL
 177 );
 178 CREATE INDEX part_export1 ON part_export ( machine );
 179 CREATE INDEX part_export2 ON part_export ( exporttype );
 180
 181 CREATE TABLE part_export_option (
 182   optionnum int primary key,
 183   exportnum int not null,
 184   optionname varchar(80) not null,
 185   optionvalue text NULL
 186 );
 187 CREATE INDEX part_export_option1 ON part_export_option ( exportnum );
 188 CREATE INDEX part_export_option2 ON part_export_option ( optionname );
 189
 190 CREATE TABLE radius_usergroup (
 191   usergroupnum int primary key,
 192   svcnum int not null,
 193   groupname varchar(80) not null
 194 );
 195 CREATE INDEX radius_usergroup1 ON radius_usergroup ( svcnum );
 196 CREATE INDEX radius_usergroup2 ON radius_usergroup ( groupname );
 197
 198 CREATE TABLE msgcat (
 199   msgnum int primary key,
 200   msgcode varchar(80) not null,
 201   locale varchar(16) not null,
 202   msg text not null
 203 );
 204 CREATE INDEX msgcat1 ON msgcat ( msgcode, locale );
 205
 206 CREATE TABLE cust_tax_exempt (
 207   exemptnum int primary key,
 208   custnum int not null,
 209   taxnum int not null,
 210   year int not null,
 211   month int not null,
 212   amount decimal(10,2)
 213 );
 214 CREATE UNIQUE INDEX cust_tax_exempt1 ON cust_tax_exempt ( taxnum, year, month );
 215
 216 ALTER TABLE svc_acct ADD domsvc integer NOT NULL;
 217 ALTER TABLE svc_domain ADD catchall integer NULL;
 218 ALTER TABLE cust_main ADD referral_custnum integer NULL;
 219 ALTER TABLE cust_pay ADD custnum integer;
 220 ALTER TABLE cust_pay_batch ADD paybatchnum integer;
 221 ALTER TABLE cust_refund ADD custnum integer;
 222 ALTER TABLE cust_pkg ADD manual_flag char(1) NULL;
 223 ALTER TABLE part_pkg ADD plan varchar(80) NULL;
 224 ALTER TABLE part_pkg ADD plandata text NULL;
 225 ALTER TABLE part_pkg ADD setuptax char(1) NULL;
 226 ALTER TABLE part_pkg ADD recurtax char(1) NULL;
 227 ALTER TABLE part_pkg ADD disabled char(1) NULL;
 228 ALTER TABLE part_svc ADD disabled char(1) NULL;
 229 ALTER TABLE cust_bill ADD closed char(1) NULL;
 230 ALTER TABLE cust_pay ADD closed char(1) NULL;
 231 ALTER TABLE cust_credit ADD closed char(1) NULL;
 232 ALTER TABLE cust_refund ADD closed char(1) NULL;
 233 ALTER TABLE cust_bill_event ADD status varchar(80);
 234 ALTER TABLE cust_bill_event ADD statustext text NULL;
 235 ALTER TABLE svc_acct ADD sec_phrase varchar(80) NULL;
 236 ALTER TABLE part_pkg ADD taxclass varchar(80) NULL;
 237 ALTER TABLE cust_main_county ADD taxclass varchar(80) NULL;
 238 ALTER TABLE cust_main_county ADD exempt_amount decimal(10,2);
 239 CREATE INDEX cust_main3 ON cust_main ( referral_custnum );
 240 CREATE INDEX cust_credit_bill1 ON cust_credit_bill ( crednum );
 241 CREATE INDEX cust_credit_bill2 ON cust_credit_bill ( invnum );
 242 CREATE INDEX cust_bill_pay1 ON cust_bill_pay ( invnum );
 243 CREATE INDEX cust_bill_pay2 ON cust_bill_pay ( paynum );
 244 CREATE INDEX cust_credit_refund1 ON cust_credit_refund ( crednum );
 245 CREATE INDEX cust_credit_refund2 ON cust_credit_refund ( refundnum );
 246 CREATE UNIQUE INDEX cust_pay_batch_pkey ON cust_pay_batch ( paybatchnum );
 247 CREATE UNIQUE INDEX part_svc_column1 ON part_svc_column ( svcpart, columnname );
 248 CREATE INDEX cust_pay2 ON cust_pay ( paynum );
 249 CREATE INDEX cust_pay3 ON cust_pay ( custnum );
 250 CREATE INDEX cust_pay4 ON cust_pay ( paybatch );
 251 </pre>
 252
 253   <li>If you are using PostgreSQL, apply the following changes to your database:
 254 <pre>
 255 CREATE UNIQUE INDEX agent_pkey ON agent ( agentnum );
 256 CREATE UNIQUE INDEX agent_type_pkey ON agent_type ( typenum );
 257 CREATE UNIQUE INDEX cust_bill_pkey ON cust_bill ( invnum );
 258 CREATE UNIQUE INDEX cust_credit_pkey ON cust_credit ( crednum );
 259 CREATE UNIQUE INDEX cust_main_pkey ON cust_main ( custnum );
 260 CREATE UNIQUE INDEX cust_main_county_pkey ON cust_main_county ( taxnum );
 261 CREATE UNIQUE INDEX cust_main_invoice_pkey ON cust_main_invoice ( destnum );
 262 CREATE UNIQUE INDEX cust_pay_pkey ON cust_pay ( paynum );
 263 CREATE UNIQUE INDEX cust_pkg_pkey ON cust_pkg ( pkgnum );
 264 CREATE UNIQUE INDEX cust_refund_pkey ON cust_refund ( refundnum );
 265 CREATE UNIQUE INDEX cust_svc_pkey ON cust_svc ( svcnum );
 266 CREATE UNIQUE INDEX domain_record_pkey ON domain_record ( recnum );
 267 CREATE UNIQUE INDEX nas_pkey ON nas ( nasnum );
 268 CREATE UNIQUE INDEX part_pkg_pkey ON part_pkg ( pkgpart );
 269 CREATE UNIQUE INDEX part_referral_pkey ON part_referral ( refnum );
 270 CREATE UNIQUE INDEX part_svc_pkey ON part_svc ( svcpart );
 271 CREATE UNIQUE INDEX port_pkey ON port ( portnum );
 272 CREATE UNIQUE INDEX prepay_credit_pkey ON prepay_credit ( prepaynum );
 273 CREATE UNIQUE INDEX session_pkey ON session ( sessionnum );
 274 CREATE UNIQUE INDEX svc_acct_pkey ON svc_acct ( svcnum );
 275 CREATE UNIQUE INDEX svc_acct_pop_pkey ON svc_acct_pop ( popnum );
 276 CREATE UNIQUE INDEX svc_acct_sm_pkey ON svc_acct_sm ( svcnum );
 277 CREATE UNIQUE INDEX svc_domain_pkey ON svc_domain ( svcnum );
 278 CREATE UNIQUE INDEX svc_www_pkey ON svc_www ( svcnum );
 279 CREATE UNIQUE INDEX type_pkgs_pkey ON type_pkgs ( typenum );
 280 </pre>
 281   <li>If you wish to enable service/shipping addresses, apply the following
 282       changes to your database:
 283 <pre>
 284 ALTER TABLE cust_main ADD COLUMN ship_last varchar(80) NULL;
 285 ALTER TABLE cust_main ADD COLUMN ship_first varchar(80) NULL;
 286 ALTER TABLE cust_main ADD COLUMN ship_company varchar(80) NULL;
 287 ALTER TABLE cust_main ADD COLUMN ship_address1 varchar(80) NULL;
 288 ALTER TABLE cust_main ADD COLUMN ship_address2 varchar(80) NULL;
 289 ALTER TABLE cust_main ADD COLUMN ship_city varchar(80) NULL;
 290 ALTER TABLE cust_main ADD COLUMN ship_county varchar(80) NULL;
 291 ALTER TABLE cust_main ADD COLUMN ship_state varchar(80) NULL;
 292 ALTER TABLE cust_main ADD COLUMN ship_zip varchar(10) NULL;
 293 ALTER TABLE cust_main ADD COLUMN ship_country char(2) NULL;
 294 ALTER TABLE cust_main ADD COLUMN ship_daytime varchar(20) NULL;
 295 ALTER TABLE cust_main ADD COLUMN ship_night varchar(20) NULL;
 296 ALTER TABLE cust_main ADD COLUMN ship_fax varchar(12) NULL;
 297 CREATE INDEX cust_main1 ON cust_main ( ship_last );
 298 CREATE INDEX cust_main2 ON cust_main ( ship_company );
 299 </pre>
 300   <li>If you wish to enable customer comments, apply the following change to
 301       your database:
 302 <pre>
 303 ALTER TABLE cust_main ADD COLUMN comments text NULL;
 304 </pre>
 305   <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.
 306   <li>Run bin/dbdef-create.
 307   <li>If you have svc_acct_sm records or service definitions:
 308     <ul>
 309       <li>Create a service definition with table svc_forward
 310       <li>Run bin/fs-migrate-svc_acct_sm
 311     </ul>
 312   <li>Run bin/fs-migrate-payref
 313   <li>Run bin/fs-migrate-part_svc
 314   <li><b>After running bin/fs-migrate-payref</b>, apply the following changes to your database:
 315   <table border><tr><th>PostgreSQL</th><th>MySQL, others</th></tr>
 316 <tr><td>
 317 <font size=-1><pre>
 318 CREATE TABLE cust_pay_temp (
 319   paynum int primary key,
 320   custnum int not null,
 321   paid decimal(10,2) not null,
 322   _date int null,
 323   payby char(4) not null,
 324   payinfo varchar(16) null,
 325   paybatch varchar(80) null
 326 );
 327 INSERT INTO cust_pay_temp SELECT * from cust_pay;
 328 DROP TABLE cust_pay;
 329 ALTER TABLE cust_pay_temp RENAME TO cust_pay;
 330 CREATE UNIQUE INDEX cust_pay1 ON cust_pay (paynum);
 331 CREATE TABLE cust_refund_temp (
 332   refundnum int primary key,
 333   custnum int not null,
 334   _date int null,
 335   refund decimal(10,2) not null,
 336   otaker varchar(8) not null,
 337   reason varchar(80) not null,
 338   payby char(4) not null,
 339   payinfo varchar(16) null,
 340   paybatch varchar(80) null
 341 );
 342 INSERT INTO cust_refund_temp SELECT * from cust_refund;
 343 DROP TABLE cust_refund;
 344 ALTER TABLE cust_refund_temp RENAME TO cust_refund;
 345 CREATE UNIQUE INDEX cust_refund1 ON cust_refund (refundnum);
 346 </pre></font>
 347 </td><td>
 348 <font size=-1><pre>
 349 ALTER TABLE cust_pay DROP COLUMN invnum;
 350 ALTER TABLE cust_refund DROP COLUMN crednum;
 351 </pre></font>
 352 </td></tr></table>
 353   <li><b>IMPORTANT: After applying the second set of database changes</b>, run bin/dbdef-create again.
 354   <li><b>IMPORTANT</b>: run bin/create-history-tables
 355   <li><b>IMPORTANT: After running bin/create-history-tables</b>, run bin/dbdef-create again.
 356   <li>set the <a href="../config/config.cgi#username_policy">user_policy configuration value</a> as appropriate for your site.
 357   <li>set the <a href="../config/config.cgi#locale">locale configuration value</a> to en_US.
 358   <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.
 359   <li>Create the `/usr/local/etc/freeside/cache.<i>datasrc</i>' directory
 360       (owned by the freeside user).
 361   <li>freeside-queued was installed with the Perl modules.  Start it now and ensure that is run upon system startup.
 362   <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.
 363   <li>Use <a href="man/bin/freeside-daily.html">freeside-daily</a> instead of <a href="man/bin/freeside-bill.html">freeside-bill</a>.
 364   <li>If you would like Freeside to notify your customers when their credit
 365   cards and other billing arrangements are about to expire, arrange for
 366   <b>freeside-expiration-alerter</b> to be run daily by cron or similar
 367   facility.  The message it sends can be configured from the
 368   <u>Configuration</u> choice of the main menu as <u>alerter_template</u>.
 369   <li>Export has been rewritten.  If you were using the icradiusmachines,
 370   icradius_mysqldest, icradius_mysqlsource, or icradius_secrets files, add
 371   an appropriate "sqlradius" export to all relevant Service Definitions
 372   instead.  Use <a href="http://www.mysql.com/documentation/mysql/bychapter/manual_MySQL_Database_Administration.html#Replication">MySQL replication</a> or
 373   point the "sqlradius" export directly at your external ICRADIUS or FreeRADIUS
 374   database (or through an SSL-necrypting proxy...)
 375 </ul>
 376 </body>