Merged changes form stabel branch up to the current state (2.3.22+).
[fa-stable.git] / update.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2 <html><head>\r
3 \r
4 \r
5 \r
6 \r
7 \r
8 <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1"><title>FrontAccounting Update</title>\r
9 \r
10 <meta name="GENERATOR" content="OpenOffice.org 2.4 (Linux)">\r
11 <meta name="CREATED" content="0;0">\r
12 <meta name="CHANGED" content="20100902;19041400"></head><body style="direction: ltr;" lang="en-US">\r
13 <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
14 Update</font></strong></h4>\r
15 <h2>Important Notes for release 2.3.22.</h2>\r
16 \r
17 \r
18 <h4>New global flags in config.php (config-default.php):</h4>\r
19 /* Show average costed values instead of fixed standard cost */ In Enventory Valuation Report.<br>\r
20 <span style="font-weight: bold;">$use_costed_values = 0;</span><br>\r
21 <br>\r
22 /* Print Item Images on Sales Quotations. Set to 1 if so. */<br>\r
23 <span style="font-weight: bold;">$print_item_images_on_quote = 0;</span><br>\r
24 <h2>Important Notes for release 2.3.21.</h2>\r
25 \r
26 \r
27 \r
28 \r
29 <h4>Crucial security patches:</h4>\r
30 \r
31 This version consists of crucial security patches and this applies especially to all publicly available servers, <br>\r
32 &nbsp;f.i. installations which are run in not fully trusted environment like public demos, shared accounts or SAAS.<br>\r
33 <h4>New global flags in config.php (config-default.php):</h4>\r
34 /* Whether to allow sending new password by e-mail */<br>\r
35 <span style="font-weight: bold;">$allow_password_reset = false</span><h2>Important Notes for release 2.3.20.</h2>\r
36 \r
37 \r
38 <h4>Crucial security patches:</h4>\r
39 This version consists of crucial security patches and all guest FA\r
40 installations (I mean whenever FA is run in not fully trusted\r
41 environment) should be updtaed.<br>\r
42 <h2>Important Notes for release 2.3.17.</h2>\r
43 \r
44 <h4>New global flags in config.php (config-default.php):</h4>\r
45 /*<br>\r
46 &nbsp;&nbsp;&nbsp; Choose Exchange Rate Provider<br>\r
47 &nbsp;&nbsp;&nbsp; Default is ECB for backwards compatibility<br>\r
48 */<br>\r
49 <span style="font-weight: bold;">$xr_providers = array("ECB", "YAHOO", "GOOGLE", "BLOOMBERG");<br>\r
50 $dflt_xr_provider = 0;<br>\r
51 <br>\r
52 </span>/*<br>\r
53 &nbsp;&nbsp;&nbsp; Set to true when remote service is authoritative\r
54 source of exchange rates, and can be stored automatically without<br>\r
55 &nbsp;&nbsp;&nbsp; manual edition. Otherwise exrate is stored on first new currency transaction of the day.<br>\r
56 */<br>\r
57 <span style="font-weight: bold;">$xr_provider_authoritative = false;<br>\r
58 </span><h2>Important Notes for release 2.3.16.</h2>\r
59 <h4>New global flags in config.php (config-default.php):</h4><span style="font-weight: bold;">/*<br>&nbsp;&nbsp; </span>&nbsp;Optional sorting new sales documents lines according to item code<span style="font-weight: bold;"><br>*/<br>$sort_sales_items = false;<br><br>/*<br>&nbsp;&nbsp; &nbsp;</span>Trial Balance opening balance presentation option.<br>&nbsp;&nbsp; &nbsp;When set to true past years part of opening balance is cleared.<span style="font-weight: bold;"><br>*/<br>$clear_trial_balance_opening = false;</span><h2>Important Notes for release 2.3.14.</h2>\r
60 <h4>New global flags in config.php (config-default.php):</h4>\r
61 /* default print orientation. 0 = Portrait, 1 = Landscape */<br>\r
62 &nbsp;&nbsp;&nbsp; <span style="font-weight: bold;">$def_print_orientation\r
63 = 0;</span><br>\r
64 <h2>Important Notes for release 2.3.13.</h2>\r
65 <h4>New global flags in config.php (config-default.php):</h4>\r
66 /* No check on edit conflicts. Maybe needed to be set to 1 in certains\r
67 Windows Servers */<br>\r
68 &nbsp;&nbsp;&nbsp; <span style="font-weight: bold;">$no_check_edit_conflicts\r
69 = 0;</span><br>\r
70 <h2>Important Notes for release 2.3.12.</h2>\r
71 <h4>New global flags in config.php (config-default.php):</h4>\r
72 /* <br>\r
73 &nbsp;&nbsp;&nbsp; Display a dropdown select box for\r
74 choosing Company to login if false.<br>\r
75 &nbsp;&nbsp;&nbsp; Show a blank editbox only if true where\r
76 the Company NickName<br>\r
77 &nbsp;&nbsp;&nbsp; will have to be manually entered. This\r
78 is when privacy is needed.<br>\r
79 */<br>\r
80 &nbsp; &nbsp; <span style="font-weight: bold;">$text_company_selection</span>&nbsp;\r
81 = false;<br>\r
82 <br>\r
83 /*&nbsp; Should FA hide menu items (Applications, Modules, and\r
84 Actions) from the user if they don't have access to them? <br>\r
85 &nbsp;&nbsp;&nbsp; 0 for\r
86 no&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 1 for yes<br>\r
87 */<br>\r
88 <br>\r
89 &nbsp;&nbsp;&nbsp; <span style="font-weight: bold;">$hide_inaccessible_menu_items</span>\r
90 = 0;<br>\r
91 <br>\r
92 /*<br>\r
93 &nbsp;&nbsp;&nbsp; Brute force prevention.<br>\r
94 &nbsp;&nbsp;&nbsp; $login_delay seconds delay is required\r
95 between login attempts after $login_max_attemps failed logins.<br>\r
96 &nbsp;&nbsp;&nbsp; Set $login_delay to 0 to disable the\r
97 feature (not recommended)<br>\r
98 */<br>\r
99 &nbsp; &nbsp; <span style="font-weight: bold;">$login_delay</span>\r
100 = 30;<br>\r
101 &nbsp; &nbsp; <span style="font-weight: bold;">$login_max_attempts</span>\r
102 = 10;\r
103 <h2><strong></strong>Important Notes for release\r
104 2.3.5.</h2>\r
105 Change in the behaviour of <span style="font-weight: bold; font-style: italic;">Recurrent\r
106 Invoices</span>.<br>\r
107 <ul>\r
108 <li>Now\r
109 the Last Sent day is stamped with the former Last Sent (or Begin date\r
110 the first time) + months + days. Before the Last Sent day was stamped\r
111 with tthe creation date (today). The Invoice date is still todays date.\r
112 </li>\r
113 <li>If you for some reason want to make a pause in the\r
114 recurrent\r
115 invoices, you can now edit the Last Sent day in the Management section\r
116 of Sales tab.</li>\r
117 <li>Before the days value, together with a month\r
118 value, decided which day in the month the invoice was due..\r
119 &nbsp;This\r
120 does not&nbsp;work now. You can&nbsp;change the day in the\r
121 month you\r
122 want the recurrency to happen by setting the Last Sent day with the new\r
123 day in the Management section.&nbsp;</li>\r
124 <li>If you create a new Recurrent Invoice the Beginning date\r
125 can be set to the day in the month you want the recurrencies to be due.</li>\r
126 </ul>\r
127 <h2>Important Notes</h2>\r
128 <p>Upgrade process can be done only by administrator of the first\r
129 company created during FrontAccounting installation. This person is\r
130 considered as a site admin who have granted access to potentially\r
131 dangerous setup options, like Setup/Software Upgrade.</p>\r
132 <p>In the following description sections related to older FA\r
133 versions are\r
134 prefixed with <span style="background: rgb(235, 97, 61) none repeat scroll 0% 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;">[color\r
135 tags]</span><span style="background: transparent none repeat scroll 0% 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;">\r
136 . Y</span>ou can skip tagged fragment safely if currently FA\r
137 application is newer than the version in tag.</p>\r
138 <p>Upgrade process consists of up to four stages, some of them\r
139 are\r
140 optional:</p>\r
141 <ol>\r
142 <li>\r
143 <p>Application source files update </p>\r
144 </li>\r
145 <li>\r
146 <p>Database upgrade &#8211; this step is needed only during upgrade\r
147 which involves change in major application version number (e.g. from\r
148 2.2.x to 2.3.x), and sometimes during upgrade from beta release to\r
149 stable version. Otherwise this step can be skipped.</p>\r
150 </li>\r
151 <li>\r
152 <p>Final cleanup &#8211; is needed when some old source files,\r
153 obsoleted by new release should be removed.</p>\r
154 </li>\r
155 <li>\r
156 <p>New features configuration &#8211; this is optional step needed\r
157 for most major releases and some minor ones. </p>\r
158 </li>\r
159 </ol>\r
160 <p style="margin-bottom: 0cm;">Before starting upgrade\r
161 ensure nobody\r
162 is using the application and make database backup for all companies.\r
163 To be on safe side backup also old source files, especially those\r
164 locally customized (if any).</p>\r
165 <p>Log into admin account of first company.<strong> </strong><strong><span style="">If\r
166 you use a theme other than the standard 3 (aqua, cool or default),\r
167 switch to one of these before going further.</span></strong></p>\r
168 <h2><strong><b>1. Application files update</b></strong></h2>\r
169 <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
170 files update</span></strong></font></font></p>\r
171 <p><strong><span style="">Extract distribution\r
172 zip/tar.gz file in empty directory, and copy all the files to your\r
173 FrontAccounting directory overwriting old files. If it is major\r
174 release upgrade you can skip next step and go directly to cleanup.</span></strong></p>\r
175 <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
176 files update</span></font></font></strong></p>\r
177 <p><strong><span style="">Compare new\r
178 </span></strong><strong><i><b>config.default.php</b></i></strong><strong>\r
179 </strong><strong><span style="">file with the\r
180 old\r
181 </span></strong><strong><i><b>config.php </b></i></strong><strong><span style="font-style: normal;"><span style="">and\r
182 add all n</span></span></strong><strong><span style="">ew\r
183 settings (if any). </span></strong>\r
184 </p>\r
185 <p><strong><span style=""><span style="background: rgb(235, 97, 61) none repeat scroll 0% 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;">[&lt;FA\r
186 2.2beta]</span></span></strong></p>\r
187 <p><strong> <span style="">$show_users_online\r
188 = 0;</span></strong></p>\r
189 <p><strong> <span style="">$def_print_destination\r
190 = 0;</span></strong></p>\r
191 <p><strong><span style="">$dflt_date_fmt=0;</span></strong></p>\r
192 <p><strong><span style="">$dflt_date_sep=0;</span></strong></p>\r
193 <p><strong><span style="">$table_style,table_style2\r
194 changed</span></strong></p>\r
195 <p><strong><span style=""><span style="background: rgb(235, 97, 61) none repeat scroll 0% 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;">[&lt;FA\r
196 2.3beta]</span></span></strong></p>\r
197 <p><strong> <span style="">$alternative_tax_include_on_doc=0;</span></strong></p>\r
198 <p><strong><span style="">$suppress_tax_rates\r
199 = 0;</span></strong></p>\r
200 <p><strong><span style=""><span style="background: rgb(235, 97, 61) none repeat scroll 0% 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;">[&lt;FA\r
201 2.3RC1]</span></span></strong><strong> </strong>\r
202 </p>\r
203 <p><strong><span style="">Application version\r
204 information and a couple of other private FA variables are stored in\r
205 </span></strong><strong><i><b>version.php</b></i></strong><strong>\r
206 </strong><strong><span style="">file. The\r
207 application version displayed in footer is defined in $version\r
208 variable unless this is set in config.php file. If you want current\r
209 release version to be displayed on every FA update just remove or\r
210 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
211 <p><strong><span style=""><span style="background: rgb(235, 97, 61) none repeat scroll 0% 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;">[&lt;FA\r
212 2.3RC2]</span></span></strong></p>\r
213 <p><strong> <span style="">$save_report_selections\r
214 &nbsp;= 0; &nbsp;// A value &gt; 0 means days to save the\r
215 report selections.</span></strong></p>\r
216 <p><strong><span style=""><span style="background: rgb(235, 97, 61) none repeat scroll 0% 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;">[&lt;FA\r
217 2.3]</span></span></strong></p>\r
218 <p><strong> <span style="">$save_po_item_codes\r
219 &nbsp;= 0; &nbsp;//&nbsp; show item codes on purchase\r
220 order&nbsp;</span></strong></p>\r
221 <p><strong><span style="">$def_print_destination\r
222 = 0; // &nbsp;default print destination. 0 = PDF/Printer, 1 = Excel</span></strong></p>\r
223 <p><strong><span style="">$alternative_tax_include_on_docs\r
224 = 0; // &nbsp;1 = print Subtotal tax excluded, tax and Total tax\r
225 included</span></strong></p>\r
226 <p><strong><span style="">$suppress_tax_rates\r
227 = 0; // &nbsp;suppress tax rates on documents. 0 = no, 1 = yes.</span></strong></p>\r
228 <strong><span style=""><span style="background: rgb(235, 97, 61) none repeat scroll 0% 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;"></span></span></strong><strong><span style=""><span style="background: rgb(235, 97, 61) none repeat scroll 0% 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;"></span></span></strong>\r
229 <h2><strong><b>2. Database upgrade</b></strong></h2>\r
230 <p><strong><span style="">This step can be\r
231 skipped\r
232 for small version updates i.e. when you have already installed\r
233 FrontAccounting version 2.3.1 or later. Before database upgrade is\r
234 done on all company databases backup file is created automatically to\r
235 enable database restore after failure.</span></strong></p>\r
236 <p><strong><span style="">After major version\r
237 upgrade overwriting files in first step makes the system unaccessible\r
238 for all users but site admin, who have to run upgrade procedures to\r
239 update all company databases to the new version provided with the\r
240 release. After logging to administrator account of first installed\r
241 company go directly to Setup/Software Upgrade screen, mark all\r
242 subsequent 'Install' checkboxes and press 'Upgrade System'.</span></strong></p>\r
243 <p style="">If something goes wrong during\r
244 upgrade, you can eventually try forced upgrade option. Forced upgrade\r
245 ignores some smaller errors which can arise during upgrade due to\r
246 some exotic database configuration. This is depreciated option, so\r
247 first read error messages if any, try to fix signalized problems,\r
248 restore databases from backup and retry normal installation. To run\r
249 upgrade in forced mode check box 'Force Upgrade', and press 'Upgrade\r
250 System' again.</p>\r
251 <h2>3. Final cleanup</h2>\r
252 <p>Remove or rename install folder in main FrontAccounting\r
253 directory.\r
254 </p>\r
255 <p>After upgrade is installed you can remove files obsoleted by\r
256 new\r
257 FrontAccounting version. Also old, unused settings <span style="font-style: normal;"><span style="">can\r
258 be removed from </span></span><i><b>config.php</b></i><span style="font-style: normal;"><span style="">\r
259 file.</span></span></p>\r
260 <p style="margin-top: 0.42cm; page-break-after: avoid;"><font face="Liberation Sans, sans-serif"><font size="4">a.\r
261 Source files cleanup</font></font></p>\r
262 <p><strong><span style=""><span style="background: rgb(235, 97, 61) none repeat scroll 0% 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;">[&lt;FA\r
263 2.2beta]</span></span></strong></p>\r
264 <p><strong><span style=""><span style="background: transparent none repeat scroll 0% 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;">/includes/reserved.inc\r
265 &#8211; removed.</span></span></strong></p>\r
266 <p><strong><span style=""><span style="background: rgb(235, 97, 61) none repeat scroll 0% 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;">[&lt;FA\r
267 2.1]</span></span></strong><strong> </strong>\r
268 </p>\r
269 <p><strong><span style="">/admin/db/v_banktrans.inc\r
270 - removed</span></strong></p>\r
271 <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
272 Config.php cleanup </span></span></font></font>\r
273 </p>\r
274 <p><strong><span style=""><span style="background: rgb(235, 97, 61) none repeat scroll 0% 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;">[&lt;FA\r
275 2.2RC1]</span></span></strong><strong> </strong>\r
276 </p>\r
277 <p><strong><span style="">$security_headings,\r
278 $security_groups arrays &#8211; moved to database (see Access Setup) </span></strong>\r
279 </p>\r
280 <p><strong><span style="">$def_app &#8211; moved\r
281 to user configuration in database.</span></strong></p>\r
282 <p><strong><span style="font-style: normal;"><span style="">$version\r
283 &#8211; moved to </span></span></strong><strong><i><b>version.php</b></i></strong><strong><span style="font-style: normal;"><span style="">\r
284 file. Remove</span></span></strong></p>\r
285 <h2>4. New features configuration</h2>\r
286 <p>During upgrade process new features are initialized to default\r
287 status, and sometimes old settings are also changed to conform with\r
288 new security policy. This automatic process is designed to be as\r
289 neutral for end users as possible, however sometimes site or company\r
290 admin intervention can be necessary to set thing after changes to\r
291 their best state. Below you will find description of new settings\r
292 available after upgrade.</p>\r
293 <p><br>\r
294 <br>\r
295 </p>\r
296 <p>----------------------</p>\r
297 <ul>\r
298 </ul>\r
299 </body></html>