Wiki source code of YellowFox Geocoder

Last modified by YellowFox_RD on 2025/01/20 13:52

version	line-number	content
1.1	1	(% class="box" %)
3.1	2	(((
	3	Table of Contents
	4	)))
	5
1.1	6	{{toc/}}
	7
3.1	8	= YellowFox Geocoder =
1.1	9
3.1	10	This tool is designed as an import assistant to convert your preliminary database into your yellowfox portal address database. CSV files will be supported. The converted and self entried records can be previously geocoded.
	11
	12	= program start =
	13
	14	After the start of "YellowFox Geocoder", the program is searching for new updates.
	15	This procedure can take up to 1 minute, depending on your internet connection. If no new updates was found, the program is checking if you entered rti access codes.If you have ever started this tool and you not closed your previous project, the tool will starting this one.
	16	Immediately the status bar displayed "ready", the starting proccess is done and you will seen approximately following window.
	17
	18	[[image:Mainwindow.jpg]]
	19
	20	= main menu =
	21
1.1	22	(((
3.1	23	* File(((
	24	* new project - creates a new project
	25	* open project - opens an existing project
	26	* close project - closes the open project
	27	* close - close YellowFox Geocoder
1.1	28	)))
3.1	29
	30	* Im-Export(((
	31	* import CSV file - open the dialog to import a csv file
	32	* delete portal address database - delete all records from the portal address database
1.1	33	)))
3.1	34
	35	* Settings(((
	36	* access codes - open the dialog to update your rti access codes
	37	* language - language selection of YellowFox GeoCoder
1.1	38	)))
3.1	39
	40	* Help(((
	41	* Help (F1) - open internet help site of YellowFox GeoCoder
	42	* debugging - set the program into the debug mode
	43	* delete debugging - reset the debugging
	44	* searching for new updates... - connect the internet and searches for new updates
	45	* about - information window of YellowFox Geocoder
1.1	46	)))
	47	)))
3.1	48
	49	= functions =
	50
	51	== new project ==
	52
	53	To create a new project, just enter the wanted name of the project into the text box and click "ok". The YellowFox Geocoder will create an new project automaticly.
	54	With the button "reload table" you will open the empty table and you are now able to insert new records.
	55
	56	== new update ==
	57
	58	After every program start and on every click in the menu extras ~-~-> "searching for new updates..." an update check will be procceded. If a new update is available, you will be informed about the current and the available version. If you want to procced the update, please click "yes" otherwise "no". Not installing available updates may cause malfunction up to destroying your address database. While the update is running the YellowFox Geocoder close himself, download the new update and restart
	59
	60	== import csv file ==
	61
	62	In this dialog you set the attributes of the csv file you will imprt. It is divided into 6 steps.
	63
	64	=== 1st step ===
	65
	66	Source file selection. Click on "open" and select the file you want to import. The path including the filename will be shown in the textbox of step 1.
	67
	68	=== 2nd step ===
	69
	70	properties of the csv file:
	71
