updated quick payment entry
[freeside.git] / httemplate / docs / upgrade10.html
index e984073..a4ed271 100644 (file)
 <pre>
 this is incomplete
 
-install DBIx::DBSchema 0.22
-
-install NetAddr::IP, Chart::Base, IPC::ShareLite and Locale::SubCountry
-
-CREATE TABLE cust_bill_pkg_detail (
-  detailnum serial,
-  pkgnum int NOT NULL,
-  invnum int NOT NULL,
-  detail varchar(80),
-  PRIMARY KEY (detailnum)
-);
-CREATE INDEX cust_bill_pkg_detail1 ON cust_bill_pkg_detail ( pkgnum, invnum );
-
-CREATE TABLE part_virtual_field (
-  vfieldpart int NOT NULL,
-  dbtable varchar(32) NOT NULL,
-  name varchar(32) NOT NULL,
-  check_block text,
-  list_source text,
-  length integer,
-  label varchar(80),
-  PRIMARY KEY (vfieldpart)
-);
-
-CREATE TABLE virtual_field (
-  recnum integer NOT NULL,
-  vfieldpart integer NOT NULL,
-  value varchar(128) NOT NULL,
-  PRIMARY KEY (vfieldpart, recnum)
-);
-
-CREATE TABLE router (
-  routernum serial,
-  routername varchar(80),
-  svcnum int,
-  PRIMARY KEY (routernum)
-);
-
-CREATE TABLE part_svc_router (
-  svcpart int NOT NULL,
-  routernum int NOT NULL
-);
-
-CREATE TABLE addr_block (
-  blocknum serial,
-  routernum int NOT NULL,
-  ip_gateway varchar(15) NOT NULL,
-  ip_netmask int NOT NULL,
-  PRIMARY KEY (blocknum)
-);
-CREATE UNIQUE INDEX addr_block1 ON addr_block ( blocknum, routernum );
-
-CREATE TABLE svc_broadband (
-  svcnum int NOT NULL,
-  blocknum int NOT NULL,
-  speed_up int NOT NULL,
-  speed_down int NOT NULL,
-  ip_addr varchar(15),
-  PRIMARY KEY (svcnum)
-);
-
-CREATE TABLE acct_snarf (
-  snarfnum serial,
-  svcnum int NOT NULL,
-  machine varchar(255) NULL,
-  protocol varchar(80) NULL,
-  username varchar(80) NULL,
-  _password varchar(80) NULL,
-  PRIMARY KEY (snarfnum)
-);
-CREATE INDEX acct_snarf1 ON acct_snarf ( svcnum );
-
-CREATE TABLE svc_external (
-  svcnum int NOT NULL,
-  id int NOT NULL,
-  title varchar(80),
-  PRIMARY KEY (svcnum)
-);
-
-CREATE TABLE part_pkg_temp (
-    pkgpart serial NOT NULL,
-    pkg varchar(80) NOT NULL,
-    "comment" varchar(80) NOT NULL,
-    setup text NULL,
-    freq varchar(80) NOT NULL,
-    recur text NULL,
-    setuptax char(1) NULL,
-    recurtax char(1) NULL,
-    plan varchar(80) NULL,
-    plandata text NULL,
-    disabled char(1) NULL,
-    taxclass varchar(80) NULL,
-    PRIMARY KEY (pkgpart),
-);
-INSERT INTO part_pkg_temp SELECT * from part_pkg;
-DROP TABLE part_pkg;
-ALTER TABLE part_pkg_temp RENAME TO part_pkg;
-ALTER TABLE part_pkg DROP CONSTRAINT part_pkg_temp_pkey;
-ALTER TABLE part_pkg ADD PRIMARY KEY (pkgpart);
-CREATE INDEX part_pkg1 ON part_pkg(disabled);
-select setval('public.part_pkg_temp_pkgpart_seq', ( select max(pkgpart) from part_pkg) ); #?
-
-CREATE TABLE h_part_pkg_temp (
-    historynum serial NOT NULL,
-    history_date int,
-    history_user varchar(80) NOT NULL,
-    history_action varchar(80) NOT NULL,
-    pkgpart int NOT NULL,
-    pkg varchar(80) NOT NULL,
-    "comment" varchar(80) NOT NULL,
-    setup text NULL,
-    freq varchar(80) NOT NULL,
-    recur text NULL,
-    setuptax char(1) NULL,
-    recurtax char(1) NULL,
-    plan varchar(80) NULL,
-    plandata text NULL,
-    disabled char(1) NULL,
-    taxclass varchar(80) NULL,
-    PRIMARY KEY (historynum)
-);
-INSERT INTO h_part_pkg_temp SELECT * from h_part_pkg;
-DROP TABLE h_part_pkg;
-ALTER TABLE h_part_pkg_temp RENAME TO h_part_pkg;
-ALTER TABLE h_part_pkg DROP CONSTRAINT h_part_pkg_temp_pkey;
-ALTER TABLE h_part_pkg ADD PRIMARY KEY (historynum);
-CREATE INDEX h_part_pkg1 ON h_part_pkg(disabled);
-select setval('public.h_part_pkg_temp_historynum_seq', ( select max(historynum) from h_part_pkg) );
+NOTE: Version numbering has been simplified.  1.5.7 is the version after
+1.5.0pre6.  It is still a development version - releases with odd numbered 
+middle parts (NN in x.NN.x) are development versions, like Perl or Linux.
 
