View source for Account Hierarchy Template

Creating localized Account Hierarchy Templates

== Motivation and Overview ==

Sometimes the standard GnuCash account hierarchy template needs a bigger rework before it fits the requirements of your government - especially for business purposes. In this case it might be better to start creating a new hierarchy template from scratch.

Depending on your experience and resources there are different approachs:
* ''Use GnuCash'' to create a new or adjust an outdated template:  [[#An almost normal Start]]
: and do some ''Copy&Paste'' [[#Changing the Header]] [[#... and the Footer]] with your preferred text editor.
:* If you already have a working file, you want to remove personal: [[#Strip data from an existing, uncompressed gnucash xml file]]
* With some ''XML knowledge'' it might be faster to use a text editor to adjust an existing template: [[#Strip data from an existing, uncompressed gnucash xml file]].
* With some ''programming knowledge'' adjust [[#A_sample_script_for_big_templates]] to generate an account template from a formated text file of your standard.
In all cases you want to run the [[#Syntax Check]] before sharing your file.

== Create an Example File ==
Usually you will start with an empty file or a similar - e.g. an older version - template, but it is also possible to strip down the copy of a working gnucash file.

=== Start with an new empty gnucash file ===
Create the account hierarchy, which is according your needs.
* Usually you should mark accounts which have subaccounts as '''Placeholder'''.

Before you save to file in xml format, uncheck <tt>Edit->Preferences->General->Files:Compress Files</tt> to get an uncompressed xml file.

FIXME: I am not quite sure whether "Save file" or "Export hierarchy" is the better choice currently. One obvious difference: export saves no transactions, but also other parts will be ignored.
(E.g. what will happen with taxtables, but it seems only accounts can be created.)

=== Strip data from an existing, uncompressed gnucash xml file ===
You have a nice working GnuCash file and somebody asks for a copy of your template. So you want to ''remove'' all your '''personal data'''. But you surely want to ''keep'' the '''accounts''' and in ''business'' templates the '''tax table'''.

Open the copy of the file with a text editor, preferential with syntax highlighting for xml. Remove unwanted sections:
<syntaxhighlight lang="xml">
<book:slots> ... </book:slots>
<gnc:count-data ...>        <!-- give you an overview, and should be adjusted at the end -->
<gnc:commodity version="2.0.0">...</gnc:commodity>   <!-- remove only foreign currencies -->
<gnc:transaction version="2.0.0">...</gnc:transaction>
<gnc:budget version="2.0.0">...</gnc:budget>
<gnc:GncCustomer version="2.0.0">...</gnc:GncCustomer>
<gnc:GncEntry version="2.0.0">...</gnc:GncEntry>
<gnc:GncInvoice version="2.0.0">...</gnc:GncInvoice>
<gnc:GncVendor version="2.0.0">...</gnc:GncVendor>
<!-- feel free to add that which I missed like employee, price, order... -->
</syntaxhighlight>

Now run a [[#Syntax Check]].

== Convert the Example into a Template ==

=== Extensible Stylesheet Language Transformations ===
XSLT is a powerful standard to convert XML files in other formats. GnuCash has several XSL files in [https://github.com/Gnucash/gnucash/tree/maint/contrib/xslt contrib/xslt]. Unfortunately the contrib directory is currently not part of the installation. The XSLs can be processed by the program <code>xsltproc</code>, which is part of a package '''libxslt-tools''' or similar.
Example for a compressed file:
<Syntaxhighlight lang="sh">
gunzip -c <your gnucash file> | \
       xsltproc --stringparam title "Spacecraft project" \
                --stringparam short-description "Accounts useful for space exploration" \
                --stringparam long-description "A set of accounts useful for space exploration. Implements NASA Standards FOO-1234-BAR and FOO-3456-BAZ for Earth Orbit Satellites, Earth Orbit Space Stations, Solar System Manned and Unmanned Spaceflight, and Interstellar Exploration." \
                gnc2xea.xsl -
</Syntaxhighlight>
*For uncompressed files start from line 2.
*''gnc-act:exclude-from-select-all'' (see below) will be set.
* Because there was a change after the xsl was written, you still need to change [[#... the Body ...]].

See gnc2xea.xsl in [https://github.com/Gnucash/gnucash/tree/maint/contrib/xslt/README xslt README].

=== Manually ===
In case xsltproc fails, you want some adjustments or you want to understand the differences read this section.
==== Adjust the Header ====

After you saved your template, you must manually adjust the first lines (the "header") of your new created file as follows. Otherwise the "New File Wizard" would not know how to handle your template. The file name itself does not matter (it will not be shown anywhere), but the first lines of the file must contain the following information:

<syntaxhighlight lang="xml" line highlight="1,2,34,37,40,43,45">
<?xml version="1.0" encoding="utf-8" ?>
<gnc-account-example 
  xmlns="http://www.gnucash.org/XML/"
  xmlns:act="http://www.gnucash.org/XML/act"
  xmlns:addr="http://www.gnucash.org/XML/addr"
  xmlns:bgt="http://www.gnucash.org/XML/bgt"
  xmlns:billterm="http://www.gnucash.org/XML/billterm"
  xmlns:book="http://www.gnucash.org/XML/book"
  xmlns:bt-days="http://www.gnucash.org/XML/bt-days"
  xmlns:bt-prox="http://www.gnucash.org/XML/bt-prox"
  xmlns:cd="http://www.gnucash.org/XML/cd"
  xmlns:cmdty="http://www.gnucash.org/XML/cmdty"
  xmlns:cust="http://www.gnucash.org/XML/cust"
  xmlns:employee="http://www.gnucash.org/XML/employee"
  xmlns:entry="http://www.gnucash.org/XML/entry"
  xmlns:fs="http://www.gnucash.org/XML/fs"
  xmlns:gnc="http://www.gnucash.org/XML/gnc"
  xmlns:gnc-act="http://www.gnucash.org/XML/gnc-act"
  xmlns:invoice="http://www.gnucash.org/XML/invoice"
  xmlns:job="http://www.gnucash.org/XML/job"
  xmlns:lot="http://www.gnucash.org/XML/lot"
  xmlns:order="http://www.gnucash.org/XML/order"
  xmlns:owner="http://www.gnucash.org/XML/owner"
  xmlns:price="http://www.gnucash.org/XML/price"
  xmlns:recurrence="http://www.gnucash.org/XML/recurrence"
  xmlns:slot="http://www.gnucash.org/XML/slot"
  xmlns:split="http://www.gnucash.org/XML/split"
  xmlns:sx="http://www.gnucash.org/XML/sx"
  xmlns:taxtable="http://www.gnucash.org/XML/taxtable"
  xmlns:trn="http://www.gnucash.org/XML/trn"
  xmlns:ts="http://www.gnucash.org/XML/ts"
  xmlns:tte="http://www.gnucash.org/XML/tte"
  xmlns:vendor="http://www.gnucash.org/XML/vendor">
<gnc-act:title>
  IGAS-2099
</gnc-act:title>
<gnc-act:short-description>
  Inter Galactical Accounting Standard, Stardate 2099
</gnc-act:short-description>
<gnc-act:long-description>
  This is the Base Module of the Inter Galactical Accounting Standard as transmitted on stardate 2099-01-01. You might also need the module "starfleet" or "klingon". ~Cpt. Picard
</gnc-act:long-description>
<gnc-act:exclude-from-select-all>1</gnc-act:exclude-from-select-all>
<gnc:account version="2.0.0">
  <act:name>Root Account</act:name>
  <act:id type="new">e24772da4864456b196be5a6301c6756</act:id>
  <act:type>ROOT</act:type>
  <act:commodity-scu>0</act:commodity-scu>
</gnc:account>
</syntaxhighlight>

Annotations:
* Line 1: encoding
: You must save your file in the appropriate '''character encoding''' and note the used character encoding here! For possible values refer [[Locale Settings]].
* Line 2ff: Namespace
: The parser in GC 2.2.x makes no use of it, but future versions might change. 
: Some details can be found in [http://lists.gnucash.org/logs/2009/01/2009-01-22.html#T00:44:42] or in [https://github.com/Gnucash/gnucash/blob/master/libgnucash/doc/xml/gnucash-v2.rnc gnucash-v2.rnc]. Defining the namespace has the benefit, you can check the syntax of your file later with <code>xmllint</code>.
* gnc-act:title
: Enter a short, unique Name, which is shown in the table in the "New File Wizard" so that the user can choose this template. This name is usually also part of the filename, but the file name itself does not matter and is never shown to the user. This name is restricted to ONE line.
* gnc-act:short-description
: A one-line description shown in the table in the "New File Wizard"
* gnc-act:long-description
: A somewhat longer description which is shown in a text box in the "New File Wizard" if the user selects this template. This should explain the content and the efficient usage of the template to the user.
* gnc-act:exclude-from-select-all
: Whether this template should be selected if the user clicks the button "Select All". The business-related templates are probably rather special and should not be mixed with a general home-user account structure, so you should probably enable this flag by writing a "1" in here.
* Root Account
: Only the base module should have exactly one.
: Because it is only used internally, do not translate it!
: The accounts in the optional modules linked over <act:parent type="new">...</act:parent>

If you decide to copy&paste this template, please '''replace the root guid by a self generated''' with
* either:
:<Syntaxhighlight lang="sh">
uuidgen | sed -e 's/-//g'
</Syntaxhighlight>
: (Dependencies: '''uuidgen''' is part of ''util-linux'' and '''sed''' has it's own package)
* or use an online uuid generator like [https://www.guidgenerator.com/ this one] (any other one will do as well). Be sure to untick "Hyphens" to generate gnucash compatible guids. If you forget or the site you use doesn't offer that option, simply remove the hyphens yourself.
.

==== ... the Body ... ====
Just replace all occurrences of
<Syntaxhighlight lang="xml"><act:id type="guid"></Syntaxhighlight> by
<Syntaxhighlight lang="xml"><act:id type="new"></Syntaxhighlight>.
From 2.6.2 commit [https://github.com/Gnucash/gnucash/commit/1e303f5d211fa41 Replace type="guid" with type="new" in gnucash-xea files]: Having type="guid" causes the accounts created from the file to use the example GUID instead of generating a new one.

And if you used the XSLT, replace all occurrences of
<Syntaxhighlight lang="xml"><slot xmlns=""></Syntaxhighlight> by
<Syntaxhighlight lang="xml"><slot></Syntaxhighlight>.
From [https://bugs.gnucash.org/show_bug.cgi?id=795237#c19 Comment 19 of Update of "wohnungsw" template].

This is an example shell script doing the conversion and replacing the above mentioned parts after that:
<Syntaxhighlight lang="sh">
#!/bin/sh
BAK=`date +%Y%j%H%M%S`
for D in $@
do
 KRXEA="$D.xea"
 if [ "$D" = "KRI" ]
 then
  KRXAC="$D.xac.gz"
  TITLE="Kontenrahmen für die Wohnungswirtschaft"
  SHORT="Kontenrahmen für die Immobilienwirtschaft (Stand 2012)"
  LONG="Kontenrahmen für die Wohnungswirtschaft nach GdW / Hammonia Verlag (jetzt Haufe), Stand 2012
Hinweise zur Verwendung: https://wiki.gnucash.org/wiki/De/Wohnungswirtschaft
Ersteller: Christoph Franzen, christoph@alte-pflasterei.de"
 elif [ "$D" = "SKR49" ]
 then
  KRXAC="$ENTW/$D.gnucash"
  TITLE="Kontenrahmen SKR49 für Vereine, Stiftungen, gGmbHs"
  SHORT="Datev-Kontenrahmen SKR49 für Vereine, Stiftungen und gemeinnützige GmbHs"
  LONG="Ein Kontenrahmen für Vereine nach dem SKR49 der Datev

Bei Gebrauch dieses Kontenrahmens sind die allgemeinen Konten abzuwählen.
An dem Rahmen sind selbstverständlich noch Anpassungen erforderlich,
bis man den seinen Bedürfnissen entsprechenden Kontenplan hat.
Hinweise zur Verwendung: https://wiki.gnucash.org/wiki/De/SKR49

Ersteller: Michael Braun 2009, michael-developer@fami-braun.de
Formalia für GnuCash-Vorlagen: Frank H. Ellenberger 2009
Erweitert auf den Stand 2018: Christoph Franzen 2017-2018, christoph@alte-pflasterei.de"
 else
  exit 
 fi
done
mv "$KRXEA.gz" "$KRXEA.$BAK.gz"
gunzip -c $KRXAC | xsltproc --stringparam title "$TITLE" --stringparam short-description "$SHORT" --stringparam long-description "$LONG" gnc2xea.xsl - | sed -e "s/act:id type=\"guid/act:id type=\"new/g" > "$KRXEA.tmp"
sed -e "s/slot xmlns=\"\"/slot/g" < "$KRXEA.tmp" > "$KRXEA"
gzip -N9 "$KRXEA"
</Syntaxhighlight>

==== ... and the Footer ====

Close to the end of the file, you should replace
<Syntaxhighlight lang="xml"></gnc-v2></Syntaxhighlight>
by
<Syntaxhighlight lang="xml"></gnc-account-example></Syntaxhighlight>
.

== Testing ==
From time to time you should check the syntax and finally by using your file in GnuCash.

=== Syntax Check ===
Finally you should run 
<SyntaxHighlight lang="sh">xmllint --noout <mytemplate></SyntaxHighlight>
to verify the syntactical correctnes (std well-formed check) of your file. No output means no errors found.
<!-- Fixme: --valid fails: no DTD found !
    xmlns:vendor="http://www.gnucash.org/XML/vendor">
-->

If xmllint is missing on your computer see [[Translation#Prerequisite]].

'''Commiters''' can use in the respective directory:
<SyntaxHighlight lang="sh">for i in *-xea; do xmllint --noout $i; done</SyntaxHighlight>

=== Testing in Gnucash ===
* If you are '''using [[Git]]''' (after adding it to the repo and make) do an normal <code>make && make install</code>.
* '''Otherwise''' locate the template directory on your system - it might be /usr/share/gnucash/accounts/<yourlocale> or similar. As administrator copy it there in. '''Warning:''' This is a dirty hack which your distibutor will discourage.
Now start Gnucash, select <tt>New file</tt>..., select your template and try every possible and impossible operation.

== A sample script for big templates ==

If the template is really big - as the german - and you have it as text file, it might be less work to adjust the following script from [http://bugzilla.gnome.org/show_bug.cgi?id=568653] to create the gnucash template. There exist tools in the internet and probably on your computer to convert often used formats like PDF to plain text files e.g. ''pdf2txt''.

<syntaxhighlight lang="bash">
#! /bin/bash

# This applications takes an text input file $FILE
# and converts it into a gnucash account scheme with a random name.
# The input file is read line by line where each line
# should be formatted as
#  number name (no leading spaces)
# or
#  category name (one leading space)
# .
# Empty lines are not allowed, number is expected to have 4 digits.
# The output is a two layer structure
# of all accounts. Whenever the first
# digit of number changes, a new source group is created.
# Whenever a new category line is passed, all following
# accounts are put below.
#
# Example:
# input:
#   1234 A
#   2000 B
#    Type B1
#   2001 B1a
#   2002 B1b
#    Type B2
#   2010 B2a
#   2011 B2b
# output:
#   Class 0
#   Class 1
#    \- 1234 A
#   Class 2
#    \- 2000 B
#    \- Type B1
#       \- 2001 B1a
#       \- 2002 B1b
#    \- Type B2
#       \- 2010 B2a
#       \- 2011 B2b
#
# (C) 2009, Michael Braun, michael-developer@fami-braun.de
# Distributed under GPL v3.0 or newer.
# see http://www.gnu.org/licenses/gpl.html for details

echo "start"

FILE="<source>.txt"

if [ ! -f "$FILE" ]; then 
 echo "no such file $FILE"
 exit 1;
fi

getuid()
{
 dd if=/dev/urandom bs=1 count=32  2>/dev/null | md5sum | awk -F' ' '{print $1}';
}

OUT="$(getuid).gnucash"

ROOT=$(getuid);
NUM=$(cat $FILE | wc -l)
NUM=$(expr $NUM + 1);
ID=0

echo -n > $OUT;

cat >> "$OUT" <<EOF
<?xml version="1.0" encoding="utf-8" ?>
<gnc-v2
     xmlns:gnc="http://www.gnucash.org/XML/gnc"
     xmlns:gnc-act="http://www.gnucash.org/XML/gnc-act"
     xmlns:act="http://www.gnucash.org/XML/act"
     xmlns:book="http://www.gnucash.org/XML/book"
     xmlns:cd="http://www.gnucash.org/XML/cd"
     xmlns:cmdty="http://www.gnucash.org/XML/cmdty"
     xmlns:price="http://www.gnucash.org/XML/price"
     xmlns:slot="http://www.gnucash.org/XML/slot"
     xmlns:split="http://www.gnucash.org/XML/split"
     xmlns:sx="http://www.gnucash.org/XML/sx"
     xmlns:trn="http://www.gnucash.org/XML/trn"
     xmlns:ts="http://www.gnucash.org/XML/ts"
     xmlns:fs="http://www.gnucash.org/XML/fs"
     xmlns:bgt="http://www.gnucash.org/XML/bgt"
     xmlns:recurrence="http://www.gnucash.org/XML/recurrence"
     xmlns:lot="http://www.gnucash.org/XML/lot"
     xmlns:cust="http://www.gnucash.org/XML/cust"
     xmlns:job="http://www.gnucash.org/XML/job"
     xmlns:addr="http://www.gnucash.org/XML/addr"
     xmlns:owner="http://www.gnucash.org/XML/owner"
     xmlns:taxtable="http://www.gnucash.org/XML/taxtable"
     xmlns:tte="http://www.gnucash.org/XML/tte"
     xmlns:employee="http://www.gnucash.org/XML/employee"
     xmlns:order="http://www.gnucash.org/XML/order"
     xmlns:billterm="http://www.gnucash.org/XML/billterm"
     xmlns:bt-days="http://www.gnucash.org/XML/bt-days"
     xmlns:bt-prox="http://www.gnucash.org/XML/bt-prox"
     xmlns:invoice="http://www.gnucash.org/XML/invoice"
     xmlns:entry="http://www.gnucash.org/XML/entry"
     xmlns:vendor="http://www.gnucash.org/XML/vendor">
<gnc:count-data cd:type="account">$NUM</gnc:count-data>
<gnc:account version="2.0.0">
  <act:name>Root Account</act:name>
  <act:id type="new">$ROOT</act:id>
  <act:type>ROOT</act:type>
  <act:commodity-scu>0</act:commodity-scu>
</gnc:account>
EOF
LAST=0
CURR=$(getuid);
CURRSUB=$CURR;

addkontenklasse() {
echo
echo -n "add kontenklasse $LAST";
cat >>"$OUT" <<EOF
<gnc:account version="2.0.0">
  <act:name>Kontenklasse $LAST</act:name>
  <act:id type="new">$CURR</act:id>
  <act:type>ASSET</act:type>
  <act:commodity>
    <cmdty:space>ISO4217</cmdty:space>
    <cmdty:id>EUR</cmdty:id>
  </act:commodity>
  <act:commodity-scu>100</act:commodity-scu>
  <act:description>Erträge</act:description>
  <act:slots>
    <slot>
      <slot:key>placeholder</slot:key>
      <slot:value type="string">true</slot:value>
    </slot>
  </act:slots>
  <act:parent type="new">$ROOT</act:parent>
</gnc:account>
EOF
echo " done";
}

addkontenklasse;

addkontengruppe() {
echo
echo -n "add kontengruppe $1";
cat >>"$OUT" <<EOF
<gnc:account version="2.0.0">
  <act:name>$ID $1</act:name>
  <act:id type="new">$CURRSUB</act:id>
  <act:type>ASSET</act:type>
  <act:commodity>
    <cmdty:space>ISO4217</cmdty:space>
    <cmdty:id>EUR</cmdty:id>
  </act:commodity>
  <act:commodity-scu>100</act:commodity-scu>
  <act:description>$1</act:description>
  <act:slots>
    <slot>
      <slot:key>placeholder</slot:key>
      <slot:value type="string">true</slot:value>
    </slot>
  </act:slots>
  <act:parent type="new">$CURR</act:parent>
</gnc:account>
EOF
echo " done";
}

addkonto() {
cat >>"$OUT" <<EOF
<gnc:account version="2.0.0">
  <act:name>$1 $2</act:name>
  <act:id type="new">$(getuid)</act:id>
  <act:type>ASSET</act:type>
  <act:commodity>
    <cmdty:space>ISO4217</cmdty:space>
    <cmdty:id>EUR</cmdty:id>
  </act:commodity>
  <act:commodity-scu>100</act:commodity-scu>
  <act:description>$2</act:description>
  <act:code>$1</act:code>
  <act:parent type="new">$CURRSUB</act:parent>
</gnc:account>
EOF
}

while (true); do
 LL=$REPLY
 read
 if [ "x$REPLY" = "x" ]; then
   echo
   echo "end of file after $LL";
   break;
 fi
 REPLY=$(echo "$REPLY" | sed 's/\s\+/ /g');
 KTOID=$(echo "$REPLY" | sed 's/ .*//');
 NAME=$(echo "$REPLY" | sed 's/^[0-9]\+ \+//');
 if [ -z "$NAME" ]; then
   NAME="dummy";
 fi
 #echo "$REPLY => $KTOID | $NAME";
 echo -n "$KTOID "
 if [ -z "$KTOID" ]; then
   CURRSUB=$(getuid);
   ID=$(expr $ID + 1);
   addkontengruppe "$NAME";
 else 
  if [ $KTOID -gt "$LAST"999 ]; then
   # new cat
   LAST=$(echo $KTOID | sed 's/\(.\).*/\1/');
   CURR=$(getuid);
   CURRSUB=$CURR;
   ID=0
   addkontenklasse;
  fi
  addkonto "$KTOID" "$NAME"; 
 fi
done < "$FILE"

echo "</gnc-account-example>" >> "$OUT";
echo "done: written to $OUT"
</syntaxhighlight>

=== Annotations ===
There are a few terms in the script, you might wish to adjust or at least understand:
* Kontenklasse: account class, first level in the account hierarchy.
* kontengruppe: account group, lower node in the tree, but no leave.
: Both above are placeholders.
* Konto: account.
* Erträge: earnings.
* <cmdty:id>: 3-letter ISO-currency symbol.
* <act:commodity-scu>: smallest currency unit, in most cases 100 ''{C/S}en[t]*''|''P[f]en*'' or whatever.
Eventually you wish the account code $1 only in <act:code> and not in <act:name>.

== Exporting an existing account hierarchy ==

You can create an account hierarchy template using this method.

* You already have a account hierarchy in a gnucash file, but you want to export a subset
* Go to file > export > export the xml
* Select the subset you want from the xml as a starting point
* Change the file xml structure according to the rules defined in this article
* Take care when you change the xml file: ids and other information may conflict with your current account hierarchy
* Put the xml file you edit on /usr/share/gnucash/your_language/yourfilename.gnucash-xea
* Restart Gnucash
* Use the New Account Hierarchy wizard to import your new account hierarchy  

[[Translation#How_to_translate_the_files_containing_the_new_account_hierarchies | Back to Translation]]
----
== Future Development ==
This section is intended for developers.

===Make Check===
As shown above we can use <code>xmllint</code> to validate the syntax of account templates, if they include the namespace header. PR [https://github.com/Gnucash/gnucash/pull/300 Adjustment of Account Hierarchy Templates. #300] now shows, we should at least determinate the direction.
 
* If we want this, we have to adjust the old files.
** If a template got modularized, should all parts get the full header (like above) or
** use DOCTYPE definition like <syntaxhighlight lang="xml">
<!DOCTYPE gnc-account-example ... [ ... ]>
</syntaxhighlight>
***with PUBLIC <syntaxhighlight lang="xml">
<!DOCTYPE gnc-account-example PUBLIC "FIXME"
    "http://www.gnucash.org/XML/" [ ... ]>
</syntaxhighlight>
***or SYSTEM <syntaxhighlight lang="xml">
<!DOCTYPE gnc-account-example SYSTEM "libgnucash/doc/xml/FIXME.dtd" [ ... ]>
</syntaxhighlight>
* Were there changes in the current parser required?
* Would it be worth the huddle?

----
[[Category:Translation]][[Category:Kontenrahmen]]