How to install SQLEdit.

1. Download the package source here.
   
     root@devel# wget .../SQLEdit-xx-yy-zz.tar.gz
    
2. Enter into you WebGUI root directory (default is /data/WebGUI)
   
       root@devel# cd /data/WebGUI
    
3. Extract SQLEdit into this directory
   
     root@devel# tar zxvf /dir/where/you/saved/SQLEdit-xx.yy.zz.tar.gz
    

   These files will be installed:

   • read1st-SQLEdit.txt
   • docs/SQLEdit/create.sql
   • docs/SQLEdit/create_01_pre_06_01.sql
   • docs/SQLEdit/install.txt
   • docs/SQLEdit/readme.txt
   • docs/SQLEdit/uninstall.sql
   • docs/SQLEdit/changelog/01.xx.xx.txt
   • docs/SQLEdit/changelog/06.xx.xx.txt
   • docs/SQLEdit/upgrades/upgrade_01.00.00_01.00.01.sql
   • docs/SQLEdit/upgrades/upgrade_01.00.01_01.00.02.sql
   • docs/SQLEdit/upgrades/upgrade_01.00.02_01.00.03.sql
   • docs/SQLEdit/upgrades/upgrade_01.00.03_01.00.04.sql
   • docs/SQLEdit/upgrades/upgrade_01.00.04_06.00.00.sql
   • docs/SQLEdit/upgrades/upgrade_06.00.00_06.00.01.sql
   • docs/SQLEdit/upgrades/upgrade_06.00.01_06.00.02.sql
   • docs/SQLEdit/upgrades/upgrade_06.00.02_06.00.03.sql
   • docs/SQLEdit/upgrades/upgrade_06.00.03_06.00.04.sql
   • docs/SQLEdit/upgrades/upgrade_06.00.04_06.00.05.sql
   • docs/SQLEdit/upgrades/upgrade_06.00.05_06.00.06.sql
   • docs/SQLEdit/upgrades/upgrade_06.00.06_06.00.07.sql
   • docs/SQLEdit/upgrades/upgrade_06.00.07_06.00.08.sql
   • docs/SQLEdit/upgrades/upgrade_06.00.08_06.00.09.sql
   • docs/SQLEdit/upgrades/upgrade_06.00.09_06.00.10.sql
   • docs/SQLEdit/upgrades/upgrade_06.00.11_06.00.12.sql
   • docs/SQLEdit/upgrades/upgrade_06.01.02_06.01.03.sql
   • docs/SQLEdit/upgrades/upgrade_06.01.03_06.01.04.sql
   • docs/SQLEdit/upgrades/upgrade_06.01.04_06.02.00.sql
   • docs/SQLEdit/upgrades/upgrade_06.02.02_06.02.03.sql
   • docs/SQLEdit/upgrades/upgrade_06.03.00_06.03.01.sql
   • docs/SQLEdit/upgrades/upgrade_06.03.02_06.03.03.sql
   • lib/WebGUI/Wobject/SQLEdit.pm
   • lib/WebGUI/i18n/English/SQLEdit.pm
   • lib/WebGUI/i18n/Italian/SQLEdit.pm
   • lib/WebGUI/Help/SQLEdit.pm
   • lib/DBIx/DBDescribe.pm
   • lib/DBIx/DBDescribe/DBD.pm
   • lib/DBIx/DBDescribe/DBD/mysql.pm
   • lib/DBIx/DBDescribe/DBD/mssql.pm

    

4. Execute sql query script (change the WebGUI database name to your database name)
   
     root@devel# mysql -p WebGUI < docs/SQLEdit/create.sql
    
5. If your WebGUI version is prior than 06.01.xx you must also execute this script

   
     root@devel# mysql -p WebGUI < docs/SQLEdit/create_01_pre_06_01.sql
    

6. Edit WebGUI.conf file to add SQLEdit module to Wobject list
   
     root@devel# vi /data/WebGUI/etc/WebGUI.conf
     ...
     wobjects = Article, EventsCalendar, ExtraColumn, FAQ, FileManager, \
     HttpProxy, Item, LinkList, DataForm, MessageBoard, Poll, Product, \
     SiteMap, SQLReport, Survey, SyndicatedContent, USS, WobjectProxy, \
     SQLEdit
     ...
    
7. Restart web server (this shouldn't be necessary...)

Note about ^International; macro used in default template

Default template uses ^International; macro to create some piece of HTML traslated code. ^International; is a programmer macro and, by default, these macros are disabled in WebGUI. E.g., if you see ^International(62); in the submit button instead of "save", this macro is disabled.

To enable ^International, edit WebGUI.conf and append

International => International

into the end of macro section. As an example, if the last line of macro section was

u => u_companyUrl

replace with

u => u_companyUrl, \
International => International

Obviously you can always replace ^International macro in the template with your preferred statical translation but, in this way, you lost dynamical translation possibility.

How to upgrade.

1. Extract SQLEdit into your WebGUI directory
   
       root@devel# tar zxvf /dir/where/you/saved/SQLEdit-xx.yy.zz.tar.gz
    
2. Execute every sql scripts available in docs/SQLEdit/upgrades from your previous version until current version. Be carefull that if, from a version to another, no database changes have been made, no script is available. As an example, if you upgrade from 06.00.12 to 06.01.01 you have no script to execute but if you upgrade from 06.00.12 to 06.01.03 you must execute upgrade_06.01.02_06.01.03.sql.

How to uninstall.

1. Execute docs/SQLEdit/uninstall.sql sql script.
2. Delete every file listed in read1st-SQLEdit.txt file