OXMF Howto

OXMF, short for Open-Xchange Meta Format, is the notation for Open-Xchange data contained in HTML. The content of this website is generated automatically from each release of Open-Xchange. This ensures that information presented here is up to date and accurate. It can also be easily replicated by installing Open-Xchange locally and generating specification feeds as documented (probably from version 6.14 onwards).

There are three sections in each data type specification page that can be leveraged by programmers and other interested parties to implement and test OXMF implementations:

  • Specification
  • Example feed
  • Test

Specification is the written definition of OXMF per data type. It contains field names, data type (as used in Java), and a description of the respective data field.

Example feeds can be subscribed to by OXMF capable applications. The result will be data sets in folders showing the field name as content. Input masks and templates can be easily tested with this method: simply subscribe to the example feed and look at how your data ends up.

Test is an upcoming facility at http://ox.io to simplify the subscription and re-publication of generic data to enable tests for identity between what http://ox.io published back, and what an application published to http://ox.io in the first place.