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