+If migrating from 1.5.7, see README.1.5.8 instead
+
+If migrating from 1.5.0pre6, see README.1.5.7 instead
+
+install JSON
+install DBD::Pg 1.32, 1.41 or later (not 1.40) (or, if you're using a Perl version before 5.6, you could try installing DBD::Pg 1.22 with <a href="http://420.am/~ivan/DBD-Pg-1.22-fixvercmp.patch">this patch</a> and commenting out the "use DBD::Pg 1.32" at the top of DBIx/DBSchema/DBD/Pg.pm)
+install DBIx::DBSchema 0.26
+install Net::SSH 0.08
+install HTML::Widgets::SelectLayers 0.05
+
+- If using Apache::ASP, add PerlSetVar RequestBinaryRead Off and PerlSetVar IncludesDir /your/freeside/document/root/ to your Apache configuration and make sure you are using Apache::ASP minimum version 2.55.
+- In httpd.conf, change &lt;Files ~ \.cgi&gt; to  &lt;Files ~ (\.cgi|\.html)&gt;
+- In httpd.conf, change <b>AddHandler perl-script .cgi</b> or <b>SetHandler perl-script</b> to <b>AddHandler perl-script .cgi .html</b>
+
+install NetAddr::IP, Chart::Base, Locale::SubCountry, Text::CSV_XS, 
+Spreadsheet::WriteExcel, IO-stringy (IO::Scalar), Frontier::RPC
+(Frontier::RPC2), MIME::Entity (MIME-tools) and IPC::Run3
+<!-- and Crypt::YAPassGen-->
+
+INSERT INTO msgcat ( msgnum, msgcode, locale, msg ) VALUES ( 20, 'svc_external-id', 'en_US', 'External ID' );
+INSERT INTO msgcat ( msgnum, msgcode, locale, msg ) VALUES ( 21, 'svc_external-title', 'en_US', 'Title' );
 
 DROP INDEX cust_bill_pkg1;
 
-ALTER TABLE cust_bill_pkg ADD itemdesc varchar(80) NULL;
-ALTER TABLE h_cust_bill_pkg ADD itemdesc varchar(80) NULL;
-ALTER TABLE cust_main_county ADD taxname varchar(80) NULL;
-ALTER TABLE h_cust_main_county ADD taxname varchar(80) NULL;
-ALTER TABLE cust_main_county ADD setuptax char(1) NULL;
-ALTER TABLE h_cust_main_county ADD setuptax char(1) NULL;
-ALTER TABLE cust_main_county ADD recurtax char(1) NULL;
-ALTER TABLE h_cust_main_county ADD recurtax char(1) NULL;
-ALTER TABLE cust_pkg ADD last_bill int NULL;
-ALTER TABLE h_cust_pkg ADD last_bill int NULL;
-ALTER TABLE agent ADD disabled char(1) NULL;
-ALTER TABLE h_agent ADD disabled char(1) NULL;
-ALTER TABLE agent ADD username varchar(80) NULL;
-ALTER TABLE h_agent ADD username varchar(80) NULL;
-ALTER TABLE agent ADD _password varchar(80) NULL;
-ALTER TABLE h_agent ADD _password varchar(80) NULL;
-ALTER TABLE cust_main ADD paycvv varchar(4) NULL;
-ALTER TABLE h_cust_main ADD paycvv varchar(4) NULL;
-ALTER TABLE part_referral ADD disabled char(1) NULL;
-ALTER TABLE h_part_referral ADD disabled char(1) NULL;
-CREATE INDEX part_referral1 ON part_referral ( disabled );
-ALTER TABLE pkg_svc ADD primary_svc char(1) NULL;
-ALTER TABLE h_pkg_svc ADD primary_svc char(1) NULL;
-
-dump database, edit:
-- cust_main: increase otaker from 8 to 32
-- cust_main: change ss from char(11) to varchar(11)
-- cust_credit: increase otaker from 8 to 32
-- cust_pkg: increase otaker from 8 to 32
-- cust_refund: increase otaker from 8 to 32
-- domain_record: increase reczone from 80 to 255
-- domain_record: change rectype from char to varchar
-- domain_record: increase recdata from 80 to 255
-then reload
+On recent Pg versions:
 
-optionally:
+ALTER TABLE cust_main ALTER COLUMN payinfo varchar(512) NULL;
+ALTER TABLE h_cust_main ALTER COLUMN payinfo varchar(512) NULL;
 
-  CREATE INDEX cust_main6 ON cust_main ( daytime );
-  CREATE INDEX cust_main7 ON cust_main ( night );
-  CREATE INDEX cust_main8 ON cust_main ( fax );
-  CREATE INDEX cust_main9 ON cust_main ( ship_daytime );
-  CREATE INDEX cust_main10 ON cust_main ( ship_night );
-  CREATE INDEX cust_main11 ON cust_main ( ship_fax );
-  CREATE INDEX agent2 ON agent ( disabled );
-  CREATE INDEX part_bill_event2 ON part_bill_event ( disabled );
+Or on older Pg versions that don't support altering columns directly:
+(write me)
 
-  serial columns
+On recent Pg versions:
+
+ALTER TABLE svc_forward ALTER COLUMN srcsvc DROP NOT NULL;
+ALTER TABLE h_svc_forward ALTER COLUMN srcsvc DROP NOT NULL;
+ALTER TABLE svc_forward ALTER COLUMN dstsvc DROP NOT NULL;
+ALTER TABLE h_svc_forward ALTER COLUMN dstsvc DROP NOT NULL;
+ALTER TABLE cust_main ALTER COLUMN zip DROP NOT NULL;
+ALTER TABLE h_cust_main ALTER COLUMN zip DROP NOT NULL;
+
+Or on Pg versions that don't support DROP NOT NULL (tested on 7.1 and 7.2 so far):
+UPDATE pg_attribute SET attnotnull = FALSE WHERE ( attname = 'srcsvc' OR attname = 'dstsvc' ) AND ( attrelid = ( SELECT oid FROM pg_class WHERE relname = 'svc_forward' ) OR attrelid = ( SELECT oid FROM pg_class WHERE relname = 'h_svc_forward' ) );
+UPDATE pg_attribute SET attnotnull = FALSE WHERE ( attname = 'zip' ) AND ( attrelid = ( SELECT oid FROM pg_class WHERE relname = 'cust_main' ) OR attrelid = ( SELECT oid FROM pg_class WHERE relname = 'h_cust_main' ) );
+
+If you created your database with a version before 1.4.2, dump database, edit:
+- cust_main and h_cust_main: increase otaker from 8 to 32
+- cust_main and h_cust_main: change ss from char(11) to varchar(11) ( "character(11)" to "character varying(11)" )
+- cust_credit and h_cust_credit: increase otaker from 8 to 32
+- cust_pkg and h_cust_pkg: increase otaker from 8 to 32
+- cust_refund and h_cust_refund: increase otaker from 8 to 32
+- domain_record and h_domain_record: increase reczone from 80 to 255
+- domain_record and h_domain_record: change rectype from char to varchar ( "character(5)" to "character varying(5)" )
+- domain_record and h_domain_record: increase recdata from 80 to 255
+then reload
 
 mandatory again:
 
-dbdef-create username
-create-history-tables username cust_bill_pkg_detail router part_svc_router addr_block svc_broadband acct_snarf svc_external
-dbdef-create username
+make install-perl-modules to install the new libraries and CLI utilities
+run "freeside-upgrade username" to create the remaining new tables and columns
+
+optionally:
+
+CREATE INDEX cust_main6 ON cust_main ( daytime );
+CREATE INDEX cust_main7 ON cust_main ( night );
+CREATE INDEX cust_main8 ON cust_main ( fax );
+CREATE INDEX cust_main9 ON cust_main ( ship_daytime );
+CREATE INDEX cust_main10 ON cust_main ( ship_night );
+CREATE INDEX cust_main11 ON cust_main ( ship_fax );
+CREATE INDEX agent2 ON agent ( disabled );
+CREATE INDEX part_bill_event2 ON part_bill_event ( disabled );
+CREATE INDEX cust_pay4 ON cust_pay (_date);
+CREATE INDEX part_referral1 ON part_referral ( disabled );
+CREATE INDEX part_pkg2 ON part_pkg ( promo_code );
+CREATE INDEX h_part_pkg2 ON h_part_pkg ( promo_code );
 
 apache - fix <Files> sections to include .html also