1.1	72	(((
3.1	73	* seperator: Is the character, which seperates the single columns of the csv file.(((
	74	* tabulator (<TAB>)
	75	* comma (,)
	76	* semicolon (;)
	77	* tilde ()
	78	* pipe (\|)
	79	* space (<SPC>)
1.1	80	)))
3.1	81
	82	* text delimiter: selection of the character, which fences the text. Inside this perimeter for example seperators or end of line files will be ignored.(((
	83	* double quotation mark (")
	84	* single quotation mark (')
	85	* without text delimiter (without)
1.1	86	)))
3.1	87
	88	* sort field names - the field names of the import file will be sortet alphabeticly
1.1	89	)))
3.1	90
	91	=== 3rd step ===
	92
	93	Check the import file - at this step the settings which you have selected will be checked. Additionally the field names of the csv file will be added to the selection fields.
	94
	95	=== 4th step ===
	96
	97	In this step you will allocate the fields of the csv file to the fields of the YellowFox database.
	98	In the textbox default value, you can input default text. You can yhoose, when they will be used. Whether only if there is nothing inputed into the field or always.
	99
	100	=== 5th step ===
	101
	102	At this option group you can select between delete all records from the temporaray YellowFox Geocoder database and add the records you want to import to the temporary database.
	103	reaction if a doublet was found:
	104
1.1	105	(((
3.1	106	* Doublet: checks if the record already exists (checks for name1, name2, city, postcode, country, street, house number and position description)
1.1	107	)))
3.1	108
	109	What kind of reaction do you want to proceed if a doublet was found?
	110
1.1	111	(((
3.1	112	* ask: If a doublet was found, you will be asked, what you will do. Do yout want to add this record or do you want to discard them.
	113	* add doublet: Although a doublet was found, it will be added to the project
	114	* discard doublet: If a doublet was found, the record will be discard. No additional insert into the project database.
1.1	115	)))
	116
3.1	117	=== 6th step ===
	118
	119	A click on "import start" the import procedure will be starting. A click on " close" will close the dialog and you will go back to the main window.
	120	While the import process you will be informed in the status bar, how many records have been imported yet. Immediately the import procedure has been completed, you will be informed how many records toal have been imported.
	121
	122	== access code ==
	123
	124	=== portal ===
	125
	126	You will find the rti access codes in the extras menu RTI (interface)
	127
	128	=== rti - company key ===
	129
	130	Is the authorization code from company.
	131
	132	=== rti - import key ===
	133
	134	Is the authorization code from import.
	135
	136	=== validation ===
	137
	138	The entered key pair will be checked.
	139
	140	== delete portal address database ==
	141
	142	Attention, this process can not be reversed!
	143	All records from the address database in the portal will be deleted.
	144
	145	== language selection ==
	146
1.1	147	(((
3.1	148	* available languages:(((
	149	* German
	150	* English
1.1	151	)))
	152	)))
	153
3.1	154	The requested language can be selected in the menu under settings ~-~-> language.
	155
	156	== about ==
	157
	158	In this information window you get informations about the YellowFox Geocoder.
	159
	160	= table =
	161
	162	The table conatins all address entries, which are in the project database.
	163
	164	== structure ==
	165
	166	\|=column name\|=description\|=format
	167	\|ID\|continous id number\|number (automatic)
	168	\|company\|company description 1\|text (max. 100 characters)
	169	\|company2\|company description 2\|text (max. 100 characters)
	170	\|postcode\|postcode\|text (max. 10 characters)
	171	\|city\|city\|text (max. 100 characters)
	172	\|street\|street\|text (max. 100 characters)
	173	\|hnr\|house number\|text (max. 10 characters)
	174	\|on map\|do you want to display the address on the map\|check (yes/ no)
	175	\|position description\|text that will be shown on the map\|text (max. 100 characters)
	176	\|Lat\|latitude (x coordinate)\|number (not editable)
	177	\|Lon\|longitude (y coordinate)\|number (not editable)
	178	\|LatM\|latitude (x coordinate) - mercator format\|number (not editable)
	179	\|LonM\|Longitude (y coordinate) - mercator frmat\|number (not editable)
	180	\|encoded\|address is geocoded\|number (1/0) (not editable)
	181	\|Online\|address is transmitted\|number (1/0) (not editable)
	182
	183	== views ==
	184
	185	The view can be specialised by predefined filter values.
	186	following data views are available:
	187
1.1	188	(((
3.1	189	* show all
	190	* only geocoded
	191	* only to edit
	192	* not yet geocoded
	193	* failing geocoded
	194	* already transmitted
	195	* not yet transmitted
	196	* with certain content (selfdefinable filter for company/postcode/city/country/street/position description)
1.1	197	)))
	198
3.1	199	== edit record ==
1.1	200
3.1	201	If you want to edit a record, you must check this one. After that, input the favoured value into the cell. If you want to cancel your input press the key 'ESC'. To save the record uncheck thisone or check another cell. Inside the table you can navigate with mouse and the arrow keys of your keyboard. To change the value of 'on map' you must check this cell and press the 'SPACE' key or click into the selection box with the mouse arrow. The addresses which are already geocoded, but with the comment 'to edit'(beige background), has found more than one possible geocode address. To select which address you will allocate to this entry, right-click on the record and select 'to edit'. A selective-dialog will be shown (see picture), there you can select the wanted address you will allocate. By using the button GoogleEarth you can view the addresses in GoogleEarth. You need a working installation of GoogleEarth to use this feature.
	202
	203	== delete displayed ==
	204
	205	With this option you celete all displayed records from the project database. To change the data view, you only must change the filter. If you want to delete only one record, just right-click them and select 'delete record'.
	206
	207	== find address of displayed ==
	208
	209	With this function the geocoder will find the address values (street, hnr, city...) by the given coordinates (reverse geocoding).
	210	result colours:
	211
1.1	212	(((
3.1	213	* white: not yet geocoded
	214	* green: already geocoded (1 address allocation)
	215	* beige: to edit (more than 1 possible address allocations)
	216	* red: failing geocoded (no address allocation found)
1.1	217	)))
3.1	218
	219	== geocode displayed ==
	220
	221	With this function you try to geocode all displayed records. If you want to change the displayed view, use the filter option 'data view'.
	222	result colours:
	223
1.1	224	(((
3.1	225	* white: not yet geocoded
	226	* green: already geocoded (1 address allocation)
	227	* beige: to edit (more than 1 possible address allocations)
	228	* red: failing geocoded (no address allocation found)
1.1	229	)))
3.1	230
	231	== use given coordinates ==
	232
	233	If the imported material contains longitude and latitude values alreay, you can use them without any further processing needed.
	234
	235	== transmit displayed ==
	236
	237	With this function you try to send all displayed records to the portal address database. All successful transmitted records have a '1' in the column 'online'. Only these records will be shown the data view filter 'already transmitted'.
	238
	239	= failing geocoding =
	240
	241	possible reasons for an failing geocoding:
	242
1.1	243	(((
3.1	244	* unknown country code (([[list of country codes>>http://en.wikipedia.org/wiki/List_of_international_vehicle_registration_codes]]))
	245	* literal error in address submission
1.1	246	)))
3.1	247
1.1	248