User:Tierlieb - Revision history

Tierlieb at 07:55, 27 September 2011

2011-09-27T07:55:14Z

← Older revision		Revision as of 07:55, 27 September 2011
Line 1:		Line 1:
	== User Information ==		== User Information ==
	* '''Real name:''' Tobias Prinz		* '''Real name:''' Tobias Prinz
	* '''Jobs:''' Freelancer, ~~worked~~ on: OX5~~, OX6~~		* '''Jobs:''' Freelancer, on board since OX5
	* '''Homepage:''' http://www.~~tobias-prinz~~.de		* '''Homepage:''' http://www.tobiasprinz.biz
	* '''IRC Nick:''' Tierlieb

Tierlieb at 08:33, 29 July 2009

2009-07-29T08:33:02Z

← Older revision		Revision as of 08:33, 29 July 2009
Line 1:		Line 1:
	== User Information ==		== User Information ==
	* '''Real name:''' Tobias Prinz		* '''Real name:''' Tobias Prinz
	* '''Jobs:''' ~~OX6 Developer~~, OX5 ~~Maintenance guy~~		* '''Jobs:''' Freelancer, worked on: OX5, OX6
	* '''Wikipedia User Page:''' [http://en.wikipedia.org/wiki/User:Tierlieb Tierlieb]
	* '''Homepage:''' http://www.tobias-prinz.de		* '''Homepage:''' http://www.tobias-prinz.de
	* '''IRC Nick:''' Tierlieb		* '''IRC Nick:''' Tierlieb
	* ''worked here from 11/2006 to 9/2007''

Tierlieb at 11:46, 16 August 2007

2007-08-16T11:46:06Z

← Older revision		Revision as of 11:46, 16 August 2007
Line 5:		Line 5:
	* '''Homepage:''' http://www.tobias-prinz.de		* '''Homepage:''' http://www.tobias-prinz.de
	* '''IRC Nick:''' Tierlieb		* '''IRC Nick:''' Tierlieb
			* ''worked here from 11/2006 to 9/2007''
	~~== TODOs ==~~

Tierlieb: changed TODO

2007-03-23T15:21:54Z

changed TODO

← Older revision		Revision as of 15:21, 23 March 2007
Line 7:		Line 7:

	== TODOs ==		== TODOs ==
	* [[Building an exporter]]

Tierlieb: /* TODOs */

2007-03-19T15:53:26Z

TODOs

← Older revision		Revision as of 15:53, 19 March 2007
Line 7:		Line 7:

	== TODOs ==		== TODOs ==
	* Refractor [[Open Xchange Installation]] to use headings instead of bold text for titles to allow for editing of sub sections instead of whole text.
	* [[Wiki usage hints]]
	* [[Building an importer]]
	* [[Building an exporter]]		* [[Building an exporter]]

Tierlieb: /* TODOs */

2007-03-19T14:43:25Z

TODOs

← Older revision		Revision as of 14:43, 19 March 2007
Line 8:		Line 8:
	== TODOs ==		== TODOs ==
	* Refractor [[Open Xchange Installation]] to use headings instead of bold text for titles to allow for editing of sub sections instead of whole text.		* Refractor [[Open Xchange Installation]] to use headings instead of bold text for titles to allow for editing of sub sections instead of whole text.
	* Wiki~~-Howto/Styleguide~~		* [[Wiki usage hints]]
			* [[Building an importer]]
			* [[Building an exporter]]

Tierlieb: moved import/export explanation to HTTP API

2007-03-07T12:06:08Z

moved import/export explanation to HTTP API

← Older revision		Revision as of 12:06, 7 March 2007
Line 9:		Line 9:
	* Refractor [[Open Xchange Installation]] to use headings instead of bold text for titles to allow for editing of sub sections instead of whole text.		* Refractor [[Open Xchange Installation]] to use headings instead of bold text for titles to allow for editing of sub sections instead of whole text.
	* Wiki-Howto/Styleguide		* Wiki-Howto/Styleguide

	~~=== How to import/export ===~~
	~~=== Using it to import or export data ===~~
	Importing and exporting is done by the servlet ImportExport.java in the package com.openexchange.ajax. The path to this servlet is stored in servletmapping.properties, usually it is [serveraddress]/ajax/importexport.

	Whether you do an import or an export is decided quite simply: If you send a PUT request, you're importing (because you are sending data), if you send a GET request, you're exporting (because you are requesting data). So no parameter is needed to indicate that. This has the additional advantage that you can use the same kind of URL to import and export (which also means: I only have to describe this only once ;-)). So, let's construct an URL:

	~~StringBuilder bob = new StringBuilder();~~
	~~bob.append("http://");~~
	~~bob.append(getHostName());~~
	~~you probably know your hostname better than I do. ;-)~~

	~~bob.append("/ajax/importexport?session=");~~
	~~bob.append(getSessionId());~~
	~~how you get the session depends on whether use write another servlet or work from the GUI.~~

	~~addParam(bob, ImportExport.PARAMETER_FOLDERID, folderId ) ;~~
	~~folderID = the ID of the folder you want to export from or import into.~~

	~~addParam(bob, ImportExport.AJAX_TYPE, type);~~
	type = the type of folder (Contact, Task, Appointment or whatever), as defines in com.openexchange.groupware.Types. Now, if you are stuck with another number (yeah, the OX design is a bit incongruent there...), you might want to take a look at com.openexchange.groupware.importexport.ModuleTypeTranslator, which was written to solve this problem.

	~~addParam(bob, ImportExport.PARAMETER_CONTENT_TYPE, format.getMimeType());~~
	~~format is usually of type com.openexchange.groupware.importexport.Format - you can use a selfmade MIME-type if you're sure you have a converter for that.~~

	~~addParam(bob, ImportExport.PARAMETER_COLUMNS, ContactField.GIVEN_NAME.getNumber());~~
	~~addParam(bob, ImportExport.PARAMETER_COLUMNS, ContactField.EMAIL1.getNumber());~~
	This one is additional and currently only used for CSV: If you have a format that allows for a variable number of data fields to be exported or imported, this is the way to pass them to the servlet. This is an array (so you can use this parameter more than one). For Contacts, the way to identify a field is to use the enum ContactField of the package com.openexchange.groupware.contact.ContactException.

