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://www.apache-asp.org/">Apache::ASP</a> or <a href="http://www.masonhq.com/">HTML::Mason</a>.
  11 </ul>
  12 <table>
  13   <tr>
  14     <th>Apache::ASP</th><th>Mason</th>
  15   </tr>
  16   <tr>
  17     <td><ul>
  18       <li>Run <tt>make aspdocs</tt>
  19       <li>Copy <tt>aspdocs/</tt> to your web server's document space.
  20       <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>
  21       <li>Copy <tt>htetc/global.asa</tt> to the Global directory.
  22       <li>Configure Apache for the Global directory and to execute .cgi files using Apache::ASP.  For example:
  23 <font size="-1"><pre>
  24 &lt;Directory /usr/local/apache/htdocs/freeside-asp&gt;
  25 &lt;Files ~ (\.cgi)&gt;
  26 AddHandler perl-script .cgi
  27 PerlHandler Apache::ASP
  28 &lt;/Files&gt;
  29 &lt;Perl&gt;
  30 $MLDBM::RemoveTaint = 1;
  31 &lt;/Perl&gt;
  32 PerlSetVar Global /usr/local/etc/freeside/asp-global/
  33 &lt;/Directory&gt;
  34 </pre></font>
  35     </ul></td>
  36     <td><ul>
  37       <li>Run <tt>make masondocs</tt>
  38       <li>Copy <tt>masondocs/</tt> to your web server's document space.
  39       <li>Copy <tt>htetc/handler.pl</tt> to your web server's configuration directory.
  40       <li>Edit <tt>handler.pl</tt> and set an appropriate <tt>data_dir</tt>, such as <tt>/usr/local/etc/freeside/mason-data</tt>
  41       <li>Configure Apache to use the <tt>handler.pl</tt> file and to execute .cgi files using HTML::Mason.  For example:
  42 <font size="-1"><pre>
  43 &lt;Directory /usr/local/apache/htdocs/freeside-mason&gt;
  44 &lt;Files ~ (\.cgi)&gt;
  45 AddHandler perl-script .cgi
  46 PerlHandler HTML::Mason
  47 &lt;/Files&gt;
  48 &lt;Perl&gt;
  49 require "/usr/local/apache/conf/handler.pl";
  50 &lt;/Perl&gt;
  51 &lt;/Directory&gt;
  52 </pre></font>
  53     </ul></td>
  54   </tr>
  55 </table>
  56 <ul>
  57   <li>Build and install the Perl modules:
  58     <pre>
  59 $ su
  60 # make install-perl-modules</pre>
  61    <li>Apply the following changes to your database:
  62 <pre>
  63 CREATE TABLE svc_forward (
  64   svcnum int NOT NULL,
  65   srcsvc int NOT NULL,
  66   dstsvc int NOT NULL,
  67   dst varchar(80),
  68   PRIMARY KEY (svcnum)
  69 );
  70
  71 CREATE TABLE cust_credit_bill (
  72   creditbillnum int primary key,
  73   crednum int not null,
  74   invnum int not null,
  75   _date int not null,
  76   amount decimal(10,2) not null
  77 );
  78
  79 CREATE TABLE cust_bill_pay (
  80   billpaynum int primary key,
  81   invnum int not null,
  82   paynum int not null,
  83   _date int not null,
  84   amount decimal(10,2) not null
  85 );
  86
  87 CREATE TABLE cust_credit_refund (
  88   creditrefundnum int primary key,
  89   crednum int not null,
  90   refundnum int not null,
  91   _date int not null,
  92   amount decimal(10,2) not null
  93 );
  94
  95 CREATE TABLE part_svc_column (
  96   columnnum int primary key,
  97   svcpart int not null,
  98   columnname varchar(64) not null,
  99   columnvalue varchar(80) null,
 100   columnflag char(1) null
 101 );
 102
 103 CREATE TABLE queue (
 104   jobnum int primary key,
 105   job text not null,
 106   _date int not null,
 107   status varchar(80) not null
 108 );
 109
 110 CREATE TABLE queue_arg (
 111   argnum int primary key,
 112   jobnum int not null,
 113   arg text null
 114 );
 115 CREATE INDEX queue_arg1 ON queue_arg ( jobnum );
 116
 117 CREATE TABLE part_pop_local (
 118   localnum int primary key,
 119   popnum int not null,
 120   city varchar(80) null,
 121   state char(2) null,
 122   npa char(3) not null,
 123   nxx char(3) not null
 124 );
 125 CREATE UNIQUE INDEX part_pop_local1 ON part_pop_local ( npa, nxx );
 126
 127 CREATE TABLE cust_bill_event (
 128   eventnum int primary key,
 129   invnum int not null,
 130   eventpart int not null,
 131   _date int not null
 132 );
 133 CREATE UNIQUE INDEX cust_bill_event1 ON cust_bill_event ( eventpart, invnum );
 134 CREATE INDEX cust_bill_event2 ON cust_bill_event ( invnum );
 135
 136 CREATE TABLE part_bill_event (
 137   eventpart int primary key,
 138   payby char(4) not null,
 139   event varchar(80) not null,
 140   eventcode text null,
 141   seconds int null,
 142   weight int not null,
 143   plan varchar(80) null,
 144   plandata text null,
 145   disabled char(1) null
 146 );
 147 CREATE INDEX part_bill_event1 ON part_bill_event ( payby );
 148
 149 CREATE TABLE part_export (
 150   exportnum int primary key,
 151   svcpart int not null,
 152   machine varchar(80) not null,
 153   exporttype varchar(80) not null,
 154   nodomain char(1) NULL
 155 );
 156 CREATE INDEX part_export1 ON part_export ( machine );
 157 CREATE INDEX part_export2 ON part_export ( exporttype );
 158
 159 CREATE INDEX part_export_option (
 160   optionnum int primary key,
 161   exportnum int not null,
 162   option varchar(80) not null,
 163   optionvalue text NULL
 164 );
 165 CREATE INDEX part_export_option1 ON part_export ( exportnum );
 166 CREATE INDEX part_export_option2 ON part_export ( option );
 167
 168 ALTER TABLE svc_acct ADD domsvc integer NOT NULL;
 169 ALTER TABLE svc_domain ADD catchall integer NULL;
 170 ALTER TABLE cust_main ADD referral_custnum integer NULL;
 171 ALTER TABLE cust_pay ADD custnum integer;
 172 ALTER TABLE cust_pay_batch ADD paybatchnum integer;
 173 ALTER TABLE cust_refund ADD custnum integer;
 174 ALTER TABLE cust_pkg ADD manual_flag char(1) NULL;
 175 ALTER TABLE part_pkg ADD plan varchar(80) NULL;
 176 ALTER TABLE part_pkg ADD plandata text NULL;
 177 ALTER TABLE part_pkg ADD setuptax char(1) NULL;
 178 ALTER TABLE part_pkg ADD recurtax char(1) NULL;
 179 ALTER TABLE part_pkg ADD disabled char(1) NULL;
 180 ALTER TABLE part_svc ADD disabled char(1) NULL;
 181 ALTER TABLE cust_bill ADD closed char(1) NULL;
 182 ALTER TABLE cust_pay ADD closed char(1) NULL;
 183 ALTER TABLE cust_credit ADD closed char(1) NULL;
 184 ALTER TABLE cust_refund ADD closed char(1) NULL;
 185 CREATE INDEX cust_main3 ON cust_main ( referral_custnum );
 186 CREATE INDEX cust_credit_bill1 ON cust_credit_bill ( crednum );
 187 CREATE INDEX cust_credit_bill2 ON cust_credit_bill ( invnum );
 188 CREATE INDEX cust_bill_pay1 ON cust_bill_pay ( invnum );
 189 CREATE INDEX cust_bill_pay2 ON cust_bill_pay ( paynum );
 190 CREATE INDEX cust_credit_refund1 ON cust_credit_refund ( crednum );
 191 CREATE INDEX cust_credit_refund2 ON cust_credit_refund ( refundnum );
 192 CREATE UNIQUE INDEX cust_pay_batch_pkey ON cust_pay_batch ( paybatchnum );
 193 CREATE UNIQUE INDEX part_svc_column1 ON part_svc_column ( svcpart, columnname );
 194 </pre>
 195
 196   <li>If you are using PostgreSQL, apply the following changes to your database:
 197 <pre>
 198 CREATE UNIQUE INDEX agent_pkey ON agent ( agentnum );
 199 CREATE UNIQUE INDEX agent_type_pkey ON agent_type ( typenum );
 200 CREATE UNIQUE INDEX cust_bill_pkey ON cust_bill ( invnum );
 201 CREATE UNIQUE INDEX cust_credit_pkey ON cust_credit ( crednum );
 202 CREATE UNIQUE INDEX cust_main_pkey ON cust_main ( custnum );
 203 CREATE UNIQUE INDEX cust_main_county_pkey ON cust_main_county ( taxnum );
 204 CREATE UNIQUE INDEX cust_main_invoice_pkey ON cust_main_invoice ( destnum );
 205 CREATE UNIQUE INDEX cust_pay_pkey ON cust_pay ( paynum );
 206 CREATE UNIQUE INDEX cust_pkg_pkey ON cust_pkg ( pkgnum );
 207 CREATE UNIQUE INDEX cust_refund_pkey ON cust_refund ( refundnum );
 208 CREATE UNIQUE INDEX cust_svc_pkey ON cust_svc ( svcnum );
 209 CREATE UNIQUE INDEX domain_record_pkey ON domain_record ( recnum );
 210 CREATE UNIQUE INDEX nas_pkey ON nas ( nasnum );
 211 CREATE UNIQUE INDEX part_pkg_pkey ON part_pkg ( pkgpart );
 212 CREATE UNIQUE INDEX part_referral_pkey ON part_referral ( refnum );
 213 CREATE UNIQUE INDEX part_svc_pkey ON part_svc ( svcpart );
 214 CREATE UNIQUE INDEX port_pkey ON port ( portnum );
 215 CREATE UNIQUE INDEX prepay_credit_pkey ON prepay_credit ( prepaynum );
 216 CREATE UNIQUE INDEX session_pkey ON session ( sessionnum );
 217 CREATE UNIQUE INDEX svc_acct_pkey ON svc_acct ( svcnum );
 218 CREATE UNIQUE INDEX svc_acct_pop_pkey ON svc_acct_pop ( popnum );
 219 CREATE UNIQUE INDEX svc_acct_sm_pkey ON svc_acct_sm ( svcnum );
 220 CREATE UNIQUE INDEX svc_domain_pkey ON svc_domain ( svcnum );
 221 CREATE UNIQUE INDEX svc_www_pkey ON svc_www ( svcnum );
 222 CREATE UNIQUE INDEX type_pkgs_pkey ON type_pkgs ( typenum );
 223 </pre>
 224   <li>If you wish to enable service/shipping addresses, apply the following
 225       changes to your database:
 226 <pre>
 227 ALTER TABLE cust_main ADD COLUMN ship_last varchar(80) NULL;
 228 ALTER TABLE cust_main ADD COLUMN ship_first varchar(80) NULL;
 229 ALTER TABLE cust_main ADD COLUMN ship_company varchar(80) NULL;
 230 ALTER TABLE cust_main ADD COLUMN ship_address1 varchar(80) NULL;
 231 ALTER TABLE cust_main ADD COLUMN ship_address2 varchar(80) NULL;
 232 ALTER TABLE cust_main ADD COLUMN ship_city varchar(80) NULL;
 233 ALTER TABLE cust_main ADD COLUMN ship_county varchar(80) NULL;
 234 ALTER TABLE cust_main ADD COLUMN ship_state varchar(80) NULL;
 235 ALTER TABLE cust_main ADD COLUMN ship_zip varchar(10) NULL;
 236 ALTER TABLE cust_main ADD COLUMN ship_country char(2) NULL;
 237 ALTER TABLE cust_main ADD COLUMN ship_daytime varchar(20) NULL;
 238 ALTER TABLE cust_main ADD COLUMN ship_night varchar(20) NULL;
 239 ALTER TABLE cust_main ADD COLUMN ship_fax varchar(12) NULL;
 240 CREATE INDEX cust_main1 ON cust_main ( ship_last );
 241 CREATE INDEX cust_main2 ON cust_main ( ship_company );
 242 </pre>
 243   <li>If you wish to enable customer comments, apply the following change to
 244       your database:
 245 <pre>
 246 ALTER TABLE cust_main ADD COLUMN comments text NULL;
 247 </pre>
 248   <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.
 249   <li>Run bin/dbdef-create.
 250   <li>If you have svc_acct_sm records or service definitions:
 251     <ul>
 252       <li>Create a service definition with table svc_forward
 253       <li>Run bin/fs-migrate-svc_acct_sm
 254     </ul>
 255   <li>Run bin/fs-migrate-payref
 256   <li>Run bin/fs-migrate-part_svc
 257   <li><b>After running bin/fs-migrate-payref</b>, apply the following changes to your database:
 258   <table border><tr><th>PostgreSQL</th><th>MySQL, others</th></tr>
 259 <tr><td>
 260 <font size=-1><pre>
 261 CREATE TABLE cust_pay_temp (
 262   paynum int primary key,
 263   custnum int not null,
 264   paid decimal(10,2) not null,
 265   _date int null,
 266   payby char(4) not null,
 267   payinfo varchar(16) null,
 268   paybatch varchar(80) null
 269 );
 270 INSERT INTO cust_pay_temp SELECT * from cust_pay;
 271 DROP TABLE cust_pay;
 272 ALTER TABLE cust_pay_temp RENAME TO cust_pay;
 273 CREATE UNIQUE INDEX cust_pay1 ON cust_pay (paynum);
 274 CREATE TABLE cust_refund_temp (
 275   refundnum int primary key,
 276   custnum int not null,
 277   _date int null,
 278   refund decimal(10,2) not null,
 279   otaker varchar(8) not null,
 280   reason varchar(80) not null,
 281   payby char(4) not null,
 282   payinfo varchar(16) null,
 283   paybatch varchar(80) null
 284 );
 285 INSERT INTO cust_refund_temp SELECT * from cust_refund;
 286 DROP TABLE cust_refund;
 287 ALTER TABLE cust_refund_temp RENAME TO cust_refund;
 288 CREATE UNIQUE INDEX cust_refund1 ON cust_refund (refundnum);
 289 </pre></font>
 290 </td><td>
 291 <font size=-1><pre>
 292 ALTER TABLE cust_pay DROP COLUMN invnum;
 293 ALTER TABLE cust_refund DROP COLUMN crednum;
 294 </pre></font>
 295 </td></tr></table>
 296   <li><b>IMPORTANT: After applying the second set of database changes</b>, run bin/dbdef-create again.
 297   <li>set the <a href="../config/config.cgi#username_policy">user_policy configuration value</a> as appropriate for your site.
 298   <li>Create the `/usr/local/etc/freeside/cache.<i>datasrc</i>' directory
 299       (ownded by the freeside user).
 300   <li>freeside-queued was installed with the Perl modules.  Start it now and ensure that is run upon system startup.
 301 </ul>
 302 </body>