Home

RETE-DB - Manual

1. Importing new modified records a G por Ft Desktop Demolmport csv _ Browse Encoding Tatin 1 450 8859 Explain Data import from XYZ Database Format CSV auto detect z Test Only p Match ID Column J none all records are new z Import Explain Explain the reason for your import actions here Done E Choose the CSV file which to import Encoding Select the character encoding in which the application stored the csv file If you are ot sure select Latin 1 This fits in many cases 6 Match ID Column Choose none all records are new if all imported records are new If you want to update existing records choose the field name by which the imported records shall be matched to the existing RETE DB records Upload the file in Test Only mode first 28 CHAPTER 1 USER MANUAL OOO Todo List Import e a e 48 8 hup 127 0 0 1 8080 MyReteDb import html v gt W Wikipedia Eng a Q Todo List Import 9 last login 2008 06 15 03 20 35 0 change password logout Andreas A Warnke Address Todo List lt projects gt lt fields gt lt keywords gt lt users gt lt groups gt lt members gt list 1000 1001 show import new record for Todo List please Walt c dscc nes dcrcat ov oasuucanda A a a ral cedars Character encoding set ISO 8859 1 Cell separator detected automatically Quoting symbo
2. 12 CHAPTER 1 USER MANUAL 1 1 2 Logout ANAA List o lt a gt E Y hup 127 0 0 1 5080 MyReteDb lst html v W7 Wikipedia Eng DT a I List x y SD A E ooo 2008 08 15 09 20 35 0 change password logout eas Warnke Address Todo List lt projects gt lt fields gt lt keywords gt lt users gt lt groups gt lt members gt G Welcome Please check the date of your last login local UTC 2008 06 15 09 20 35 0 2008 06 15 08 20 35 Ifthis date is wrong change your password immediately and inform your administrator as soon as possible Please select a project Address Demo address database Todo List Demo todo list Done Please log out when you are finished Every page provides a link in the top right corner 1 1 3 Change your Password Every page provides a link to change the password and timezone Note e Some users might have fix passwords In this case the link is greyed out Change Password a a E 4 0 mp 127 0 0 1 8080 MyReteDb password html v gt W7 Wikipedia Eng Q e Change Password x last login meer so change password logout Andreas Warnke A Change Password 0 Address Todo List lt projects gt lt fields gt lt keywords gt lt users gt lt groups gt lt members gt Changing the password of Andreas Warnke Current password Name Andreas Warnke
3. A Andreas Warnke has access to Address ro Read only fields You do not have write access rr Read restricted fields Some people do not have read access Explain Explain the reason for your modifications here Done Enter User ID and Project and press create record 000 lt members gt 1000 Y El 4 0 mup 127 0 0 1 5080 MyReteDb form html v gt W7 Wikipedia Eng a Q lt members gt 1000 o gt La Ei a Ha debug change password logout System Administrator 5 Address Todo List lt projects gt lt fields gt lt keywords gt lt users gt lt groups gt lt members gt list info show 1000 import new record for lt members gt Ok 5 The project was modified Please check if the group field needs to be updated Project gt Groups update 1000 copy 1000 1000 Andreas Warnke lt users gt 1000 Ok Address z Ok Lee admin P all vi External Staff M Guest update 1000 E ala Fall External Staff History new value old value Group Mask 0 Access admin sx HT Enter all Groups to which the user belongs and press update 1000 60 CHAPTER 2 ADMINISTRATION 900 lt members gt 1000 e y e tS http 127 0 0 1 8080 MyReteDb form htm ve W Wikipedia Eng a lt members gt 1000 o
4. 2 1 OVERVIEW ON PROJECTS AND FIELDS 45 e The third step is to update all records where this specific keyword is still set This must be done manually for every single record 46 CHAPTER 2 ADMINISTRATION 2 1 9 Check Results To see how the project looks like go to the new project Feature List XZ2 page list eos Feature List XZ2 List o Q amp fai http 192 168 0 20 8080 MyReteDb list html proj 1000 v O W AUREA A A debug change password logout System Administrator Feature List XZ2 Address Todo List lt projects gt lt fields gt lt keywords gt lt users gt lt groups gt lt members gt list show import new record for Feature List XZ2 pages 0 results 2 ms ESS Title Urgency Em C order by search 20 50 100 page low empty 0 records displayed 2 ms Export results as XML CSV 1 CSV 2 CSV 3 CSV 4 tab Fertig Then go to page new record a ODO Feature List XZ2 New Record am Q amp fas 0 http 192 168 0 20 8080 MyReteDb form html proj 1000 amp count 50 W ads Feature List XZ2 New l debug change password logout System Administrator Feature List XZ2 Address Todo List lt projects gt lt fields gt lt keywords gt lt users gt lt groups gt lt members gt list info show import new record for Feature
5. If the Modified Version includes new front matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document you may at your option designate some or all of these sections as invariant To do this add their titles to the list of Invariant Sections in the Modified Version s license notice These titles must be distinct from any other section titles You may add a section Entitled Endorsements provided it contains nothing but endorsements of your Modified Version by various parties for example statements of 96 APPENDIX D GNU FREE DOCUMENTATION LICENSE peer review or that the text has been approved by an organization as the authoritative definition of a standard You may add a passage of up to five words as a Front Cover Text and a passage of up to 25 words as a Back Cover Text to the end of the list of Cover Texts in the Modified Version Only one passage of Front Cover Text and one of Back Cover Text may be added by or through arrangements made by any one entity If the Document already includes a cover text for the same cover previously added by you or by arrangement made by the same entity you are acting on behalf of you may not add another but you may replace the old one on explicit permission from the previous publisher that added the old one The author s and publisher s of the Document do not by this License give per mission to use their names for publicity for or to as
6. lt members gt 1000 A debug change password logout System Administrator A Address lt projects gt lt fields lt users gt lt groups gt lt members gt list info show 1000 import new record for lt members gt Ok 1 update 1000 copy 1000 1000 V admin P all External Staff 1000 Andreas Warnke lt users gt 1000 Address gt fy net FT admin all Y External Staff Guest update 1000 nx RT 2 3 7 Check Groups of a User Go to the project lt members gt page list search for the User ID you are interested AAA lt members gt List o E 4S 0 hup 127 0 0 1 8080 MyReteDb list htmi proj 64find a101e22a40031003 Y gt W Wikipedia Eng a lt members gt List o z lt members gt List BE debug change password logout System Administrator Address Todo List lt projects gt lt fields gt lt keywords gt lt users gt lt groups gt lt members gt list 1000 1001 1002 1003 1004 1005 1006 1007 show import new record for lt members gt pages 1 8 results 2 ms D MA Project Groups me __ _ _ O_O zl El order by gt search 20 50 100 records per page list all columns 1000 Andreas Warnke lt users gt 1000 Address External Staff 1001 Andreas Warnke lt users gt 1000 Todo List External Staff 1002 Andreas
7. and take the first characters of each word resulting in MpT sd tf2mbj 14 CHAPTER 1 USER MANUAL 1 1 4 Menu The top lines of all pages look similar OOO Todo List List o a e 10 mup 127 0 0 1 8080 MyReteDb list htmi proj 33 v gt W7 Wikipedia Eng Q Q Todo List List x Todo List List PE E Best togin 2008 06 15 03 20 35 0 change password logout Andreas Warnke Address Todo List 1 ects gt lt fields gt lt keywords gt lt users gt lt groups gt lt members gt list show import new record for Todo List pages 0 results 216 ms 1D ES Subject Prio Description Comment Mark A AS e order by z search 20 50 100 records per page 0 records displayed 12 ms Export results as XML CSV 1 OSV 2 CSV 3 I CSV 4 tab Done The second line shows all projects to which you have access This allows to switch between the different projects 1 2 RECORDS 15 1 2 Records 1 2 1 Create a Record Select the project Choose new record to get a form for creating a new record Note e This option is greyed out if you do not have permission to create a new record in the current project AAA Todo List New Record e a 0 hutp 127 0 0 1 8080 MyReteDb form htmI proj 3 3 amp count 50 amp list 1 amp row gt W Wikipedia Eng Q a Todo List New Record Todo List Ma
8. 106 TX Mandatory 40 TX16 36 TX32 36 TX80 36 TX80 Narrow Input 39 TXCC 36 TXCC Narrow Input 39 unlock 65 URL 106 user INDEX create 57 delete 58 User Manual 9 utc 30 virus 65 web xml 73 workflow 100 Write Access 48 Write DB 33 xml 24
9. 43 44 45 46 47 7 48 149 5 50 F 51 FT 52 53 F 54 F 55 56 TF 57 J 58 J 59 COT 61 r 62 63 V user M admin all Y Guest Ok 800 update 1000 AAA lt groups gt 1000 e dar gt E 5 0 mup 127 0 0 1 8080 MyReteDb form huml v Wr Wikipedia Eng Q 10 lt groups gt 1000 o gt lt groups gt 1000 Il debug change password logout System Administrator Address Todo List lt projects gt lt fields gt lt keywords gt lt users gt lt groups gt lt members gt list 64 65 68 info show 1000 import new record for lt groups gt Ok 1 update 1000 copy 1000 sE 56 CHAPTER 2 ADMINISTRATION Create all groups you need and check the result on the lt groups gt list page a and write access External Staff Guest 1004 lt projects gt External Staff External Staff with limited read admin all External Staff and write access 2 2 3 3 3 1005 lt fields gt External Staff External Staff with limited read 3 admin all External Staff 500 3 3 3 3 OOO lt groups gt List o lt A y e GS http 127 0 0 1 8080 MyReteDb list html proj 4 amp order O amp count 50 amp find gt W Wikipedia Eng Q e lt groups gt List Z EE debuo change password logout System Administrator Address Todo List lt projects gt lt fields gt lt keywords gt lt u
10. Copyright C yyyy name of author This program is free software you can redistribute it and or modify it under the terms of the GNU General Public License as published by the Free Software Foundation either version 2 of the License or at your option any later version This program is distributed in the hope that it will be useful but WITHOUT ANY WARRANTY without even the implied warranty of MERCHANTABIL ITY or FITNESS FOR A PARTICULAR PURPOSE See the GNU General Public License for more details You should have received a copy of the GNU General Public License along with this program if not write to the Free Software Foundation Inc 59 Temple Place Suite 330 Boston MA 02111 1307 USA Also add information on how to contact you by electronic and paper mail If the program is interactive make it output a short notice like this when it starts in an interactive mode Gnomovision version 69 Copyright C yyyy name of author Gnomovision comes with ABSOLUTELY NO WARRANTY for details type show w This is free software and you are welcome to redistribute it under certain conditions type show c for details The hypothetical commands show w and show c should show the appropriate parts of the General Public License Of course the commands you use may be called something other than show w and show c they could even be mouse clicks or menu items whatever suits your program You should also get your employer if you
11. admin admin admin admin all admin admin all all user user user user KEYW Family Name TX80 lt fields gt List I isstlogirf 2008 06 29 10 02 18 0 debug change password logout System Administrator Address List Feature List XZ2 Address Todo List T lt projects gt lt i ields gt P lt keywords gt lt users gt lt aroups gt lt members gt list 1000 1001 1002 pages 1 3 results 2 ms ID Mr Mrs Family Name Given Name Title Birthday a Fo order by search 20 50 100 records per page F list all columns 1000 admin Mr Simpson Homer 1001 user admin Mrs Duck Dasy 1002 user admin Mr Roadrunner j all records Notes on ID and Access Fields Write access on the ID field is the record creation right Write access on the Access field is also record deletion right since removing all access rights is equal to deleting a record 2 2 ACCESS RIGHTS 49 If a user creates a record who has no write access to the Access field this new record is visible to all groups that are listed in the Default Access field of the user s groups 2 2 2 Check Group Definitions Go to the project lt groups gt page list search for the Project you are interested in 900 lt groups gt List o El 4S 0 hup 127 0 0 1 8080 MyReteDb list htmi proj 480rder 08count
12. for access by all web apps or tomcat webapps MyReteDb WEB INF lib for access by RETE DB only 4 8 Setup email notification optional To enable sending email notifications unzip rete db_notifications jar edit the file net rete_db rete_db consistency SendMailConfiguration properties and zip the archive again If your java runtime environment does not provide the J2EE packages you need to install the packages activation jar imap jar mailapi jar pop3 jar smtp jar See RETE DB_3rd_ party libs zip at http sourceforge net projects accs files RETE DB RETE DB_1 1 9_dev 76 CHAPTER 4 INSTALLATION 4 9 Restart the Servlet Engine mac mini local jakarta tomcat 5 0 18 bin root setenv JAVA_HOME usr mac mini local jakarta tomcat 5 0 18 bin root shutdown sh Using CATALINA_BASE usr Local jakarta tomcat 5 0 18 Using CATALINA_HOME usr Local jakarta tomcat 5 0 18 Using CATALINA_TMPDIR usr local jakarta tomcat 5 0 18 temp Using JAVA_HOME usr mac mini local jakarta tomcat 5 0 18 bin root sudo u www startup sh Using CATALINA_BASE usr Local jakarta tomcat 5 0 18 Using CATALINA_HOME usr local jakarta tomcat 5 0 18 Using CATALINA_TMPDIR usr local jakarta tomcat 5 0 18 temp Using JAVA_HOME usr mac mini local jakarta tomcat 5 0 18 bin root 4 10 Check if RETE DB is running Start a browser and enter the address of RETE DB http 127 0 0 1 8080 MyReteDb AAA Login e e
13. list 1064 1065 info show import new record for lt fields gt create record 1 Feature List XZ2 v KEYW gt Access Y admin T all Label Urgency i urg_1234 Description Urgency of the new feature 030 El 030 I l 880000 Options FF index Consistency Type gt Foreign Project o create record f Explain ro Read only fields You do not have write access bd Fertig Set the Type to KEYW for a drop down box or to MULT for a multiple choice field 42 CHAPTER 2 ADMINISTRATION Database structure adapted The project was modified Please check if the group field needs to be updated Project gt Write Access Read Access update 1067 copy 1067 Feature List XZ2 gt 1067 Ok Ok admin PF all Ok Ok Label Urgency lurg 1234 Ok Ok Description pa of the new feature Ok Fall Y admin Ok KEYW gt Mall vi admin Ok O00 lt fields gt 1067 o a amp fas http 192 168 0 20 8080 MyReteDb form html vow j J debug change password logout System Administrator Addre lt projects gt lt fields gt lt keywords gt lt users gt lt groups gt lt members gt list 1064 1065 info _show 1067 import new record for lt fields gt Ok 18 pal go E El E Update Read Access and Write Access fields An Id is assigned to th
14. ADMINISTRATION Chapter 3 Maintenance Read this chapter to get an overview on the following tasks Back ups Resuming Operation Avoiding Intrusion Intrusion Detection e Virus detection Observing server load Performance Tuning 63 64 CHAPTER 3 MAINTENANCE 3 1 Back Ups Back ups must be done from the database contents and from the file archive directories As described in the MySQL Y documentation back ups of the database can be invoked by one of the four commands mysqldump mysqlhotcopy cp or scp Remember to lock and flush the tables when using the cp or scp commands via the MySQL commands LOCK TABLES FLUSH TABLES and UNLOCK TABLES before copying the database files To keep the reference integrity of the data it is strongly recommended to do the backups in the following order e First back up all user projects this is the rete_db data database e then back up all administration projects this is the rete_db_meta database and e at last copy the file archive folders to your back up media 3 2 Resume Operation To copy your data from one system to another or to recover from a backup install the RETE DB system as explained in chapter 4 Before starting RETE DB copy the databases to your new system as well as the file archive folders Check the parameters in the WEB INF web xml file and check the following fields in the database e rete db_meta accs projects data Read_DBs e rete db_meta accs projects
15. Group Definitions 02 49 2 23 GHECks ACCOUNTS Ary duh eh a A A 50 2 2 4 Check Group Members 2022000 51 2 3 Manage Users and Groups 0 0000 52 2 32 Greate a Groupe yes o ea A at A Ee oe SES 52 2 3 2 Delete or Modify a Group ooo 56 2 3 3 Create a User Account 22004 57 2 3 4 Delete a User Account 2 e 58 2 3 5 Check User Accounts 0 0 e 58 2 3 6 Define Groups of a User 0 e 2 59 2 3 7 Check Groups of a User ooa a aa 60 DAs Checklists ri a a Y a e ge 61 2 4 1 Define a new Project 0 0 02022000 61 2 4 2 Check a new Project eee 61 3 Maintenance 63 3 1 Back Ups La ea oo rd de le ys e See ada a 64 3 27 Resume Operation ceci A AA eae 64 3 3 AVoldINTFUSION dedic aa a o aren a R E E 64 3 4 Detect Intruso tomo da E A A E AA 65 3 5 Unlock the Database 0 0 e 65 3 01 Detect Viruses en we ala al AAA us oe ee eS 65 3 7 Observe Server Load aoaaa a 65 3 8 System Performance s tte A a o 65 3 8 1 Performance tuning o 66 3 8 2 Distribute the Database and RETE DB 66 4 Installation 69 O A A O PS Ge eh pe Oa we ety Te 70 4 2 Download RETE DB 0 202020222 2 71 4 3 Unzip the Archive 2 202020 0 00000000 a 71 4 4 Prepare the MySQL Y Database 04 72 4 5 Update the web xml Fil
16. List XZ2 create record K Access Tall M admin Title est Record Urgency create record Explain ro Read only fields You do not have write access y Fertig 2 1 OVERVIEW ON PROJECTS AND FIELDS 47 At last check the page info 00 Feature List XZ2 1000 e a cy g ES fas http 192 168 0 20 8080 MyReteDb form html proj 1000 amp count 50 Y O wW Feature List XZ2 1000 E debug change password logout System Administrator lt projects gt lt fields gt lt keywords gt lt users gt lt groups gt lt members gt list show 1000 import new record for Feature List XZ2 update 1000 copy 1000 I all Everybody in any group of this project admin Administrators for this project a Unique ID within this project Title E Record Urgency high gt update 1000 s M 4 Fertig 48 CHAPTER 2 ADMINISTRATION 2 2 Access Rights 2 2 1 Overview All access rights are defined on groups A group has read access to data if Access to the record and Read Access to the field is granted A group has write access if Access to the record and Write Access to the field is user all user all user all user Address Todo List lt projects gt lt fields gt lt keywords gt ee lt lt lt lt Y Address 3 El El granted
17. New password SHA 1 Password d10f7e5e2b7a8df2ae135a79a5c94634e7236090 Retype new password Email RETE DBOandreaswarnke de Birthday Attack protection Phone z 6 Change 4 timezone UTC 1 Y Security Notes Encryption Passwords are transmitted from your Birthday A birthday attack is a check if someone else has the same browser to the RETE DB servlet Attack password as you This can be done by the system administrator How secure this transmission is and others if thev have access to the user datahase with all Done E Information on your account is displayed here name email address and telephone number 1 1 GENERAL USAGE 13 E You are requested to enter your current password and to enter your new password twice You may update your timezone here see 1 5 6 Submit your new password and or timezone A Good Password e is at least 7 characters long e is a combination of different character types such as capitals A Z lower case characters a z digits 0 9 and other symbols e is not a word in any language e is not related to the user like the number plate of the user s car e is not written on a piece of paper as reminder where other people can see it e is known to exactly one person meaning you and only you A common way to find such a password is to think on a sentence that you can remember easily e g My pink T shirts don t fit to my blue jeans
18. The time of the record creation is logged in this field This only works if all groups that have record creation rights also have read access to this TIME field e TIME LastMod The time of the last modification is logged in this field This only works if all groups that have any write access also have read access to this TIME field 2 1 OVERVIEW ON PROJECTS AND FIELDS 41 e ACL_ Admin Access Ensures that the administration group 0 always has access Apply this consistency type to the Access field of the relevant project e TX Mandatory Ensures that this field is never empty This type can be applied to TX16 TX32 TX80 and TXCC field types This only works if all groups that have record creation rights also have write access to this field 2 1 5 Delete a Field Fields cannot be deleted Also the type cannot be changed But you can remove all access rights to hide a field see 2 2 2 1 6 Create a Drop Down or Multiple Choice Keyword Field A keyword is a selectable option in a drop down box or multiple choice field To define a keyword create a field as shown in chapter 2 1 4 TARA lt fields gt New Record e e SH fas http 192 168 0 20 8080 MyReteDb form htmi proj 2 amp find alo Y Wr lt tields gt New Record debug change password logout System Administrator List lt fields gt lt keywords gt lt users gt lt groups gt lt members gt ture List X Addr
19. Warnke lt users gt 1000 lt projects gt External Staff 1003 Andreas Warnke lt users gt 1000 lt fields gt External Staff 1004 Andreas Warnke lt users gt 1000 lt keywords gt External Staff 1005 Andreas Warnke lt users gt 1000 lt users gt External Staff 1006 Andreas Warnke lt users gt 1000 lt groups gt External Staff 1007 Andreas Warnke lt users gt 1000 lt members gt External Staff 8 records displayed 39 ms Export results as XML CSV 1 CSV 2 CSV 3 CSV 4 tab 2 4 CHECKLIST 61 2 4 Checklist This chapter provides two checklists to ensure that a new project is created successfully 2 4 1 Define a new Project Major tasks that need to be done when creating a new project are listed here e Create one lt projects gt record e Create several lt fields gt records e For all KEYW and MULT fields create the appropriate lt keywords gt records e Define all lt groups gt for this project e Define which user is in which group by adding one lt members gt record for each user who shall have access 2 4 2 Check a new Project Some issues are stated here that are easily forgotten when creating a new project e Check if the default access rights of the new lt groups gt are set e Check the read and write permissions on the new lt fields gt records e Check the lt members gt records if all users are in the right groups 62 CHAPTER 2
20. a z underscore _ or digits 0 9 the first character must be a letter Type You can choose the following types for your fields e INT_ Integer number e REAL Real number e DATE Date without time 2 1 OVERVIEW ON PROJECTS AND FIELDS 37 e TIME Date and time with automatic conversion between timezones e TX16 Varchar 16 String of up to 16 characters e TX32 Varchar 32 String of up to 32 characters e TX80 Varchar 80 String of up to 80 characters e TXCC Varchar 200 String of up to 200 characters e TEXT MediumText String of arbitrary length Note on performance Do not use this type if a TXCC is sufficient e KEYW Dropdown box which references a single keyword How to create the list of keywords is explained in 2 1 7 e MULT Multiple choice is a selection of multiple keywords How to create the list of keywords is explained in 2 1 7 e FILE One file Use a zip archive if you want to upload several files to a FILE field e ID__ RETE DB internal type for the Id field Do not use this type for other fields e ACL_ RETE DB internal type for the Access field Do not use this type for other fields e PASS Password field e PROJ Project list e GR_P Group list This list only makes sense in combination with one PROJ field otherwise the list will be empty This type should not be used except in the administration projects e Ntol Reference to one record of another project This type requires that the Foreign Project fiel
21. any free program is threatened constantly by software patents We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses in effect making the program proprietary To prevent this we have made it clear that any patent must be licensed for everyone s free use or not licensed at all The precise terms and conditions for copying distribution and modification follow TERMS AND CONDITIONS FOR COPYING DISTRIBUTION AND MODIFICATION 0 This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License The Program below refers to any such program or work and a work based on the Program means either the Program or any derivative work under copyright law that is to say a work containing the Program or a portion of it either verbatim or with modifications and or translated into another language Hereinafter translation is included without limitation in the term modification Each licensee is addressed as you Activities other than copying distribution and modification are not covered by this License they are outside its scope The act of running the Program is not restricted and the output from the Program is covered only if its contents consti tute a work based on the Program independent of having been made by running the Program Whether that is true depen
22. at least 2 minutes 2a You run the performance test for 12 hours old value a 1 You start the system 2a You run the performance test for 12 hours 2b In parallel you manually trigger the system 2b In parallel you manually trigger the system Description details added user admin External Staff user admin all External Staff Guest 1 Mark Comment Description top difficult risk Ask A W if you have further questions 1 You start the system 2a You run the performance test for 12 hours 2b In parallel you manually trigger the system user admin all External Staff Guest high 1000 accepted The System crashes when there is too much traffic Subject ro Read only fields You do not have write access rr Read restricted fields Some people do not have read access Explain Explain the reason for your modifications here Done sE The dark grey lines shows by whom and when a modification has been done The most recent changes are sorted to the top of the list E The first column shows what has been changed E The second column shows the new value that has been set The third column shows the old value before the modification 20 CHAPTER 1 USER MANUAL 1 2 5 Modify a Record You can modify any record to which you have write access 000 Todo List 1123 o e 4S http 127 0 0 1 8080 MyReteDb form html proj 33 amp find
23. gt susers gt lt groups gt lt members gt list 1000 1069 1213 1270 1275 1335 1123 show import new record for Todo List pages 1 6 results 78 ms D Access Subject Status Description Comment Mark Y contains performance E Y contains speed z E zj Ea z search 20 50 100 records per page 1000 user admin The System high accepted 1a You start the system 1b Ask A W if top External Staff crashes when Wait at least 2 minutes 2a You you have difficult risk there is too run the performance test for 12 further much traffic hours 2b In parallel you questions manually trigger the system 1069 user admin all high validated Speed improvements when SW Design External Staff creating SQL Strings less Guest StringBuffers required E 1213 user admin all low in nroaress Performance imnrovements in SW Desian x Done a Enter the record id in the middle of the third line and press show 24 CHAPTER 1 USER MANUAL 1 4 Export Import 1 4 1 Export Select a project E Search for all records which you want to export the total number of records is displayed on the right then The export file will contain all records that match to your current search Supposed there are 348 records that match your search criteria but there are only 50 displayed in your browser all 348 records will be exported nonetheless Skoka To
24. ot ie Batten 10 bel 2 ALO SOUR entr aoe ea a a te a u 12 1 1 3 Change your Password o o e 12 LLAMEN a le a a 14 12 A be Ald aL ae S a aaae hne be Salers Ole 15 1 2 1 Createa Record 2 00 00 EA A E h 15 1 2 2 Copy a Record ou hap eee a We ee OA 17 1 2 3 Record Information oaoa aa 17 1 2 4 Record History oaa eee 19 1 2 5 Modify a Record v3 2 aiy an a a mei ee ee ey BLS 20 1 37 Queries dl to a TA Ae ek a a la E a 21 L3 Search o habas Heh oe a Get ae AA 21 1 3 2 Bookmark a Query 0 o 23 133 GotoaRecord ss saran gora e 23 1 4 Export Import E is da A 24 LAT AEXPO a ole oe a a ee ia yl 24 LAX UMPON et wien gure ae a Po eh e Pe ee 26 LS TimeZOneS soe Soe ee be a eee ee eae ee as 30 2 Administration 31 2 1 Overview on Projects and Fields 04 32 2 1 1 Create a Projet its A ee A et 33 2 1 2 Delete a ProjeCt o 0 2 ee 35 2 1 3 List all Fields of a Project o 0 2 35 2114 Created hiel nk eek ee a TE hod eos 36 Zeb Delete ariel ia ee ep ye eae teat wee Se See Ge As 41 2 1 6 Create a Keyword Field 0 0 e 41 21 7 Define Keywords s r a vania eo rata e boa e 43 2 1 8 Delete a Keyword 0 00020002 2a 44 2 19 Check Results Lara feck ceed a ES a Deeb We Be Rok a 46 6 CONTENTS 2 2 ACCESS Rights tia a lew ar ee o ee eee opa E 48 Q 2A COVES ui e Sides A a Ee Sa SS 48 2 2 2 Check
25. project was modified Please check if the group field needs to be updated Project gt Write Access Read Access update 1066 copy 1066 oe List XZ2 gt 109s TX80 v admin P all Ok Ok Label fie fit_xz Ok Ok Description SY Ok M all Y admin Ok Y all Y admin Ok 20 TX80 Narrow Input v Ok ok Fertig Eat The lt fields gt record is created the database structure is modified Update the fields Write Access and Read Access for the new field now Press the update button again 2 1 OVERVIEW ON PROJECTS AND FIELDS 39 000 lt fields gt 1066 e y a http 192 168 0 20 8080 MyReteDb form html vO i A lt fields gt 1066 JE E E debug change password logout System Administrator Feature List XZ2 Address Todo List lt projects gt lt fields gt lt keywords gt lt users gt lt groups gt lt members gt list 1064 1065 info show 1066 import new record for lt fields gt Ok 2 update 1066 copy 1066 Project Feature List XZ2 x 1D 1066 Type TX80 y F admin all Label Title Field ftitt_xz Description Title Short description of the new feature Fall M admin Ok Mall Y admin Ok 20 TX80 Narrow Input gt 20 a Colors effffee Options V index Consistency Type Foreign Project fo update 1066 Explain i v Fertig A new f
26. the whole aggregate 8 TRANSLATION Translation is considered a kind of modification so you may distribute translations of the Document under the terms of section 4 Replacing Invariant Sections with trans lations requires special permission from their copyright holders but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections You may include a translation of this License and all the license notices in the Document and any Warranty Disclaimers provided that you also include the original English version of this License and the original versions of those notices and disclaimers In case of a disagreement between the translation and the original version of this License or a notice or disclaimer the original version will prevail If a section in the Document is Entitled Acknowledgements Dedications or History the requirement section 4 to Preserve its Title section 1 will typically require changing the actual title 9 TERMINATION You may not copy modify sublicense or distribute the Document except as ex pressly provided for under this License Any other attempt to copy modify sublicense or distribute the Document is void and will automatically terminate your rights under this License However parties who have received copies or rights from you under this License will not have their licenses terminated so long as such parties remain i
27. to someone else so that the same page will be visible when the URL is requested again E 5 1 find Parameter In general a query URL contains a phrase like find a203e The first a says that the criteria of the different columns shall be connected by an AND operator Replace the a by an o to connect the criteria of the different columns by OR Or prepend an n in front of the a203e query to get all results that do not match the specified criteria n NOT The digit 2 says that there are 2 columns that are connected by AND The 03 says that there are three criteria on the first column that are logically connected by an OR Note e The NOT operator might produce unexpected results when applied to TEXT DATE and TIME fields due to possible NULL values E 6 Errors Table rete_db_meta accs_users_data doesn t exist You get a java lang RuntimeException java sql SQLException Table rete_db_meta accs_users_data doesn t exist if you delete the database while RETE DB is running In this case you need to restart the RETE DB servlet No such file or directory You get a java lang RuntimeException java io IOException No such file or directory exception if either the FileUpload_TempFolder in the web xml file does not exist or is write protected or if the Archive Folder of the project does not exist or is write protected Login impossible or changing data does not work These effects may occur if your
28. where write access is better controlled by the more flexible consistency checks e Any number of user defined fields These are appended to this table automat ically when a record in the lt fields gt project is created e FILE fields are also user defined but in contrast to the other field types every FILE field produces three fields in the database ACCS_FilePath_ ACCS_FileSize_ and where is the field name E 4 2 History Tables Each project has a history table History records consist of the following information e Id Id of the history entry e ReadSnapShot Read access to the modified field at the time when the history entry was created e DataRow Id of the modified record e NewStart Time when the change was made e NewEndCopy Time when the next change to the field is made This information is currently not used but it is interesting if you want to implement a search or data export on a past time e Userld ID of the user who did the changes e UserNameCopy A copy of the user s name This field is not updated when the name of the user is modified later e Action Currently there are only two types created 1 and modified 2 e Reason Explanation text e Fieldid Id of the field that was modified e OldValueCopy Value before the change e NewValue Value after the change 104 APPENDIX E DESIGN e OldTextCopy Only for TEXT fields Id of the text record before the change e NewText On
29. 06 15 09 20 35 0 change password logout Andreas 4 Todo List List Warnke Ad Todo List lt projects gt lt fields gt lt keywords gt lt users gt lt groups gt lt members gt st 1000711001 simciic n comics cece access 1049 show import new record for Todo List pages 1 2 3 4 5 6 7 348 results 9 ms Status Description Comment Mark gi FO order by gt search 20 50 100 records per page 1000 user admin all The System high accepted 1 You start the system 2a You run the Ask A W if top External Staff crashes performance test for 12 hours 2b In parallel you have difficult Guest when there is you manually trigger the system urther risk too much questions traffic 1001 user admin The system low accepted External Staff is slow in case of no traffic 1002 user admin all high validated Wrong GR_P options displayed If you try to Bug External Staff change a PROJ field and this update is Guest rejected the GR_P shows the options of the y E e Done y Here you can enter search criteria for records and order the results Submit your query 22 CHAPTER 1 USER MANUAL Note that there might be multiple result pages In this case you have to click on the different page links to see the results E The total number of records to which you have access and which match your query is displ
30. 2012 02 20 RETE DB Manual version 2 aro s LOL e T e w E HRSA PIE ld olle ETDE TodoList List E E E pages 1 19 results 24 ms Copyright 2008 2012 Andreas Warnke RETE DB andreaswarnke de Permission is granted to copy distribute and or modify this document under the terms of the GNU Free Documentation License Version 1 2 or any later version published by the Free Software Foundation with no Invariant Sections no Front Cover Texts and no Back Cover Texts A copy of the license is included in the section D entitled GNU Free Documentation License RETE DB Manual RETE DB is a multi user web database providing high performance data security and system scalability Target This program is suitable for e Address databases Define the fields you need e g Name Address Phone number Bank Account and limit the access rights e g restrict the read access to Bank Account e Todo lists Define a Title and a Description field and a choice list of responsible persons e Bug management Define a choice list for Status and Priority e g open in progress closed and high medium low an file upload field to attach photos or videos and restrict the write access for e g the Priority field e Any other list which may contain texts numbers dates choice options or even files and to which you can limit read or write access on fields or records Features RETE DB is a web based database fron
31. 3 4 51 6 32 33 info _show import new record for lt projects gt create record Label Feature List XZ2 i Description of new features for Product XZ2 jdbc mysql 127 0 0 1 3306 rete_db_data other_name user ReteDbUse A y 306 rete_db_data_other_name user ReteDbUserName amp password anyPassWd lt AAA feature_any_name Users www RETE DB WET fields You do not have write access Fertig Enter the requested information e Label Give your new project a name This can be modified later e WriteDB This is an Url that is needed to access a database The user and password should be encoded in this DB Url An example URL looks like jdbc mysql 127 0 0 1 3306 rete_db_data user RETEDB amp password aaaabbCad amp characterEncoding utf8 e ReadDBs See WriteDB above Multiple DB Urls are separated by a whitespace character e TablePrefix This is a database internal identifier that cannot be modified after creation Choose a name that is similar to the Label Please choose only lowercase letters a z underscore _ or digits 0 9 the first character must be a letter Note This identifier needs to be unique among all projects in the RETE DB system 34 CHAPTER 2 ADMINISTRATION e ArchiveFolder This is a path to a folder in the filesystem where RETE DB stores all uploaded files Note 1 RETE DB needs read and write access to this folder 2 This path must be access
32. 4116 e a E fat htp 192 168 0 20 8080 MyReteDb form html vow lt keywords gt 4116 EE debug change password logout System Administrator Feature List XZ2 Address Todo List lt projects gt lt fields gt lt keywords gt lt users gt lt groups gt lt members gt list 4114 4115 info show 4116 import new record for lt keywords gt Ok 9 update 4116 copy 4116 4116 Ok Feature List XZ2 gt 1067 Urgency lt fields gt 1067 Ok Label high Ok Description Po admin P all Ok af Fertig Every keyword has an order field which defines the position of the keyword within a dropdown box The lower the number the higher the keyword appears within the list 44 CHAPTER 2 ADMINISTRATION Note e The order field does not define the order of search results when sorting results by this keyword Search results are always sorted by the keyword ID in case of single select keywords or by the Bit Mask in case of multi select keywords never by the order field of the keywords e The field Notification Email defines to which distribution list an email shall be sent when the keyword gets selected This field is intended to contain the email address of one distribution list It is possible to add multiple email addresses here separated by whitespace Email are only sent if this feature is activated see 4 8 To create sev
33. 5O8find a1 Y gt W y Wikipedia Eng Q lt groups gt List X OPTE 11 lastlogin 2008 06 29 10 02 18 0 debug change password logout System Administrator ature List lt keywords gt lt users gt lt groups gt lt members gt list 64 65 68 show import new record for lt groups gt pages 1 3 results 3 ms ee Eee ASE PE Done order by _search 20 50 100 records per page F list all columns 64 Address admin Address Project 0 admin admin Administrator 65 Address all All 0 admin 1 2 3 4 5 6 7 8 9 10 11 12 13 14 admin 200 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 68 Address user Address Project 1 admin Users 3 records displayed 17 ms Export results as XML CSV 1 CSV 2 CSV 3 CSV 4 tabY ly Here you see all groups that are defined for this project 50 CHAPTER 2 ADMINISTRATION 2 2 3 Check Accounts Go to the project lt users gt page list lt users gt List M e AA 0 hup 127 0 0 1 8080 MyReteDb list htmPproj 3 vl W Wikipe Q Q lt users gt List A last login 2008 06 29 10 02 18 0 debug change password logout System Administrator Feature List XZ2 Address Todo List lt pr
34. CHAPTER 1 USER MANUAL This adds description texts on green background AAA Todo List 1000 o E G 0 hup 127 0 0 1 8080 MyReteDb form htmi proj 338count S08list 18row Y gt Wr Wikipedia Eng Q gt 9 Todo List 1000 o s 09 20 35 0 change password logout Andreas Warnke z Cee ee e LN eee vc rtemmens list _show 1000 import new record for Todo List Todo List Demo todo list update 1000 copy 1000 Subje E System crashes when there is too much traffic accepted gt Status of the todo item high gt Priority of the todo item Description T You start the system 2a You run the performance test for 12 hours 2b In parallel you manually trigger the system Comment sk A W if you have further questions Comment on the todo item Mark top most important issue F difficult dificultto solve F risk resultis a bit risky T cost payment unclear update 1000 NIELS You may change data on this info page E Or switch back to normal mode by clicking on the record id 1 2 RECORDS 19 1 2 4 Record History Each record has a history on the bottom of its page which lists all changes AAA Todo List 1000 lt a gt e 0 mup 127 0 0 1 5080 MyReteDb form html v gt W7 Wikipedia Eng a e Todo List 1000 o Description History 3 new value 1a You start the system 1b Wait
35. CTER SET utf8 Query OK 1 row affected 0 00 sec mysql gt GRANT select insert update create index alter ON rete_db_meta_some_n ame TO ReteDbUserName 127 1 IDENTIFIED BY anyPassWd Query OK rows affected 0 08 sec mysql gt GRANT select insert update create index alter ON rete_db_data_other_ name TO ReteDbUserNameB127 0 0 1 Query OK rows affected 0 00 sec mysql gt quit Note e Adjust the G127 0 0 1 or localhost restriction if your database runs on a remote server e utf8 allows fulltext indices even in older MySQL database versions and might therefore be more interesting than ucs2 e f your database is older than MySQL 4 1 do not specify a DEFAULT CHARAC TER SET since this is not supported gt 8 4 5 UPDATE THE WEB XML FILE 73 4 5 Update the web xml File Update the settings in the web xml file RETE DB WEB INF 2 lib gt RETE DB_Copyright txt web xml RETE DB_License txt RETE DB_Manual pdf 2 RETE DB_src gt miaf lt xml version 1 8 encoding 1S0 8859 1 gt lt DOCTYPE web app PUBLIC Sun Microsystems Inc DTD Heb Application 2 2 EN http java sun com j2ee dtds web app_2_2 dtd gt Si This is the RETE DB configuration Modify as appropriate gt lt web app gt lt display name gt RETE DB lt display name gt lt description Multi User Database Frontend designed for speed scalability and security lt descript
36. Cell separator detected automatically Quoting symbol detected automatically Internal s messages start 1 Ok 8 Internal s essages stop 1 gt 1002 Internal system messages start 2 Ok 8 Internal system messages stop 2 gt 1003 Internal system messages start 3 Done Check also the second error report because the first error report checked the file structure only not the access rights Look out for red colored items 30 CHAPTER 1 USER MANUAL 1 5 Timezones All time values and history dates are stored in universal time UTC Universal time coordinated UTC is the time on longitude O degree Since longitude 0 is defined at London s suburb Greenwich UTC is also called Greenwich mean time GMT For easier handling of UTC times these times are converted from and to local time when entering and displaying these time values This feature only works if every user sets the timezone correctly This can be done via the change password link in the top line of each page see 1 1 3 A list of cities and their timezones is displayed there Choose the appropriate timezone and click on the change button Note e The RETE DB system does not switch automatically between summer daylight savings and winter standard time If you are living in a region where summer and winter time are not identical you need to switch your timezone twice each year C
37. DN e LDAP_ServerPassword e LDAP_UserLoginDN Check the comments in web xml for a description on these parameters A lt users gt record will be created automatically when an LDAP user logs in 4 6 INSTALL RETE DB 75 4 6 Install RETE DB Copy the RETE DB folder to your Apache Tomcat ii webapps folder Rename it to for example MyReteDb Change the owner of all files in MyReteDb to www 2 bin 2 bin 2 balancer 2 include T common I 2 jsp examples l jakarta tomcat 5 0 18 2 conf MyReteDb 2 lib C LICENSE 2 ROOT T man 2 logs 2 servlets examples I mysql gt RELEASE NOTES 3 tomcat docs i 2 mysql ma powerpc l RUNNING txt 2 share 2 server 2 teTeX 2 shared h tomcat 2 temp webapps 2 work 4 7 Install Required Java Packages Three Java packages are required that are not part of a the standard Java Runtime Environment A MySQL database driver org gjt mm mysql Driver or com mysql jdbc Driver this is contained in the archive mysql connector java 5 1 18 bin jar see http www mysql com The Jakarta File Upload Classes commons fileupload 1 2 1 jar and commmons io 1 4 jar see http www apache org And the OpenLDAP Classes novell jldap devel 2009 10 07 1unix contains Idap jar and utilities jar see http www openldap org These packages shall exist somewhere in the Java classpath You can put these e g in tomcat common lib for tomcat and all web apps access or tomcat shared lib
38. Fertig To check which fields are already defined search for all fields of the project Up to 318 fields per project may be defined 36 CHAPTER 2 ADMINISTRATION 2 1 4 Create a Field To create a new field go to project lt fields gt page new record AAO lt fields gt New Record e a amp fas http 192 168 0 20 8080 MyReteDb form htmi proj 2 amp find al Wr lt fields gt New Record BB debug change password logout System Administrator Feature List XZ2 Address Todo List lt projects gt lt fields gt lt keywords gt lt users gt lt groups gt lt members gt list 1064 1065 info show import new record for lt fields gt create record Feature List XZ2 gt 1 Tx80 gt Access V admin Fall Label Title titi_xz Description i Short description of the new feature TX80 Narrow Input v p Bold Original Colors y fcc Options Y index Consistency Type gt Foreign Project o create record f Explain af Ira Daad only fialde Vau da not haun writa anrence Fertig Enter the requested information Note e Project Type and Field are fix and cannot be changed later e Field The field name needs to be unique within this project This is just a database internal identifier and has no effect on anything the user can see e Field Choose only letters A Z
39. ICULAR PURPOSE THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU SHOULD THE PROGRAM PROVE DEFECTIVE YOU ASSUME THE COST OF ALL NECESSARY SERVICING REPAIR OR CORRECTION IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER OR ANY OTHER PARTY WHO MAY MODIFY AND OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE BE LIABLE TO YOU FOR DAMAGES INCLUDING ANY GENERAL SPECIAL INCIDEN TAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES END OF TERMS AND CONDITIONS Appendix How to Apply These Terms to Your New Programs If you develop a new program and you want it to be of the greatest possible use to the public the best way to achieve this is to make it free software which everyone can redistribute and change under these terms To do so attach the following notices to the program It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty and each file should have at least the copyright line and a pointer to where the full notice is found 89 one line to give the program s name and a brief idea of what it does
40. R 1 USER MANUAL 1 1 General Usage 1 1 1 Login Enter the address of the RETE DB server to a browser E g Firefox Internet Explorer Safari oe Login lt e http 127 0 0 1 8080 MyReteDb list html w gt We Wikipedia Eng Q Q Login Login EEE 127 0 0 1 Domain 2 Login law Password Login RETE DB Version 0 6 License Gnu Public License RETE DB comes with ABSOLUTELY NO WARRANTY for details click here This is free software and you are welcome to redistribute it under certain conditions click here for details Author and Copyright 2004 2008 Andreas Warnke Done Enter your domain if any login and password E Submit your login data Note e To use the RETE DB system you need to enable the Cookies checkbox in the preferences of your browser Otherwise you will be asked for your password on every second page 1 1 GENERAL USAGE 11 OOO List Oo a e 0 hup 127 0 0 1 8080 MyReteDb list html v gt W Wikipedia Eng Q a List o EE MOTA logout Andreas Warnke Address Todo List lt projects gt lt fields gt lt keywords gt lt users gt lt ar lt members gt Welcome to RETE DB Please change your password immediately and update your timezone Please select a project Address Demo address database Todo List Demo todo list lt projects gt List of all user defined projects
41. System Administrator lt users gt 2 System Administrator lt users gt 2 System Administrator lt users gt 2 System Administrator lt users gt 2 System Administrator lt users gt 2 System Administrator lt users gt 2 lt projects gt admin lt fields gt admin lt users gt admin lt groups gt admin lt keywords gt admin lt members gt admin Address user admin Todo List admin Feature List XZ2 admin Io UserID Project Groups CA WT CC tC order by gt search 20 50 100 records per page F list all columns 9 records displayed 61 ms Export results as XML CSV 1 CSV 2 CSV 3 W CSV 4 tabY Done This page lists which user is in which group Note that all group definitions are project specific If a user is in group admin in project Address for example this does not mean that this user has any rights in any other project 52 CHAPTER 2 ADMINISTRATION 2 3 Manage Users and Groups 2 3 1 Create a Group Go to the project lt groups gt page list Search for the Project you are interested in As you see all groups are specific to one project there are no system wide groups 900 lt groups gt List e e oth http 127 0 0 1 8080 MyReteDb list html proj 4 amp order O amp count S50 amp find gt WY Wikipedia Eng Q y lt groups gt List x z AA E debug change password logout Syste
42. Transparent copy of the Document means a machine readable copy repre sented in a format whose specification is available to the general public that is suitable for revising the document straightforwardly with generic text editors or for images com posed of pixels generic paint programs or for drawings some widely available drawing editor and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters A copy made in an otherwise Transparent file format whose markup or absence of markup has been arranged to thwart or discourage subsequent modification by readers is not Transparent An image format is not Transparent if used for any substantial amount of text A copy that is not Transparent is called Opaque Examples of suitable formats for Transparent copies include plain ASCII without markup Texinfo input format LaTeX input format SGML or XML using a publicly available DTD and standard conforming simple HTML PostScript or PDF designed 93 for human modification Examples of transparent image formats include PNG XCF and JPG Opaque formats include proprietary formats that can be read and edited only by proprietary word processors SGML or XML for which the DTD and or processing tools are not generally available and the machine generated HTML PostScript or PDF produced by some word processors for output purposes only The Title Page mean
43. a Record ME E Hion 2008 06 15 09 20 35 0 change password logout Andreas Warnke Address Todo List pcts gt lt fields gt lt keywords gt lt users gt lt groups gt lt members gt 2 new record for Todo List list info show i Subject Status accepted gt Prio high Description 1 You start the system 2a You run the performance test for 12 hours 2b In parallel you manually trigger the system The System crashes when there is too much traffic create record j M user Y admin Y all Y External Staff Guest Comment Ask A W if you have further questions Mark top F difficult P risk M cost create record Explain ro Read only fields You do not have write access rr Read restricted fields Some people do not have read access Explain Explain the reason for your modifications here Done E Fill in the requested data Note If you want to limit the access to this record remove the marks from the all group as well as from the groups which shall not have access e Date format is YYYY MM DD e Time Format is YYYY MM DD hh mm ss If you want to you can add a short explanation for your changes in the Explain field Then click on one of the create record buttons 16 CHAPTER 1 USER MANUAL 000 Todo List 1000 o E 4 0 mup 127 0 0 1 8080 MyReteDb form html v gt W7 Wikipedia Eng a e Todo L
44. again E Remove the Test Only option E Upload the import file a second time 1 4 EXPORT IMPORT 29 Todo List Import e a E 4 mp 1127 0 0 1 8080 MyReteDb import html v gt CW gt Wikipedia Eng Q ne Todo List Import 3 a j last login 2008 06 15 09 20 35 0 change password logout Andreas Warnke Todo List Import Address Todo List lt projects gt lt fields gt lt keywords gt lt users gt lt groups gt lt members gt list 1000 1001 show import new record for Todo List PIS Wall foo oa arse A A A A mes a aria seas Transferring data from 127 0 0 1 Uploading a file might take some minutes The reason for this is partly the huge number of history entries that need to be created and partly the way how RETE DB ensures that your import does not block the RETE DB system for other users OO Todo List Import o a e 4S 18 mup 127 0 0 1 5080 MyReteDb import html v gt W Wikipedia Eng a Q Todo List Import E y last login 2008 06 15 09 20 35 0 change password logout Andreas A Todo List Import Warnke Address Todo List lt projects gt lt fields gt lt keywords gt lt users gt lt groups gt lt members gt list 1000 1001 show import new record for Todo List Please TATT T T AA AS A EL T Character encoding set ISO 8859 1
45. age requests information form the database via the security package and displays the results Access Control Boundaries There are three possible data streams From the http request to the database from the database to the html response from the request directly to the response Access is controlled at the database boundary by the security package If the current user has no read access data must never be loaded from the database to the RETE DB servlet If the user has no write access data must never be sent to the database Note The consistency checks can bypass these rules if necessary by requesting a superuser account E 3 Perfornamce Scalability and Security High performance is achieved by the following concepts e Database design Some redundancy decreases the number of SQL statements and inner joins Redundant fields are marked with the ending Copy in their database field name e Access rights are determined by simple bit operations no joins to group or users tables are required e No use of tag libraries servlet frameworks xml transformations e Database connection pools e Object pools e Avoiding String manipulations e Avoiding Object creations e Only a few SQL statements per http request are sent to the database which is a great advantage if the database is located on a remote server e Only few bytes are stored in the session object This speeds up the data transfer between servlet engines when these are distrib
46. alo2i2thb0070006 gt W Wikipedia Eng a Q Todo List 1123 E Best ogin 2008 08 15 09 21 47 0 change password logout Andreas Warnke Address Todo List lt projects gt lt fields gt lt keywords gt lt users gt lt groups gt lt members gt list 1000 1069 1213 1270 1275 1335 info show 1123 import new record for Todo List update 1123 copy 1123 Subject Status validated gt ID 1123 Prio high gt Access user M admin y all v External Staff M Guest Description hange Layout of History new on left old on right side comment below if available r nThis will better fit to short field content text field content and history entries without content because less screen space is wasted Comment ayout Mark I top I difficult risk cost G update 1123 OLL b Done Simply change the data in the displayed fields Note e Fields that you cannot modify are marked by ro which means read only e Some other users do not have read access to the fields marked with rr which means read restricted E Write a short explanation why you change the data E Submit your changes 1 3 QUERIES 21 1 3 Queries 1 3 1 Search Click on the list link to get to the search form AAA Todo List List an e 0 hutp 127 0 0 1 8080 MyReteDb list htmi proj 33 v gt Wr Wikipedia Eng Q Q Todo List List lest login 2008
47. alues format The encoding shall be set to UTF 8 Latin 1 or Unicode UCS 2 the cell separator can be either semicolon colon or tab the quoting symbol should be a double quote 000 XxX OpenOffice org 2 0 9 y This document may contain formatting or content that cannot be 2 saved in the Text CSV file format Do you want to save the document in this format anyway Click Yes to save in Text CSV file format Click No to use the latest OpenDocument file format and be sure all formatting and content is saved correctly Yes No F Do not show this warning again When saving the file in CSV format some formatting information will be lost 1 4 EXPORT IMPORT 27 In RETE DB select the project to which you want to import data E Go the the import page of the project to which you want to import data Note e Since updating existing records may change the complete project by one single action you need special permissions to this LAA Todo List Import e 0 hup 127 0 0 1 8080 MyReteDb import htmi proj 338count 5O8list 2rsrt Y gt Wr Wikipedia Eng q a Todo List Import last login 2008 06 15 09 20 35 0 change password logout Andreas Warnke Todo List Import Ad Todo List lt projects gt lt fields gt lt keywords gt lt users gt lt groups gt lt me rs gt list 1000 1001 show import new record for Todo List
48. and the RETE DB administration tables lt fields gt List of all defined fields There is exactly one entry for each table column in every project E ae Tee oun the chistes options for fields of type KEYW and MULT lt users gt List of all users lt groups gt List of all groups Each group is defined for exactly one project Each project can have up to 64 groups lt members gt List of all group members This table defined which user belongs to which groups Done All projects to which you have access are listed on this page If you login the first time you are asked to change your password see 1 1 3 000 List B e 0 hutp 127 0 0 1 8080 MyReteDb list html a v gt W7 Wikipedia Eng Q List o s e O AA change password logout Andreas Warnke Address Todo List lt projects gt lt fields gt lt keyw lt users gt lt groups gt lt members gt Welcome Please check the date of your last login local UTC 2008 06 15 09 20 35 0 2008 06 15 08 20 35 Ifthis date is wrong change your password immediately and inform your administrator as soon as possible Please select a project Address Demo address database Toda 1 ist Namna todo list Done Otherwise if this is not your first login please check the date and time of your last login In case this information is wrong it might be that someone else has used your account
49. apply and the section as a whole is intended to apply in other circumstances It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims this section has the sole purpose of protecting the integrity of the free software distribution system which is implemented by public license practices Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system it is up to the author donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice This section is intended to make thoroughly clear what is believed to be a conse quence of the rest of this License If the distribution and or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries so that distribution is permitted only in or among countries not thus excluded In such case this License incorporates the limitation as if written in the body of this License The Free Software Foundation may publish revised and or new versions of the General Public License from time to time Such new versions will be similar in spirit to the present version but may d
50. as a special exception the source code distributed need not include anything that is normally distributed in either source or binary form with the major components compiler kernel and so on of the operating system on which the executable runs unless that component itself accompanies the executable If distribution of executable or object code is made by offering access to copy from a designated place then offering equivalent access to copy the source code from the same place counts as distribution of the source code even though third parties are not compelled to copy the source along with the object code You may not copy modify sublicense or distribute the Program except as expressly provided under this License Any attempt otherwise to copy modify sublicense or distribute the Program is void and will automatically terminate your rights under this License However parties who have received copies or rights from you under this License will not have their licenses terminated so long as such parties remain in full compliance 5 You are not required to accept this License since you have not signed it However nothing else grants you permission to modify or distribute the Program or its derivative works These actions are prohibited by law if you do not accept this License Therefore by modifying or distributing the Program or any work based on the Program you indicate your acceptance of this License to do so and all its t
51. atabase e Java Runtime Environment e Servlet Engine e g Apache Tomcat e mysql connector java 5 1 18 bin jar see 4 7 e commons fileupload 1 2 1 jar and commmons io 1 4 jar see 4 7 e Idap jar and utilities jar see 4 7 Optionally you may want to install e phpMyAdmin or MySQL Administrator e Apache HTTP Server e mod_jk to connect Apache Tomcat to Apache HTTP Server mod_jk also provides load balancer functionality e mod_ssl to provide encrypted data transfer 4 2 DOWNLOAD RETE DB 4 2 Download RETE DB 0 http sourceforge net projects aces 000 74 of 1 file Downloads h A rr 4 3 Unzip the Archive Li RETE DB70 b7stable zip RETE DB_0 6_stable 2 WEB INF gt RETE DB_Copyright txt 3 RETE DB_License txt RETE DB_Manual pdf 2 RETE DB_src gt 71 72 CHAPTER 4 INSTALLATION 4 4 Prepare the MySQL Database Login to your database system create two databases and a database account with access to these 000 Terminal mysql 80x25 d mac mini warnke mysql u root p Enter password Welcome to the MySQL monitor Commands end with or g Your MySQL connection id is 47 to server version 4 1 4 gamma max Type help or h for help Type c to clear the buffer mysql gt CREATE DATABASE rete_db_meta_some_name DEFAULT CHARACTER SET utf8 Query OK 1 row affected 0 02 sec mysql gt CREATE DATABASE rete_db_data_other_name DEFAULT CHARA
52. ayed on the right Todo List List o lt a a a http 127 0 0 1 8080 MyReteDb list html proj 3 3 amp order O amp count 50 amp find y gt Wrw ec Enc a Q Todo List List lastlogin 2008 06 15 09 20 35 0 change password logout Andreas A Todo List List Warnke Address Todo List lt projects gt lt fields gt lt keywords gt lt users gt lt groups gt lt members gt list 101 cz to 281 1981 3 show import n cord for Todo List pages 1 6 results 39 ms Subject Prio Status Description Comment Mark contains performance EJ Y contains speed z i Es EJ E Hi order by gt search 20 50 100 records per page 1000 user admin all The System high accepted 1 You start the system 2a Ask A W if top difficult External Staff crashes when You run the performance test you have risk Guest there is too for 12 hours 2b In parallel urther much traffic you manually trigger the questions system 1069 user admin all high validated Speed improvements when SW Design External Staff creating SQL Strings less Guest StringBuffers required 1213 user admin all low in progress Performance improvements in SW Design External Staff the Convert html class see Guest the todo comments 1270 user admin all low validated performance improvement of SW Design External Staff synchronizing StringBuffers Guest checked and updated r n checked 1275 use
53. be updated Project gt Default Access update 1000 copy 1000 1000 Ok V admin all Ok Address Y Ok Label Guest Ok Access Ok TO admin Fi F2 1731417515657 1781795710 11 T 12 1 13 T 14 Tf 15 F16 117 18 F19 F 20 Tf 21 F 22 F 23 24 25 F 26 F 27 28 f 29 F 30 Tf 31 F 32 7 33 f 34 F 35 F 36 J 37 F 38 F 39 40 41 742 TJ 43 744 745 746 47 148 49 50 T 51 52 F 53 F 54 55 56 F 57 F 58 59 F 6O 761 Tf 62 F 63 Ok M user admin y all 800 Ok update 1000 History new value old value 800 Group for Guests was required by M B Group Mask 0 2 Group for Guests was required by M B Description People who can not modify any data Group for Guests was required by M B CP rio J NZI Done Update the Default Access This field defines who has access to a record created by this group Then press update 1000 Note e Which user is in this group will be defined by lt members gt records e The option Include LDAP members allows to add all LDAP users to this group without defining records int the lt members gt project 2 3 MANAGE USERS AND GROUPS 55 A new group exists now 1000 M admin all Label Guest FO admin Fi F273 F475 76 9 ori Fi2713 14 T 15 16 117 18 19 F 20 OGA 1 22 5 r25 126 f 27 F 28 F 29r 30r 31 7 32 F 33 34 35 36 37 38 39 40 41 F 42
54. ct virus storage Therefore it is strongly recommended to install a virus scanner on the RETE DB server that regularly scans the file archive directories 3 7 Observe Server Load As a system administrator it is your task to monitor the system load and check if there is enough performance available Good tools which you may consider to install are webalizer and sar they analyze http requests and server load 3 8 System Performance RETE DB is an amazingly fast database On fast computers with only few data anyway but even on slow computers with hundred thousands of records working with RETE DB is fun My Book G3 needs only 20 seconds to search through 200 000 records 5 58 sec 10 000 existing user accounts have no effect on the efficiency of a single request Even my 10 years old 120 MHz PPC604 Processor without Java Just In Time Com piler needs only 20 seconds to search through 200 000 records 6 50 sec On both tested systems the hard disk speed was the limiting factor This chapter describes how you can further improve response times 66 CHAPTER 3 MAINTENANCE 3 8 1 Performance tuning Creating indices on fields that are often searched is the most common way to enhance performance This can easily be done by checking the index option of the lt fields gt records as shown in chapter 2 1 4 Other options are e f there are a lot of TEXT fields defined in a project modify the constant net rete_db RETE_DB security Ro
55. d is filled in Options Check the index box if you want to speed up searches on this field Only check this option if this field is often searched because indices slow down other functions and occupy memory There is no need to define an index on the ID field because this field has already an database internal index 38 CHAPTER 2 ADMINISTRATION Note e Indices on TEXT typed fields cannot be created if the character encoding of the database table is ucs2 or if MySQL is older than version 3 23 23 or if the table type is not MyISAM e Indices on TEXT fields cannot be removed e MySQL does not allow to define more than 16 indices per table 2 are already used by RETE DB internally 14 are remaining for your purposes Foreign Project If the field type is Ntol the Foreign Project states the number of the project which shall be referenced by the Ntol field Finally press the create record button TARA lt fields gt 1066 e a E fas http 192 168 0 20 8080 MyReteDb form html OW lt fields gt 1066 I debug change password logout System Administrator Feature List XZ2 Address Todo List lt projects gt lt fields gt lt keywords gt lt users gt lt groups gt lt members gt list 1064 1065 info show 1066 import new record for lt fields gt Ok 18 Database structure adapted Database structure adapted The
56. d press create record Note e The fields Last IP Failed Trials Last Login Last Logout and Password Change need not be filled in These fields are updated by RETE DB automatically e The fields Options and Admin Options allow to control if the user may login see 2 3 4 if changing the password or timezone for this user is allowed if the user can only login via a valid LDAP account and password if the user gets informed on his her last login date if the user can see the log files if the user knows about the import problems see E 4 4 and therefore is allowed to overwrite fields by an import or do other administration tasks 58 CHAPTER 2 ADMINISTRATION 2 3 4 Delete a User Account A user account is deleted by setting the Login disabled flag in the options field of the user Note If the user is logged in at that time this user is thrown out of the system immediately 2 3 5 Check User Accounts Go to the project lt users gt page link 90 lt users gt List lt a e GA 8 hup 127 0 0 1 8080 MyReteDb list htmi proj 3 v gt W7 wikipe e Q Q lt users gt List lt users gt List EHE debug change password logout System Administrator Address Todo List lt projects gt lt fields gt lt keywords gt lt users gt lt groups gt lt members gt list 2 1000 show import new record for lt users g
57. d publisher of the Modified Version as given on the Title Page If there is no section Entitled History in the Docu ment create one stating the title year authors and publisher of the Document as given on its Title Page then add an item describing the Modified Version as stated in the previous sentence Preserve the network location if any given in the Document for public access to a Transparent copy of the Document and likewise the network locations given in the Document for previous versions it was based on These may be placed in the History section You may omit a network location for a work that was published at least four years before the Document itself or if the original publisher of the version it refers to gives permission For any section Entitled Acknowledgements or Dedications Preserve the Title of the section and preserve in the section all the substance and tone of each of the contributor acknowledgements and or dedications given therein Preserve all the Invariant Sections of the Document unaltered in their text and in their titles Section numbers or the equivalent are not considered part of the section titles Delete any section Entitled Endorsements Such a section may not be included in the Modified Version Do not retitle any existing section to be Entitled Endorsements or to conflict in title with any Invariant Section Preserve any Warranty Disclaimers
58. d replace the individual copies of this License in the various documents with a single copy that is included in the collection provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects You may extract a single document from such a collection and distribute it individ ually under this License provided you insert a copy of this License into the extracted document and follow this License in all other respects regarding verbatim copying of that document 97 7 AGGREGATION WITH INDEPENDENT WORKS A compilation of the Document or its derivatives with other separate and independent documents or works in or on a volume of a storage or distribution medium is called an aggregate if the copyright resulting from the compilation is not used to limit the legal rights of the compilation s users beyond what the individual works permit When the Document is included in an aggregate this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document If the Cover Text requirement of section 3 is applicable to these copies of the Docu ment then if the Document is less than one half of the entire aggregate the Document s Cover Texts may be placed on covers that bracket the Document within the aggregate or the electronic equivalent of covers if the Document is in electronic form Otherwise they must appear on printed covers that bracket
59. data Write_DB e rete_db_meta accs_projects_data ArchiveFolder Then start RETE DB and check the system 3 3 Avoid Intrusion One vulnerable point of a world wide accessible multi user system is that some users ignore security issues It therefore is the administrator s task to regularly remind all users on the security problems stated on the change password page see chapter 1 1 3 Another problem is that access right are not revoked automatically when a user leaves a project The administrator should take care of keeping the list of valid user accounts up to date 3 4 DETECT INTRUSION 65 3 4 Detect Intrusion After every login each user should check the date of the last login If this date is not correct it is likely that someone else used this users account in the meantime If this happens this user should change the password immediately and inform the administator as soon as possible The administrator then should check the log files to find out what happended 3 5 Unlock the Database To unlock the database after a brute force attack login directly to your MySQL database and set the accs users data Options fields to 0 3 6 Detect Viruses RETE DB is completely ignorant to any code that is uploaded to the server A virus is stored in the database and sent to the clients as any other data It is not executed on the RETE DB server This seems to be a consequent and robust handling but please note This makes RETE DB a perfe
60. do List List e a E 0 mup 127 0 0 1 8080 MyReteDb list hmi proj 338order 08count 34find Y gt Wr Wikipedia Eng Q a Todo List List Todo List List DE E Hoon 2008 06 15 09 20 35 0 change password logout Andreas Warnke Todo List lt projects gt lt ields gt lt keywords gt lt users gt lt groups gt lt members gt 1000 1001 1002 show import ecord for Todo List pagas 1 MAA 116 2 Jura 16 ms Subject Prio Status Description Comment Mark El zil zi order by z search C 20 50 100 3 records per page 1000 user admin The System high accepted 1a You start the system 1b Ask A W if top difficult External Staff crashes when Wait at least 2 minutes 2a You you have risk there is too much run the performance testfor12 further traffic hours 2b In parallel you questions manually trigger the system 1001 user admin The system is low accepted External Staff slow in case of no traffic 1002 user admin all high validated Wrong GR_P options Bug External Staff displayed If you try to change a Guest PROJ field and this update is rejected the GR_P shows the options of the new rejected project instead of the currently selected project 3 records displayed 49 ms G results as XML CSV 1 CSV 2 CSV 3 CSV 4 tab Done E On the bottom of each list page some export links are sh
61. ds on what the Program does 1 You may copy and distribute verbatim copies of the Program s source code as you receive it in any medium provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty keep intact all the notices that refer to this License and to the absence of any warranty and give any other recipients of the Program a copy of this License along with the Program You may charge a fee for the physical act of transferring a copy and you may at your option offer warranty protection in exchange for a fee 2 You may modify your copy or copies of the Program or any portion of it thus forming a work based on the Program and copy and distribute such modifications or work under the terms of Section 1 above provided that you also meet all of these conditions 85 a You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change b You must cause any work that you distribute or publish that in whole or in part contains or is derived from the Program or any part thereof to be licensed as a whole at no charge to all third parties under the terms of this License c If the modified program normally reads commands interactively when run you must cause it when started running for such interactive use in the most ordinary way to print or display an announcement including an appropriate copyright n
62. e 0 0 20 73 4 6 Install RETE DB 0 0 e 75 4 7 Install Required Java Packages 0 0 75 4 8 Setup email notification optional o 75 4 9 Restart the Servlet Engine 0 0 e 76 4 10 Check if RETE DB is running o o o 76 4 11 Troubleshooting eita i area t on a 2 00000 20 R E e 77 A Trademarks 79 CONTENTS 7 B Colors 81 Bul Text Colors e fia Ah Be ea al e N 81 B 2 Ground Colors aoaaa 81 C The GNU General Public License 83 D GNU Free Documentation License 91 E Design 99 E 1 Packages static view ded a A Pati te datt 100 E 2 Packages dynamic view oops Es bak Ae he a Dale 84 100 E 3 Perfornamce Scalability and Security 101 E 4 Database Design 2 2 020 000 2 ee 102 E 4 1 Data Tables ad a Ans ee e ce Re Be ee 102 E 4 2 History Tables 0 0000000022 eee 103 E43 Text Tables Do Yea nck kN Ae Bey he Sots eee Dot 104 E 4 4 Transactions oao r ean E E eE e a hia e 104 E 5 Design of Request URLS 20 a e a Wia a 106 ED find Parameter roda haret ack ca o a A a eS 106 ED EmO A A e aoe oe A NET 106 CONTENTS Chapter 1 User Manual This section describes the basic functionality of RETE DB record entry modification and record queries as well as some more sophisticated features like data export data import or bookmarks on search queries 10 CHAPTE
63. e gt lt init param gt Other Errors Please feel free to write an email to RETE DB andreaswarnke de in case of problems Index Black on Light Color 39 Black on White 39 Bold Black on Light Color 39 Bold Black on White 39 Bold Original Colors 39 Hidden 39 Original Colors 39 access control 48 access rights 48 account create 57 disable 58 ACCS 102 ACL_ 36 ACL_ Admin Access 40 ACL_ Wide Input 39 Administration 31 AND 21 Apache Tomcat as 75 79 Archive Folder 33 Auto Type 40 automatic changes 100 back up 64 recover 64 bookmark 23 browser 10 Checklist 61 color 39 81 consistency checks 100 Consistency Type 40 cookies 10 copy 17 Created Time 40 108 csv 24 26 Custom Query 106 data export 26 import 24 DATE 36 date format 15 debug 77 106 Default Access 48 distribute 66 dropdown box options 41 43 email notifications 43 75 Entry Disabled 44 error 106 exception 106 explain 15 20 export 24 favorites 23 field 32 create 36 delete 41 Field Name 36 Field Type 36 FILE 36 find a203e 106 Firefox 10 79 Foreign Project 36 38 Form Layout 39 Form Order 39 GRP 36 Ground Color 39 81 INDEX group create 52 delete 56 modify 56 group member 59 history 19 ID__ 36 import 26 Index 36 create 66 info 17 install 69 INT_ 36 Internet Explorer 10 79
64. e new keyword field 1067 2 1 OVERVIEW ON PROJECTS AND FIELDS 43 2 1 7 Define Keywords To create a new keyword go to project lt keywords gt page new record TARA lt keywords gt New Record o a g A htp 192 168 0 20 8080 MyReteDb form htmPproj 5 amp count 51 W lt keywords gt New Record A debug change password logout System Administrator ist XZ2 Address Todo List lt projects gt lt fields gt lt keywords gt lt users gt lt groups gt lt members gt list 4 2 e sesiis ssssssssee eercrcacas sesos 1299 info show import new record for lt keywords gt create record Feature List XZ2 gt al 1067 Access Y admin all Label high Description o mo NT E imo mom imo omy ES Moo my HS MO me me oe 30 31 32 33 J 34 35 J 36 J 37 T 45 5 46 J 47 48 J 49 50 J S51 JT 59 60 J 61 J 62 J 63 Oner fio Options J Entry disabled Search disabled create record ro Read only fields You do not have write access rr Read restricted fields Some people do not have read access al Fe rtig Enter the Project the Field Id 1067 in example of chapter 2 1 6 and a Label If this keyword is used in a field of type MULT check one of the Bit Mask flags Do not change this flag later TARA lt keywords gt
65. ebalizer is the name of a program which displays server statistics 79 80 APPENDIX A TRADEMARKS Appendix B Colors This chapter shows some example colors Y m Text Colors Black 33333 Gray m Blue 4 00333 Blue Green 003300 Green Brn Brown Red mee Violet SE JE a a 2 e S a Y by Ground Colors weet White Zec Gray eceefp Blue tccrr Blue ticefice Green serie Yellow ffecce Red series Violet 81 82 APPENDIX B COLORS Appendix C The GNU General Public License Version 2 June 1991 Copyright 1989 1991 Free Software Foundation Inc 59 Temple Place Suite 330 Boston MA 02111 1307 USA Everyone is permitted to copy and distribute verbatim copies of this license document but changing it is not allowed Preamble The licenses for most software are designed to take away your freedom to share and change it By contrast the GNU General Public License is intended to guarantee your freedom to share and change free software to make sure the software is free for all its users This General Public License applies to most of the Free Software Foundation s software and to any other program whose authors commit to using it Some other Free Software Foundation software is covered by the GNU Library General Public License instead You can apply it to your programs too When we speak of free software we are referring to freedom not price Our General Public Lic
66. enses are designed to make sure that you have the freedom to distribute copies of free software and charge for this service if you wish that you receive source code or can get it if you want it that you can change the software or use pieces of it in new free programs and that you know you can do these things To protect your rights we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights These restrictions translate to certain responsibilities for you if you distribute copies of the software or if you modify it For example if you distribute copies of such a program whether gratis or for a fee you must give the recipients all the rights that you have You must make sure that they too receive or can get the source code And you must show them these terms so they know their rights 83 84 APPENDIX C THE GNU GENERAL PUBLIC LICENSE We protect your rights with two steps 1 copyright the software and 2 offer you this license which gives you legal permission to copy distribute and or modify the software Also for each author s protection and ours we want to make certain that everyone understands that there is no warranty for this free software If the software is modified by someone else and passed on we want its recipients to know that what they have is not the original so that any problems introduced by others will not reflect on the original authors reputations Finally
67. eral keywords for the same field click on the copy 4116 link TARA lt keywords gt New Record e E g fay http 192 168 0 20 8080 MyReteDb form htmi proj 5 count 504list Y O w lt keywords gt New Record L debug change password logout System Administrator Feature Li Address Todo List lt projects gt lt fields gt lt keywords gt lt users gt lt groups gt lt members gt std LILLO iiin sisina 1129981 M show import new record for lt keywords gt History not copied create record Feature List XZ2 y L 1 1067 Urgency lt fields gt 1067 Access M admin all Label fho ss sSOSCS Description EOE EE NO Se es a IS MT MEN MSN eon Boi 122 120 a S a 1278 pone 2981 O 32 7 33 34 35 36 37 38 f 39 40 f 41 142 43 44 45 46 47 48 1 49 50 7 51 52 153 54 55 56 r 57 58 FT 59r 60 r 62 TF 63 20 Options J Entry disabled Search disabled create record Explain ro Read only fields Yau da not have write access Fertig 2 1 8 Delete a Keyword There may be several phases when deleting a keyword e The first most likely is disabling the keyword entry By selecting the Entry disabled flag nobody can enter this keyword anymore e The second phase is disabling the search for the keyword By selecting the Search disabled flag it is not possible anymore to search for this keyword
68. ered responsible for modifications made by others This License is a kind of copyleft which means that derivative works of the doc ument must themselves be free in the same sense It complements the GNU General Public License which is a copyleft license designed for free software We have designed this License in order to use it for manuals for free software because free software needs free documentation a free program should come with manuals providing the same freedoms that the software does But this License is not limited to software manuals it can be used for any textual work regardless of subject matter or whether it is published as a printed book We recommend this License principally for works whose purpose is instruction or reference 91 92 APPENDIX D GNU FREE DOCUMENTATION LICENSE 1 APPLICABILITY AND DEFINITIONS This License applies to any manual or other work in any medium that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License Such a notice grants a world wide royalty free license unlimited in duration to use that work under the conditions stated herein The Document below refers to any such manual or work Any member of the public is a licensee and is addressed as you You accept the license if you copy modify or distribute the work in a way requiring permission under copyright law A Modified Version of the Document means any wo
69. erms and conditions for copying distributing or modifying the Program or works based on it Each time you redistribute the Program or any work based on the Program the recipient automatically receives a license from the original licensor to copy distribute or modify the Program subject to these terms and conditions You may not impose any further restrictions on the recipients exercise of the rights granted herein You are not responsible for enforcing compliance by third parties to this License If as a consequence of a court judgment or allegation of patent infringement or for any other reason not limited to patent issues conditions are imposed on you whether by court order agreement or otherwise that contradict the conditions of this License they do not excuse you from the conditions of this License If 10 87 you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations then as a consequence you may not distribute the Program at all For example if a patent license would not permit royalty free redistribution of the Program by all those who receive copies directly or indirectly through you then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program If any portion of this section is held invalid or unenforceable under any particular circumstance the balance of the section is intended to
70. fit reasonably on the actual cover and continue the rest onto adjacent pages If you publish or distribute Opaque copies of the Document numbering more than 100 you must either include a machine readable Transparent copy along with each Opaque copy or state in or with each Opaque copy a computer network location from which the general network using public has access to download using public standard network protocols a complete Transparent copy of the Document free of added material If you use the latter option you must take reasonably prudent steps when you begin distribution of Opaque copies in quantity to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy directly or through your agents or retailers of that edition to the public It is requested but not required that you contact the authors of the Document well before redistributing any large number of copies to give them a chance to provide you with an updated version of the Document 4 MODIFICATIONS You may copy and distribute a Modified Version of the Document under the condi tions of sections 2 and 3 above provided that you release the Modified Version under precisely this License with the Modified Version filling the role of the Document thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it In addition you must do the
71. gt lt groups gt lt members gt last login 2008 06 15 09 20 35 0 change password logout Andreas Warnke A list info show 1000 import new record for Todo List Ok 8 update 1000 copy 1000 Subject The System crashes when there is too much traffic Ok y Done To the right there is a copy link which simplifies creating several records with similar content Note e There is no copy link if you have no create record permissions e The history is not copied e f there are files or passwords stored in the original record these are not copied Afterwards click on the create record button to permanently store the new record 1 2 3 Record Information If you are not sure what to enter into a field or what meaning a multiple choice item has submit your changes and then click on the info link Todo List 1000 a e 4 htup 127 0 0 1 8080 MyReteDb form html ve Wr Wikipe y Q Q Todo List 1000 lastlogin 2008 06 15 09 20 35 0 change password logout Andreas Warnke A Todo List 1000 Address o List lt projects gt lt fields gt lt keywords gt lt users gt lt groups gt lt members gt list info show 1000 import new record for Todo List Ok 8 update 1000 copy 1000 Subject The System crashes when there is too much traffic Ok Y Done 18
72. hapter 2 Administration This chapter describes how to create projects and how to manage accounts 31 32 CHAPTER 2 ADMINISTRATION 2 1 Overview on Projects and Fields lt projects gt define the tables lt fields gt define the columns of each table lt keywords gt define the options of drop down KEYW and multiple choice MULT typed fields AE E E y ce debug change password logout System Administrator Feature List XZ2 Address Todo List lt projects gt lt fields gt lt keywords gt lt users gt lt groups gt lt members gt list Access Title Urgency EE order by search FLO 50 00 SIST lt splomisy gt lt spjay gt lt spatord gt 2 1 OVERVIEW ON PROJECTS AND FIELDS 33 2 1 1 Create a Project To create a new project go to project lt projects gt page new record Take into account that every project causes some administration efforts In some cases it is simpler to extend an existing similar project than to create a new one AAA lt projects gt New Record e a E fat http 192 168 0 20 8080 MyReteDb form html proj 1 amp count 5 Wr A Ml debug change password logout System Administrator lt projects gt New Record ess Todo lt projects gt lt fields gt lt keywords gt lt users gt lt groups gt lt members gt list 1 2
73. harddisk is full or if the MySQL database file has reached the maximum file size of your filesystem E 6 ERRORS 107 2 history entries modified instead of 0 or 1 This effect may occur if one record is modified by two different tasks at the same time See E 4 4 Unexpected Either the system user has limited access rights or nothing has to be done in Dispatcher doAutomaticChanges This might occur if the admin group 0 does not have access on a field for which a consistency check is defined Please check the access rights on the fields sun io MalformedInputException Missing byte order mark When importing a csv file in unicode UCS 2 format check that this file begins with the unicode character FEFF to identify the byte order in the file java lang RuntimeException java sql SQLException Syntax error or access violation message from server You have an error in your SQL syntax Check the manual that corresponds to your MySQL server version for the right syntax to use near at line 1 de quartztime RETE_DB security DBStatementWrapper executeQuery DBStatemen tWrapper java 439 Add the following lines to your web xml file lt init param gt lt Does the UTC_TIMESTAMP command exist This should be false for MySQL 3 x or 4 0 x databases true or undefined for MySQL 4 1 1 and newer gt lt param name gt Database_UT CTimestampAvailable lt param name gt lt param value gt false lt param valu
74. heet application e g at 10 00 am modifies the data there and imports the records afterwards back to RETE DB e g at 11 30 am this user might unintentionally overwrite changes done by other users during that time between 10 00 and 11 30 am To avoid this problem a user needs a special right to overwrite records by an import The administrator should give this right only to users who know about these problems or to users who have very limited write access and therfore can not overwrite changes done by others E 4 DATABASE DESIGN 105 Simultaneous changes via a browser When two users change a record at the same time the second user who sends the update request will overwrite all modifications of the first user Even fields that were not modified by the second user will be reset to their original value if the first user changed them The risk of a second user overwriting the values of the first can be reduced by limiting the write access rights of every user to the necessary minimum Should this case happen nonetheless the second user will notice that more fields were changed than intended The user can see the earlier changes in the history and undo the unintended modifications Extremely rare situations Supposed two users press the submit button at the exact same time Then it can happen that the history is partly inconsistent e Two history entries might have the same timestamp e The order of the history entries might be differen
75. hup 127 0 0 1 8080 MyReteDb Y gt Q 2 Q Login o T 127 001 A Domain Login Password Login RETE DB License Gnu Public License _ _Version 0 6 RETE DB comes with ABSOLUTELY NO WARRANTY for details y Done The initial password is Domain RETE DB Login root Password RETE DB 4 11 TROUBLESHOOTING TT 4 11 Troubleshooting In case of problems e set the DebugLevel in the web xml file to debug see 4 5 e enable logging in your Servlet Engine e restart your Servlet Engine and e check the log files This may help you in finding the problem Note e A ClassNotFound or NoSuchMethod exception may indicate incompatibilities to the installed libraries 78 CHAPTER 4 INSTALLATION Appendix A Trademarks e Apache and Apache Tomcat are trademarks of the Apache Software Foun dation e Firefox is a browser name of Mozilla e Internet Explorer Y is a registered trademark of the Microsoft group of companies e Jakarta is a name of a project of the Apache Software Foundation e Java ss JRE and JVM are trademarks of Sun Microsystems Inc or its subsidiaries in the United States and other countries e MySQL Y is a registered trademark of MySQL AB in Sweden and other countries MySQL is a trademark in the United States and other countries e Safari is a trademark of of Apple Inc registered in the U S and other countries e sar is the name of a program which analyzes system performance e w
76. ible from all RETE DB instances if RETE DB is distributed to different servers There are some less important fields that you may want to fill in e Order Allows to position this project within the list of all projects Increase the number to shift this project right decrease the number to shift it left e Description Provide a short description for this project This is visible to all users e Default Order Field ID Choose the field by which the search results shall be ordered if a user has not provided a search order e Default Order Direction Choose the direction ascending or descending if a user has not provided a search order Press the create record button INO lt projects gt 1000 lt lt y E fat http 192 168 0 20 8080 MyReteDb form html vi W lt projects gt 1000 HH E debug change password logout System Administrator Address Todo List lt projects gt lt fields gt a lt users gt lt groups gt lt members gt list 11 2 3 4 5 6 32 33 info show 1000 import new record for lt projects gt Ok 11 Database structure adapted Internal system messages start Ok 5 Ok 1 Ok 12 Database structure adapted Ok 12 ar structure adapted Ok 8 Ok 8 Internal system messages stop update 1000 copy 1000 Label Feature List XZ2 1D 1000 Ok Ok 1000 Access V ad
77. ield is created If the field is of type KEYW dropdown box or MULT multiple choice you need to define the lt keywords gt see 2 1 7 Display Options for Fields There are some options that affect the color and layout of the fields e Form Order This is a number that controls the position of the field in the form layout The lower the number the higher the line where the field is displayed If fields have identical or consecutive numbers RETE DB tries to display these fields in the same line e List Order This is a number that controls the position column of the field in the list layout For Ntol fields this number also influences which field shall be displayed in other projects when referencing this project The TX32 TX80 or TXCC field with the lowest list order will be shown e Text Color Here you can enter a color for the field name in the format rrggbb where r g and b are numbers from 0 1 2 9 a b c d e f Every color is mixed from a red rr a green gg and a blue bb component 000000 is black FffFfF is white FF00ff00 is green ff0000 is red ffff00 is a mix of green and red which results in yellow See chapter B for more examples 40 CHAPTER 2 ADMINISTRATION e Ground Color Background color of the field name See chapter B for examples Leave this field empty for a white background e Form Layout You can influence the layout of some field types by setting this option The width of the in
78. iffer in detail to address new problems or concerns Each version is given a distinguishing version number If the Program specifies a version number of this License which applies to it and any later version you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation If the Program does not specify a version number of this License you may choose any version ever published by the Free Software Foundation If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different write to the author to ask for permission For software which is copyrighted by the Free Software Foundation write to the Free Software Foundation we sometimes make exceptions for this Our decision will 88 11 12 APPENDIX C THE GNU GENERAL PUBLIC LICENSE be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally No WARRANTY BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE THERE IS NO WAR RANTY FOR THE PROGRAM TO THE EXTENT PERMITTED BY APPLICABLE LAW EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLD ERS AND OR OTHER PARTIES PROVIDE THE PROGRAM AS IS WITHOUT WAR RANTY OF ANY KIND EITHER EXPRESSED OR IMPLIED INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PART
79. intrusion avoid 64 detect 65 Jakarta 75 79 KEYW 32 36 41 43 keyword 32 41 create 43 delete 44 Last Modification Time 40 LDAP 52 57 73 list 21 List Layout 39 List Order 39 local time 30 log 19 login 10 Login Disabled 58 logout 12 Maintenance 63 Mandatory Fields 40 member 59 MULT 32 36 41 43 MULT Narrow Input 39 multiple choice options 41 43 109 MySQL 70 72 79 replicate 66 101 NOT 21 106 Ntol 36 38 39 Ntol Wide Input 39 OR 21 order 21 pages 21 PASS 36 password change 12 73 performance 65 permissions 48 process 100 PROJ 36 project 14 32 create 33 delete 35 query 21 bookmark 23 export 24 Read Access 48 Read DBs 33 REAL 36 record copy 17 create 15 create right 48 default access 48 delete right 48 export 24 history 19 import 26 info 17 modify 20 search 21 replicate 66 restart 76 RETE DB 110 move 64 restart 76 unlock 65 RuntimeException 106 Safari O 10 79 scalability 101 search 21 bookmark 23 export 24 Search Disabled 44 security 101 server load 65 distribute 66 enhance performance 66 speed 65 101 spreadsheet application 24 26 SQLException 106 system performance 65 Table Prefix 33 TEXT 36 Text Color 39 81 TEXT HTTP Link 39 TIME 36 time format 15 TIME Created 40 TIME LastMod 40 timezone 30 change 12 Transactions 104 troubleshooting 77
80. ion gt lt distributable gt Standard fiction Serviet Configuration with debugging gt lt servlet gt lt sery let name gt RETE DB lt sery let name gt lt servlet class gt net rete_db rete_db controller Main lt servlet class gt lt init param gt the initial database connection gt lt param name gt Meta_DB_Ur lt param name gt lt param value gt dbc mysql 127 0 8 1 3306 rete_db meta_ some_name user ReteDbUserNametamp password anyPassH lt init param gt lt init param gt the default database connection gt lt param name gt Dat a_DB_Ur lt param name gt lt param value gt jdbc mysql 127 0 0 1 3306 rete db data other_name user ReteDblserNametomp password anyPassl lt init param gt Note In the web xml file the character amp needs to be replaced by amp amp Check that the www user has access to the File Upload folder lt init param gt S folder for temporary files These are deleted automatically if no longer needed The folder name needs no slash at the ending o lt param name gt F i leUpload_TempFolder lt param name gt lt paras value gt tmp RETE DB_f i le_up loads lt param va lue gt lt init paraw gt There are several parameters to configure a connection to an LDAP server if you want to use external authentication 74 CHAPTER 4 INSTALLATION e LDAP Enabled e LDAP_ServerHost e LDAP_ServerPort e LDAP_ServerLogin
81. ist 1000 o E penso receso 1 perrera change password logout Andreas Warnke A Address Todo List lt projects gt lt fields gt lt keywords gt lt users gt lt groups gt lt members gt list info show 1000 import new record for Todo List Ok 8 G update 1000 copy 1000 he System crashes when there is too much traffic accepted gt 1000 Ok Ok ja user Y admin y all Y External Staff Y Guest Subject Description You start the system You run the performance test for 12 hours In parallel you manually trigger the system Comment if you have further questions Ok Mark F top F difficult Y risk cost Ok History E new value old value Mark top difficult risk Comment Ask A W if you have further questions Description 1 You start the system 2a You run the performance test for 12 hours 2b In parallel you manually trigger the system user admin all External Staff Guest Done After updating the record the results are displayed E On top of the history list a new entry is displayed which shows your modifications 1 2 RECORDS 17 1 2 2 Copy a Record Todo List 1000 a E 4 O mp 127 0 0 1 8080 MyReteDb form html v B W7 Wikipedia Eng Q Q Todo List 1000 Todo List 1000 Address Todo List lt projects gt lt fields gt lt keywords gt lt users
82. k after Connection has been lost e g due to Exception rin gt A Rc 4 high validated Bug After Importing new records all access rights were set to 0 This happened only once with version 0 4 rinNeither reproduc 5 fhigh validated New Feature Search for does not contain and is not equal 6 high validated Layout all fields must have an order high validated New Feature Use the same DB connection pool on projects with identical DB Uris to avoid that the maximum number of database connec 8 high validated SW Design Support for MySQL Replication 9 fnigh rejected Layout duplicate error messages when changing a field where i have no accessinin not a bug 10 fhigh validated Layout Design White background for active project 11 fhigh validated Doku Info Java 1 5 Programs do not run on Java 1 4 virtual machines gt Tomcat 12 fhigh validated Doku Chapter Maintenance updated in Manual review of complete manual 13 low Layout Field type TITL which represents a title in the form layout and is ignored in list layout export and import 14 high validated Bug security MetaRow creates history entries even if the record does not exist n INSERT INTO ACCS _Users _history Dat 15 fhigh validated SW Design review of SQL log one rare bug solved 16 high validated SW Design Quoting symbols in SQL statements must be checked rinThe HistoryList should not quote dates this might slow down the hi 17 high validated SW De
83. l detected automatically Internal system messages start 1 Testmode active database not changed Internal system messages stop 1 Internal system messages start 2 Testmode active database not changed Internal system messages stop 2 Internal system messages start 3 Testmode active database not changed Done E WS Lal Check the results of the upload Are there red colored items OOO Todo List Import o lt a e AA 8 hup 127 0 0 1 8080 MyReteDb import html v gt W7 Wikipedia Eng a Q Todo List Import o z Testmode active database not changed Internal system messages stop 344 Internal system messages start 345 Testmode active database not changed Internal system messages stop 345 Internal system messages start 346 Testmode active database not changed Internal system messages stop 346 Internal system messages start 347 Internal system messages stop 347 empty Pe ee ee ee T Importing new modified records Import File Desktop Demolmport csv _ Browse Encoding Latin 1 150 8859 x Explain Data import from XYZ Database Format CSV auto detect gt Test Only 7 Match ID Column none all records are new gt Import G Explain Explain the reason for your import actions here 9 Done If everything is ok choose the file
84. ly for TEXT fields Id of the text record after the change e OldValue2Copy Only for FILE fields Filesize before the change e NewValue2 Only for FILE fields Filesize after the change e OldValue3Copy Only for FILE fields Path to the file in the filesystem of the server e NewValue3 Only for FILE fields Path to the file in the filesystem of the server E 4 3 Text Tables Each project has a text table The reasons for not simply storing TEXT fields in the data table are e Performance When searching over non indexed fields in the data table huge texts in that table would slow down the search On the other hand this design slows down the display of one single record since multiple records need to be read from the database just to display a single record Nonetheless the database design is a good compromize between fast search and fast record display e Compactness Every text would have to be stored three times if it were not stored in a separate table once in the data table and two times in the history Text records consist of the following information e Id Id of the text entry used to reference texts from the data as well as from the history tables e Text Text E 4 4 Transactions RETE DB does not know about transactions This has the advantage of high perfor mance but it also has some disadvantages when multiple users change a record at the same time Export Import When a user exports some records to a spreads
85. m Administrator Address Todo List lt projects gt lt fields gt lt keywords gt lt users gt lt groups gt lt members gt list 64 65 68 show import new record for lt groups gt pages 1 3 results 190 ms E aee E E M A order by gt search 20 50 100 records per page list all columns 64 Address admin Address Project 0 admin admin Administrator 65 Address all All 0 admin 1 2 3 4 5 6 7 8 9 10 11 12 13 14 admin 200 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 68 Address user Address Project 1 admin Users 3 records displayed 50 ms Export results as XML CSV 1 CSV 2 CSV 3 CSV 4 taby Check which group masks are already in use 0 and 1 in this case ignore the all group 2 3 MANAGE USERS AND GROUPS 53 Go to the project lt groups gt page new record TARA lt groups gt New Record v e t http 127 0 0 1 8080 MyReteDb form html proj 4 amp find alole21h200330 gt W Wikipedia Eng Q 7 Q lt groups gt New Record x z lt groups gt New Record A debug change password logout System Administrator Address Todo List lt projects gt lt fields gt lt keywords gt lt u
86. matically e Passwords are encrypted before they are stored in the database E 4 Database Design For every project a group of three tables exists in the database A data table which contains the current values a log table which contains the histories and a table storing long texts There are some table groups for the administration tasks lt projects gt lt fields gt lt keywords gt lt users gt lt groups gt lt members gt and there is one of these groups for each custom project that is managed by RETE DB Most of these table groups are independant of each other This enables a distribution of the databases to different servers The lt projects gt and the lt members gt tables must be located in the same database For compatibility to future versions it is recommended to keep all administration tables in one database E 4 1 Data Tables Each project has a data table Data records consist of the following information E 4 DATABASE DESIGN 103 e ACCS _Id Id of the record The name of this field still reflects the former program name Access controlled cell server e ACCS_Read Read rights to this record This is a bitmask each bit sets or revokes access for one group This field also determines the write access There iS no separate write access field for the following two reasons It is difficult to explain separate write and read permissions to the users and this solution would not fit to many real world problems
87. min F all Ok Ok Description ist of new features for Product XZ2 Fertig The lt projects gt record is created the database structure is modified Also the two default lt fields gt Id and Access the lt groups gt admin and all and some lt members gt records are created 2 1 OVERVIEW ON PROJECTS AND FIELDS 35 2 1 2 Delete a Project A project cannot be deleted from the database but you can revoke all access rights See chapter 2 2 how to hide a project 2 1 3 List all Fields of a Project Go to project lt fields gt page list AAA lt fields gt List e a E fat http 192 168 0 20 8080 MyReteDb list htmi proj 2 amp order 08 Wr BB debug change password logout System Administrator Feature List XZ2 Address Todo List lt projects gt lt fields gt lt keywords gt lt users gt lt groups gt lt members gt list 1064 1065 show import new record for lt fields gt pages 1 2 results 3 ms E a ama z order by zl search C 20 50 100 records per page list all colun 1064 Feature ListXZ2 ID DE ACCS_ld Unique ID admin all 0 index within this admin project 1065 Feature ListXZ2 Access ACL_ ACCS_Read ed admin admin 0 0 index recor 2 records displayed 9 ms Export results as XML CSV 1 CSV 2 CSV 3 CSV 4 tab n sd
88. n full compliance 10 FUTURE REVISIONS OF THIS LICENSE The Free Software Foundation may publish new revised versions of the GNU Free Documentation License from time to time Such new versions will be similar in spirit to the present version but may differ in detail to address new problems or concerns See http www gnu org copyleft 98 APPENDIX D GNU FREE DOCUMENTATION LICENSE Each version of the License is given a distinguishing version number If the Docu ment specifies that a particular numbered version of this License or any later version applies to it you have the option of following the terms and conditions either of that specified version or of any later version that has been published not as a draft by the Free Software Foundation If the Document does not specify a version number of this License you may choose any version ever published not as a draft by the Free Software Foundation ADDENDUM How to use this License for your documents To use this License in a document you have written include a copy of the License in the document and put the following copyright and license notices just after the title page Copyright YEAR YOUR NAME Permission is granted to copy distribute and or modify this document under the terms of the GNU Free Documenta tion License Version 1 2 or any later version published by the Free Software Foundation with no Invariant Sections no Front Cover Texts and no Back Cover Tex
89. nse You may copy and distribute the Program or a work based on it under Section 2 in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following a Accompany it with the complete corresponding machine readable source code which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange or b Accompany it with a written offer valid for at least three years to give any third party for a charge no more than your cost of physically performing source distribution a complete machine readable copy of the corresponding source code to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange or 86 APPENDIX C THE GNU GENERAL PUBLIC LICENSE c Accompany it with the information you received as to the offer to distribute corresponding source code This alternative is allowed only for noncom mercial distribution and only if you received the program in object code or executable form with such an offer in accord with Subsection b above The source code for a work means the preferred form of the work for making modifications to it For an executable work complete source code means all the source code for all modules it contains plus any associated interface definition files plus the scripts used to control compilation and installation of the executable However
90. nt are reproduced in all copies and that you add no other conditions whatsoever to those of this License You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute However you may accept compensation in exchange for copies If you distribute a large enough number of copies you must also follow the conditions in section 3 You may also lend copies under the same conditions stated above and you may publicly display copies 3 COPYING IN QUANTITY If you publish printed copies or copies in media that commonly have printed covers of the Document numbering more than 100 and the Document s license notice requires Cover Texts you must enclose the copies in covers that carry clearly and legibly all these Cover Texts Front Cover Texts on the front cover and Back Cover Texts on the back cover Both covers must also clearly and legibly identify you as the publisher of these copies The front cover must present the full title with all words of the title equally prominent and visible You may add other material on the covers in addition Copying 94 APPENDIX D GNU FREE DOCUMENTATION LICENSE with changes limited to the covers as long as they preserve the title of the Document and satisfy these conditions can be treated as verbatim copying in other respects If the required texts for either cover are too voluminous to fit legibly you should put the first ones listed as many as
91. ojects gt lt fields gt lt keywords gt lt users gt lt aroups gt lt members gt list 2 show import new record for lt users gt pages 1 1 results 51 ms 1D Name Domain Login Email Phone Time 0 Ss Zone El z El El z _E l OOOO order by z search 20 50 100 records per page list all columns 2 System RETE DB root 0 see log can 0 Administrator sudo 1 records displayed 6 ms Export results as XML CSV 1 CSV 2 CSV 3 CSV 4 tabY 0 gt Done This page lists all user accounts Note that this page does not show which user belongs to which group The lt members gt project lists this relation see 2 2 4 2 2 ACCESS RIGHTS 2 2 4 Check Group Members 51 Go to the project lt members gt page list search for the Project you are interested in OO lt members gt List o c pages 1 list 2114 lt members gt List 4 0 mup 127 0 0 1 8080 MyReteDb list hrmi proj 68count 50 w gt Wr Wikipedia Eng a lastlogin 2008 06 29 10 02 18 0 debug change password logout System enn PeT show Administrator import new record for lt members gt 9 results 2 ms 2 4 6 8 10 12 129 131 1001 System Administrator lt users gt 2 System Administrator lt users gt 2 System Administrator lt users gt 2
92. otice and a notice that there is no warranty or else saying that you provide a warranty and that users may redistribute the program under these conditions and telling the user how to view a copy of this License Exception if the Program itself is interactive but does not normally print such an announcement your work based on the Program is not required to print an announcement These requirements apply to the modified work as a whole If identifiable sections of that work are not derived from the Program and can be reasonably considered independent and separate works in themselves then this License and its terms do not apply to those sections when you distribute them as separate works But when you distribute the same sections as part of a whole which is a work based on the Program the distribution of the whole must be on the terms of this License whose permissions for other licensees extend to the entire whole and thus to each and every part regardless of who wrote it Thus it is not the intent of this section to claim rights or contest your rights to work written entirely by you rather the intent is to exercise the right to control the distribution of derivative or collective works based on the Program In addition mere aggregation of another work not based on the Program with the Program or with a work based on the Program on a volume of a storage or distribution medium does not bring the other work under the scope of this Lice
93. own The format of the export is either csv comma separated values or XML There are slight variations between the csv file formats of different spreadsheet applications Therefore there are several csv formats provided Try these links to determine which format is the best for your purposes 1 4 EXPORT IMPORT Click on an export link and save the file to disk A Opening export_2008 06 15_09 03UTC_utf8_sql csv You have chosen to open _ export_2008 06 15_09 03UTC_utf8_sql csv which is a Comma Separated Vars from http 127 0 0 1 8080 What should Firefox do with this file O Open with O Save to Disk C Do this automatically for files like this from now on 25 26 CHAPTER 1 USER MANUAL 1 4 2 Import If you want to import data from a spread sheed application the first row must list the field names of the RETE DB project 000 X Demolmport OpenOffice org Calc File Edit View Insert Format Tools Data Window Help iA SHSBIASRIF 2358 9160 1GNHIQYIMOBEQIO Y iad Jana Hlio O BJ USE P ob a e O o A p2 fm E wrong GR P options displayed iF you try to change a PRO field and this update is rejected the GR_P shows thi A B B 1 Prio Status Comment Description high validated Bug rong GR P _opti Bplayed If you try to change a PROJ field and this update is rejected the GR P shows the options 3 high validated Bug Load Balancing among MySQL Replicates does not wor
94. put fields can be changed by ACL_ Wide Input Ntol1 Wide Input TX80 Narrow Input TXCC Narrow Input MULT Narrow Input links can be highlighted by TEXT HTTP Link e List Layout Set this option to Hidden if you want to hide a field column in the list view Note The field is not completely invisible Every user who has read access still can make this field visible in the list page by selecting the list all columns option The other options influence text style and colors Black on Light Color Bold Black on Light Color Black on White Bold Black on White Original Colors Bold Original Colors Consistency Options for Fields RETE DB allows to define rules that reject changes of records and rules that do auto matic changes after a user modified a record Some of these rules are already built into RETE DB but it is also possible to define your own rules by writing some lines of java code e Consistency Type Activates consistency rules for this field E g the rule that logs the last modification date is activated by the TIME LastMod marker Note e Automatic changes to records are only possible if the admin group Group Mask 0 has write access to this field E g the TIME LastMod rule does not work on fields without write access for the admin group Consistency Types The following types are predefined in RETE DB 1 2 e TIME Created
95. r admin all low validated optimized performance SW Design External Staff pote Dal displaying Guest search criteria use of stringbuffers 1335 user admin all low validated Errar r nPerformance Note Rua x Done E Click on the record ids to see the detailed record data Note e You can enter multiple conditions for your query RETE DB allows to define several conditions on several fields simultaneously e Multiple criteria for one field are logically connected by an OR criteria for different fields are logically connected by a lower priority AND e Some field types allow to invert the search After searching on a field a checkbox with the label not appears and can be selected 1 3 QUERIES 23 1 3 2 Bookmark a Query You can store the current query in your Bookmark or Favorite List EE Toos wing Helo Todo List List E 4 0 mp 127 0 0 1 8080 MyReteDb list htmi proj 3 38order 08count 508find Y gt Bookmark All Tat E Organize Bookmarks Todo List List RETE DB Todo List O E E ioo 2008 06 15 09 21 47 0 change passwa 1 33 Goto a Record AAA Todo List List lt a gt G 0 mup 127 0 0 1 8080 MyReteDb list htmi proj 33 order 08count 5O8find Y gt W 7 Wikipe e Q Q Todo List List j I last login 2008 06 15 09 21 47 0 change password logout Andreas Warnke A Todo List List Address Todo List lt projects gt elds lt keywords
96. rk containing the Document or a portion of it either copied verbatim or with modifications and or translated into another language A Secondary Section is a named appendix or a front matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document s overall subject or to related matters and contains nothing that could fall directly within that overall subject Thus if the Document is in part a textbook of mathematics a Secondary Section may not explain any mathematics The relationship could be a matter of historical connection with the subject or with related matters or of legal commercial philosophical ethical or political position regarding them The Invariant Sections are certain Secondary Sections whose titles are desig nated as being those of Invariant Sections in the notice that says that the Document is released under this License If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant The Document may contain zero Invariant Sections If the Document does not identify any Invariant Sections then there are none The Cover Texts are certain short passages of text that are listed as Front Cover Texts or Back Cover Texts in the notice that says that the Document is released under this License A Front Cover Text may be at most 5 words and a Back Cover Text may be at most 25 words A
97. s for a printed book the title page itself plus such following pages as are needed to hold legibly the material this License requires to appear in the title page For works in formats which do not have any title page as such Title Page means the text near the most prominent appearance of the work s title preceding the beginning of the body of the text A section Entitled XYZ means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language Here XYZ stands for a specific section name mentioned below such as Acknowledgements Dedications Endorsements or History To Preserve the Title of such a section when you modify the Document means that it remains a section Entitled XYZ according to this definition The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document These Warranty Disclaimers are considered to be included by reference in this License but only as regards disclaiming warranties any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License 2 VERBATIM COPYING You may copy and distribute the Document in any medium either commercially or noncommercially provided that this License the copyright notices and the license notice saying this License applies to the Docume
98. se things in the Modified Version A Use in the Title Page and on the covers if any a title distinct from that of the Document and from those of previous versions which should if there were any be listed in the History section of the Document You may use the same title as a previous version if the original publisher of that version gives permission B List on the Title Page as authors one or more persons or entities responsible for authorship of the modifications in the Modified Version together with at least five of the principal authors of the Document all of its principal authors if it has fewer than five unless they release you from this requirement C State on the Title page the name of the publisher of the Modified Version as the publisher D Preserve all the copyright notices of the Document E Add an appropriate copyright notice for your modifications adjacent to the other copyright notices O 95 Include immediately after the copyright notices a license notice giving the public permission to use the Modified Version under the terms of this License in the form shown in the Addendum below Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document s license notice Include an unaltered copy of this License Preserve the section Entitled History Preserve its Title and add to it an item stating at least the title year new authors an
99. sers gt lt groups gt lt members gt list 1000 1001 1009 show import new record for lt groups gt pages 1 10 results 5 ms E Label Description order by _search z 2 AO aaa _ per page F list all m 1000 Address Guest People who can not modify any user admin all data External Staff Guest 1001 Todo List Guest People who can not modify any user admin all 800 data External Staff Guest 1002 Address External Staff External Staff with limited read user admin all and write access External Staff Guest 1003 Todo List External Staff External Staff with limited read user admin all 500 and write access 1006 lt keywords gt External Staff External Staff with limited read and write access 1007 lt users gt External Staff External Staff with limited read and write access 1008 lt groups gt External Staff External Staff with limited read and write access 1009 lt members gt External Staff External Staff with limited read and write access admin all External Staff admin all External Staff 500 admin all External Staff admin all External Staff 500 10 records displayed 95 ms Export results as XML CSV 1 CSV 2 CSV 3 CSV 4 taby Done 2 3 2 Delete or Modify a Group Never change the label or group mask of a group except spelling errors or in new empty projects since you would change only the label of a group all exi
100. sers gt lt groups gt lt members gt list 64 65 68 info show import new record for lt groups gt create record 1 V admin F all Label Fut tt iti O S Description People who can not modify any data MO admin Fi F2 1731415165718 F910 Fi 1 12 13 Tf 14 7 15 7 16 F17 F18 19 F 20 Tf 21 F 22 F 23 F 24 25 26 F 27 F 28 F 29 r 30 r31 FP 32 7 33 f 34 F 35 F 36 37 F 38 39 40 41 42 43 44 45 746 47 gs F49 50 f 51 F 52 53 r54 55 F 56 FT 57 58 F 59 F 60 FT 61 r62 r 800 roup for Guests was required by M B ro Read only fields You do not have write access rr Read restricted fields Some people do not have read access Explain Explain the reason for your modifications here Done Check one of the Bit Mask flags which are still unused Do not change this flag later Enter all data and press create record 54 CHAPTER 2 ADMINISTRATION BOO lt groups gt 1000 o lt nd y e 4 http 127 0 0 1 8080 MyReteDb form html ve W 7 Wikipedia Eng Q gt Q lt groups gt 1000 o 5 1000 A debug change password logout System Administrator lt projects gt lt keywords gt lt users gt lt groups gt lt members gt ist 64 165 168 info _show 1000 import new record for lt groups gt Ok 8 The project was modified Please check if the group field needs to
101. sert or imply endorsement of any Modified Version 5 COMBINING DOCUMENTS You may combine the Document with other documents released under this License under the terms defined in section 4 above for modified versions provided that you include in the combination all of the Invariant Sections of all of the original documents unmodified and list them all as Invariant Sections of your combined work in its license notice and that you preserve all their Warranty Disclaimers The combined work need only contain one copy of this License and multiple identical Invariant Sections may be replaced with a single copy If there are multiple Invariant Sections with the same name but different contents make the title of each such section unique by adding at the end of it in parentheses the name of the original author or publisher of that section if known or else a unique number Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work In the combination you must combine any sections Entitled History in the var ious original documents forming one section Entitled History likewise combine any sections Entitled Acknowledgements and any sections Entitled Dedications You must delete all sections Entitled Endorsements 6 COLLECTIONS OF DOCUMENTS You may make a collection consisting of the Document and other documents re leased under this License an
102. sign when updating the history sysdate needs to be called only once 18 high validated Doku documentation on history access rights 19 high validated New Feature The date of the last login should be displayed on every page maybe stored serializable in a cookie 20 high validated Layout The Demo DB should be a bug database not an abstract project r n and an address database 21 high validated Layout Design clustering history entries 22 high validated New Feature user shall have an Admin options field possible Admin Options canDebug seeRightsOverview Table 23 high validated SW Design security Query Review findings should be fixed rnn 1 Exceptions should not be catched within parseUrl nn 24 high validated Layout rename projectid to project bitmask to groupnumber 25 high validated Layout history design created new old shall be written to other column 26 high validated Bug CommunicationExceptions from the MySQL connector J may indicate that the servlet is waiting for the network This shall re 27 high validated New Feature consistency check for Fields FG BG_Colour format dddddd 28 high validated SW Design Fields RangeDef must be deleted since unused iah dunlicate_New Feature a wrong database connection is provided when creatina a new oroiect it is difficult to set the resultina mess sra JJ Sheetl I Sheet1 1 Default 100 sto Sum 0 Save the file in CSV Comma Separated V
103. st to the appropriate handler RETE DB is designed to be a lean database front end with access control and logging functionality Both features are implemented by the security package Additionally there is a mechanism designed to implement some consistency checks This can support the workflow of your process to some degree Modifications to records can be rejected easily or additional changes can be done in the database automatically E 2 Packages dynamic view RETE DB is an event driven application All actions are caused by a request to the servlet container RETE DB first handles the requested actions and collects the results in a result list then it displays these results and the requested information to the user A typical call chain is e A user requests modifications to and information from the database e Main the front controller class checks the login data e Main delegates the modification request to the Updater class in the controller package e the Updater asks the consistency package if the changes are allowed e the Updater performs the modifications on the database via the security package e the Updater tells the consistency package to do additional changes e the Updater returns a list of results to Main e Main tells the view package to display the results as well as the requested infor mation e the view package displays the result list E 3 PERFORNAMCE SCALABILITY AND SECURITY 101 e the view pack
104. sting definitions of access rights would change their intension You cannot delete a group 2 3 MANAGE USERS AND GROUPS 57 2 3 3 Create a User Account Go to the project lt users gt page new record 2 lt users gt New Record O e a http 127 0 0 1 8080 MyReteDb form html proj 3 amp count 50 amp list 12 amp row W Wikipec Enc Q Q lt users gt New Record lt users gt New Record HES debug change password logout System Administrator Address Todo List lt projects gt lt fields gt lt keywords gt lt users gt lt aroups gt lt members gt list 2 info show import new record for lt users gt create record Name Andreas Warnke Domain pS sl Login Ln Y admin all External Staff Password rr Email RETE DB andreaswarnke de Phone Time Zone 60 F Login disabled Fix password Fixtimezone Hide lastlogin M Allow overwrite by import see log can sudo Failed Trials rr f Last Login rr a local LastLogout tr local Password Change rr local Info The ugly guy who seldom smiles create record Explain User account requested by Q A ro Read only fields You do not have write access rr Read restricted fields Some people do not have read access Explain Explain the reason for your modifications here Done Enter all data including an initial password an
105. t pages 1 2 results 3 ms ID Name Domain Login Email Phone Time i Zone 2 order by gt search 20 50 100 records per page list all colu 2 System RETE DB root 0 Administrator 1000 Andreas aw RETE DB andreaswarnk 60 Allow overwrite by import Warnke e de 2 records displayed 23 ms Export results as XML CSV 1 CSV 2 CSV 3 CSV 4 tab z gt Done 2 3 MANAGE USERS AND GROUPS 59 2 3 6 Define Groups of a User A Member record defines to which groups a user belongs For every user and every project there should be zero or one record in the lt members gt project if there is no record for a user project pair the user has no access to the project at all if there is one record for a user project pair the Groups field defines to which groups the user belongs Go to the project lt members gt page new record BOO lt members gt New Record o v 4 A O meio te okie eae gt Wr Wikipedia Eng q y lt members gt New Record Ea debug change password logout System Administrator Address Todo List lt projects gt lt fields gt lt keywords gt lt users gt lt aroups gt lt members gt list info show import new record for lt members gt _create record _create record al Address gt admin all External Staff create _create record
106. t from the order of the actual changes This means that the actual value of a record might be logged in the second latest history entry e The displayed old value might be wrong e There is a hidden and unused feature in RETE DB that logs not only the date of a change in the history but also the time intervals without change see E 4 2 These time intervals might overlap Unexpected errors If the RETE DB servlet is terminated or encounters an unex pected error the following things can happen e The latest history entries might be missing e Some texts exist in the database but are not referenced This is not a problem only a waste of memory e Some uploaded files might exist but are not referenced This is not a problem only a waste of memory Conclusion e lt might occur that one user overwrites changes of another user by accident if both users modify a record at the same time e Some very unlikely situations produce small inconsistencies in the history For most applications these problems are acceptable Data is not modified without cause every change is logged in the history except if the servlet is terminated in the right millisecond access rights are not compromized 106 APPENDIX E DESIGN E 5 Design of Request URLs The request URLs Uniform resource locators are defined in such a way that e No URL should exceed the 1024 byte limit This cannot be guaranteed e A user can bookmark any URL or send it
107. tend which allows to enter search and modify records e Custom database structure The administrator defines the database layout via the web frontend e Groups Access rights are defined on groups a group concept simplifies the ad ministration e Security For every record and for every field access rights can be defined sepa rately e Performance As tests have shown see chapter 3 8 this program is amazingly fast even when working with hundred thousands of records e Scalability Multiple distributed RETE DB instances can run in parallel on the same database e History Every change of data is logged even changes in the RETE DB adminis tration e Export Search results can easily be exported to spreadsheet applications e Import New records can be created and existing records can be updated with data of spreadsheet applications Limits e RETE DB is a project management tool It is not a tool for individual issue han dling as for example help desk systems Therefore no access rights for individual users exist only a group concept is supported License of RETE DB GPL RETE DB 1 2 Copyright C 2004 2012 Andreas Warnke RETE DB comes with ABSOLUTELY NO WARRANTY for details see appendix C This is free software and you are welcome to redistribute it under certain conditions see appendix C for details Contents 1 User Manual 9 1 1 General Usage ses y AR th ea ee ha Be 10 Dell Login a As Sete a ee Sot
108. ts A copy of the license is included in the section entitled GNU Free Documentation License If you have Invariant Sections Front Cover Texts and Back Cover Texts replace the with Texts line with this with the Invariant Sections being LIST THEIR TITLES with the Front Cover Texts being LIST and with the Back Cover Texts being LIST If you have Invariant Sections without Cover Texts or some other combination of the three merge those two alternatives to suit the situation If your document contains nontrivial examples of program code we recommend releasing these examples in parallel under your choice of free software license such as the GNU General Public License to permit their use in free software Appendix E Software Design Several aspects of the general design speed scaling and security issues are described here The abstraction level of this description is focused on packages not on classes See the javadoc documentation for a low level interface specification 99 100 APPENDIX E DESIGN E 1 Packages static view RETE DB implements an MVC architecture e model entity classes and security DB access classes e view and export e controller event handler import_ and consistency business logic e utils The controller package implements a Front Controller Design Pattern All requests are passed to net rete_db RETE_DB controller Main which first identifies the user and then dispatches the reque
109. uted to different servers Scalability is possible through e The MySQL database the RETE DB servlet and the Apache webserver can be distributed to different computers e only the few serializable session data a database connection and NFS access are required for an instance of the RETE DB servlet to handle a request This allows RETE DB to run simultaneously on different servers 102 APPENDIX E DESIGN e The database is clustered tables can be distributed to different databases on different computers e Only few SQL commmands are sent from the RETE DB servlet to the database This avoids that the network becomes the bottleneck when moving the database to a remote server e The MySQL feature of replicating one database to different servers is supported Security A clear and restrictive security policy which was already part of the design before the first line of code was written guarantees the safety of the data e Data to that the user has no read access is never loaded from the database to the RETE DB servlet e Data to that the user has no write access is never sent to the database e Responsibility for these access checks is located at the security package e The fact that neither SQL statements nor SQL connection objects must ever cross the package boundary of the security package allows the security package complete access control on the database e f someone probes invalid passwords this user s account is disabled auto
110. wSelector MAX_TEXT_JOINS between 3 and 30 and recompile RETE DB Set this value to a higher value if your database runs on a remote machine or if your MySQL database has a lot of memory set it to lower values if memory is limited e Use a faster computer with more memory 3 8 2 Distribute the Database and RETE DB If the performance is still not sufficient you have the following options RETE DB MySQL Tomcat Meta DB MySQL Master All Databases Replicate Load Balancer Rep MySQL Firewall Project A RETE DB Master Tomcat MySQL Load Balancer All Databases MySQL Firewall Replicate Project B Back Up Master Network Filesystem Replicate e Distribute the RETE DB servlet to multiple computers and let multiple instances run in parallel e Use a load balancer to dispatch the http requests to these RETE DB instances 3 8 SYSTEM PERFORMANCE 67 e Replicate the MySQL databases RETE DB will send all UPDATE and INSERT requests to the master server and RETE DB will send the SELECT statements to the local replicated database e Partition the MySQL Y database and distribute the different RETE DB projects to different servers You can do this also with the uploaded files if necessary 68 CHAPTER 3 MAINTENANCE Chapter 4 Installation This chapter explains how to install RETE DB 69 70 CHAPTER 4 INSTALLATION 4 1 Overview The following environment is required e MySQL Y d
111. work as a programmer or your school if any to sign a copyright disclaimer for the program if necessary Here is a sample alter the names Yoyodyne Inc hereby disclaims all copyright interest in the program Gnomovision which makes passes at compilers written by James Hacker signature of Ty Coon 1 April 1989 Ty Coon President of Vice This General Public License does not permit incorporating your program into propri etary programs If your program is a subroutine library you may consider it more useful to permit linking proprietary applications with the library If this is what you want to do use the GNU Library General Public License instead of this License 90 APPENDIX C THE GNU GENERAL PUBLIC LICENSE Appendix D GNU Free Documentation License Version 1 2 November 2002 Copyright 2000 2001 2002 Free Software Foundation Inc 51 Franklin St Fifth Floor Boston MA 02110 1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document but changing it is not allowed Preamble The purpose of this License is to make a manual textbook or other functional and useful document free in the sense of freedom to assure everyone the effective freedom to copy and redistribute it with or without modifying it either commercially or noncommercially Secondarily this License preserves for the author and publisher a way to get credit for their work while not being consid

RETE-DB - Manual

Contents

Download Pdf Manuals

Related Search

Related Contents