Release 2.3.12
[fa-stable.git] / update.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2 <html><head>\r
3         <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-2">\r
4         \r
5         <title>FrontAccounting Update</title><meta name="GENERATOR" content="OpenOffice.org 2.4  (Linux)">\r
6         <meta name="CREATED" content="0;0">\r
7         <meta name="CHANGED" content="20100902;19041400"></head>\r
8 <body dir="ltr" lang="en-US">\r
9 <h4><strong><font color="#cc6600"><font style="font-size: 20pt;" size="5"><i>Front</i></font></font></strong><strong><font style="font-size: 20pt;" size="5">Accounting\r
10 Update</font></strong></h4><h2>Important Notes for release 2.3.12.</h2><h4>New global flags in config.php (config-default.php):</h4>/* <br>&nbsp;&nbsp;&nbsp; Display a dropdown select box for choosing Company to login if false.<br>&nbsp;&nbsp;&nbsp; Show a blank editbox only if true where the Company NickName<br>&nbsp;&nbsp;&nbsp; will have to be manually entered. This is when privacy is needed.<br>*/<br>&nbsp; &nbsp; <span style="font-weight: bold;">$text_company_selection</span>&nbsp; = false;<br><br>/*&nbsp; Should FA hide menu items (Applications, Modules, and Actions) from the user if they don't have access to them? <br>&nbsp;&nbsp;&nbsp; 0 for no&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 1 for yes<br>*/<br><br>&nbsp;&nbsp;&nbsp; <span style="font-weight: bold;">$hide_inaccessible_menu_items</span> = 0;<br><br>/*<br>&nbsp;&nbsp;&nbsp; Brute force prevention.<br>&nbsp;&nbsp;&nbsp; $login_delay seconds delay is required between login attempts after $login_max_attemps failed logins.<br>&nbsp;&nbsp;&nbsp; Set $login_delay to 0 to disable the feature (not recommended)<br>*/<br>&nbsp; &nbsp; <span style="font-weight: bold;">$login_delay</span> = 30;<br>&nbsp; &nbsp; <span style="font-weight: bold;">$login_max_attempts</span> = 10;<h2><strong></strong>Important Notes for release 2.3.5.</h2>\r
11 Change in the behaviour of <span style="font-weight: bold; font-style: italic;">Recurrent Invoices</span>.<br><ul><li>Now\r
12 the Last Sent day is stamped with the former Last Sent (or Begin date\r
13 the first time) + months + days. Before the Last Sent day was stamped\r
14 with tthe creation date (today). The Invoice date is still todays date.\r
15 </li><li>If you for some reason want to make a pause in the recurrent\r
16 invoices, you can now edit the Last Sent day in the Management section\r
17 of Sales tab.</li><li>Before the days value, together with a month\r
18 value, decided which day in the month the invoice was due.. &nbsp;This\r
19 does not&nbsp;work now. You can&nbsp;change the day in the month you\r
20 want the recurrency to happen by setting the Last Sent day with the new\r
21 day in the Management section.&nbsp;</li><li>If you create a new Recurrent Invoice the Beginning date can be set to the day in the month you want the recurrencies to be due.</li></ul>\r
22 <h2>Important Notes</h2>\r
23 <p>Upgrade process can be done only by administrator of the first\r
24 company created during FrontAccounting installation. This person is\r
25 considered as a site admin who have granted access to potentially\r
26 dangerous setup options, like Setup/Software Upgrade.</p>\r
27 <p>In the following description sections related to older FA versions are\r
28 prefixed with <span style="background: rgb(235, 97, 61) none repeat scroll 0% 50%; -moz-background-clip: initial; -moz-background-origin: initial; -moz-background-inline-policy: initial;">[color tags]</span><span style="background: transparent none repeat scroll 0% 50%; -moz-background-clip: initial; -moz-background-origin: initial; -moz-background-inline-policy: initial;">\r
29 . Y</span>ou can skip tagged fragment safely if currently FA\r
30 application is newer than the version in tag.</p>\r
31 <p>Upgrade process consists of up to four stages, some of them are\r
32 optional:</p>\r
33 <ol>\r
34         <li><p>Application source files update \r
35         </p>\r
36         </li><li><p>Database upgrade &#8211; this step is needed only during\r
37         upgrade which involves change in major application version number\r
38         (e.g. from 2.2.x to 2.3.x), and sometimes during upgrade from beta\r
39         release to stable version. Otherwise this step can be skipped.</p>\r
40         </li><li><p>Final cleanup &#8211; is needed when some old source files,\r
41         obsoleted by new release should be removed.</p>\r
42         </li><li><p>New features configuration &#8211; this is optional step\r
43         needed for most major releases and some minor ones. \r
44         </p>\r
45 </li></ol>\r
46 <p style="margin-bottom: 0cm;">Before starting upgrade ensure nobody\r
47 is using the application and make database backup for all companies.\r
48 To be on safe side backup also old source files, especially those\r
49 locally customized (if any).</p>\r
50 <p>Log into admin account of first company.<strong> </strong><strong><span style="">If\r
51 you use a theme other than the standard 3 (aqua, cool or default),\r
52 switch to one of these before going further.</span></strong></p>\r
53 <h2><strong><b>1. Application files update</b></strong></h2>\r
54 <p style="margin-top: 0.42cm; page-break-after: avoid;"><font face="Liberation Sans, sans-serif"><font size="4"><strong><span style="">a. Source\r
55 files update</span></strong></font></font></p>\r
56 <p><strong><span style="">Extract distribution\r
57 zip/tar.gz file in empty directory, and copy all the files to your\r
58 FrontAccounting directory overwriting old files. If it is major\r
59 release upgrade you can skip next step and go directly to cleanup.</span></strong></p>\r
60 <p style="margin-top: 0.42cm; page-break-after: avoid;"><strong><font face="Liberation Sans, sans-serif"><font size="4"><span style="">b. Configuration\r
61 files update</span></font></font></strong></p>\r
62 <p><strong><span style="">Compare new\r
63 </span></strong><strong><i><b>config.default.php</b></i></strong><strong>\r
64 </strong><strong><span style="">file with the old\r
65 </span></strong><strong><i><b>config.php </b></i></strong><strong><span style="font-style: normal;"><span style="">and\r
66 add all n</span></span></strong><strong><span style="">ew\r
67 settings (if any). </span></strong>\r
68 </p>\r
69 <p><strong><span style=""><span style="background: rgb(235, 97, 61) none repeat scroll 0% 50%; -moz-background-clip: initial; -moz-background-origin: initial; -moz-background-inline-policy: initial;">[&lt;FA\r
70 2.2beta]</span></span></strong></p>\r
71 <p><strong> <span style="">$show_users_online = 0;</span></strong></p>\r
72 <p><strong> <span style="">$def_print_destination\r
73 = 0;</span></strong></p>\r
74 <p><strong><span style="">$dflt_date_fmt=0;</span></strong></p>\r
75 <p><strong><span style="">$dflt_date_sep=0;</span></strong></p>\r
76 <p><strong><span style="">$table_style,table_style2\r
77 changed</span></strong></p>\r
78 <p><strong><span style=""><span style="background: rgb(235, 97, 61) none repeat scroll 0% 50%; -moz-background-clip: initial; -moz-background-origin: initial; -moz-background-inline-policy: initial;">[&lt;FA\r
79 2.3beta]</span></span></strong></p>\r
80 <p><strong> <span style="">$alternative_tax_include_on_doc=0;</span></strong></p>\r
81 <p><strong><span style="">$suppress_tax_rates = 0;</span></strong></p>\r
82 <p><strong><span style=""><span style="background: rgb(235, 97, 61) none repeat scroll 0% 50%; -moz-background-clip: initial; -moz-background-origin: initial; -moz-background-inline-policy: initial;">[&lt;FA\r
83 2.3RC1]</span></span></strong><strong> </strong>\r
84 </p>\r
85 <p><strong><span style="">Application version\r
86 information and a couple of other private FA variables are stored in\r
87 </span></strong><strong><i><b>version.php</b></i></strong><strong>\r
88 </strong><strong><span style="">file. The\r
89 application version displayed in footer is defined in $version\r
90 variable unless this is set in config.php file. If you want current\r
91 release version to be displayed on every FA update just remove or\r
92 comment out $version variable in </span></strong><strong><span style="font-style: normal;"><span style="">config.php</span></span></strong><strong><span style="">.</span></strong></p>\r
93 <p><strong><span style=""><span style="background: rgb(235, 97, 61) none repeat scroll 0% 50%; -moz-background-clip: initial; -moz-background-origin: initial; -moz-background-inline-policy: initial;">[&lt;FA\r
94 2.3RC2]</span></span></strong></p>\r
95 <p><strong> <span style="">$save_report_selections &nbsp;= 0; &nbsp;// A value &gt; 0 means days to save the report selections.</span></strong></p><p><strong><span style=""><span style="background: rgb(235, 97, 61) none repeat scroll 0% 50%; -moz-background-clip: initial; -moz-background-origin: initial; -moz-background-inline-policy: initial;">[&lt;FA\r
96 2.3]</span></span></strong></p><p><strong> <span style="">$save_po_item_codes &nbsp;= 0; &nbsp;//&nbsp; show item codes on purchase order&nbsp;</span></strong></p><p><strong><span style="">$def_print_destination = 0; // &nbsp;default print destination. 0 = PDF/Printer, 1 = Excel</span></strong></p><p><strong><span style="">$alternative_tax_include_on_docs = 0; // &nbsp;1 = print Subtotal tax excluded, tax and Total tax included</span></strong></p><p><strong><span style="">$suppress_tax_rates = 0; // &nbsp;suppress tax rates on documents. 0 = no, 1 = yes.</span></strong></p><strong><span style=""><span style="background: rgb(235, 97, 61) none repeat scroll 0% 50%; -moz-background-clip: initial; -moz-background-origin: initial; -moz-background-inline-policy: initial;"></span></span></strong>\r
97 \r
98 <strong><span style=""><span style="background: rgb(235, 97, 61) none repeat scroll 0% 50%; -moz-background-clip: initial; -moz-background-origin: initial; -moz-background-inline-policy: initial;"></span></span></strong><h2><strong><b>2. Database upgrade</b></strong></h2>\r
99 <p><strong><span style="">This step can be skipped\r
100 for small version updates i.e. when you have already installed\r
101 FrontAccounting version 2.3.1 or later. Before database upgrade is\r
102 done on all company databases backup file is created automatically to\r
103 enable database restore after failure.</span></strong></p>\r
104 <p><strong><span style="">After major version\r
105 upgrade overwriting files in first step makes the system unaccessible\r
106 for all users but site admin, who have to run upgrade procedures to\r
107 update all company databases to the new version provided with the\r
108 release. After logging to administrator account of first installed\r
109 company go directly to Setup/Software Upgrade screen, mark all\r
110 subsequent 'Install' checkboxes and press 'Upgrade System'.</span></strong></p>\r
111 <p style="">If something goes wrong during\r
112 upgrade, you can eventually try forced upgrade option. Forced upgrade\r
113 ignores some smaller errors which can arise during upgrade due to\r
114 some exotic database configuration. This is depreciated option, so\r
115 first read error messages if any, try to fix signalized problems,\r
116 restore databases from backup and retry normal installation. To run\r
117 upgrade in forced mode check box 'Force Upgrade', and press 'Upgrade\r
118 System' again.</p>\r
119 <h2>3. Final cleanup</h2>\r
120 <p>Remove or rename install folder in main FrontAccounting directory.\r
121 </p>\r
122 <p>After upgrade is installed you can remove files obsoleted by new\r
123 FrontAccounting version. Also old, unused settings <span style="font-style: normal;"><span style="">can\r
124 be removed from  </span></span><i><b>config.php</b></i><span style="font-style: normal;"><span style="">\r
125 file.</span></span></p>\r
126 <p style="margin-top: 0.42cm; page-break-after: avoid;"><font face="Liberation Sans, sans-serif"><font size="4">a.\r
127 Source files cleanup</font></font></p>\r
128 <p><strong><span style=""><span style="background: rgb(235, 97, 61) none repeat scroll 0% 50%; -moz-background-clip: initial; -moz-background-origin: initial; -moz-background-inline-policy: initial;">[&lt;FA\r
129 2.2beta]</span></span></strong></p>\r
130 <p><strong><span style=""><span style="background: transparent none repeat scroll 0% 50%; -moz-background-clip: initial; -moz-background-origin: initial; -moz-background-inline-policy: initial;">/includes/reserved.inc\r
131 &#8211; removed.</span></span></strong></p>\r
132 <p><strong><span style=""><span style="background: rgb(235, 97, 61) none repeat scroll 0% 50%; -moz-background-clip: initial; -moz-background-origin: initial; -moz-background-inline-policy: initial;">[&lt;FA\r
133 2.1]</span></span></strong><strong> </strong>\r
134 </p>\r
135 <p><strong><span style="">/admin/db/v_banktrans.inc\r
136 - removed</span></strong></p>\r
137 <p style="margin-top: 0.42cm; page-break-after: avoid;"><font face="Liberation Sans, sans-serif"><font size="4"><span style="font-style: normal;"><span style="">b.\r
138 Config.php cleanup </span></span></font></font>\r
139 </p>\r
140 <p><strong><span style=""><span style="background: rgb(235, 97, 61) none repeat scroll 0% 50%; -moz-background-clip: initial; -moz-background-origin: initial; -moz-background-inline-policy: initial;">[&lt;FA\r
141 2.2RC1]</span></span></strong><strong> </strong>\r
142 </p>\r
143 <p><strong><span style="">$security_headings,\r
144 $security_groups arrays &#8211; moved to database (see Access Setup) \r
145 </span></strong>\r
146 </p>\r
147 <p><strong><span style="">$def_app &#8211; moved\r
148 to user configuration in database.</span></strong></p>\r
149 <p><strong><span style="font-style: normal;"><span style="">$version\r
150 &#8211; moved to </span></span></strong><strong><i><b>version.php</b></i></strong><strong><span style="font-style: normal;"><span style="">\r
151 file. Remove</span></span></strong></p>\r
152 <h2>4. New features configuration</h2>\r
153 <p>During upgrade process new features are initialized to default\r
154 status, and sometimes old settings are also changed to conform with\r
155 new security policy. This automatic process is designed to be as\r
156 neutral for end users as possible, however sometimes site or company\r
157 admin intervention can be necessary to set thing after changes to\r
158 their best state. Below you will find description of new settings\r
159 available after upgrade.</p>\r
160 <p><br><br>\r
161 </p>\r
162 <p>----------------------</p>\r
163 <ul></ul>\r
164 </body></html>