Difference between revisions of "List of external software interfaces"

Revision as of 12:52, 23 February 2006

This article lists past and present external software interfaces of GnuCash, and suggests possible additional interfaces. It was started to figure out how one can "plug in" to gnucash.

This article is just descriptive, and neither normative nor authoritative.

Current interfaces

• QIF/OFX import
  • From files: There are two different implementations of importing possibilities in gnucash. One is for QIF, the other for OFX and HBCI/AqBanking.
    • CSV/TSV/XLS/ODS → QIF conversion (see FAQ#Q: How do I convert from CSV, TSV, XLS (Excel), or SXC (!OpenOffice.org Calc) to a QIF?)
    • See bugs for QIF import: [1]
    • OFX import from file
      • bugs for OFX import: [2]
      • libofx
  • OFX Direct Connect via AqBanking library http://www.aquamaniac.de/aqbanking. Aqbanking has also additional import/export facilities which are currently not yet implemented in gnucash, but are almost finished for a MT940 file import. (Note: HBCI and Aqbanking are used interchangeably because the predecessor of Aqbanking only supported the German online banking protocol HBCI, but Aqbanking now supports not only this but additionally other means of online banking protocols plus file importing.)
  • Bugs for general import, including HBCI/AqBanking import issues [3]
• direct data manipulation
  • XML; there is currently no valid schema/DTD existing for the current XML file format. The existing DTDs in gnucash are outdated and do not describe the current file format correctly.
    • "The new [1.6] version uses XML (making it much easier to write independent tools to manipulate GnuCash files) …" [GnuCash 1.6 User Manual]
    • "risky and not recommended" (see FAQ)
  • PostgreSQL The postgreSQL backend is not actively maintained and has several serious issues [4]
• QOF access to the data file. I hope http://qof.sourceforge.net does offer some documentation about how this is intended to work, but I don't understand it so far. For some part it could be used as a command-line utility to import and export various data parts into and from the gnucash file.
• custom reports (in the programming language Scheme)
• Finance::Quote

Legacy/unsupported interfaces

These interfaces were supported in prior versions of GnuCash.

• RPC (bitrotted [5])
• Perl bindings (bitrotted [6])

Prospective interfaces

The main place for submitting enhancement requests is the Bugzilla database. Feel free to collect anything you want here on this page, especially any kind of overview, but please keep in mind that single issues are followed by the developers in Bugzilla much more closely.

• CORBA, to communicate with a running GnuCash instance. E.g., a running GnuCash incarnates a CORBA object of type:

interface GnuCash // simplified
{
  exception GnuCashException

  typedef string Guid;

  struct Split
  {
    Guid id;
    boolean reconciledState;
    string value;
    string quantity;
    Guid account;
  };

  typedef sequence<Split> SplitSeq;

  struct Transaction
  {
    Guid id;
    string datePosted;
    string dateEntered;
    string description;
    SplitSeq splits;
  };

  void submitTransaction(in Transaction t)
    raises (GnuCashException);
};

• linkable library (see also WishList#Export an API)
  • • Note that the modular structure of gnucash "almost" already offers this -- the "engine" module is pretty much exactly this kind of API. Except that nobody recently tried to use it from anywhere outside of gnucash.
  • for communicating with a running GnuCash instance
  • for manipulation of GnuCash database or XML file directly

See also

• WishList#Connecting with PalmOS