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