Tierlieb: /* TODOs */

2007-03-06T13:03:09Z

TODOs

← Older revision		Revision as of 13:03, 6 March 2007
Line 9:		Line 9:
	* Refractor [[Open Xchange Installation]] to use headings instead of bold text for titles to allow for editing of sub sections instead of whole text.		* Refractor [[Open Xchange Installation]] to use headings instead of bold text for titles to allow for editing of sub sections instead of whole text.
	* Wiki-Howto/Styleguide		* Wiki-Howto/Styleguide

			=== How to import/export ===
			=== Using it to import or export data ===
			Importing and exporting is done by the servlet ImportExport.java in the package com.openexchange.ajax. The path to this servlet is stored in servletmapping.properties, usually it is [serveraddress]/ajax/importexport.

			Whether you do an import or an export is decided quite simply: If you send a PUT request, you're importing (because you are sending data), if you send a GET request, you're exporting (because you are requesting data). So no parameter is needed to indicate that. This has the additional advantage that you can use the same kind of URL to import and export (which also means: I only have to describe this only once ;-)). So, let's construct an URL:

			StringBuilder bob = new StringBuilder();
			bob.append("http://");
			bob.append(getHostName());
			you probably know your hostname better than I do. ;-)

			bob.append("/ajax/importexport?session=");
			bob.append(getSessionId());
			how you get the session depends on whether use write another servlet or work from the GUI.

			addParam(bob, ImportExport.PARAMETER_FOLDERID, folderId ) ;
			folderID = the ID of the folder you want to export from or import into.

			addParam(bob, ImportExport.AJAX_TYPE, type);
			type = the type of folder (Contact, Task, Appointment or whatever), as defines in com.openexchange.groupware.Types. Now, if you are stuck with another number (yeah, the OX design is a bit incongruent there...), you might want to take a look at com.openexchange.groupware.importexport.ModuleTypeTranslator, which was written to solve this problem.

			addParam(bob, ImportExport.PARAMETER_CONTENT_TYPE, format.getMimeType());
			format is usually of type com.openexchange.groupware.importexport.Format - you can use a selfmade MIME-type if you're sure you have a converter for that.

			addParam(bob, ImportExport.PARAMETER_COLUMNS, ContactField.GIVEN_NAME.getNumber());
			addParam(bob, ImportExport.PARAMETER_COLUMNS, ContactField.EMAIL1.getNumber());
			This one is additional and currently only used for CSV: If you have a format that allows for a variable number of data fields to be exported or imported, this is the way to pass them to the servlet. This is an array (so you can use this parameter more than one). For Contacts, the way to identify a field is to use the enum ContactField of the package com.openexchange.groupware.contact.ContactException.

Tierlieb: /* User Information */

2007-03-02T20:32:11Z

User Information

← Older revision		Revision as of 20:32, 2 March 2007
Line 1:		Line 1:
	== User Information ==		== User Information ==
	* '''Real name:''' Tobias Prinz		* '''Real name:''' Tobias Prinz
	* '''~~Position~~:''' OX6 Developer, OX5 Maintenance		* '''Jobs:''' OX6 Developer, OX5 Maintenance guy
			* '''Wikipedia User Page:''' [http://en.wikipedia.org/wiki/User:Tierlieb Tierlieb]
			* '''Homepage:''' http://www.tobias-prinz.de
			* '''IRC Nick:''' Tierlieb

	== TODOs ==		== TODOs ==
	* Refractor [[Open Xchange Installation]] to use headings instead of bold text for titles to allow for editing of sub sections instead of whole text.		* Refractor [[Open Xchange Installation]] to use headings instead of bold text for titles to allow for editing of sub sections instead of whole text.
	* Wiki-Howto/Styleguide		* Wiki-Howto/Styleguide

Tierlieb: Added real name

2007-03-02T12:15:56Z

Added real name

← Older revision		Revision as of 12:15, 2 March 2007
Line 1:		Line 1:
	~~TODOs~~:		== User Information ==
			* '''Real name:''' Tobias Prinz
			* '''Position:''' OX6 Developer, OX5 Maintenance

			== TODOs ==
	* Refractor [[Open Xchange Installation]] to use headings instead of bold text for titles to allow for editing of sub sections instead of whole text.		* Refractor [[Open Xchange Installation]] to use headings instead of bold text for titles to allow for editing of sub sections instead of whole text.
	* Wiki-Howto/Styleguide		* Wiki-Howto/Styleguide