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