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