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