Opentaps Wiki - User contributions [en]

https://docs.opentaps.org/docs/api.php?action=feedcontributions&feedformat=atom&user=Spark Opentaps Wiki - User contributions [en] 2026-05-15T17:05:14Z User contributions MediaWiki 1.32.1 https://docs.opentaps.org/docs/index.php?title=Using_Memcache_with_opentaps&diff=6961 Using Memcache with opentaps 2010-12-21T01:04:40Z

<p>Spark: /* Start the Memcached Server */</p> <hr /> <div>opentaps can be integrated with the [http://memcached.org/ Memcached] to use memcached in opentaps. This short tutorial teaches you how to configure the Memcached integration.<br /> <br /> == Start the Memcached Server ==<br /> example: memcached -d -m 256 -u root -l 127.0.0.1 -p 11211 -c 256 -P /tmp/memcached.pid<br /> <br /> Also you can choice your options for start memcached<br /> <br /> -p TCP port number to listen on (default: 11211)<br /> <br /> -U UDP port number to listen on (default: 11211, 0 is off)<br /> <br /> -s UNIX socket path to listen on (disables network support)<br /> <br /> -a access mask for UNIX socket, in octal (default: 0700)<br /> <br /> -l interface to listen on (default: INADDR_ANY, all addresses)<br /> <br /> -d run as a daemon<br /> <br /> -r maximize core file limit<br /> <br /> -u assume identity of (only when run as root)<br /> <br /> -m max memory to use for items in megabytes (default: 64 MB)<br /> <br /> -M return error on memory exhausted (rather than removing items)<br /> <br /> -c max simultaneous connections (default: 1024)<br /> <br /> -k lock down all paged memory. Note that there is a limit on how much memory you may lock. Trying to allocate more than that would fail, so be sure you set the limit correctly for the user you started the daemon with (not for -u user; under sh this is done with 'ulimit -S -l NUM_KB').<br /> <br /> -v verbose (print errors/warnings while in event loop)<br /> <br /> -vv very verbose (also print client commands/reponses)<br /> <br /> -vvv extremely verbose (also print internal state transitions)<br /> <br /> -h print this help and exit<br /> <br /> -i print memcached and libevent license<br /> <br /> -P save PID in , only used with -d option<br /> <br /> -f chunk size growth factor (default: 1.25)<br /> <br /> -n minimum space allocated for key+value+flags (default: 48)<br /> <br /> -L Try to use large memory pages (if available). Increasing the memory page size could reduce the number of TLB misses and improve the performance. In order to get large pages from the OS, memcached will llocate the total item-cache in one large chunk.<br /> <br /> -D Use as the delimiter between key prefixes and IDs. This is used for per-prefix stats reporting. The default is ":" (colon). If this option is specified, stats collection is turned on automatically; if not, then it may be turned on by sending the "stats detail on" command to the server.<br /> <br /> -t number of threads to use (default: 4)<br /> <br /> -R Maximum number of requests per event, limits the number of requests process for a given connection to prevent starvation (default: 20)<br /> <br /> -C Disable use of CAS<br /> <br /> -b Set the backlog queue limit (default: 1024)<br /> <br /> -B Binding protocol - one of ascii, binary, or auto (default)<br /> <br /> -I Override the size of each slab page. Adjusts max item size (default: 1mb, min: 1k, max: 128m)<br /> <br /> == Configuring opentaps ==<br /> <br /> Edit the file <tt>framework/base/config/cache.properties</tt>:<br /> <br /> * Turn on memcached integration by changing <tt>default.cache.store</tt> from CacheLineTable to Memcached<br /> <br /> Now you are ready. Restart opentaps, and let's see what it does!</div>

Spark https://docs.opentaps.org/docs/index.php?title=Using_Memcache_with_opentaps&diff=6960 Using Memcache with opentaps 2010-12-21T01:03:43Z

<p>Spark: </p> <hr /> <div>opentaps can be integrated with the [http://memcached.org/ Memcached] to use memcached in opentaps. This short tutorial teaches you how to configure the Memcached integration.<br /> <br /> == Start the Memcached Server ==<br /> example: memcached -d -m 256 -u root -l 127.0.0.1 -p 11211 -c 256 -P /tmp/memcached.pid<br /> <br /> Also you can choice your options for start memcached<br /> <br /> -p TCP port number to listen on (default: 11211)<br /> -U UDP port number to listen on (default: 11211, 0 is off)<br /> -s UNIX socket path to listen on (disables network support)<br /> -a access mask for UNIX socket, in octal (default: 0700)<br /> -l interface to listen on (default: INADDR_ANY, all addresses)<br /> -d run as a daemon<br /> -r maximize core file limit<br /> -u assume identity of (only when run as root)<br /> -m max memory to use for items in megabytes (default: 64 MB)<br /> -M return error on memory exhausted (rather than removing items)<br /> -c max simultaneous connections (default: 1024)<br /> -k lock down all paged memory. Note that there is a limit on how much memory you may lock. Trying to allocate more than that would fail, so be sure you set the limit correctly for the user you started the daemon with (not for -u user; under sh this is done with 'ulimit -S -l NUM_KB').<br /> -v verbose (print errors/warnings while in event loop)<br /> -vv very verbose (also print client commands/reponses)<br /> -vvv extremely verbose (also print internal state transitions)<br /> -h print this help and exit<br /> -i print memcached and libevent license<br /> -P save PID in , only used with -d option<br /> -f chunk size growth factor (default: 1.25)<br /> -n minimum space allocated for key+value+flags (default: 48)<br /> -L Try to use large memory pages (if available). Increasing the memory page size could reduce the number of TLB misses and improve the performance. In order to get large pages from the OS, memcached will llocate the total item-cache in one large chunk.<br /> -D Use as the delimiter between key prefixes and IDs. This is used for per-prefix stats reporting. The default is ":" (colon). If this option is specified, stats collection is turned on automatically; if not, then it may be turned on by sending the "stats detail on" command to the server.<br /> -t number of threads to use (default: 4)<br /> -R Maximum number of requests per event, limits the number of requests process for a given connection to prevent starvation (default: 20)<br /> -C Disable use of CAS<br /> -b Set the backlog queue limit (default: 1024)<br /> -B Binding protocol - one of ascii, binary, or auto (default)<br /> -I Override the size of each slab page. Adjusts max item size (default: 1mb, min: 1k, max: 128m)<br /> <br /> == Configuring opentaps ==<br /> <br /> Edit the file <tt>framework/base/config/cache.properties</tt>:<br /> <br /> * Turn on memcached integration by changing <tt>default.cache.store</tt> from CacheLineTable to Memcached<br /> <br /> Now you are ready. Restart opentaps, and let's see what it does!</div>

Spark https://docs.opentaps.org/docs/index.php?title=Using_Memcache_with_opentaps&diff=6959 Using Memcache with opentaps 2010-12-21T01:01:25Z

<p>Spark: /* Start the Memcached Server */</p> <hr /> <div>opentaps can be integrated with the [http://memcached.org/ Memcached] to use memcached in opentaps. This short tutorial teaches you how to configure the Memcached integration.<br /> <br /> == Start the Memcached Server ==<br /> example: memcached -d -m 256 -u root -l 127.0.0.1 -p 11211 -c 256 -P /tmp/memcached.pid<br /> <br /> Also you can choice your options for start memcached<br /> <br /> -p TCP port number to listen on (default: 11211)<br /> -U UDP port number to listen on (default: 11211, 0 is off)<br /> -s UNIX socket path to listen on (disables network support)<br /> -a access mask for UNIX socket, in octal (default: 0700)<br /> -l interface to listen on (default: INADDR_ANY, all addresses)<br /> -d run as a daemon<br /> -r maximize core file limit<br /> -u assume identity of (only when run as root)<br /> -m max memory to use for items in megabytes (default: 64 MB)<br /> -M return error on memory exhausted (rather than removing items)<br /> -c max simultaneous connections (default: 1024)<br /> -k lock down all paged memory. Note that there is a<br /> limit on how much memory you may lock. Trying to<br /> allocate more than that would fail, so be sure you<br /> set the limit correctly for the user you started<br /> the daemon with (not for -u user;<br /> under sh this is done with 'ulimit -S -l NUM_KB').<br /> -v verbose (print errors/warnings while in event loop)<br /> -vv very verbose (also print client commands/reponses)<br /> -vvv extremely verbose (also print internal state transitions)<br /> -h print this help and exit<br /> -i print memcached and libevent license<br /> -P save PID in , only used with -d option<br /> -f chunk size growth factor (default: 1.25)<br /> -n minimum space allocated for key+value+flags (default: 48)<br /> -L Try to use large memory pages (if available). Increasing<br /> the memory page size could reduce the number of TLB misses<br /> and improve the performance. In order to get large pages<br /> from the OS, memcached will allocate the total item-cache<br /> in one large chunk.<br /> -D Use as the delimiter between key prefixes and IDs.<br /> This is used for per-prefix stats reporting. The default is<br /> ":" (colon). If this option is specified, stats collection<br /> is turned on automatically; if not, then it may be turned on<br /> by sending the "stats detail on" command to the server.<br /> -t number of threads to use (default: 4)<br /> -R Maximum number of requests per event, limits the number of<br /> requests process for a given connection to prevent<br /> starvation (default: 20)<br /> -C Disable use of CAS<br /> -b Set the backlog queue limit (default: 1024)<br /> -B Binding protocol - one of ascii, binary, or auto (default)<br /> -I Override the size of each slab page. Adjusts max item size (default: 1mb, min: 1k, max: 128m)<br /> <br /> == Configuring opentaps ==<br /> <br /> Edit the file <tt>framework/base/config/cache.properties</tt>:<br /> <br /> * Turn on memcached integration by changing <tt>default.cache.store</tt> from CacheLineTable to Memcached<br /> <br /> Now you are ready. Restart opentaps, and let's see what it does!</div>

Spark https://docs.opentaps.org/docs/index.php?title=Using_Memcache_with_opentaps&diff=6958 Using Memcache with opentaps 2010-12-21T01:00:36Z

<p>Spark: </p> <hr /> <div>opentaps can be integrated with the [http://memcached.org/ Memcached] to use memcached in opentaps. This short tutorial teaches you how to configure the Memcached integration.<br /> <br /> == Start the Memcached Server ==<br /> example: memcached -d -m 256 -u root -l 127.0.0.1 -p 11211 -c 256 -P /tmp/memcached.pid<br /> <br /> Also you can choice your options for start memcached<br /> {{{<br /> -p TCP port number to listen on (default: 11211)<br /> -U UDP port number to listen on (default: 11211, 0 is off)<br /> -s UNIX socket path to listen on (disables network support)<br /> -a access mask for UNIX socket, in octal (default: 0700)<br /> -l interface to listen on (default: INADDR_ANY, all addresses)<br /> -d run as a daemon<br /> -r maximize core file limit<br /> -u assume identity of (only when run as root)<br /> -m max memory to use for items in megabytes (default: 64 MB)<br /> -M return error on memory exhausted (rather than removing items)<br /> -c max simultaneous connections (default: 1024)<br /> -k lock down all paged memory. Note that there is a<br /> limit on how much memory you may lock. Trying to<br /> allocate more than that would fail, so be sure you<br /> set the limit correctly for the user you started<br /> the daemon with (not for -u user;<br /> under sh this is done with 'ulimit -S -l NUM_KB').<br /> -v verbose (print errors/warnings while in event loop)<br /> -vv very verbose (also print client commands/reponses)<br /> -vvv extremely verbose (also print internal state transitions)<br /> -h print this help and exit<br /> -i print memcached and libevent license<br /> -P save PID in , only used with -d option<br /> -f chunk size growth factor (default: 1.25)<br /> -n minimum space allocated for key+value+flags (default: 48)<br /> -L Try to use large memory pages (if available). Increasing<br /> the memory page size could reduce the number of TLB misses<br /> and improve the performance. In order to get large pages<br /> from the OS, memcached will allocate the total item-cache<br /> in one large chunk.<br /> -D Use as the delimiter between key prefixes and IDs.<br /> This is used for per-prefix stats reporting. The default is<br /> ":" (colon). If this option is specified, stats collection<br /> is turned on automatically; if not, then it may be turned on<br /> by sending the "stats detail on" command to the server.<br /> -t number of threads to use (default: 4)<br /> -R Maximum number of requests per event, limits the number of<br /> requests process for a given connection to prevent<br /> starvation (default: 20)<br /> -C Disable use of CAS<br /> -b Set the backlog queue limit (default: 1024)<br /> -B Binding protocol - one of ascii, binary, or auto (default)<br /> -I Override the size of each slab page. Adjusts max item size<br /> (default: 1mb, min: 1k, max: 128m)<br /> <br /> }}}<br /> == Configuring opentaps ==<br /> <br /> Edit the file <tt>framework/base/config/cache.properties</tt>:<br /> <br /> * Turn on memcached integration by changing <tt>default.cache.store</tt> from CacheLineTable to Memcached<br /> <br /> Now you are ready. Restart opentaps, and let's see what it does!</div>

Spark https://docs.opentaps.org/docs/index.php?title=Using_Memcache_with_opentaps&diff=6957 Using Memcache with opentaps 2010-12-21T00:59:51Z

<p>Spark: /* Start the Memcached Server */</p> <hr /> <div>opentaps can be integrated with the [http://memcached.org/ Memcached] to use memcached in opentaps. This short tutorial teaches you how to configure the Memcached integration.<br /> <br /> opentaps can be integrated with the [http://memcached.org/ Memcached] to use memcached in opentaps. This short tutorial teaches you how to configure the Memcached integration.<br /> <br /> opentaps can be integrated with the [http://memcached.org/ Memcached] to use memcached in opentaps. This short tutorial teaches you how to configure the Memcached integration.<br /> <br /> == Start the Memcached Server ==<br /> example: memcached -d -m 256 -u root -l 127.0.0.1 -p 11211 -c 256 -P /tmp/memcached.pid<br /> <br /> Also you can choice your options for start memcached<br /> {{{<br /> -p TCP port number to listen on (default: 11211)<br /> -U UDP port number to listen on (default: 11211, 0 is off)<br /> -s UNIX socket path to listen on (disables network support)<br /> -a access mask for UNIX socket, in octal (default: 0700)<br /> -l interface to listen on (default: INADDR_ANY, all addresses)<br /> -d run as a daemon<br /> -r maximize core file limit<br /> -u assume identity of (only when run as root)<br /> -m max memory to use for items in megabytes (default: 64 MB)<br /> -M return error on memory exhausted (rather than removing items)<br /> -c max simultaneous connections (default: 1024)<br /> -k lock down all paged memory. Note that there is a<br /> limit on how much memory you may lock. Trying to<br /> allocate more than that would fail, so be sure you<br /> set the limit correctly for the user you started<br /> the daemon with (not for -u user;<br /> under sh this is done with 'ulimit -S -l NUM_KB').<br /> -v verbose (print errors/warnings while in event loop)<br /> -vv very verbose (also print client commands/reponses)<br /> -vvv extremely verbose (also print internal state transitions)<br /> -h print this help and exit<br /> -i print memcached and libevent license<br /> -P save PID in , only used with -d option<br /> -f chunk size growth factor (default: 1.25)<br /> -n minimum space allocated for key+value+flags (default: 48)<br /> -L Try to use large memory pages (if available). Increasing<br /> the memory page size could reduce the number of TLB misses<br /> and improve the performance. In order to get large pages<br /> from the OS, memcached will allocate the total item-cache<br /> in one large chunk.<br /> -D Use as the delimiter between key prefixes and IDs.<br /> This is used for per-prefix stats reporting. The default is<br /> ":" (colon). If this option is specified, stats collection<br /> is turned on automatically; if not, then it may be turned on<br /> by sending the "stats detail on" command to the server.<br /> -t number of threads to use (default: 4)<br /> -R Maximum number of requests per event, limits the number of<br /> requests process for a given connection to prevent<br /> starvation (default: 20)<br /> -C Disable use of CAS<br /> -b Set the backlog queue limit (default: 1024)<br /> -B Binding protocol - one of ascii, binary, or auto (default)<br /> -I Override the size of each slab page. Adjusts max item size<br /> (default: 1mb, min: 1k, max: 128m)<br /> <br /> }}}<br /> == Configuring opentaps ==<br /> <br /> Edit the file <tt>framework/base/config/cache.properties</tt>:<br /> <br /> * Turn on memcached integration by changing <tt>default.cache.store</tt> from CacheLineTable to Memcached<br /> <br /> Now you are ready. Restart opentaps, and let's see what it does!<br /> <br /> == Configuring opentaps ==<br /> <br /> Edit the file <tt>framework/base/config/cache.properties</tt>:<br /> <br /> * Turn on memcached integration by changing <tt>default.cache.store</tt> from CacheLineTable to Memcached<br /> <br /> Now you are ready. Restart opentaps, and let's see what it does!<br /> <br /> == Configuring opentaps ==<br /> <br /> Edit the file <tt>framework/base/config/cache.properties</tt>:<br /> <br /> * Turn on memcached integration by changing <tt>default.cache.store</tt> from CacheLineTable to Memcached<br /> <br /> Now you are ready. Restart opentaps, and let's see what it does!</div>

Spark https://docs.opentaps.org/docs/index.php?title=Using_Memcache_with_opentaps&diff=6956 Using Memcache with opentaps 2010-12-21T00:58:52Z

<p>Spark: /* Start the Memcached Server */</p> <hr /> <div>opentaps can be integrated with the [http://memcached.org/ Memcached] to use memcached in opentaps. This short tutorial teaches you how to configure the Memcached integration.<br /> <br /> opentaps can be integrated with the [http://memcached.org/ Memcached] to use memcached in opentaps. This short tutorial teaches you how to configure the Memcached integration.<br /> <br /> == Start the Memcached Server ==<br /> example: memcached -d -m 256 -u root -l 127.0.0.1 -p 11211 -c 256 -P /tmp/memcached.pid<br /> <br /> Also you can choice your options for start memcached<br /> <nowiki>-p TCP port number to listen on (default: 11211)<br /> -U UDP port number to listen on (default: 11211, 0 is off)<br /> -s UNIX socket path to listen on (disables network support)<br /> -a access mask for UNIX socket, in octal (default: 0700)<br /> -l interface to listen on (default: INADDR_ANY, all addresses)<br /> -d run as a daemon<br /> -r maximize core file limit<br /> -u assume identity of (only when run as root)<br /> -m max memory to use for items in megabytes (default: 64 MB)<br /> -M return error on memory exhausted (rather than removing items)<br /> -c max simultaneous connections (default: 1024)<br /> -k lock down all paged memory. Note that there is a<br /> limit on how much memory you may lock. Trying to<br /> allocate more than that would fail, so be sure you<br /> set the limit correctly for the user you started<br /> the daemon with (not for -u user;<br /> under sh this is done with 'ulimit -S -l NUM_KB').<br /> -v verbose (print errors/warnings while in event loop)<br /> -vv very verbose (also print client commands/reponses)<br /> -vvv extremely verbose (also print internal state transitions)<br /> -h print this help and exit<br /> -i print memcached and libevent license<br /> -P save PID in , only used with -d option<br /> -f chunk size growth factor (default: 1.25)<br /> -n minimum space allocated for key+value+flags (default: 48)<br /> -L Try to use large memory pages (if available). Increasing<br /> the memory page size could reduce the number of TLB misses<br /> and improve the performance. In order to get large pages<br /> from the OS, memcached will allocate the total item-cache<br /> in one large chunk.<br /> -D Use as the delimiter between key prefixes and IDs.<br /> This is used for per-prefix stats reporting. The default is<br /> ":" (colon). If this option is specified, stats collection<br /> is turned on automatically; if not, then it may be turned on<br /> by sending the "stats detail on" command to the server.<br /> -t number of threads to use (default: 4)<br /> -R Maximum number of requests per event, limits the number of<br /> requests process for a given connection to prevent<br /> starvation (default: 20)<br /> -C Disable use of CAS<br /> -b Set the backlog queue limit (default: 1024)<br /> -B Binding protocol - one of ascii, binary, or auto (default)<br /> -I Override the size of each slab page. Adjusts max item size<br /> (default: 1mb, min: 1k, max: 128m)</nowiki><br /> <br /> == Configuring opentaps ==<br /> <br /> Edit the file <tt>framework/base/config/cache.properties</tt>:<br /> <br /> * Turn on memcached integration by changing <tt>default.cache.store</tt> from CacheLineTable to Memcached<br /> <br /> Now you are ready. Restart opentaps, and let's see what it does!<br /> <br /> == Configuring opentaps ==<br /> <br /> Edit the file <tt>framework/base/config/cache.properties</tt>:<br /> <br /> * Turn on memcached integration by changing <tt>default.cache.store</tt> from CacheLineTable to Memcached<br /> <br /> Now you are ready. Restart opentaps, and let's see what it does!</div>

Spark https://docs.opentaps.org/docs/index.php?title=Using_Memcache_with_opentaps&diff=6954 Using Memcache with opentaps 2010-12-21T00:57:48Z

<p>Spark: New page: opentaps can be integrated with the [http://memcached.org/ Memcached] to use memcached in opentaps. This short tutorial teaches you how to configure the Memcached integration. == Start t...</p> <hr /> <div>opentaps can be integrated with the [http://memcached.org/ Memcached] to use memcached in opentaps. This short tutorial teaches you how to configure the Memcached integration.<br /> <br /> == Start the Memcached Server ==<br /> example: memcached -d -m 256 -u root -l 127.0.0.1 -p 11211 -c 256 -P /tmp/memcached.pid<br /> <br /> Also you can choice your options for start memcached<br /> -p TCP port number to listen on (default: 11211)<br /> -U UDP port number to listen on (default: 11211, 0 is off)<br /> -s UNIX socket path to listen on (disables network support)<br /> -a access mask for UNIX socket, in octal (default: 0700)<br /> -l interface to listen on (default: INADDR_ANY, all addresses)<br /> -d run as a daemon<br /> -r maximize core file limit<br /> -u assume identity of (only when run as root)<br /> -m max memory to use for items in megabytes (default: 64 MB)<br /> -M return error on memory exhausted (rather than removing items)<br /> -c max simultaneous connections (default: 1024)<br /> -k lock down all paged memory. Note that there is a<br /> limit on how much memory you may lock. Trying to<br /> allocate more than that would fail, so be sure you<br /> set the limit correctly for the user you started<br /> the daemon with (not for -u user;<br /> under sh this is done with 'ulimit -S -l NUM_KB').<br /> -v verbose (print errors/warnings while in event loop)<br /> -vv very verbose (also print client commands/reponses)<br /> -vvv extremely verbose (also print internal state transitions)<br /> -h print this help and exit<br /> -i print memcached and libevent license<br /> -P save PID in , only used with -d option<br /> -f chunk size growth factor (default: 1.25)<br /> -n minimum space allocated for key+value+flags (default: 48)<br /> -L Try to use large memory pages (if available). Increasing<br /> the memory page size could reduce the number of TLB misses<br /> and improve the performance. In order to get large pages<br /> from the OS, memcached will allocate the total item-cache<br /> in one large chunk.<br /> -D Use as the delimiter between key prefixes and IDs.<br /> This is used for per-prefix stats reporting. The default is<br /> ":" (colon). If this option is specified, stats collection<br /> is turned on automatically; if not, then it may be turned on<br /> by sending the "stats detail on" command to the server.<br /> -t number of threads to use (default: 4)<br /> -R Maximum number of requests per event, limits the number of<br /> requests process for a given connection to prevent<br /> starvation (default: 20)<br /> -C Disable use of CAS<br /> -b Set the backlog queue limit (default: 1024)<br /> -B Binding protocol - one of ascii, binary, or auto (default)<br /> -I Override the size of each slab page. Adjusts max item size<br /> (default: 1mb, min: 1k, max: 128m)<br /> <br /> == Configuring opentaps ==<br /> <br /> Edit the file <tt>framework/base/config/cache.properties</tt>:<br /> <br /> * Turn on memcached integration by changing <tt>default.cache.store</tt> from CacheLineTable to Memcached<br /> <br /> Now you are ready. Restart opentaps, and let's see what it does!</div>

Spark https://docs.opentaps.org/docs/index.php?title=Using_Memcache_with_opentaps&diff=6955 Using Memcache with opentaps 2010-12-21T00:57:48Z

<p>Spark: Protected "Using Memcache with opentaps": Sysop page [edit=sysop:move=sysop]</p> <hr /> <div>opentaps can be integrated with the [http://memcached.org/ Memcached] to use memcached in opentaps. This short tutorial teaches you how to configure the Memcached integration.<br /> <br /> == Start the Memcached Server ==<br /> example: memcached -d -m 256 -u root -l 127.0.0.1 -p 11211 -c 256 -P /tmp/memcached.pid<br /> <br /> Also you can choice your options for start memcached<br /> -p TCP port number to listen on (default: 11211)<br /> -U UDP port number to listen on (default: 11211, 0 is off)<br /> -s UNIX socket path to listen on (disables network support)<br /> -a access mask for UNIX socket, in octal (default: 0700)<br /> -l interface to listen on (default: INADDR_ANY, all addresses)<br /> -d run as a daemon<br /> -r maximize core file limit<br /> -u assume identity of (only when run as root)<br /> -m max memory to use for items in megabytes (default: 64 MB)<br /> -M return error on memory exhausted (rather than removing items)<br /> -c max simultaneous connections (default: 1024)<br /> -k lock down all paged memory. Note that there is a<br /> limit on how much memory you may lock. Trying to<br /> allocate more than that would fail, so be sure you<br /> set the limit correctly for the user you started<br /> the daemon with (not for -u user;<br /> under sh this is done with 'ulimit -S -l NUM_KB').<br /> -v verbose (print errors/warnings while in event loop)<br /> -vv very verbose (also print client commands/reponses)<br /> -vvv extremely verbose (also print internal state transitions)<br /> -h print this help and exit<br /> -i print memcached and libevent license<br /> -P save PID in , only used with -d option<br /> -f chunk size growth factor (default: 1.25)<br /> -n minimum space allocated for key+value+flags (default: 48)<br /> -L Try to use large memory pages (if available). Increasing<br /> the memory page size could reduce the number of TLB misses<br /> and improve the performance. In order to get large pages<br /> from the OS, memcached will allocate the total item-cache<br /> in one large chunk.<br /> -D Use as the delimiter between key prefixes and IDs.<br /> This is used for per-prefix stats reporting. The default is<br /> ":" (colon). If this option is specified, stats collection<br /> is turned on automatically; if not, then it may be turned on<br /> by sending the "stats detail on" command to the server.<br /> -t number of threads to use (default: 4)<br /> -R Maximum number of requests per event, limits the number of<br /> requests process for a given connection to prevent<br /> starvation (default: 20)<br /> -C Disable use of CAS<br /> -b Set the backlog queue limit (default: 1024)<br /> -B Binding protocol - one of ascii, binary, or auto (default)<br /> -I Override the size of each slab page. Adjusts max item size<br /> (default: 1mb, min: 1k, max: 128m)<br /> <br /> == Configuring opentaps ==<br /> <br /> Edit the file <tt>framework/base/config/cache.properties</tt>:<br /> <br /> * Turn on memcached integration by changing <tt>default.cache.store</tt> from CacheLineTable to Memcached<br /> <br /> Now you are ready. Restart opentaps, and let's see what it does!</div>

Spark https://docs.opentaps.org/docs/index.php?title=General_Installation_of_Opentaps&diff=5775 General Installation of Opentaps 2010-04-14T08:37:28Z

<p>Spark: </p> <hr /> <div>__TOC__<br /> <br /> Installing opentaps ERP + CRM is fairly easy, and you do not need root user privileges. These instructions will help you get started running opentaps ERP + CRM on both Unix/Linux and Windows operating systems.<br /> <br /> ==Prerequisites==<br /> <br /> The first step is to make sure that you have the correct Java Virtual Machine installed. For opentaps 0.8.x and 0.9.x, you must use Java 1.4.2. For opentaps 1.0.x, you must use Java 5. opentaps 1.4 works with both Java 5 or Java 6, though it is pre-compiled with Java 6. In both cases, <b>you must use the Sun Java SDK</b>, not GNU gcj which may have been supplied with Fedora Core or Ubuntu or the Java Runtime JRE supplied with Windows.<br /> <br /> To determine what version of Java you are using, type the following command:<br /> <br /> $ java -version<br /> <br /> For opentaps 0.8.x and opentaps 0.9.x, you must see something like this:<br /> Java(TM) 2 Runtime Environment, Standard Edition (build 1.4.2_xxxx)<br /> <br /> For opentaps 1.0.x, you must see something like the following:<br /> Java(TM) 2 RuntimeEnvironment, Standard Edition (build 1.5.xxxx)<br /> <br /> You must not see anything like<br /> gij (GNU libgcj) version 4.0.1 20050727 (Red Hat 4.0.1-5)<br /> <br /> or anything that says "JRE".<br /> <br /> <b>If you do not see the correct JVM, you must go download it from Sun.</b><br /> <br /> Next, you should unzip the opentaps ERP + CRM .zip file you have just downloaded and go into the directory where it is unzipped:<br /> <br /> $ cd opentaps<br /> <br /> ==Starting on Unix/Linux==<br /> <br /> If you are using a Unix/Linux system, you should make the startup scripts executable:<br /> <br /> $ chmod u+x startofbiz.sh<br /> $ chmod u+x stopofbiz.sh<br /> <br /> <b>IMPORTANT:</b> If your system already has gcj and you just installed new Sun JVM, you must tell opentaps ERP + CRM to use the Sun JVM instead of the GCJ JVM in /bin/java by specifying where the JVM is:<br /> <br /> $ export JAVA_HOME=/usr/java/j2sdk_xxxx/<br /> <br /> (or whichever directory your Sun JVM was installed.) You can even put this directive into startofbiz.sh and stopofbiz.sh<br /> <br /> To start the opentaps server,<br /> <br /> $ ./startofbiz.sh<br /> <br /> The server is started as a background process, and the logs are piped to a file called "console.log" in the logs/ sub-directory for opentaps 0.8.x and 0.9.x and runtime/logs sub-directory for opentaps 1.0.x To see the logs,<br /> <br /> $ tail -f runtime/logs/console.log<br /> <br /> or<br /> <br /> $ tail -f logs/console.log<br /> <br /> To stop the opentaps ERP + CRM server,<br /> <br /> $ ./stopofbiz.sh<br /> <br /> To start the Point Of Sales terminal, instead of using startofbiz.sh and stopofbiz.sh, use<br /> <br /> $ java -jar ofbiz.jar -pos<br /> <br /> ==Starting on Windows==<br /> <br /> <b>IMPORTANT:</b> If you are using Windows, you may run into problems with having paths with directories that have spaces in the name, such as "C:\Documents and Settings". You can avoid these problems by unzipping in your C:\ directory.<br /> <br /> <b>IMPORTANT:</b> opentaps ERP + CRM runs as a server on your computer and needs to access a number of ports. If you are having start up problems, try re-configuring or temporarily disabling your firewall.<br /> <br /> If you are using Windows, call up a command line terminal (Windows > Run Program > "cmd") From the terminal, go to your opentaps ERP + CRM directory<br /> <br /> C:> cd c:\opentaps<br /> <br /> You may need set a variable called JAVA_HOME first to tell Windows where Java is located:<br /> <br /> C:> set JAVA_HOME=c:\java_x.x.x<br /> <br /> <br /> Or which ever directory Java was installed in.<br /> <br /> Now run the batch file to start the opentaps ERP + CRM server:<br /> <br /> C:\opentaps> startofbiz.bat<br /> <br /> The server will run in the terminal. Alternatively, you can create a Windows shortcut to the startofbiz.bat and place it on your desktop.<br /> <br /> If you want to start the Point Of Sales system, use this command instead:<br /> <br /> C:\opentaps> java -jar ofbiz.jar -pos<br /> <br /> ==Mac OS X Users==<br /> A recent update to OS X 10.4.6 has made Java 5 the default JVM. To use Java 1.4.2 for opentaps 0.8.x or 0.9.x, set your JAVA_HOME to the correct path:<br /> <br /> $ export JAVA_HOME=/System/Library/Frameworks/JavaVM.framework/Versions/1.4.2/Home<br /> <br /> You can also use /Applications/Utilities/Java/J2SE 5.0/Java Preferences.app to set your preferred Java environment.<br /> <br /> ==Accessing the Server==<br /> <br /> To access the opentaps ERP + CRM server, open any browser and type in the following:<br /> <br /> * For version 1.4: <tt>http://localhost:8080/opentaps</tt><br /> * For version 1.0 and earlier: <tt>http://localhost:8080/</tt><br /> <br /> <br /> With opentaps 1.4, you will see a greeting page which prompts you to login. The applications you can access are displayed as icons:<br /> <br /> [[Image:Opentaps home.png]]<br /> <br /> In earlier versions of opentaps, you will see a menu in your browser which shows you all the applications available.<br /> <br /> [[Image:Opentaps startup.png]]<br /> <br /> You can now click on the application you wish to access. If you are using an older version of Sequoia ERP, you will need to access the applications directly using:<br /> <br /> <tt>http://locahost:8080/crmsfa/control/main</tt><br /> <br /> for CRMSFA or<br /> <br /> <tt>http://localhost:8080/ecommerce/control/main</tt><br /> <br /> for the online store.<br /> <br /> ==Signing In==<br /> <br /> For the back end web applications, use the username "admin" and the password "ofbiz".<br /> <br /> For the ecommerce online store application, use username "DemoCustomer" and password "ofbiz".<br /> <br /> For the Point Of Sales application, use username "1" and password "1" for a manager and username "2" and password "2" for a cashier.<br /> <br /> ==Oh No! It Didn't Work! What Do I Do?==<br /> <br /> Look in your runtime/logs/console.log and runtime/logs/ofbiz.log (or simply logs/console.log or logs/ofbiz.log files for opentaps 0.8.x and 0.9.x) and see what error messages are recorded. Check that you are using the correct version, that your database connection is successful, that there were no port conflicts, and that none of the required ports are blocked.<br /> <br /> Here are some specific issues and possible solutions:<br /> <br /> ===Bad version number in .class file===<br /> <br /> This means that the Java virtual machine on your computer is different than the one that was used to compile opentaps. For example, your computer might have Java 5, and you may have downloaded opentaps 1.4, which was pre-compiled with Java 6.<br /> <br /> To fix this, either download and install the same Java virtual machine SDK as was used to compile the copy of opentaps you obtained, or try to recompile opentaps using your computer's Java virtual machine with <br /> <br /> ant<br /> or<br /> ./ant<br /> <br /> ===Cannot create the Java virtual machine===<br /> <br /> Your computer may not have the memory available to satisfy opentaps. Check the [[Hardware Guidelines for Opentaps]] and [[Recommended Memory Settings]].<br /> <br /> ===PermGen Space and other Memory Errors===<br /> <br /> See [[Recommended Memory Settings]] for possible changes to your start scripts.<br /> <br /> ===Build Aspect class Errors===<br /> <br /> If you got "Unable to rename old file" build error, you can try to use follow line to replace the weave target on hot-deploy/opentaps-common/build-aspects.xml.<br /> <pre><br /> <br /> <br /> <br /> <target name="weave" depends="detect-dependencies" if="processRequired"><br /> <echo message="[build] =========== Start Building Aspect (Weave) ============="/><br /> <java classname="org.codehaus.aspectwerkz.compiler.AspectWerkzC" fork="true"><br /> <jvmarg value="-Daspectwerkz.definition.file=${aopConfig}"/><br /> <jvmarg value="-Daspectwerkz.transform.filter=no"/><br /> <br /> <br /> <arg value="-verify"/><br /> <classpath refid="local.class.path" /><br /> <classpath><br /> <pathelement path="${build.dir}/classes/common"/><br /> </classpath><br /> <br /> <arg value="${ofbiz.dir}/framework/entity/build/lib/ofbiz-entity.jar"/><br /> </java><br /> <java classname="org.codehaus.aspectwerkz.compiler.AspectWerkzC" fork="true"><br /> <jvmarg value="-Daspectwerkz.definition.file=${aopConfig}"/><br /> <jvmarg value="-Daspectwerkz.transform.filter=no"/><br /> <br /> <br /> <arg value="-verify"/><br /> <classpath refid="local.class.path" /><br /> <classpath><br /> <pathelement path="${build.dir}/classes/common"/><br /> </classpath><br /> <br /> <arg value="${ofbiz.dir}/framework/common/build/lib/ofbiz-common.jar"/><br /> </java><br /> <java classname="org.codehaus.aspectwerkz.compiler.AspectWerkzC" fork="true"><br /> <jvmarg value="-Daspectwerkz.definition.file=${aopConfig}"/><br /> <jvmarg value="-Daspectwerkz.transform.filter=no"/><br /> <br /> <br /> <arg value="-verify"/><br /> <classpath refid="local.class.path" /><br /> <classpath><br /> <pathelement path="${build.dir}/classes/common"/><br /> </classpath><br /> <br /> <arg value="${ofbiz.dir}/applications/order/build/lib/ofbiz-order.jar"/><br /> </java><br /> <jar jarfile="${lib.dir}/${name}.jar" update="true" basedir="${build.dir}/classes/common" includes="org/opentaps/aspect/secas/**" /><br /> <br /> <mkdir dir="${build.dir}/classes/META-INF" /><br /> <copy file="${aopConfig}" tofile="${build.dir}/classes/META-INF/aop.xml" overwrite="true"/><br /> <br /> <zip destfile="${lib.dir}/ofbiz-entity.jar"><br /> <zipfileset src="${ofbiz.dir}/framework/entity/build/lib/ofbiz-entity.jar"/><br /> <fileset dir="${build.dir}/classes/"><br /> <include name="META-INF/aop.xml"/><br /> </fileset><br /> </zip><br /> <delete file="${ofbiz.dir}/framework/entity/build/lib/ofbiz-entity.jar" failonerror="false"/><br /> <move file="${lib.dir}/ofbiz-entity.jar" tofile="${ofbiz.dir}/framework/entity/build/lib/ofbiz-entity.jar"/><br /> <br /> <zip destfile="${lib.dir}/ofbiz-common.jar"><br /> <zipfileset src="${ofbiz.dir}/framework/common/build/lib/ofbiz-common.jar"/><br /> <fileset dir="${build.dir}/classes/"><br /> <include name="META-INF/aop.xml"/><br /> </fileset><br /> </zip><br /> <delete file="${ofbiz.dir}/framework/common/build/lib/ofbiz-common.jar" failonerror="false"/><br /> <move file="${lib.dir}/ofbiz-common.jar" tofile="${ofbiz.dir}/framework/common/build/lib/ofbiz-common.jar"/><br /> <br /> <zip destfile="${lib.dir}/ofbiz-order.jar"><br /> <zipfileset src="${ofbiz.dir}/applications/order/build/lib/ofbiz-order.jar"/><br /> <fileset dir="${build.dir}/classes/"><br /> <include name="META-INF/aop.xml"/><br /> </fileset><br /> </zip><br /> <delete file="${ofbiz.dir}/applications/order/build/lib/ofbiz-order.jar" failonerror="false"/><br /> <move file="${lib.dir}/ofbiz-order.jar" tofile="${ofbiz.dir}/applications/order/build/lib/ofbiz-order.jar"/><br /> <br /> <echo message="[build] =========== Done Building Aspect (Weave) =============="/><br /> </target></pre><br /> <br /> ===What to do if you get an RMIDispatcher Error===<br /> <br /> If you see an error message like this:<br /> Exception in thread "main" java.lang.NoSuchMethodError: sun.rmi.transport.Object <br /> Table.getStub(Ljava/rmi/Remote;)Ljava/rmi/server/RemoteStub; <br /> at org.objectweb.carol.rmi.jrmp.server.JUnicastRemoteObject.unexportObject(JUnicastRemoteObject.java:138) <br /> at org.objectweb.carol.rmi.multi.JrmpPRODelegate.unexportObject(JrmpPRODelegate.java:94) <br /> at org.objectweb.carol.rmi.multi.MultiPRODelegate.unexportObject(MultiPRODelegate.java:132) <br /> at javax.rmi.PortableRemoteObject.unexportObject(Unknown Source) <br /> at org.objectweb.jotm.SubCoordinator.doAfterCompletion(SubCoordinator.java:1548) <br /> <br /> You are experiencing a problem instantiating the RMI dispatcher. The RMI dispatcher is used to call remote services running on another instance of oopentaps. For demo purposes, you can usually turn this off by editing the file base/config/ofbiz-containers.xml and commenting out the <containers> for rmi-dispatcher and rmi-print-server.<br /> <br /> ===What to do if you get a BSH Error===<br /> <br /> If you see this error message:<br /> java.lang.NoSuchMethodError: bsh.BshClassManager.createClassManager()Lbsh/BshClassManager;<br /> at org.ofbiz.base.util.BshUtil.getMasterInterpreter(BshUtil.java:124)<br /> at org.ofbiz.base.util.BshUtil.makeInterpreter(BshUtil.java:95)<br /> at org.ofbiz.base.util.BshUtil.runBshAtLocation(BshUtil.java:144)<br /> <br /> The problem is that your computer has another copy of beanshell (bsh.jar) installed in the Java class path. For example, OS X sometimes has a bsh.jar in /Library/Java/Extensions/ Simply move it out of the way and try again.<br /> <br /> ===Keystore was tampered with, or password was incorrect on OS X===<br /> <br /> If you encounter this error message:<br /> Keystore was tampered with, or password was incorrect<br /> <br /> It is actually a problem with Java 6 on OS X, and you can fix it by changing your keystore:<br /> <br /> sudo keytool -keystore "/System/Library/Frameworks/JavaVM.framework/Versions/A/Resources/Deploy.bundle/Contents/Home/lib/security/cacerts"<br /> -storepasswd -new "changeit"<br /> Enter password: <your sudo password><br /> Enter password: changeme<br /> <br /> The new keystore password must be exactly "changeme". You do not need to modify the ofbiz-containers.xml file. Just restart opentaps after this.</div>

Spark https://docs.opentaps.org/docs/index.php?title=Opentaps_Magento_Integration&diff=5607 Opentaps Magento Integration 2010-02-27T03:44:45Z

<p>Spark: </p> <hr /> <div>__TOC__<br /> <br /> '''This module is now ready for beta testing by developers. If you are interested, please [http://www.opensourcestrategies.com/contact/ contact Open Source Strategies] to request access to the Subversion repository.'''<br /> <br /> ==Introduction==<br /> This integration allows you to use the [http://www.magentocommerce.com/ Magento e-commerce system] with [http://www.opentaps.org opentaps Open Source ERP + CRM]. The integration is designed to allow you to set up your products and catalogs in Magento, take orders using the Magento online store or using the Magento order entry module, and then import the products and orders to opentaps for purchasing, manufacturing fulfillment, and invoicing.<br /> <br /> Specific features supported are:<br /> * One way push from Magento of newly added products and sales orders (Changes to products and orders are currently not handled.)<br /> * All Magento orders added to one "Magento Customer" in opentaps<br /> * Payments received in Magento are imported into opentaps under "Magento customer" an associated with the corresponding order<br /> * Once orders are shipped in opentaps, the tracking number is sent back to Magento and associate it with the original order.<br /> * Only one magento product store is supported at any time.<br /> <br /> This integration is compatible with the free [http://www.magentocommerce.com/product/community-edition Magento Community Edition].<br /> <br /> ==Installation==<br /> <br /> The opentaps-Magento integration requires one module for Magento and two components for opentaps:<br /> * IntegratingWeb module for Magento<br /> * Data Access Layer (DAL) and magento-integration components for opentaps<br /> <br /> The Magento module retrieves product and order data from Magento and serves them up via the REST protocol. The DAL component for opentaps receives the data from the Magento module and stores them in the opentaps database, and the magento-integration component uses the opentaps data import component to import the products and orders.<br /> <br /> ===Installing the Source Version from Subversion===<br /> <br /> You can install the source code version from subversion by checking out the IntegratingWeb module for Magento and the Data Access Layer (dal) and magento integration modules for opentaps.<br /> <br /> ====Installing the Magento Extension====<br /> <br /> 1. Checkout the IntegratingWeb Magento module in $magentoInstallationPath/app/code/local<br /> svn co svn://svn.opentaps.org/opentaps_magento/magento_component/versions/1.0/trunk/OpentapsIntegration OpentapsIntegration <br /> <br /> After the download, the Magento directory structure must look like the following:<br /> $magentoInstallationPath/app/code/local/OpentapsIntegration<br /> <br /> 2. Move $magentoInstallationPath/app/code/local/OpentapsIntegration/Restful/etc/OpentapsIntegration_Restful.xml in $magentoInstallationPath/app/etc/modules:<br /> mv $magentoInstallationPath/app/code/local/OpentapsIntegration/Restful/etc/OpentapsIntegration_Restful.xml $magentoInstallationPath/app/etc/modules<br /> <br /> 3. Go on the Magento backend in System->Configuration, then Advanced->Advanced (at the bottom of the left-hand side tabs for the System->Configuration screen.)<br /> <br /> 4. Click on "SAVE CONFIG" so that the Magento configuration files will be reloaded.<br /> <br /> 5. Now click on "Disable modules output", make sure you see a module named OpentapsIntegration_Restful. If that is your case, then you have succesfully installed the Magento module:<br /> <br /> [[Image:Magento Modules Opentaps Integration.png|600px]]<br /> <br /> ====Installing the opentaps Modules====<br /> <br /> First, go to the hot-deploy/ subdirectory for opentaps:<br /> opentaps $ cd hot-deploy<br /> <br /> Then, checkout the Data Access Layer (DAL) and magento-integration modules:<br /> <br /> hot-deploy $ svn co svn://svn.opentaps.org/opentaps_magento/opentaps_component/versions/1.4/trunk/dal dal <br /> hot-deploy $ svn co svn://svn.opentaps.org/opentaps_magento/opentaps_component/versions/1.4/trunk/magento-integration magento-integration <br /> <br /> After the download, the opentaps directory structure must look like the following:<br /> $opentapsInstallationPath/hot-deploy/dal<br /> $opentapsInstallationPath/hot-deploy/magento-integration<br /> <br /> Modify the file $opentapsInstallationPath/hot-deploy/component-load.xml uncomment the following two lines:<br /> <load-component component-location="dal"/><br /> <load-component component-location="magento-integration"/><br /> <br /> Go back to the opentaps directory and rebuild everything:<br /> opentaps $ ./ant<br /> <br /> The opentaps modules are now installed. Now restart opentaps, and go to http://localhost:8080/magento-integration/control/main to ensure that the modules are loaded.<br /> <br /> ==Configuring the opentaps Magento Integration==<br /> <br /> First you need a user which has access to magento data. You can create this user from the Magento backend:<br /> # In the Magento backend, go to System-> Web Service -> Users, and add a new user. <br /> # Then go to System-> Web Service -> Roles and create a new Role with "Resource Access" set to "All".<br /> # Finally, associate the user with that role. <br /> <br /> Next, $opentapsInstallationPath/hot-deploy/magento-integration/config/magento-integration.properties:<br /> # Set the URL and administrative access user and password for opentaps<br /> # Set the base store URL and resource access user and password for magento. Test it by trying the URL plus <tt>/ws/orders/login</tt> For example, if your base store URL is <tt>http://www.my-magento-store.com/index.php</tt>, then you should see a page at <tt>http://www.my-magento-store.com/index.php/ws/orders/login</tt> The password is also the same as your magento user's API key.<br /> # Set paging size, which is the number of products retrieved in each batch from magento<br /> # Set the magento store ID, which is the field store_id of the table core_store of the Magento DB. <br /> <br /> '''NOTE:''' when you modify any .properties file in Opentaps, you must reboot your instance because properties are loaded statically at boot application time.<br /> <br /> Finally, use the opentaps Webtools > Entity XML Import to load the following files:<br /> * hot-deploy/magento-integration/data/MagentoPrimaryStore.xml<br /> * hot-deploy/magento-integration/data/MagentoPrimaryStoreCatalog.xml<br /> * hot-deploy/magento-integration/data/MagentoCustomer.xml<br /> <br /> ==Opentaps/Magento Mappings explanation==<br /> <br /> The magento-integration Opentaps module has a directory named "mappings" that contains a CSV file for every Magento workflow/area currently supported by the integration. These CSV files are processed by the transformations, and used when <br /> storing data in Opentaps.<br /> <br /> '''storeMappings.csv''': handles the mapping between the Magento stores IDs and the Opentaps ProductStore/RootCategory entities.<br /> <br /> MagentoStoreId,OpentapsRootCategoryId,OpentapsStoreId<br /> 1,MPSCATALOG1,mag1<br /> <br /> The ProductCategory and ProductStore definitions can be found in magento-integration/data: by default XML files there are loaded as demo data. Informations about the Magento storeIDs can be found in the ''core_store'' table.<br /> <br /> <br /> '''shippingMappings.csv''': handles the mapping between the Magento shipping methods and the Opentaps shipping methods<br /> <br /> magentoShippingMethodId,opentapsShippingMethodId<br /> fedex_FEDEXGROUND,9015<br /> ups_GND,9001<br /> fedex_FEDEX2DAY,9002<br /> <br /> The Opentaps shipping method IDs are defined as seed data, and are common of every Opentaps installation. The Magento shipping methods can be found in the ''core_config_data'' table: by default Magento append the carrier code (ex.: UPS) to the shipping method (ex.: GND, states for Ground), thus resulting in a shippingMethodId of ups_GND.<br /> <br /> <br /> '''paymentsMappings.csv''': handles the mapping between Magento payment gateways and Opentaps payment methods.<br /> <br /> MagentoPaymentMethodId,OpentapsPaymentMethodId<br /> authorizenet,CREDIT_CARD<br /> <br /> The Opentaps payment method types and be found in the ''PaymentMethodType'' entity. The Magento payment methods can be found in the ''core_config_data'' table.<br /> <br /> <br /> '''taxIdMappings.csv''': handles the mapping between Magento tax codes and Opentaps tax authorities.<br /> <br /> magentoTaxCode,opentapsTaxAuthPartyId<br /> US-CA-*-Rate 1,CA_BOE<br /> US-NY-*-Rate 1,NY_DTF<br /> <br /> The Opentaps tax authorities can be found in the ''TaxAuthority'' entity (''taxAuthPartyId'' field). The Magento tax codes, that needs to be defined for tax calculation, can be found in the ''tax_calculation_rate'' table.<br /> <br /> ==Testing the Integration==<br /> <br /> Magento orders need to be in the "Processing" state to be imported into opentaps. This means that they must have payment received first. You can use the [https://developer.paypal.com/ paypal developer sandbox] to set up a dummy paypal account for payment processing. Alternatively, you can create your order with Check/Money Order and invoice the order, and then it will be "Processing."<br /> <br /> ==How-To Implement Paypal Payments Pro into Magento - SANDBOX==<br /> <br /> You can follow the [http://www.magentocommerce.com/wiki/how-to_implement_paypal_payments_pro_into_magento_-_sandbox] to set up a developer account for payment processing.<br /> <br /> ==Performance tuning==<br /> <br /> When importing a large number of products/orders (order of thousands, we made some tests with more than 10.000 products) performance issues become important.<br /> <br /> ====Opentaps====<br /> Default values of Opentaps 1.4 defined in startofbiz.sh work fine. Ensure that the Java Virtual Machine will be started with the following values<br /> -Xms512M -Xmx1536M -XX:MaxPermSize=1024M<br /> <br /> '''Note''': in Unix systems the maximum number of open file descriptors is sometimes configured for a non-production system, that probably will not have high loads. In Linux based systems, this value is most of the time configured to 1024: the value can be verified with the following command:<br /> <br /> ulimit -n<br /> <br /> To increase the default value, add a line such as the following in the file /etc/security/limits.conf<br /> <br /> yourUser - nofile 10000 <br /> <br /> Finally, reboot your machine.<br /> <br /> ====Magento====<br /> In $magentoInstallationPath/.htaccess memory used by PHP must be increased to a value of at least 512 Mb: this is a value you must tune based on the number of concurrent users that will access you production web site.<br /> <br /> php_value memory_limit 512M</div>

Spark https://docs.opentaps.org/docs/index.php?title=Upgrading_from_opentaps_1.0_to_opentaps_1.4&diff=5606 Upgrading from opentaps 1.0 to opentaps 1.4 2010-02-27T00:07:17Z

<p>Spark: </p> <hr /> <div>__TOC__<br /> <br /> == Data Changes ==<br /> <br /> * Run the service <tt>opentaps.setSupplementalDataForAllParties</tt> to populate primary contact data for all parties.<br /> * Configuration of GL accounts for invoice writeoffs have been changed. Instead of using <tt>GlAccountTypeDefault</tt>, they are now configured with <tt>InvoiceAdjustmentGlAccount</tt> with the adjustment type "WRITEOFF"<br /> * If you have custom UI labels, they may be loaded by adding them to <tt>LabelConfiguration.properties</tt> in <tt>opentaps-common/config/</tt><br /> ** If previously you were using <tt>UtilMessage.registerLabelMap()</tt> to load custom labels, you may now remove all calls to this function as it is no longer needed.<br /> * Run the upgrade SQL script in hot-deploy/opentaps-common/scripts/sql for the following:<br /> ** <tt>ProductAverageCost</tt> has been re-factored to use a single productAverageCostId as its primary key. The script will alter the table and automatically fill in its values and update <tt>SequenceValueItem</tt> so that opentaps will generate correct future keys.<br /> * Add the following to your custom component's build.xml:<br /> <fileset dir="${ofbiz.dir}/hot-deploy/opentaps-common/lib" includes="*.jar"/><br /> <fileset dir="${ofbiz.dir}/hot-deploy/opentaps-common/lib/hibernate" includes="*.jar"/><br /> * Set <tt>SupplierProduct.supplierPrefOrderId</tt> to '''10_MAIN_SUPPL''' where it is null.<br /> * Run the following services to set summary fields:<br /> ** <tt>recalcAllEmptyAmountsPayments</tt><br /> ** <tt>recalcAllEmptyAmountsInvoices</tt><br /> ** <tt>updatePostedAmountAcctgTrans</tt><br /> * Run the following service to create hibernate search index files:<br /> ** <tt>opentaps.createHibernateSearchIndex</tt><br /> * Run the following SQL query to set Invoice.paidDate:<br /> <pre><br /> update INVOICE i set PAID_DATE = (<br /> select paidDate from<br /> (<br /> select max(EFFECTIVE_DATE) paidDate, b.INVOICE_ID from PAYMENT a inner<br /> join PAYMENT_APPLICATION b on a.PAYMENT_ID=b.PAYMENT_ID group by<br /> b.INVOICE_ID<br /> ) p where p.INVOICE_ID = i.INVOICE_ID and i.STATUS_ID='INVOICE_PAID'<br /> );<br /> <br /> </pre><br /> <br /> * Run the ant import ext seed in command window: <br /> <pre><br /> ant run-install-extseed<br /> </pre><br /> == Coding Changes ==<br /> <br /> Changes in the ofbiz framework would require the following changes to your code:<br /> <br /> === URL Parameter Security ===<br /> <br /> You can no longer pass parameters to a service request directly in the URL. These requests must be part of a POST form. To make buttons work as before, you need to change them to forms and then activate them with javascript. For example, in earlier versions, you could have a button to delete a lead like this:<br /> <#assign update_options = update_options + "<a class='subMenuButtonDangerous' <br /> href='deleteLead?leadPartyId=" + partySummary.partyId + "'>" + uiLabelMap.CommonDelete + "</a>" /><br /> <br /> In opentaps 1.4, you must do it this way:<br /> <form name="deleteLeadForm" method="post" action="<@ofbizUrl>deleteLead</@ofbizUrl>"/><br /> <@inputHidden name="leadPartyId" value="${partySummary.partyId}"/><br /> </form><br /> <#assign update_options = update_options + "<a class='subMenuButtonDangerous' <br /> href='javascript:document.deleteLeadForm.submit()'>" + uiLabelMap.CommonDelete + "</a>" /><br /> <br /> For your convenience, there is also a new macro to do this (see ''form'' and ''submitFormLink'' in opentapsFormMacro.ftl):<br /> <@form name="deleteLeadForm" url="deleteLead" leadPartyId=partySummary.partyId /><br /> <#assign update_options>${update_options}<@submitFormLink form="deleteLeadForm" text=uiLabelMap.CommonDelete class="subMenuButtonDangerous" /></#assign><br /> <br /> The ''form'' macro makes hidden inputs for all parameters (except ''name'', ''url'' and ''method'' that are used to define the form element itself), and also accept nested elements for more complex cases.<br /> <br /> For the cases where a form has to be used for multiple items, for example when you have an Update form block which must include multiple remove links, instead of writing a JavaScript handler which passes the item Ids to the form before submitting, you can do:<br /> <br /> <@form name="removeReturnItemAction" url="removeReturnItem" returnId=returnId returnItemSeqId="" /><br /> <@form name="updateReturnItemsAction" url="updateReturnItems" returnId=returnId><br /> <#list returnItems as item><br /> <br /> <@submitFormLinkConfirm form="removeReturnItemAction" text=uiLabelMap.CommonRemove returnItemSeqId=item.returnItemSeqId /><br /> </#list><br /> </@form><br /> <br /> <br /> Also the new ''selectActionForm'' and ''actionForm'' can be used with ''form'' to define a drop-down menu where when an item (''actionForm'') is selected it submits the corresponding ''form'':<br /> <@form name="deleteLeadForm" url="deleteLead" leadPartyId=partySummary.partyId /><br /> <@form ... /><br /> <@selectActionForm name="leadActions" prompt="${uiLabelMap.CommonSelectOne}"><br /> <@actionForm form="deleteLeadForm" text="${uiLabelMap.CommonDelete}"/><br /> <@actionForm .../><br /> <@selectAction/><br /> <br /> === Service and HTML inputs ===<br /> <br /> As a security feature, the services will filter any input with HTML by default. Some services still require HTML (like emails or templates services) and to allow that there is a new ''allow-html'' parameter. For example:<br /> <br /> <attribute name="content" type="String" mode="IN" optional="false" allow-html="safe"/><br /> <override name="mergeFormText" allow-html="safe"/><br /> <br /> === Form Widget Changes ===<br /> <br /> Form widget URL parameters should be specified with <tt>parameter</tt> tag now, instead of in the URL:<br /> <pre><br /> - <hyperlink description="${contactListName} (${contactListId})" target="viewContactList?contactListId=${contactListId}"><br /> + <hyperlink description="${contactListName} (${contactListId})" target="viewContactList"><br /> + <parameter param-name="contactListId" from-field="contactListId"/><br /> </hyperlink><br /> </pre><br /> Do not have it both in the URL and as a <tt>parameter</tt>, or the parameter will be on the form twice and be passed incorrectly.<br /> <br /> === Controller redirects ===<br /> <br /> Redirects have been changed, now ''request-redirect'' will only copy the parameters that were in the URL string by default. To forward posted or service output parameter, use the ''redirect-parameter'' elements (one per parameter).<br /> <response name="success" type="request-redirect" value="viewAccount"><br /> <redirect-parameter name="partyId"/><br /> </response><br /> Also ''request-redirect-filter-param'' is now considered deprecated.<br /> <br /> === Js dateTime format ===<br /> <br /> Js dataTime format in ftl have been changed, now the format will return html encode string which will cause the parse exception, you should use StringUtil.wrapString to avoid this issue. For example, in earlier versions, you could have define a js dataTime format variable like this:<br /> <br /> <#assign dateFormat = Static["org.opentaps.common.util.UtilDate"].getJsDateTimeFormat(Static["org.opentaps.common.util.UtilDate"].getDateFormat(locale))/><br /> <br /> In opentaps 1.4, you must do it this way:<br /> <br /> <#assign dateFormat = StringUtil.wrapString(Static["org.opentaps.common.util.UtilDate"].getJsDateTimeFormat(Static["org.opentaps.common.util.UtilDate"].getDateFormat(locale)))/><br /> <br /> === BSH embedded in Forms ===<br /> <br /> In Forms widgets you could embed bsh code in order to have more flexibility over the formatting. Those embedded scripts need to be changed to groovy to avoid classpath issues. Fortunately this is as simple as changing the ''${bsh:'' to ''${groovy:''<br /> <br /> For example, in earlier versions, you could transform a party Id into the whole party name:<br /> <br /> <field name="partyId" title="${uiLabelMap.ProductSupplier}"> <br /> <display description="${bsh:org.ofbiz.party.party.PartyHelper.getPartyName(delegator, partyId, false)} (${partyId})"/><br /> </field><br /> <br /> In opentaps 1.4, you must change it to:<br /> <br /> <field name="partyId" title="${uiLabelMap.ProductSupplier}"> <br /> <display description="${groovy:org.ofbiz.party.party.PartyHelper.getPartyName(delegator, partyId, false)} (${partyId})"/><br /> </field><br /> <br /> === UEL in Minilang ===<br /> <br /> The ofbiz framework now supports unified express language (UEL) in the screen widgets and minilang simple methods. (See [http://docs.ofbiz.org/display/OFBTECH/Unified+Expression+Language+%28JSR-245%29+in+OFBiz ofbiz wiki])<br /> <br /> One side effect is that code in simple methods, for example:<br /> someHash.${someVariableAsKey}<br /> <br /> In opentaps 1.4, you must change it to:<br /> someHash[someVariableAsKey]<br /> <br /> === HTML escaping ===<br /> <br /> The ofbiz framework now automatically encodes most of the data displayed on the page. In some cases this is not wanted, and to avoid escaping in form widget use ''encode-output="false"'' in the field element:<br /> <field name="transactionDate" encode-output="false"><date-time/></field><br /> <br /> In the FTL templates use the ''StringUtil'' class:<br /> ${StringUtil.wrapString(someData)}<br /> <br /> Some previous helper methods that constructed HTML code will not work anymore. For example ''PartyHelper.createViewPageLink'' has been replaced with the macro:<br /> <@displayPartyLink partyId=partyId /><br /> <br /> == Internationalization and Translations ==<br /> <br /> In ofbiz09.04, translations are now in XML format instead of .properties. However, the old .properties translations are supported still as well.<br /> <br /> Furthermore, it is possible to define a component with all your translations, instead of putting them into the various existing components. As an example, <tt>hot-deploy/translations</tt> in opentaps contains a full set of translations for opentaps to Bulgarian.<br /> <br /> == Other Changes ==<br /> <br /> In some cases the ''screenlet-title-bar'' used in some ofbiz forms and screens is not wanted, in that case simply wrap the form or screen section in a ''noTitleBar'' div.<br /> <br /> For example ''ViewShipmentRouteInfo.ftl'' defines such a title, to hide it we added to the screen definition:<br /> <br /> <container style="noTitleBar"><br /> <platform-specific><br /> <html><html-template location="component://product/webapp/facility/shipment/ViewShipmentRouteInfo.ftl"/></html><br /> </platform-specific><br /> </container></div>

Spark https://docs.opentaps.org/docs/index.php?title=Upgrading_from_opentaps_1.0_to_opentaps_1.4&diff=5605 Upgrading from opentaps 1.0 to opentaps 1.4 2010-02-27T00:06:41Z

<p>Spark: </p> <hr /> <div>__TOC__<br /> <br /> == Data Changes ==<br /> <br /> * Run the service <tt>opentaps.setSupplementalDataForAllParties</tt> to populate primary contact data for all parties.<br /> * Configuration of GL accounts for invoice writeoffs have been changed. Instead of using <tt>GlAccountTypeDefault</tt>, they are now configured with <tt>InvoiceAdjustmentGlAccount</tt> with the adjustment type "WRITEOFF"<br /> * If you have custom UI labels, they may be loaded by adding them to <tt>LabelConfiguration.properties</tt> in <tt>opentaps-common/config/</tt><br /> ** If previously you were using <tt>UtilMessage.registerLabelMap()</tt> to load custom labels, you may now remove all calls to this function as it is no longer needed.<br /> * Run the upgrade SQL script in hot-deploy/opentaps-common/scripts/sql for the following:<br /> ** <tt>ProductAverageCost</tt> has been re-factored to use a single productAverageCostId as its primary key. The script will alter the table and automatically fill in its values and update <tt>SequenceValueItem</tt> so that opentaps will generate correct future keys.<br /> * Add the following to your custom component's build.xml:<br /> <fileset dir="${ofbiz.dir}/hot-deploy/opentaps-common/lib" includes="*.jar"/><br /> <fileset dir="${ofbiz.dir}/hot-deploy/opentaps-common/lib/hibernate" includes="*.jar"/><br /> * Set <tt>SupplierProduct.supplierPrefOrderId</tt> to '''10_MAIN_SUPPL''' where it is null.<br /> * Run the following services to set summary fields:<br /> ** <tt>recalcAllEmptyAmountsPayments</tt><br /> ** <tt>recalcAllEmptyAmountsInvoices</tt><br /> ** <tt>updatePostedAmountAcctgTrans</tt><br /> * Run the following services to create hibernate index files:<br /> ** <tt>opentaps.createHibernateSearchIndex</tt><br /> * Run the following SQL query to set Invoice.paidDate:<br /> <pre><br /> update INVOICE i set PAID_DATE = (<br /> select paidDate from<br /> (<br /> select max(EFFECTIVE_DATE) paidDate, b.INVOICE_ID from PAYMENT a inner<br /> join PAYMENT_APPLICATION b on a.PAYMENT_ID=b.PAYMENT_ID group by<br /> b.INVOICE_ID<br /> ) p where p.INVOICE_ID = i.INVOICE_ID and i.STATUS_ID='INVOICE_PAID'<br /> );<br /> <br /> </pre><br /> <br /> * Run the ant import ext seed in command window: <br /> <pre><br /> ant run-install-extseed<br /> </pre><br /> == Coding Changes ==<br /> <br /> Changes in the ofbiz framework would require the following changes to your code:<br /> <br /> === URL Parameter Security ===<br /> <br /> You can no longer pass parameters to a service request directly in the URL. These requests must be part of a POST form. To make buttons work as before, you need to change them to forms and then activate them with javascript. For example, in earlier versions, you could have a button to delete a lead like this:<br /> <#assign update_options = update_options + "<a class='subMenuButtonDangerous' <br /> href='deleteLead?leadPartyId=" + partySummary.partyId + "'>" + uiLabelMap.CommonDelete + "</a>" /><br /> <br /> In opentaps 1.4, you must do it this way:<br /> <form name="deleteLeadForm" method="post" action="<@ofbizUrl>deleteLead</@ofbizUrl>"/><br /> <@inputHidden name="leadPartyId" value="${partySummary.partyId}"/><br /> </form><br /> <#assign update_options = update_options + "<a class='subMenuButtonDangerous' <br /> href='javascript:document.deleteLeadForm.submit()'>" + uiLabelMap.CommonDelete + "</a>" /><br /> <br /> For your convenience, there is also a new macro to do this (see ''form'' and ''submitFormLink'' in opentapsFormMacro.ftl):<br /> <@form name="deleteLeadForm" url="deleteLead" leadPartyId=partySummary.partyId /><br /> <#assign update_options>${update_options}<@submitFormLink form="deleteLeadForm" text=uiLabelMap.CommonDelete class="subMenuButtonDangerous" /></#assign><br /> <br /> The ''form'' macro makes hidden inputs for all parameters (except ''name'', ''url'' and ''method'' that are used to define the form element itself), and also accept nested elements for more complex cases.<br /> <br /> For the cases where a form has to be used for multiple items, for example when you have an Update form block which must include multiple remove links, instead of writing a JavaScript handler which passes the item Ids to the form before submitting, you can do:<br /> <br /> <@form name="removeReturnItemAction" url="removeReturnItem" returnId=returnId returnItemSeqId="" /><br /> <@form name="updateReturnItemsAction" url="updateReturnItems" returnId=returnId><br /> <#list returnItems as item><br /> <br /> <@submitFormLinkConfirm form="removeReturnItemAction" text=uiLabelMap.CommonRemove returnItemSeqId=item.returnItemSeqId /><br /> </#list><br /> </@form><br /> <br /> <br /> Also the new ''selectActionForm'' and ''actionForm'' can be used with ''form'' to define a drop-down menu where when an item (''actionForm'') is selected it submits the corresponding ''form'':<br /> <@form name="deleteLeadForm" url="deleteLead" leadPartyId=partySummary.partyId /><br /> <@form ... /><br /> <@selectActionForm name="leadActions" prompt="${uiLabelMap.CommonSelectOne}"><br /> <@actionForm form="deleteLeadForm" text="${uiLabelMap.CommonDelete}"/><br /> <@actionForm .../><br /> <@selectAction/><br /> <br /> === Service and HTML inputs ===<br /> <br /> As a security feature, the services will filter any input with HTML by default. Some services still require HTML (like emails or templates services) and to allow that there is a new ''allow-html'' parameter. For example:<br /> <br /> <attribute name="content" type="String" mode="IN" optional="false" allow-html="safe"/><br /> <override name="mergeFormText" allow-html="safe"/><br /> <br /> === Form Widget Changes ===<br /> <br /> Form widget URL parameters should be specified with <tt>parameter</tt> tag now, instead of in the URL:<br /> <pre><br /> - <hyperlink description="${contactListName} (${contactListId})" target="viewContactList?contactListId=${contactListId}"><br /> + <hyperlink description="${contactListName} (${contactListId})" target="viewContactList"><br /> + <parameter param-name="contactListId" from-field="contactListId"/><br /> </hyperlink><br /> </pre><br /> Do not have it both in the URL and as a <tt>parameter</tt>, or the parameter will be on the form twice and be passed incorrectly.<br /> <br /> === Controller redirects ===<br /> <br /> Redirects have been changed, now ''request-redirect'' will only copy the parameters that were in the URL string by default. To forward posted or service output parameter, use the ''redirect-parameter'' elements (one per parameter).<br /> <response name="success" type="request-redirect" value="viewAccount"><br /> <redirect-parameter name="partyId"/><br /> </response><br /> Also ''request-redirect-filter-param'' is now considered deprecated.<br /> <br /> === Js dateTime format ===<br /> <br /> Js dataTime format in ftl have been changed, now the format will return html encode string which will cause the parse exception, you should use StringUtil.wrapString to avoid this issue. For example, in earlier versions, you could have define a js dataTime format variable like this:<br /> <br /> <#assign dateFormat = Static["org.opentaps.common.util.UtilDate"].getJsDateTimeFormat(Static["org.opentaps.common.util.UtilDate"].getDateFormat(locale))/><br /> <br /> In opentaps 1.4, you must do it this way:<br /> <br /> <#assign dateFormat = StringUtil.wrapString(Static["org.opentaps.common.util.UtilDate"].getJsDateTimeFormat(Static["org.opentaps.common.util.UtilDate"].getDateFormat(locale)))/><br /> <br /> === BSH embedded in Forms ===<br /> <br /> In Forms widgets you could embed bsh code in order to have more flexibility over the formatting. Those embedded scripts need to be changed to groovy to avoid classpath issues. Fortunately this is as simple as changing the ''${bsh:'' to ''${groovy:''<br /> <br /> For example, in earlier versions, you could transform a party Id into the whole party name:<br /> <br /> <field name="partyId" title="${uiLabelMap.ProductSupplier}"> <br /> <display description="${bsh:org.ofbiz.party.party.PartyHelper.getPartyName(delegator, partyId, false)} (${partyId})"/><br /> </field><br /> <br /> In opentaps 1.4, you must change it to:<br /> <br /> <field name="partyId" title="${uiLabelMap.ProductSupplier}"> <br /> <display description="${groovy:org.ofbiz.party.party.PartyHelper.getPartyName(delegator, partyId, false)} (${partyId})"/><br /> </field><br /> <br /> === UEL in Minilang ===<br /> <br /> The ofbiz framework now supports unified express language (UEL) in the screen widgets and minilang simple methods. (See [http://docs.ofbiz.org/display/OFBTECH/Unified+Expression+Language+%28JSR-245%29+in+OFBiz ofbiz wiki])<br /> <br /> One side effect is that code in simple methods, for example:<br /> someHash.${someVariableAsKey}<br /> <br /> In opentaps 1.4, you must change it to:<br /> someHash[someVariableAsKey]<br /> <br /> === HTML escaping ===<br /> <br /> The ofbiz framework now automatically encodes most of the data displayed on the page. In some cases this is not wanted, and to avoid escaping in form widget use ''encode-output="false"'' in the field element:<br /> <field name="transactionDate" encode-output="false"><date-time/></field><br /> <br /> In the FTL templates use the ''StringUtil'' class:<br /> ${StringUtil.wrapString(someData)}<br /> <br /> Some previous helper methods that constructed HTML code will not work anymore. For example ''PartyHelper.createViewPageLink'' has been replaced with the macro:<br /> <@displayPartyLink partyId=partyId /><br /> <br /> == Internationalization and Translations ==<br /> <br /> In ofbiz09.04, translations are now in XML format instead of .properties. However, the old .properties translations are supported still as well.<br /> <br /> Furthermore, it is possible to define a component with all your translations, instead of putting them into the various existing components. As an example, <tt>hot-deploy/translations</tt> in opentaps contains a full set of translations for opentaps to Bulgarian.<br /> <br /> == Other Changes ==<br /> <br /> In some cases the ''screenlet-title-bar'' used in some ofbiz forms and screens is not wanted, in that case simply wrap the form or screen section in a ''noTitleBar'' div.<br /> <br /> For example ''ViewShipmentRouteInfo.ftl'' defines such a title, to hide it we added to the screen definition:<br /> <br /> <container style="noTitleBar"><br /> <platform-specific><br /> <html><html-template location="component://product/webapp/facility/shipment/ViewShipmentRouteInfo.ftl"/></html><br /> </platform-specific><br /> </container></div>

Spark https://docs.opentaps.org/docs/index.php?title=Upgrading_from_opentaps_1.0_to_opentaps_1.4&diff=5516 Upgrading from opentaps 1.0 to opentaps 1.4 2010-02-09T13:04:14Z

<p>Spark: </p> <hr /> <div>__TOC__<br /> <br /> == Data Changes ==<br /> <br /> * Run the service <tt>opentaps.setSupplementalDataForAllParties</tt> to populate primary contact data for all parties.<br /> * Configuration of GL accounts for invoice writeoffs have been changed. Instead of using <tt>GlAccountTypeDefault</tt>, they are now configured with <tt>InvoiceAdjustmentGlAccount</tt> with the adjustment type "WRITEOFF"<br /> * If you have custom UI labels, they may be loaded by adding them to <tt>LabelConfiguration.properties</tt> in <tt>opentaps-common/config/</tt><br /> ** If previously you were using <tt>UtilMessage.registerLabelMap()</tt> to load custom labels, you may now remove all calls to this function as it is no longer needed.<br /> * Run the upgrade SQL script in hot-deploy/opentaps-common/scripts/sql for the following:<br /> * (graciousstyle only) Run the upgrade SQL script inhot-deploy/graciousstyle/scripts/sql<br /> ** <tt>ProductAverageCost</tt> has been re-factored to use a single productAverageCostId as its primary key. The script will alter the table and automatically fill in its values and update <tt>SequenceValueItem</tt> so that opentaps will generate correct future keys.<br /> * Add the following to your custom component's build.xml:<br /> <fileset dir="${ofbiz.dir}/hot-deploy/opentaps-common/lib" includes="*.jar"/><br /> <fileset dir="${ofbiz.dir}/hot-deploy/opentaps-common/lib/hibernate" includes="*.jar"/><br /> * Set <tt>SupplierProduct.supplierPrefOrderId</tt> to '''10_MAIN_SUPPL''' where it is null.<br /> * Run the following services to set summary fields:<br /> ** <tt>recalcAllEmptyAmountsPayments</tt><br /> ** <tt>recalcAllEmptyAmountsInvoices</tt><br /> ** <tt>updatePostedAmountAcctgTrans</tt><br /> ** <tt>(graciousstyle only) opentaps.convertOfbizParties</tt><br /> * Run the following SQL query to set Invoice.paidDate:<br /> <pre><br /> update INVOICE i set PAID_DATE = (<br /> select paidDate from<br /> (<br /> select max(EFFECTIVE_DATE) paidDate, b.INVOICE_ID from PAYMENT a inner<br /> join PAYMENT_APPLICATION b on a.PAYMENT_ID=b.PAYMENT_ID group by<br /> b.INVOICE_ID<br /> ) p where p.INVOICE_ID = i.INVOICE_ID and i.STATUS_ID='INVOICE_PAID'<br /> );<br /> <br /> </pre><br /> <br /> * Run the ant import ext seed in command window: <br /> <pre><br /> ant run-install-extseed<br /> </pre><br /> == Coding Changes ==<br /> <br /> Changes in the ofbiz framework would require the following changes to your code:<br /> <br /> === URL Parameter Security ===<br /> <br /> You can no longer pass parameters to a service request directly in the URL. These requests must be part of a POST form. To make buttons work as before, you need to change them to forms and then activate them with javascript. For example, in earlier versions, you could have a button to delete a lead like this:<br /> <#assign update_options = update_options + "<a class='subMenuButtonDangerous' <br /> href='deleteLead?leadPartyId=" + partySummary.partyId + "'>" + uiLabelMap.CommonDelete + "</a>" /><br /> <br /> In opentaps 1.4, you must do it this way:<br /> <form name="deleteLeadForm" method="post" action="<@ofbizUrl>deleteLead</@ofbizUrl>"/><br /> <@inputHidden name="leadPartyId" value="${partySummary.partyId}"/><br /> </form><br /> <#assign update_options = update_options + "<a class='subMenuButtonDangerous' <br /> href='javascript:document.deleteLeadForm.submit()'>" + uiLabelMap.CommonDelete + "</a>" /><br /> <br /> For your convenience, there is also a new macro to do this (see ''form'' and ''submitFormLink'' in opentapsFormMacro.ftl):<br /> <@form name="deleteLeadForm" url="deleteLead" leadPartyId=partySummary.partyId /><br /> <#assign update_options>${update_options}<@submitFormLink form="deleteLeadForm" text=uiLabelMap.CommonDelete class="subMenuButtonDangerous" /></#assign><br /> <br /> The ''form'' macro makes hidden inputs for all parameters (except ''name'', ''url'' and ''method'' that are used to define the form element itself), and also accept nested elements for more complex cases.<br /> <br /> For the cases where a form has to be used for multiple items, for example when you have an Update form block which must include multiple remove links, instead of writing a JavaScript handler which passes the item Ids to the form before submitting, you can do:<br /> <br /> <@form name="removeReturnItemAction" url="removeReturnItem" returnId=returnId returnItemSeqId="" /><br /> <@form name="updateReturnItemsAction" url="updateReturnItems" returnId=returnId><br /> <#list returnItems as item><br /> <br /> <@submitFormLinkConfirm form="removeReturnItemAction" text=uiLabelMap.CommonRemove returnItemSeqId=item.returnItemSeqId /><br /> </#list><br /> </@form><br /> <br /> <br /> Also the new ''selectActionForm'' and ''actionForm'' can be used with ''form'' to define a drop-down menu where when an item (''actionForm'') is selected it submits the corresponding ''form'':<br /> <@form name="deleteLeadForm" url="deleteLead" leadPartyId=partySummary.partyId /><br /> <@form ... /><br /> <@selectActionForm name="leadActions" prompt="${uiLabelMap.CommonSelectOne}"><br /> <@actionForm form="deleteLeadForm" text="${uiLabelMap.CommonDelete}"/><br /> <@actionForm .../><br /> <@selectAction/><br /> <br /> === Service and HTML inputs ===<br /> <br /> As a security feature, the services will filter any input with HTML by default. Some services still require HTML (like emails or templates services) and to allow that there is a new ''allow-html'' parameter. For example:<br /> <br /> <attribute name="content" type="String" mode="IN" optional="false" allow-html="safe"/><br /> <override name="mergeFormText" allow-html="safe"/><br /> <br /> === Form Widget Changes ===<br /> <br /> Form widget URL parameters should be specified with <tt>parameter</tt> tag now, instead of in the URL:<br /> <pre><br /> - <hyperlink description="${contactListName} (${contactListId})" target="viewContactList?contactListId=${contactListId}"><br /> + <hyperlink description="${contactListName} (${contactListId})" target="viewContactList"><br /> + <parameter param-name="contactListId" from-field="contactListId"/><br /> </hyperlink><br /> </pre><br /> Do not have it both in the URL and as a <tt>parameter</tt>, or the parameter will be on the form twice and be passed incorrectly.<br /> <br /> === Controller redirects ===<br /> <br /> Redirects have been changed, now ''request-redirect'' will only copy the parameters that were in the URL string by default. To forward posted or service output parameter, use the ''redirect-parameter'' elements (one per parameter).<br /> <response name="success" type="request-redirect" value="viewAccount"><br /> <redirect-parameter name="partyId"/><br /> </response><br /> Also ''request-redirect-filter-param'' is now considered deprecated.<br /> <br /> === Js dateTime format ===<br /> <br /> Js dataTime format in ftl have been changed, now the format will return html encode string which will cause the parse exception, you should use StringUtil.wrapString to avoid this issue. For example, in earlier versions, you could have define a js dataTime format variable like this:<br /> <br /> <#assign dateFormat = Static["org.opentaps.common.util.UtilDate"].getJsDateTimeFormat(Static["org.opentaps.common.util.UtilDate"].getDateFormat(locale))/><br /> <br /> In opentaps 1.4, you must do it this way:<br /> <br /> <#assign dateFormat = StringUtil.wrapString(Static["org.opentaps.common.util.UtilDate"].getJsDateTimeFormat(Static["org.opentaps.common.util.UtilDate"].getDateFormat(locale)))/><br /> <br /> === BSH embedded in Forms ===<br /> <br /> In Forms widgets you could embed bsh code in order to have more flexibility over the formatting. Those embedded scripts need to be changed to groovy to avoid classpath issues. Fortunately this is as simple as changing the ''${bsh:'' to ''${groovy:''<br /> <br /> For example, in earlier versions, you could transform a party Id into the whole party name:<br /> <br /> <field name="partyId" title="${uiLabelMap.ProductSupplier}"> <br /> <display description="${bsh:org.ofbiz.party.party.PartyHelper.getPartyName(delegator, partyId, false)} (${partyId})"/><br /> </field><br /> <br /> In opentaps 1.4, you must change it to:<br /> <br /> <field name="partyId" title="${uiLabelMap.ProductSupplier}"> <br /> <display description="${groovy:org.ofbiz.party.party.PartyHelper.getPartyName(delegator, partyId, false)} (${partyId})"/><br /> </field><br /> <br /> === UEL in Minilang ===<br /> <br /> The ofbiz framework now supports unified express language (UEL) in the screen widgets and minilang simple methods. (See [http://docs.ofbiz.org/display/OFBTECH/Unified+Expression+Language+%28JSR-245%29+in+OFBiz ofbiz wiki])<br /> <br /> One side effect is that code in simple methods, for example:<br /> someHash.${someVariableAsKey}<br /> <br /> In opentaps 1.4, you must change it to:<br /> someHash[someVariableAsKey]<br /> <br /> === HTML escaping ===<br /> <br /> The ofbiz framework now automatically encodes most of the data displayed on the page. In some cases this is not wanted, and to avoid escaping in form widget use ''encode-output="false"'' in the field element:<br /> <field name="transactionDate" encode-output="false"><date-time/></field><br /> <br /> In the FTL templates use the ''StringUtil'' class:<br /> ${StringUtil.wrapString(someData)}<br /> <br /> Some previous helper methods that constructed HTML code will not work anymore. For example ''PartyHelper.createViewPageLink'' has been replaced with the macro:<br /> <@displayPartyLink partyId=partyId /><br /> <br /> == Internationalization and Translations ==<br /> <br /> In ofbiz09.04, translations are now in XML format instead of .properties. However, the old .properties translations are supported still as well.<br /> <br /> Furthermore, it is possible to define a component with all your translations, instead of putting them into the various existing components. As an example, <tt>hot-deploy/translations</tt> in opentaps contains a full set of translations for opentaps to Bulgarian.<br /> <br /> == Other Changes ==<br /> <br /> In some cases the ''screenlet-title-bar'' used in some ofbiz forms and screens is not wanted, in that case simply wrap the form or screen section in a ''noTitleBar'' div.<br /> <br /> For example ''ViewShipmentRouteInfo.ftl'' defines such a title, to hide it we added to the screen definition:<br /> <br /> <container style="noTitleBar"><br /> <platform-specific><br /> <html><html-template location="component://product/webapp/facility/shipment/ViewShipmentRouteInfo.ftl"/></html><br /> </platform-specific><br /> </container></div>

Spark https://docs.opentaps.org/docs/index.php?title=Upgrading_from_opentaps_1.0_to_opentaps_1.4&diff=5515 Upgrading from opentaps 1.0 to opentaps 1.4 2010-02-09T11:17:32Z

<p>Spark: </p> <hr /> <div>__TOC__<br /> <br /> == Data Changes ==<br /> <br /> * Run the service <tt>opentaps.setSupplementalDataForAllParties</tt> to populate primary contact data for all parties.<br /> * Configuration of GL accounts for invoice writeoffs have been changed. Instead of using <tt>GlAccountTypeDefault</tt>, they are now configured with <tt>InvoiceAdjustmentGlAccount</tt> with the adjustment type "WRITEOFF"<br /> * If you have custom UI labels, they may be loaded by adding them to <tt>LabelConfiguration.properties</tt> in <tt>opentaps-common/config/</tt><br /> ** If previously you were using <tt>UtilMessage.registerLabelMap()</tt> to load custom labels, you may now remove all calls to this function as it is no longer needed.<br /> * Run the upgrade SQL script in hot-deploy/opentaps-common/scripts/sql for the following:<br /> ** <tt>ProductAverageCost</tt> has been re-factored to use a single productAverageCostId as its primary key. The script will alter the table and automatically fill in its values and update <tt>SequenceValueItem</tt> so that opentaps will generate correct future keys.<br /> * Add the following to your custom component's build.xml:<br /> <fileset dir="${ofbiz.dir}/hot-deploy/opentaps-common/lib" includes="*.jar"/><br /> <fileset dir="${ofbiz.dir}/hot-deploy/opentaps-common/lib/hibernate" includes="*.jar"/><br /> * Set <tt>SupplierProduct.supplierPrefOrderId</tt> to '''10_MAIN_SUPPL''' where it is null.<br /> * Run the following services to set summary fields:<br /> ** <tt>recalcAllEmptyAmountsPayments</tt><br /> ** <tt>recalcAllEmptyAmountsInvoices</tt><br /> ** <tt>updatePostedAmountAcctgTrans</tt><br /> * Run the following SQL query to set Invoice.paidDate:<br /> <pre><br /> update INVOICE i set PAID_DATE = (<br /> select paidDate from<br /> (<br /> select max(EFFECTIVE_DATE) paidDate, b.INVOICE_ID from PAYMENT a inner<br /> join PAYMENT_APPLICATION b on a.PAYMENT_ID=b.PAYMENT_ID group by<br /> b.INVOICE_ID<br /> ) p where p.INVOICE_ID = i.INVOICE_ID and i.STATUS_ID='INVOICE_PAID'<br /> );<br /> <br /> </pre><br /> <br /> * Run the ant import ext seed in command window: <br /> <pre><br /> ant run-install-extseed<br /> </pre><br /> == Coding Changes ==<br /> <br /> Changes in the ofbiz framework would require the following changes to your code:<br /> <br /> === URL Parameter Security ===<br /> <br /> You can no longer pass parameters to a service request directly in the URL. These requests must be part of a POST form. To make buttons work as before, you need to change them to forms and then activate them with javascript. For example, in earlier versions, you could have a button to delete a lead like this:<br /> <#assign update_options = update_options + "<a class='subMenuButtonDangerous' <br /> href='deleteLead?leadPartyId=" + partySummary.partyId + "'>" + uiLabelMap.CommonDelete + "</a>" /><br /> <br /> In opentaps 1.4, you must do it this way:<br /> <form name="deleteLeadForm" method="post" action="<@ofbizUrl>deleteLead</@ofbizUrl>"/><br /> <@inputHidden name="leadPartyId" value="${partySummary.partyId}"/><br /> </form><br /> <#assign update_options = update_options + "<a class='subMenuButtonDangerous' <br /> href='javascript:document.deleteLeadForm.submit()'>" + uiLabelMap.CommonDelete + "</a>" /><br /> <br /> For your convenience, there is also a new macro to do this (see ''form'' and ''submitFormLink'' in opentapsFormMacro.ftl):<br /> <@form name="deleteLeadForm" url="deleteLead" leadPartyId=partySummary.partyId /><br /> <#assign update_options>${update_options}<@submitFormLink form="deleteLeadForm" text=uiLabelMap.CommonDelete class="subMenuButtonDangerous" /></#assign><br /> <br /> The ''form'' macro makes hidden inputs for all parameters (except ''name'', ''url'' and ''method'' that are used to define the form element itself), and also accept nested elements for more complex cases.<br /> <br /> For the cases where a form has to be used for multiple items, for example when you have an Update form block which must include multiple remove links, instead of writing a JavaScript handler which passes the item Ids to the form before submitting, you can do:<br /> <br /> <@form name="removeReturnItemAction" url="removeReturnItem" returnId=returnId returnItemSeqId="" /><br /> <@form name="updateReturnItemsAction" url="updateReturnItems" returnId=returnId><br /> <#list returnItems as item><br /> <br /> <@submitFormLinkConfirm form="removeReturnItemAction" text=uiLabelMap.CommonRemove returnItemSeqId=item.returnItemSeqId /><br /> </#list><br /> </@form><br /> <br /> <br /> Also the new ''selectActionForm'' and ''actionForm'' can be used with ''form'' to define a drop-down menu where when an item (''actionForm'') is selected it submits the corresponding ''form'':<br /> <@form name="deleteLeadForm" url="deleteLead" leadPartyId=partySummary.partyId /><br /> <@form ... /><br /> <@selectActionForm name="leadActions" prompt="${uiLabelMap.CommonSelectOne}"><br /> <@actionForm form="deleteLeadForm" text="${uiLabelMap.CommonDelete}"/><br /> <@actionForm .../><br /> <@selectAction/><br /> <br /> === Service and HTML inputs ===<br /> <br /> As a security feature, the services will filter any input with HTML by default. Some services still require HTML (like emails or templates services) and to allow that there is a new ''allow-html'' parameter. For example:<br /> <br /> <attribute name="content" type="String" mode="IN" optional="false" allow-html="safe"/><br /> <override name="mergeFormText" allow-html="safe"/><br /> <br /> === Form Widget Changes ===<br /> <br /> Form widget URL parameters should be specified with <tt>parameter</tt> tag now, instead of in the URL:<br /> <pre><br /> - <hyperlink description="${contactListName} (${contactListId})" target="viewContactList?contactListId=${contactListId}"><br /> + <hyperlink description="${contactListName} (${contactListId})" target="viewContactList"><br /> + <parameter param-name="contactListId" from-field="contactListId"/><br /> </hyperlink><br /> </pre><br /> Do not have it both in the URL and as a <tt>parameter</tt>, or the parameter will be on the form twice and be passed incorrectly.<br /> <br /> === Controller redirects ===<br /> <br /> Redirects have been changed, now ''request-redirect'' will only copy the parameters that were in the URL string by default. To forward posted or service output parameter, use the ''redirect-parameter'' elements (one per parameter).<br /> <response name="success" type="request-redirect" value="viewAccount"><br /> <redirect-parameter name="partyId"/><br /> </response><br /> Also ''request-redirect-filter-param'' is now considered deprecated.<br /> <br /> === Js dateTime format ===<br /> <br /> Js dataTime format in ftl have been changed, now the format will return html encode string which will cause the parse exception, you should use StringUtil.wrapString to avoid this issue. For example, in earlier versions, you could have define a js dataTime format variable like this:<br /> <br /> <#assign dateFormat = Static["org.opentaps.common.util.UtilDate"].getJsDateTimeFormat(Static["org.opentaps.common.util.UtilDate"].getDateFormat(locale))/><br /> <br /> In opentaps 1.4, you must do it this way:<br /> <br /> <#assign dateFormat = StringUtil.wrapString(Static["org.opentaps.common.util.UtilDate"].getJsDateTimeFormat(Static["org.opentaps.common.util.UtilDate"].getDateFormat(locale)))/><br /> <br /> === BSH embedded in Forms ===<br /> <br /> In Forms widgets you could embed bsh code in order to have more flexibility over the formatting. Those embedded scripts need to be changed to groovy to avoid classpath issues. Fortunately this is as simple as changing the ''${bsh:'' to ''${groovy:''<br /> <br /> For example, in earlier versions, you could transform a party Id into the whole party name:<br /> <br /> <field name="partyId" title="${uiLabelMap.ProductSupplier}"> <br /> <display description="${bsh:org.ofbiz.party.party.PartyHelper.getPartyName(delegator, partyId, false)} (${partyId})"/><br /> </field><br /> <br /> In opentaps 1.4, you must change it to:<br /> <br /> <field name="partyId" title="${uiLabelMap.ProductSupplier}"> <br /> <display description="${groovy:org.ofbiz.party.party.PartyHelper.getPartyName(delegator, partyId, false)} (${partyId})"/><br /> </field><br /> <br /> === UEL in Minilang ===<br /> <br /> The ofbiz framework now supports unified express language (UEL) in the screen widgets and minilang simple methods. (See [http://docs.ofbiz.org/display/OFBTECH/Unified+Expression+Language+%28JSR-245%29+in+OFBiz ofbiz wiki])<br /> <br /> One side effect is that code in simple methods, for example:<br /> someHash.${someVariableAsKey}<br /> <br /> In opentaps 1.4, you must change it to:<br /> someHash[someVariableAsKey]<br /> <br /> === HTML escaping ===<br /> <br /> The ofbiz framework now automatically encodes most of the data displayed on the page. In some cases this is not wanted, and to avoid escaping in form widget use ''encode-output="false"'' in the field element:<br /> <field name="transactionDate" encode-output="false"><date-time/></field><br /> <br /> In the FTL templates use the ''StringUtil'' class:<br /> ${StringUtil.wrapString(someData)}<br /> <br /> Some previous helper methods that constructed HTML code will not work anymore. For example ''PartyHelper.createViewPageLink'' has been replaced with the macro:<br /> <@displayPartyLink partyId=partyId /><br /> <br /> == Internationalization and Translations ==<br /> <br /> In ofbiz09.04, translations are now in XML format instead of .properties. However, the old .properties translations are supported still as well.<br /> <br /> Furthermore, it is possible to define a component with all your translations, instead of putting them into the various existing components. As an example, <tt>hot-deploy/translations</tt> in opentaps contains a full set of translations for opentaps to Bulgarian.<br /> <br /> == Other Changes ==<br /> <br /> In some cases the ''screenlet-title-bar'' used in some ofbiz forms and screens is not wanted, in that case simply wrap the form or screen section in a ''noTitleBar'' div.<br /> <br /> For example ''ViewShipmentRouteInfo.ftl'' defines such a title, to hide it we added to the screen definition:<br /> <br /> <container style="noTitleBar"><br /> <platform-specific><br /> <html><html-template location="component://product/webapp/facility/shipment/ViewShipmentRouteInfo.ftl"/></html><br /> </platform-specific><br /> </container></div>

Spark https://docs.opentaps.org/docs/index.php?title=Upgrading_from_opentaps_1.0_to_opentaps_1.4&diff=5514 Upgrading from opentaps 1.0 to opentaps 1.4 2010-02-09T11:16:29Z

<p>Spark: </p> <hr /> <div>__TOC__<br /> <br /> == Data Changes ==<br /> <br /> * Run the service <tt>opentaps.setSupplementalDataForAllParties</tt> to populate primary contact data for all parties.<br /> * Configuration of GL accounts for invoice writeoffs have been changed. Instead of using <tt>GlAccountTypeDefault</tt>, they are now configured with <tt>InvoiceAdjustmentGlAccount</tt> with the adjustment type "WRITEOFF"<br /> * If you have custom UI labels, they may be loaded by adding them to <tt>LabelConfiguration.properties</tt> in <tt>opentaps-common/config/</tt><br /> ** If previously you were using <tt>UtilMessage.registerLabelMap()</tt> to load custom labels, you may now remove all calls to this function as it is no longer needed.<br /> * Run the upgrade SQL script in hot-deploy/opentaps-common/scripts/sql for the following:<br /> ** <tt>ProductAverageCost</tt> has been re-factored to use a single productAverageCostId as its primary key. The script will alter the table and automatically fill in its values and update <tt>SequenceValueItem</tt> so that opentaps will generate correct future keys.<br /> * Add the following to your custom component's build.xml:<br /> <fileset dir="${ofbiz.dir}/hot-deploy/opentaps-common/lib" includes="*.jar"/><br /> <fileset dir="${ofbiz.dir}/hot-deploy/opentaps-common/lib/hibernate" includes="*.jar"/><br /> * Set <tt>SupplierProduct.supplierPrefOrderId</tt> to '''10_MAIN_SUPPL''' where it is null.<br /> * Run the following services to set summary fields:<br /> ** <tt>recalcAllEmptyAmountsPayments</tt><br /> ** <tt>recalcAllEmptyAmountsInvoices</tt><br /> ** <tt>updatePostedAmountAcctgTrans</tt><br /> * Run the following SQL query to set Invoice.paidDate:<br /> <pre><br /> update INVOICE i set PAID_DATE = (<br /> select paidDate from<br /> (<br /> select max(EFFECTIVE_DATE) paidDate, b.INVOICE_ID from PAYMENT a inner<br /> join PAYMENT_APPLICATION b on a.PAYMENT_ID=b.PAYMENT_ID group by<br /> b.INVOICE_ID<br /> ) p where p.INVOICE_ID = i.INVOICE_ID and i.STATUS_ID='INVOICE_PAID'<br /> );<br /> <br /> </pre><br /> <br /> * Run the ant import ext seed in command window: <br /> ant run-install-extseed<br /> <br /> == Coding Changes ==<br /> <br /> Changes in the ofbiz framework would require the following changes to your code:<br /> <br /> === URL Parameter Security ===<br /> <br /> You can no longer pass parameters to a service request directly in the URL. These requests must be part of a POST form. To make buttons work as before, you need to change them to forms and then activate them with javascript. For example, in earlier versions, you could have a button to delete a lead like this:<br /> <#assign update_options = update_options + "<a class='subMenuButtonDangerous' <br /> href='deleteLead?leadPartyId=" + partySummary.partyId + "'>" + uiLabelMap.CommonDelete + "</a>" /><br /> <br /> In opentaps 1.4, you must do it this way:<br /> <form name="deleteLeadForm" method="post" action="<@ofbizUrl>deleteLead</@ofbizUrl>"/><br /> <@inputHidden name="leadPartyId" value="${partySummary.partyId}"/><br /> </form><br /> <#assign update_options = update_options + "<a class='subMenuButtonDangerous' <br /> href='javascript:document.deleteLeadForm.submit()'>" + uiLabelMap.CommonDelete + "</a>" /><br /> <br /> For your convenience, there is also a new macro to do this (see ''form'' and ''submitFormLink'' in opentapsFormMacro.ftl):<br /> <@form name="deleteLeadForm" url="deleteLead" leadPartyId=partySummary.partyId /><br /> <#assign update_options>${update_options}<@submitFormLink form="deleteLeadForm" text=uiLabelMap.CommonDelete class="subMenuButtonDangerous" /></#assign><br /> <br /> The ''form'' macro makes hidden inputs for all parameters (except ''name'', ''url'' and ''method'' that are used to define the form element itself), and also accept nested elements for more complex cases.<br /> <br /> For the cases where a form has to be used for multiple items, for example when you have an Update form block which must include multiple remove links, instead of writing a JavaScript handler which passes the item Ids to the form before submitting, you can do:<br /> <br /> <@form name="removeReturnItemAction" url="removeReturnItem" returnId=returnId returnItemSeqId="" /><br /> <@form name="updateReturnItemsAction" url="updateReturnItems" returnId=returnId><br /> <#list returnItems as item><br /> <br /> <@submitFormLinkConfirm form="removeReturnItemAction" text=uiLabelMap.CommonRemove returnItemSeqId=item.returnItemSeqId /><br /> </#list><br /> </@form><br /> <br /> <br /> Also the new ''selectActionForm'' and ''actionForm'' can be used with ''form'' to define a drop-down menu where when an item (''actionForm'') is selected it submits the corresponding ''form'':<br /> <@form name="deleteLeadForm" url="deleteLead" leadPartyId=partySummary.partyId /><br /> <@form ... /><br /> <@selectActionForm name="leadActions" prompt="${uiLabelMap.CommonSelectOne}"><br /> <@actionForm form="deleteLeadForm" text="${uiLabelMap.CommonDelete}"/><br /> <@actionForm .../><br /> <@selectAction/><br /> <br /> === Service and HTML inputs ===<br /> <br /> As a security feature, the services will filter any input with HTML by default. Some services still require HTML (like emails or templates services) and to allow that there is a new ''allow-html'' parameter. For example:<br /> <br /> <attribute name="content" type="String" mode="IN" optional="false" allow-html="safe"/><br /> <override name="mergeFormText" allow-html="safe"/><br /> <br /> === Form Widget Changes ===<br /> <br /> Form widget URL parameters should be specified with <tt>parameter</tt> tag now, instead of in the URL:<br /> <pre><br /> - <hyperlink description="${contactListName} (${contactListId})" target="viewContactList?contactListId=${contactListId}"><br /> + <hyperlink description="${contactListName} (${contactListId})" target="viewContactList"><br /> + <parameter param-name="contactListId" from-field="contactListId"/><br /> </hyperlink><br /> </pre><br /> Do not have it both in the URL and as a <tt>parameter</tt>, or the parameter will be on the form twice and be passed incorrectly.<br /> <br /> === Controller redirects ===<br /> <br /> Redirects have been changed, now ''request-redirect'' will only copy the parameters that were in the URL string by default. To forward posted or service output parameter, use the ''redirect-parameter'' elements (one per parameter).<br /> <response name="success" type="request-redirect" value="viewAccount"><br /> <redirect-parameter name="partyId"/><br /> </response><br /> Also ''request-redirect-filter-param'' is now considered deprecated.<br /> <br /> === Js dateTime format ===<br /> <br /> Js dataTime format in ftl have been changed, now the format will return html encode string which will cause the parse exception, you should use StringUtil.wrapString to avoid this issue. For example, in earlier versions, you could have define a js dataTime format variable like this:<br /> <br /> <#assign dateFormat = Static["org.opentaps.common.util.UtilDate"].getJsDateTimeFormat(Static["org.opentaps.common.util.UtilDate"].getDateFormat(locale))/><br /> <br /> In opentaps 1.4, you must do it this way:<br /> <br /> <#assign dateFormat = StringUtil.wrapString(Static["org.opentaps.common.util.UtilDate"].getJsDateTimeFormat(Static["org.opentaps.common.util.UtilDate"].getDateFormat(locale)))/><br /> <br /> === BSH embedded in Forms ===<br /> <br /> In Forms widgets you could embed bsh code in order to have more flexibility over the formatting. Those embedded scripts need to be changed to groovy to avoid classpath issues. Fortunately this is as simple as changing the ''${bsh:'' to ''${groovy:''<br /> <br /> For example, in earlier versions, you could transform a party Id into the whole party name:<br /> <br /> <field name="partyId" title="${uiLabelMap.ProductSupplier}"> <br /> <display description="${bsh:org.ofbiz.party.party.PartyHelper.getPartyName(delegator, partyId, false)} (${partyId})"/><br /> </field><br /> <br /> In opentaps 1.4, you must change it to:<br /> <br /> <field name="partyId" title="${uiLabelMap.ProductSupplier}"> <br /> <display description="${groovy:org.ofbiz.party.party.PartyHelper.getPartyName(delegator, partyId, false)} (${partyId})"/><br /> </field><br /> <br /> === UEL in Minilang ===<br /> <br /> The ofbiz framework now supports unified express language (UEL) in the screen widgets and minilang simple methods. (See [http://docs.ofbiz.org/display/OFBTECH/Unified+Expression+Language+%28JSR-245%29+in+OFBiz ofbiz wiki])<br /> <br /> One side effect is that code in simple methods, for example:<br /> someHash.${someVariableAsKey}<br /> <br /> In opentaps 1.4, you must change it to:<br /> someHash[someVariableAsKey]<br /> <br /> === HTML escaping ===<br /> <br /> The ofbiz framework now automatically encodes most of the data displayed on the page. In some cases this is not wanted, and to avoid escaping in form widget use ''encode-output="false"'' in the field element:<br /> <field name="transactionDate" encode-output="false"><date-time/></field><br /> <br /> In the FTL templates use the ''StringUtil'' class:<br /> ${StringUtil.wrapString(someData)}<br /> <br /> Some previous helper methods that constructed HTML code will not work anymore. For example ''PartyHelper.createViewPageLink'' has been replaced with the macro:<br /> <@displayPartyLink partyId=partyId /><br /> <br /> == Internationalization and Translations ==<br /> <br /> In ofbiz09.04, translations are now in XML format instead of .properties. However, the old .properties translations are supported still as well.<br /> <br /> Furthermore, it is possible to define a component with all your translations, instead of putting them into the various existing components. As an example, <tt>hot-deploy/translations</tt> in opentaps contains a full set of translations for opentaps to Bulgarian.<br /> <br /> == Other Changes ==<br /> <br /> In some cases the ''screenlet-title-bar'' used in some ofbiz forms and screens is not wanted, in that case simply wrap the form or screen section in a ''noTitleBar'' div.<br /> <br /> For example ''ViewShipmentRouteInfo.ftl'' defines such a title, to hide it we added to the screen definition:<br /> <br /> <container style="noTitleBar"><br /> <platform-specific><br /> <html><html-template location="component://product/webapp/facility/shipment/ViewShipmentRouteInfo.ftl"/></html><br /> </platform-specific><br /> </container></div>

Spark https://docs.opentaps.org/docs/index.php?title=Opentaps_Funambol_Setup&diff=5256 Opentaps Funambol Setup 2009-12-29T00:56:43Z

<p>Spark: /* Synchronising Opentaps and Windows Mobile */</p> <hr /> <div>There are currently extensive instructions available in hot-deploy/funambol/docs/man. These documents will be moved at some point to this site.<br /> <br /> ===Troubleshooting the Funambol Component===<br /> <br /> The log file for the Funambol component is in hot-deploy/funambol/logs/funambol_ds.log<br /> <br /> ===Setting up the Funambol server in Opentaps===<br /> <br /> The document which explains how to set up the funambol server is hot-deploy/funambol/docs/man/otfm_admin_guide.doc<br /> <br /> After following this steps, you should have a complete funambol server working.<br /> <br /> ===Synchronising Opentaps and Mozilla Thunderbird===<br /> <br /> Hosting: http://sourceforge.net/projects/sync4jmozilla<br /> <br /> Configuration to synchronise with the admin account with opentaps and<br /> mozilla thunderbird on the same computer:<br /> <br /> Edit --> Preferences --> Funambol<br /> <br /> Account<br /> server URL: http://127.0.0.1:8080/funambol/ds<br /> Username: admin<br /> Password: ofbiz<br /> <br /> Synchronize<br /> Items --> Contact --> Details<br /> <br /> Select the addressbook to sync<br /> Remote name: otcontact<br /> <br /> If you have the extension Lightning, you can also synchronise your calendar. I recommand to install the extension Provider for google calendar as well, so you can export items from Thunderbird to Google Calendar.<br /> <br /> Synchronize<br /> Items --> Calendar --> Details<br /> <br /> Select the Calendar to sync<br /> Remote name: otcalendar<br /> <br /> ===Synchronising Opentaps and Outlook===<br /> <br /> In case you are using windows 2000, you have to use the funambol outlook plugin 3.0.15<br /> But this plugin can't synchronise contacts with the funambol version 6 which is included in opentaps.<br /> You'll be able to synchronise tasks and calendar only.<br /> <br /> To install this plugin, you have to follow the instruction in the document http://download.forge.objectweb.org/sync4j/Outlook_Plugin_UG.pdf<br /> <br /> Configuration to synchronise with the admin account with opentaps and<br /> outlook plugin on the same computer:<br /> <br /> Edit --> Communication Settings<br /> SyncServer URL: http://127.0.0.1:8080/funambol/ds<br /> Username: admin<br /> Password: ofbiz<br /> <br /> Edit --> Synchronisation Settings<br /> Activate synchronisation with Contacts, Calendar, Tasks<br /> Remote Settings:<br /> Contact Name otcontact<br /> Calendar Name otcalendar<br /> Task Name ottask<br /> <br /> Hit the Synchronize button.<br /> <br /> ===Synchronising Opentaps and Gmail===<br /> <br /> Hosting: https://google-connector.forge.funambol.org/<br /> <br /> The version tested is 1.2.0 beta1.<br /> <br /> Edit --> Communication Settings<br /> Server URL: http://127.0.0.1:8080/funambol/ds<br /> FunambolUsername: admin<br /> FunambolPassword: ofbiz<br /> Gmail Username: myuserIdongmail<br /> Gmail Password: mypasswordongmail<br /> <br /> Edit --> Synchronisation Settings<br /> Activate synchronisation with Contacts, Calendar<br /> Remote Settings: <br /> Contact Name otcontact<br /> Calendar Name otcalendar<br /> <br /> ===Synchronising Opentaps and Yahoo===<br /> <br /> Hosting: http://sourceforge.net/projects/funambolyahoo/<br /> <br /> Edit --> Communication Settings<br /> Server URL: http://127.0.0.1:8080/funambol/ds<br /> FunambolUsername: admin<br /> FunambolPassword: ofbiz<br /> Yahoo Username: myuserIdonyahoo<br /> Yahoo Password: mypasswordonyahoo<br /> <br /> Edit --> Synchronisation Settings<br /> Activate synchronisation with Contacts<br /> <br /> The synchronisation with Calendar doesn't work, because yahoo connector use calendar in Vcalendar format only and opentaps send the calendar in sif format. Please don't activate it.<br /> <br /> Remote Settings:<br /> Contact Name otcontact<br /> Calendar Name otcalendar<br /> <br /> ===Synchronising Opentaps and Skype===<br /> <br /> Hosting: http://sourceforge.net/projects/funambolskype/<br /> <br /> There is currently no release either commit on svn on this project.<br /> <br /> ===Synchronising Opentaps and Windows Mobile ===<br /> <br /> In case you are using windows, you have to use the funambol windows mobile sync client, you can download the version which fit your mobile at https://www.forge.funambol.org/download/.<br /> <br /> After install the sync client to your mobile, we can do following steps to configure it to connect with opentaps.<br /> <br /> Menu --> Accout<br /> Server location: http://[yourserverip]:8080/funambol/ds<br /> Username: admin<br /> Password: ofbiz<br /> <br /> Menu --> Settings<br /> Activate synchronisation with Contacts, Calendar, Tasks<br /> <br /> Menu --> Settings --> Advanced<br /> Remote Name:<br /> Contacts otcontact<br /> Calendar otcalendar<br /> Tasks ottask<br /> <br /> then, Hit the Sync All button.</div>

Spark https://docs.opentaps.org/docs/index.php?title=Opentaps_Funambol_Setup&diff=5255 Opentaps Funambol Setup 2009-12-29T00:56:05Z

<p>Spark: </p> <hr /> <div>There are currently extensive instructions available in hot-deploy/funambol/docs/man. These documents will be moved at some point to this site.<br /> <br /> ===Troubleshooting the Funambol Component===<br /> <br /> The log file for the Funambol component is in hot-deploy/funambol/logs/funambol_ds.log<br /> <br /> ===Setting up the Funambol server in Opentaps===<br /> <br /> The document which explains how to set up the funambol server is hot-deploy/funambol/docs/man/otfm_admin_guide.doc<br /> <br /> After following this steps, you should have a complete funambol server working.<br /> <br /> ===Synchronising Opentaps and Mozilla Thunderbird===<br /> <br /> Hosting: http://sourceforge.net/projects/sync4jmozilla<br /> <br /> Configuration to synchronise with the admin account with opentaps and<br /> mozilla thunderbird on the same computer:<br /> <br /> Edit --> Preferences --> Funambol<br /> <br /> Account<br /> server URL: http://127.0.0.1:8080/funambol/ds<br /> Username: admin<br /> Password: ofbiz<br /> <br /> Synchronize<br /> Items --> Contact --> Details<br /> <br /> Select the addressbook to sync<br /> Remote name: otcontact<br /> <br /> If you have the extension Lightning, you can also synchronise your calendar. I recommand to install the extension Provider for google calendar as well, so you can export items from Thunderbird to Google Calendar.<br /> <br /> Synchronize<br /> Items --> Calendar --> Details<br /> <br /> Select the Calendar to sync<br /> Remote name: otcalendar<br /> <br /> ===Synchronising Opentaps and Outlook===<br /> <br /> In case you are using windows 2000, you have to use the funambol outlook plugin 3.0.15<br /> But this plugin can't synchronise contacts with the funambol version 6 which is included in opentaps.<br /> You'll be able to synchronise tasks and calendar only.<br /> <br /> To install this plugin, you have to follow the instruction in the document http://download.forge.objectweb.org/sync4j/Outlook_Plugin_UG.pdf<br /> <br /> Configuration to synchronise with the admin account with opentaps and<br /> outlook plugin on the same computer:<br /> <br /> Edit --> Communication Settings<br /> SyncServer URL: http://127.0.0.1:8080/funambol/ds<br /> Username: admin<br /> Password: ofbiz<br /> <br /> Edit --> Synchronisation Settings<br /> Activate synchronisation with Contacts, Calendar, Tasks<br /> Remote Settings:<br /> Contact Name otcontact<br /> Calendar Name otcalendar<br /> Task Name ottask<br /> <br /> Hit the Synchronize button.<br /> <br /> ===Synchronising Opentaps and Gmail===<br /> <br /> Hosting: https://google-connector.forge.funambol.org/<br /> <br /> The version tested is 1.2.0 beta1.<br /> <br /> Edit --> Communication Settings<br /> Server URL: http://127.0.0.1:8080/funambol/ds<br /> FunambolUsername: admin<br /> FunambolPassword: ofbiz<br /> Gmail Username: myuserIdongmail<br /> Gmail Password: mypasswordongmail<br /> <br /> Edit --> Synchronisation Settings<br /> Activate synchronisation with Contacts, Calendar<br /> Remote Settings: <br /> Contact Name otcontact<br /> Calendar Name otcalendar<br /> <br /> ===Synchronising Opentaps and Yahoo===<br /> <br /> Hosting: http://sourceforge.net/projects/funambolyahoo/<br /> <br /> Edit --> Communication Settings<br /> Server URL: http://127.0.0.1:8080/funambol/ds<br /> FunambolUsername: admin<br /> FunambolPassword: ofbiz<br /> Yahoo Username: myuserIdonyahoo<br /> Yahoo Password: mypasswordonyahoo<br /> <br /> Edit --> Synchronisation Settings<br /> Activate synchronisation with Contacts<br /> <br /> The synchronisation with Calendar doesn't work, because yahoo connector use calendar in Vcalendar format only and opentaps send the calendar in sif format. Please don't activate it.<br /> <br /> Remote Settings:<br /> Contact Name otcontact<br /> Calendar Name otcalendar<br /> <br /> ===Synchronising Opentaps and Skype===<br /> <br /> Hosting: http://sourceforge.net/projects/funambolskype/<br /> <br /> There is currently no release either commit on svn on this project.<br /> <br /> ===Synchronising Opentaps and Windows Mobile ===<br /> <br /> In case you are using windows, you have to use the funambol windows mobile sync client, you can download the version which fit your mobile at https://www.forge.funambol.org/download/.<br /> <br /> After install the sync client to your mobile, we can do following steps to configure it to connect with opentaps.<br /> <br /> Menu --> Accout<br /> Server location: http://127.0.0.1:8080/funambol/ds<br /> Username: admin<br /> Password: ofbiz<br /> <br /> Menu --> Settings<br /> Activate synchronisation with Contacts, Calendar, Tasks<br /> <br /> Menu --> Settings --> Advanced<br /> Remote Name:<br /> Contacts otcontact<br /> Calendar otcalendar<br /> Tasks ottask<br /> <br /> then, Hit the Sync All button.</div>

Spark https://docs.opentaps.org/docs/index.php?title=Opentaps_Funambol_Setup&diff=5254 Opentaps Funambol Setup 2009-12-26T04:28:14Z

<p>Spark: </p> <hr /> <div>There are currently extensive instructions available in hot-deploy/funambol/docs/man. These documents will be moved at some point to this site.<br /> <br /> ===Troubleshooting the Funambol Component===<br /> <br /> The log file for the Funambol component is in hot-deploy/funambol/logs/funambol_ds.log<br /> <br /> ===Setting up the Funambol server in Opentaps===<br /> <br /> The document which explains how to set up the funambol server is hot-deploy/funambol/docs/man/otfm_admin_guide.doc<br /> <br /> After following this steps, you should have a complete funambol server working.<br /> <br /> ===Synchronising Opentaps and Mozilla Thunderbird===<br /> <br /> Hosting: http://sourceforge.net/projects/sync4jmozilla<br /> <br /> Configuration to synchronise with the admin account with opentaps and<br /> mozilla thunderbird on the same computer:<br /> <br /> Edit --> Preferences --> Funambol<br /> <br /> Account<br /> server URL: http://127.0.0.1:8080/funambol/ds<br /> Username: admin<br /> Password: ofbiz<br /> <br /> Synchronize<br /> Items --> Contact --> Details<br /> <br /> Select the addressbook to sync<br /> Remote name: otcontact<br /> <br /> If you have the extension Lightning, you can also synchronise your calendar. I recommand to install the extension Provider for google calendar as well, so you can export items from Thunderbird to Google Calendar.<br /> <br /> Synchronize<br /> Items --> Calendar --> Details<br /> <br /> Select the Calendar to sync<br /> Remote name: otcalendar<br /> <br /> ===Synchronising Opentaps and Outlook===<br /> <br /> In case you are using windows 2000, you have to use the funambol outlook plugin 3.0.15<br /> But this plugin can't synchronise contacts with the funambol version 6 which is included in opentaps.<br /> You'll be able to synchronise tasks and calendar only.<br /> <br /> To install this plugin, you have to follow the instruction in the document http://download.forge.objectweb.org/sync4j/Outlook_Plugin_UG.pdf<br /> <br /> Configuration to synchronise with the admin account with opentaps and<br /> outlook plugin on the same computer:<br /> <br /> Edit --> Communication Settings<br /> SyncServer URL: http://127.0.0.1:8080/funambol/ds<br /> Username: admin<br /> Password: ofbiz<br /> <br /> Edit --> Synchronisation Settings<br /> Activate synchronisation with Contacts, Calendar, Tasks<br /> Remote Settings:<br /> Contact Name otcontact<br /> Calendar Name otcalendar<br /> Task Name ottask<br /> <br /> Hit the Synchronize button.<br /> <br /> ===Synchronising Opentaps and Gmail===<br /> <br /> Hosting: https://google-connector.forge.funambol.org/<br /> <br /> The version tested is 1.2.0 beta1.<br /> <br /> Edit --> Communication Settings<br /> Server URL: http://127.0.0.1:8080/funambol/ds<br /> FunambolUsername: admin<br /> FunambolPassword: ofbiz<br /> Gmail Username: myuserIdongmail<br /> Gmail Password: mypasswordongmail<br /> <br /> Edit --> Synchronisation Settings<br /> Activate synchronisation with Contacts, Calendar<br /> Remote Settings: <br /> Contact Name otcontact<br /> Calendar Name otcalendar<br /> <br /> ===Synchronising Opentaps and Yahoo===<br /> <br /> Hosting: http://sourceforge.net/projects/funambolyahoo/<br /> <br /> Edit --> Communication Settings<br /> Server URL: http://127.0.0.1:8080/funambol/ds<br /> FunambolUsername: admin<br /> FunambolPassword: ofbiz<br /> Yahoo Username: myuserIdonyahoo<br /> Yahoo Password: mypasswordonyahoo<br /> <br /> Edit --> Synchronisation Settings<br /> Activate synchronisation with Contacts<br /> <br /> The synchronisation with Calendar doesn't work, because yahoo connector use calendar in Vcalendar format only and opentaps send the calendar in sif format. Please don't activate it.<br /> <br /> Remote Settings:<br /> Contact Name otcontact<br /> Calendar Name otcalendar<br /> <br /> ===Synchronising Opentaps and Skype===<br /> <br /> Hosting: http://sourceforge.net/projects/funambolskype/<br /> <br /> There is currently no release either commit on svn on this project.</div>

Spark https://docs.opentaps.org/docs/index.php?title=Opentaps_Hibernate_Integration&diff=5057 Opentaps Hibernate Integration 2009-11-26T11:27:09Z

<p>Spark: /* Caching */</p> <hr /> <div>Beginning with opentaps version 1.4, [http://www.hibernate.org Hibernate] will be available as a persistence tool alongside with the original ofbiz entity engine. Hibernate is a more object oriented persistence framework and better suited for the new [[Domain Driven Architecture]], while the ofbiz entity engine will continue to be supported for legacy features from both ofbiz and opentaps. In this document, we will review how the hibernate integration in opentaps works.<br /> <br /> == Working with Hibernate in opentaps ==<br /> <br /> === Generating Hibernate Configuration Files ===<br /> <br /> After changing or defining new entities in your <tt>entitymodel.xml</tt> files, you need to generate new Java classes for your entities with<br /> $ ant make-base-entities<br /> <br /> This command updates the Java classes defined in <tt>org.opentaps.domain.base.entities</tt>, including their hibernate annotations, and the <tt>hibernate.cfg.xml</tt> for integrating with hibernate. (If you use a repository management system, you must commit both and you Java classes and the updated <tt>hibernate.cfg.xml</tt> files.)<br /> <br /> {{note|Important|Be sure to reference the JARs from <tt>/hot-deploy/opentaps-common/lib/hibernate</tt> in your Ant build file, or else during build it will not be able to locate the appropriate Hibernate files.}}<br /> <br /> === Accessing Entities with Hibernate ===<br /> <br /> {{tip|Tip|If you are developing in Eclipse, when using Hibernate make sure to run the ant task <tt>make-base-entities</tt> immediately after you are done defining new entities. Also make sure you refresh the Eclipse project so that it picks up the new Hibernate POJOs for code-assist.}}<br /> <br /> <br /> <br /> To use hibernate to access your entities, you will need an <tt>org.opentaps.foundation.entity.hibernate.Session</tt>, which is an extension of the <tt>org.hibernate.Session</tt> class. You can obtain it from the Infrastructure class like this:<br /> session = infrastructure.getSession();<br /> <br /> The <tt>Infrastructure</tt> must be created from <tt>dispatcher</tt> in order to obtain the hibernate session.<br /> <br /> In situations where you are passing through the service engine the <tt>dispatcher</tt> is obtained from the <tt>DispatchContext</tt><br /> <br /> For example:<br /> <br /> public static Map myNewService(DispatchContext dctx, Map context) {<br /> LocalDispatcher dispatcher = dctx.getDispatcher();<br /> <br /> try {<br /> Infrastructure infrastructure = new Infrastructure(dispatcher);<br /> Session session = infrastructure.getSession();<br /> } catch (InfrastructureException e) {<br /> // TODO Auto-generated catch block<br /> e.printStackTrace();<br /> }<br /> }<br /> <br /> In situations where you are bypassing the service engine and accessing the Java method directly the <tt>dispatcher</tt> is obtained from <tt>HttpServletRequest</tt><br /> <br /> For example:<br /> <br /> public static Map myNewService(HttpServletRequest request, HttpServletResponse response) {<br /> LocalDispatcher dispatcher = (LocalDispatcher) request.getAttribute("dispatcher");<br /> <br /> try {<br /> Infrastructure infrastructure = new Infrastructure(dispatcher);<br /> Session session = infrastructure.getSession();<br /> } catch (InfrastructureException e) {<br /> // TODO Auto-generated catch block<br /> e.printStackTrace();<br /> }<br /> }<br /> <br /> Then, you can work with it as if it were a Hibernate <tt>Session</tt>:<br /> <br /> Transaction tx = session.beginTransaction();<br /> TestEntity newTestEntity = new TestEntity();<br /> newTestEntity.setTestStringField("testInsertTestEntity string field");<br /> newTestEntity.setCreatedStamp(UtilDateTime.nowTimestamp());<br /> session.save(newTestEntity);<br /> tx.commit();<br /> session.flush();<br /> // ...<br /> TestEntity loadEntity = (TestEntity) session.load(TestEntity.class, newTestEntity.getTestId());<br /> // ...<br /> String hql = "from TestEntity eo where eo.testId='" + testEntityId2 + "'";<br /> Query query = session.createQuery(hql);<br /> List<TestEntity> list = query.list()<br /> <br /> You do not need to close your JDBC connection manually with the opentaps Session, however. When you call<br /> session.close();<br /> It will do it for you automatically.<br /> <br /> === Traversing Related Entities ===<br /> <br /> opentaps will automatically create the relationship annotations, such as @OneToMany, @ManyToMany, and @Join, for your Java classes.<br /> <br /> To get related entities, use the hibernate query language (HQL):<br /> String hql = "from TestEntityItem eo where eo.testEntity.testId='" + testEntity.getTestId() + "'"<br /> + " and eo.testEntityItemSeqId in (" + testEntityItemSeqIds + ")";<br /> Query query = session.createQuery(hql);<br /> List<TestEntityItem> list = query.list();<br /> <br /> Or use the getter methods in the base entities:<br /> List<TestEntityItem> list = testEntity.getTestEntityItems();<br /> <br /> Note that hibernate will automatically load related entities for you, so the getRelated methods from Repository which were designed for the ofbiz entity engine are no longer needed when you work with hibernate.<br /> <br /> === Working with View Entities ===<br /> <br /> Once a view entity has been defined in <tt>entitymodel.xml</tt>, you can access it as any other Java object from hibernate, for example:<br /> Query query = session.createQuery("from TestEntityAndItem eo where eo.testId='" <br /> + testEntityId + "' order by eo.testEntityItemSeqId");<br /> List<TestEntityAndItem> list = query.list();<br /> <br /> The opentaps Session, which extends the hibernate Session, will automatically create the SQL for accessing the view entity.<br /> <br /> === Using Transactions ===<br /> <br /> You should use the transaction manager configured in the ofbiz entity engine through the <tt>[http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/transaction/UserTransaction.html UserTransaction]</tt> class. In the entity engine, the transaction manager is configured as:<br /> <transaction-factory class="org.ofbiz.geronimo.GeronimoTransactionFactory"/><br /> <br /> This is obtained from the ofbiz <tt>TransactionFactory</tt> by our <tt>Session</tt> and used the same way as a hibernate transaction:<br /> <pre><br /> UserTransaction tx = session.beginUserTransaction();<br /> // do something useful<br /> tx.commit();<br /> </pre><br /> <br /> === Auto Generating ID Values ===<br /> <br /> ofbiz keeps track of auto generated sequence IDs in an entity called <tt>SequenceValueItem</tt> To make sure that the auto generated sequence IDs from hibernate and the ofbiz entity engine work well together, we have created an <tt>OpentapsIdentifierGenerator</tt> which also uses the same <tt>SequenceValueItem</tt> to obtain the next sequential ID. This ID generator is wired to the base entity POJO Java objects with hibernate annotations, like this:<br /> <pre><br /> @org.hibernate.annotations.GenericGenerator(name="Party_GEN", strategy="org.opentaps.foundation.entity.hibernate.OpentapsIdentifierGenerator")<br /> @GeneratedValue(generator="Party_GEN") <br /> @Id<br /> <br /> @Column(name="PARTY_ID")<br /> <br /> private String partyId;<br /> </pre><br /> <br /> So that a <tt>partyId</tt> field is automatically set for you.<br /> <br /> You can also ask the <tt>Session</tt> to generate a particular sequence ID for you:<br /> String testEntityItemSeqId = session.getNextSeqId("TestEntityItemSeqId");<br /> <br /> This can be helpful when you have complex keys with several fields, and you want the secondary key fields to be auto sequenced as well.<br /> <br /> === Support for OFBIZ EECA's ===<br /> <br /> ofbiz EECA's are supported with custom event listeners which are registered with hibernate when <tt>Infrastructure.getSessionFactory(String delegatorName)</tt> is called, usually during the initial startup. These event listeners will run ofbiz services defined in <tt>eeca.xml</tt>'s when hibernate is used to update the same entities.<br /> <br /> === Caching ===<br /> <br /> After opentaps 1.4 preview 2, opentaps added support for hibernate caching using [http://ehcache.org/ EhCache] by default. opentaps supports mutual cache clearing between the ofbiz entity engine and hibernate. This means that opentaps will synchronize hibernate cache when you update your values with ofbiz entity engine, and vice versa. The hibernate cache configuration is locate in HibernateCfg.ftl (it also in hibernate.cfg.xml) as following:<br /> <pre><br /> <property name="hibernate.cache.provider_class">org.hibernate.cache.EhCacheProvider</property><br /> <property name="net.sf.ehcache.configurationResourceName">ehcache.xml</property> <br /> <property name="hibernate.search.worker.execution">async</property><br /> <property name="hibernate.cache.use_query_cache">true</property><br /> <property name="hibernate.cache.use_second_level_cache">true</property><br /> <property name="hibernate.search.worker.buffer_queue.max">5</property><br /> <property name="hibernate.search.worker.thread_pool.size">5</property><br /> </pre><br /> <br /> You can disable the caching feature by removing or commenting out these lines (both HibernateCfg.ftl and hibernate.cfg.xml).<br /> <br /> {{note|Important|The entities of current open hibernate session will not update when they are changed by ofbiz entity engine after session has already been opened, so you must open a new session to get a refreshed version of the object. In contrast, if you update a value with hibernate, it will be refreshed in the ofbiz entity engine's cache. This is due to the different way the ofbiz entity engine works versus hibernate -- the ofbiz delegator is a static object, whereas each hibernate session is a different object.}}<br /> <br /> === Using Hibernate without the OFBIZ Entity Engine ===<br /> <br /> You can also use hibernate without the ofbiz entity engine by adding your Java objects to the template opentaps uses to generate the hibernate configuration files, <tt>hot-deploy/opentaps-common/templates/HibernateCfg.ftl</tt>. Simply put your Java objects after the <br /> <pre><br /> <#list><br /> ...<br /> </#list><br /> </pre><br /> <br /> directives in the file, like in the following example: <br /> <br /> <pre><br /> <!DOCTYPE hibernate-configuration PUBLIC "-//Hibernate/Hibernate Configuration DTD 3.0//EN" "http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd"><br /> <br /> <hibernate-configuration><br /> <session-factory><br /> <property name="hibernate.connection.provider_class">org.opentaps.foundation.entity.hibernate.OpentapsConnectionProvider</property> <br /> <property name="hibernate.transaction.factory_class">org.opentaps.foundation.entity.hibernate.OpentapsTransactionFactory</property><br /> <property name="hibernate.transaction.manager_lookup_class">org.opentaps.foundation.entity.hibernate.OpentapsTransactionManagerLookup</property> <br /> <property name="hibernate.search.default.directory_provider">org.hibernate.search.store.FSDirectoryProvider</property><br /> <#list entities as entity><br /> <mapping class="org.opentaps.domain.base.entities.${entity}"/><br /> </#list><br /> <mapping class="org.opentaps.domain.base.entities.MyPojo1"/><br /> <mapping class="org.opentaps.domain.base.entities.MyPojo2"/><br /> </session-factory><br /> </hibernate-configuration><br /> </pre><br /> <br /> opentaps will then create the hibernate configuration file for each database and include your Java objects in it. However, you would not be able to access these Java objects as generic values from the ofbiz entity engine.<br /> <br /> == Under the Hood: How It Works ==<br /> <br /> === Base Class Annotations ===<br /> <br /> In opentaps version 1.4, the entity model XML from the ofbiz entity engine is still used as the base definition for all entities. The opentaps POJO generator is used to create [[Base Entity Classes|base Java objects]] automatically from these entity definitions. This POJO generator will also create the annotations which hibernate can then use to map those base objects to the database persistence layer. The definitions of the annotations can be found in <tt>BaseEntity.ftl</tt> file used by the POJO generator.<br /> <br /> === How Hibernate Configuration Files are Generated ===<br /> <br /> The POJO Generator will use <tt>hot-deploy/opentaps-common/templates/HibernateCfg.ftl</tt> to generate a base hibernate configuration file in <tt>hot-deploy/opentaps-common/config/hibernate.cfg.xml</tt> When opentaps is started, the following new container in <tt>framework/base/config/ofbiz-containers.xml</tt><br /> <pre><br /> <container name="hibernate-container" class="org.opentaps.common.container.HibernateContainer"><br /> <property name="delegator-name" value="default"/><br /> </container> <br /> </pre><br /> <br /> will generate all the hibernate configuration XML files in the <tt>hot-deploy/opentaps/config/</tt> directory for each data source in your entity engine XML file. For example, it will generate a <tt>localmysql.cfg.xml</tt>, a <tt>localpostgres.cfg.xml</tt><br /> <br /> === How We Get the Hibernate Session ===<br /> <br /> The opentaps <tt>Infrastructure</tt> Class maintains a Map of delegatorName and hibernate SessionFactory objects. Each SessionFactory is created for its corresponding delegatorName the first time it is requested from the <tt>Infrastructure.getSessionFactory(delegatorName)</tt> method. This SessionFactory is created from ofbiz entity engine configurations:<br /> * The <tt>HibernateContainer</tt> in <tt>ofbiz-containers.xml</tt> has a property called <tt>delegator-name</tt><br /> * From this delegator, we get the data source defined in <tt>entityengine.xml</tt> for the default group helper name. This is set to <tt>org.ofbiz</tt> by default in the <tt>Infrastructure</tt> class and is the <tt>group</tt> attribute of the <tt>entitygroup.xml</tt> definitions in ofbiz:<br /> <entity-group group="org.ofbiz" entity="AcctgTagEnumType"/><br /> In <tt>entityengine.xml</tt>, you map a data source to each group:<br /> <delegator name="default" entity-model-reader="main" entity-group-reader="main" entity-eca-reader="main" distributed-cache-clear-enabled="false"><br /> <group-map group-name="org.ofbiz" datasource-name="localmysql"/><br /> </delegator><br /> <br /> So, we are basically following the entity engine from the delegator to the data source via the group.<br /> * Once we have the data source, we can create the SessionFactory from the hibernate.cfg.xml for that data source. For example, if your data source is "localmysql", we will create the SessionFactory from the <tt>localmysql.cfg.xml</tt> created by the <tt>HibernateContainer</tt><br /> <br /> The <tt>HibernateContainer</tt>, which loads on startup, will cause a SessionFactory to be loaded for the delegator in the <tt>delegator-name</tt> attribute. Once this SessionFactory is loaded, it will be available for future use. Additional session factories can be obtained later by calling the <tt>getSessionFactory</tt> directly.<br /> <br /> When the <tt>Infrastructure.getSession()</tt> method is called, it will use the delegator already in the Infrastructure object to open a JDBC connection first, and then use that JDBC connection and the SessionFactory for the delegator to return a Session.<br /> <br /> The <tt>Infrastructure.getSession()</tt> will return an <tt>org.opentaps.foundation.entity.hibernate.Session</tt>, which extends the hibernate Session with the following differences:<br /> * when the session is closed, the JDBC connection is also automatically closed<br /> * when a Query is created, this Session will check if the query is on an entity engine view entity and construct the Query from native SQL first<br /> <br /> === View Entities ===<br /> <br /> View entities are supported with @NamedNativeQuery annotations in the base entity Java classes, which are automatically generated by the opentaps POJO Generator.<br /> <br /> === Encryption ===<br /> <br /> The ofbiz delegator allows you to set a field to be encrypted in the database with the <tt>encrypt="true"</tt> attribute in the <tt>field</tt> tag of an entity definition. The opentaps hibernate will support the same encryption/decryption algorithm, so that encrypted values can be stored with the delegator and decrypted when it's retrieved with hibernate or vice versa. This is done by:<br /> # When an object is being stored, the <tt>EcaCommEvent.beforeSave</tt> Method will come for the object to an ofbiz GenericValue and then use the ofbiz delegator to encrypt it.<br /> # When an object is retrieved from the database, the <tt>Session.load</tt> will call the <tt>HibernateUtil.decryptField</tt> to decrypt it.<br /> <br /> === Transaction Management ===<br /> <br /> To maintain compatibility with the ofbiz entity engine's transaction manager and connection pool providers, we have defined transaction manager look up, transaction factory, and connection provider classes which use the ofbiz transaction manager and transaction factory to begin transactions. These are defined in the <tt>hibernate.cfg.xml</tt> configuration file. They allow you to mix delegator and hibernate transaction codes as in this following example:<br /> <pre><br /> UserTransaction tx = session.beginUserTransaction();<br /> TestEntity useIdentifierTestEntity = new TestEntity();<br /> useIdentifierTestEntity.setTestStringField("Use IdentifierGenerator string field");<br /> session.save(useIdentifierTestEntity);<br /> String getNextSeqIdTestEntityId = delegator.getNextSeqId("TestEntity");<br /> GenericValue useGetNextSeqIdTestEntity = delegator.create("TestEntity",<br /> UtilMisc.toMap("testId", getNextSeqIdTestEntityId, "testStringField", "Use getNextSeqId string field"));<br /> session.flush();<br /> tx.commit();<br /> </pre><br /> <br /> === Support for BLOBs ===<br /> <br /> To make the "BLOB" type work with postgresql, we made the following changes:<br /> # change blob field mapping to Java byte[] <br /> # avoid using the <tt>@Lob</tt> annotation<br /> # add this element in hibernate.cfg.xml<br /> <property name="hibernate.jdbc.use_streams_for_binary">true</property><br /> <br /> === Unit Tests ===<br /> <br /> Unit tests for hibernate are found in <tt>org.opentaps.tests.entity.HibernateTests</tt> in the opentaps-tests component.<br /> <br /> == Learning More ==<br /> <br /> The best way to learn more about how to use hibernate with opentaps is to look through the unit tests in <tt>org.opentaps.tests.entity.HibernateTests</tt> as an example.</div>

Spark https://docs.opentaps.org/docs/index.php?title=Opentaps_Hibernate_Integration&diff=5041 Opentaps Hibernate Integration 2009-11-21T04:09:09Z

<p>Spark: /* Caching */</p> <hr /> <div>Beginning with opentaps version 1.4, [http://www.hibernate.org Hibernate] will be available as a persistence tool alongside with the original ofbiz entity engine. Hibernate is a more object oriented persistence framework and better suited for the new [[Domain Driven Architecture]], while the ofbiz entity engine will continue to be supported for legacy features from both ofbiz and opentaps. In this document, we will review how the hibernate integration in opentaps works.<br /> <br /> == Working with Hibernate in opentaps ==<br /> <br /> === Generating Hibernate Configuration Files ===<br /> <br /> After changing or defining new entities in your <tt>entitymodel.xml</tt> files, you need to generate new Java classes for your entities with<br /> $ ant make-base-entities<br /> <br /> This command updates the Java classes defined in <tt>org.opentaps.domain.base.entities</tt>, including their hibernate annotations, and the <tt>hibernate.cfg.xml</tt> for integrating with hibernate. (If you use a repository management system, you must commit both and you Java classes and the updated <tt>hibernate.cfg.xml</tt> files.)<br /> <br /> {{note|Important|Be sure to reference the JARs from <tt>/hot-deploy/opentaps-common/lib/hibernate</tt> in your Ant build file, or else during build it will not be able to locate the appropriate Hibernate files.}}<br /> <br /> === Accessing Entities with Hibernate ===<br /> <br /> {{tip|Tip|If you are developing in Eclipse, when using Hibernate make sure to run the ant task <tt>make-base-entities</tt> immediately after you are done defining new entities. Also make sure you refresh the Eclipse project so that it picks up the new Hibernate POJOs for code-assist.}}<br /> <br /> <br /> <br /> To use hibernate to access your entities, you will need an <tt>org.opentaps.foundation.entity.hibernate.Session</tt>, which is an extension of the <tt>org.hibernate.Session</tt> class. You can obtain it from the Infrastructure class like this:<br /> session = infrastructure.getSession();<br /> <br /> The <tt>Infrastructure</tt> must be created from <tt>dispatcher</tt> in order to obtain the hibernate session.<br /> <br /> In situations where you are passing through the service engine the <tt>dispatcher</tt> is obtained from the <tt>DispatchContext</tt><br /> <br /> For example:<br /> <br /> public static Map myNewService(DispatchContext dctx, Map context) {<br /> LocalDispatcher dispatcher = dctx.getDispatcher();<br /> <br /> try {<br /> Infrastructure infrastructure = new Infrastructure(dispatcher);<br /> Session session = infrastructure.getSession();<br /> } catch (InfrastructureException e) {<br /> // TODO Auto-generated catch block<br /> e.printStackTrace();<br /> }<br /> }<br /> <br /> In situations where you are bypassing the service engine and accessing the Java method directly the <tt>dispatcher</tt> is obtained from <tt>HttpServletRequest</tt><br /> <br /> For example:<br /> <br /> public static Map myNewService(HttpServletRequest request, HttpServletResponse response) {<br /> LocalDispatcher dispatcher = (LocalDispatcher) request.getAttribute("dispatcher");<br /> <br /> try {<br /> Infrastructure infrastructure = new Infrastructure(dispatcher);<br /> Session session = infrastructure.getSession();<br /> } catch (InfrastructureException e) {<br /> // TODO Auto-generated catch block<br /> e.printStackTrace();<br /> }<br /> }<br /> <br /> Then, you can work with it as if it were a Hibernate <tt>Session</tt>:<br /> <br /> Transaction tx = session.beginTransaction();<br /> TestEntity newTestEntity = new TestEntity();<br /> newTestEntity.setTestStringField("testInsertTestEntity string field");<br /> newTestEntity.setCreatedStamp(UtilDateTime.nowTimestamp());<br /> session.save(newTestEntity);<br /> tx.commit();<br /> session.flush();<br /> // ...<br /> TestEntity loadEntity = (TestEntity) session.load(TestEntity.class, newTestEntity.getTestId());<br /> // ...<br /> String hql = "from TestEntity eo where eo.testId='" + testEntityId2 + "'";<br /> Query query = session.createQuery(hql);<br /> List<TestEntity> list = query.list()<br /> <br /> You do not need to close your JDBC connection manually with the opentaps Session, however. When you call<br /> session.close();<br /> It will do it for you automatically.<br /> <br /> === Traversing Related Entities ===<br /> <br /> opentaps will automatically create the relationship annotations, such as @OneToMany, @ManyToMany, and @Join, for your Java classes.<br /> <br /> To get related entities, use the hibernate query language (HQL):<br /> String hql = "from TestEntityItem eo where eo.testEntity.testId='" + testEntity.getTestId() + "'"<br /> + " and eo.testEntityItemSeqId in (" + testEntityItemSeqIds + ")";<br /> Query query = session.createQuery(hql);<br /> List<TestEntityItem> list = query.list();<br /> <br /> Or use the getter methods in the base entities:<br /> List<TestEntityItem> list = testEntity.getTestEntityItems();<br /> <br /> Note that hibernate will automatically load related entities for you, so the getRelated methods from Repository which were designed for the ofbiz entity engine are no longer needed when you work with hibernate.<br /> <br /> === Working with View Entities ===<br /> <br /> Once a view entity has been defined in <tt>entitymodel.xml</tt>, you can access it as any other Java object from hibernate, for example:<br /> Query query = session.createQuery("from TestEntityAndItem eo where eo.testId='" <br /> + testEntityId + "' order by eo.testEntityItemSeqId");<br /> List<TestEntityAndItem> list = query.list();<br /> <br /> The opentaps Session, which extends the hibernate Session, will automatically create the SQL for accessing the view entity.<br /> <br /> === Using Transactions ===<br /> <br /> You should use the transaction manager configured in the ofbiz entity engine through the <tt>[http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/transaction/UserTransaction.html UserTransaction]</tt> class. In the entity engine, the transaction manager is configured as:<br /> <transaction-factory class="org.ofbiz.geronimo.GeronimoTransactionFactory"/><br /> <br /> This is obtained from the ofbiz <tt>TransactionFactory</tt> by our <tt>Session</tt> and used the same way as a hibernate transaction:<br /> <pre><br /> UserTransaction tx = session.beginUserTransaction();<br /> // do something useful<br /> tx.commit();<br /> </pre><br /> <br /> === Auto Generating ID Values ===<br /> <br /> ofbiz keeps track of auto generated sequence IDs in an entity called <tt>SequenceValueItem</tt> To make sure that the auto generated sequence IDs from hibernate and the ofbiz entity engine work well together, we have created an <tt>OpentapsIdentifierGenerator</tt> which also uses the same <tt>SequenceValueItem</tt> to obtain the next sequential ID. This ID generator is wired to the base entity POJO Java objects with hibernate annotations, like this:<br /> <pre><br /> @org.hibernate.annotations.GenericGenerator(name="Party_GEN", strategy="org.opentaps.foundation.entity.hibernate.OpentapsIdentifierGenerator")<br /> @GeneratedValue(generator="Party_GEN") <br /> @Id<br /> <br /> @Column(name="PARTY_ID")<br /> <br /> private String partyId;<br /> </pre><br /> <br /> So that a <tt>partyId</tt> field is automatically set for you.<br /> <br /> You can also ask the <tt>Session</tt> to generate a particular sequence ID for you:<br /> String testEntityItemSeqId = session.getNextSeqId("TestEntityItemSeqId");<br /> <br /> This can be helpful when you have complex keys with several fields, and you want the secondary key fields to be auto sequenced as well.<br /> <br /> === Support for OFBIZ EECA's ===<br /> <br /> ofbiz EECA's are supported with custom event listeners which are registered with hibernate when <tt>Infrastructure.getSessionFactory(String delegatorName)</tt> is called, usually during the initial startup. These event listeners will run ofbiz services defined in <tt>eeca.xml</tt>'s when hibernate is used to update the same entities.<br /> <br /> === Caching ===<br /> Our caching system now support ofbiz <-> hibernate mutual cache clearing. It mean it will sync hibernate cache on you update GenericValue with ofbiz entity engine, and vice versa. The hibernate cache configuration is locate in HibernateCfg.ftl (it also in hibernate.cfg.xml) as following:<br /> <pre><br /> <property name="hibernate.search.worker.execution">async</property><br /> <property name="hibernate.cache.use_query_cache">true</property><br /> <property name="hibernate.cache.use_second_level_cache">true</property><br /> <property name="hibernate.search.worker.buffer_queue.max">5</property><br /> <property name="hibernate.search.worker.thread_pool.size">5</property><br /> </pre><br /> you can disable the caching feature by remove these lines (both HibernateCfg.ftl and hibernate.cfg.xml).<br /> <br/><br/><br /> {{note|Important|The entities of current open session will not update when it changed by ofbiz entity engine after session open, you must using open a new session to get fresh object. Creating a session is not expensive, keeping one alive a long time is maybe less expensive.}}<br /> <br /> === Using Hibernate without the OFBIZ Entity Engine ===<br /> <br /> You can also use hibernate without the ofbiz entity engine by adding your Java objects to the template opentaps uses to generate the hibernate configuration files, <tt>hot-deploy/opentaps-common/templates/HibernateCfg.ftl</tt>. Simply put your Java objects after the <br /> <pre><br /> <#list><br /> ...<br /> </#list><br /> </pre><br /> <br /> directives in the file, like in the following example: <br /> <br /> <pre><br /> <!DOCTYPE hibernate-configuration PUBLIC "-//Hibernate/Hibernate Configuration DTD 3.0//EN" "http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd"><br /> <br /> <hibernate-configuration><br /> <session-factory><br /> <property name="hibernate.connection.provider_class">org.opentaps.foundation.entity.hibernate.OpentapsConnectionProvider</property> <br /> <property name="hibernate.transaction.factory_class">org.opentaps.foundation.entity.hibernate.OpentapsTransactionFactory</property><br /> <property name="hibernate.transaction.manager_lookup_class">org.opentaps.foundation.entity.hibernate.OpentapsTransactionManagerLookup</property> <br /> <property name="hibernate.search.default.directory_provider">org.hibernate.search.store.FSDirectoryProvider</property><br /> <#list entities as entity><br /> <mapping class="org.opentaps.domain.base.entities.${entity}"/><br /> </#list><br /> <mapping class="org.opentaps.domain.base.entities.MyPojo1"/><br /> <mapping class="org.opentaps.domain.base.entities.MyPojo2"/><br /> </session-factory><br /> </hibernate-configuration><br /> </pre><br /> <br /> opentaps will then create the hibernate configuration file for each database and include your Java objects in it. However, you would not be able to access these Java objects as generic values from the ofbiz entity engine.<br /> <br /> == Under the Hood: How It Works ==<br /> <br /> === Base Class Annotations ===<br /> <br /> In opentaps version 1.4, the entity model XML from the ofbiz entity engine is still used as the base definition for all entities. The opentaps POJO generator is used to create [[Base Entity Classes|base Java objects]] automatically from these entity definitions. This POJO generator will also create the annotations which hibernate can then use to map those base objects to the database persistence layer. The definitions of the annotations can be found in <tt>BaseEntity.ftl</tt> file used by the POJO generator.<br /> <br /> === How Hibernate Configuration Files are Generated ===<br /> <br /> The POJO Generator will use <tt>hot-deploy/opentaps-common/templates/HibernateCfg.ftl</tt> to generate a base hibernate configuration file in <tt>hot-deploy/opentaps-common/config/hibernate.cfg.xml</tt> When opentaps is started, the following new container in <tt>framework/base/config/ofbiz-containers.xml</tt><br /> <pre><br /> <container name="hibernate-container" class="org.opentaps.common.container.HibernateContainer"><br /> <property name="delegator-name" value="default"/><br /> </container> <br /> </pre><br /> <br /> will generate all the hibernate configuration XML files in the <tt>hot-deploy/opentaps/config/</tt> directory for each data source in your entity engine XML file. For example, it will generate a <tt>localmysql.cfg.xml</tt>, a <tt>localpostgres.cfg.xml</tt><br /> <br /> === How We Get the Hibernate Session ===<br /> <br /> The opentaps <tt>Infrastructure</tt> Class maintains a Map of delegatorName and hibernate SessionFactory objects. Each SessionFactory is created for its corresponding delegatorName the first time it is requested from the <tt>Infrastructure.getSessionFactory(delegatorName)</tt> method. This SessionFactory is created from ofbiz entity engine configurations:<br /> * The <tt>HibernateContainer</tt> in <tt>ofbiz-containers.xml</tt> has a property called <tt>delegator-name</tt><br /> * From this delegator, we get the data source defined in <tt>entityengine.xml</tt> for the default group helper name. This is set to <tt>org.ofbiz</tt> by default in the <tt>Infrastructure</tt> class and is the <tt>group</tt> attribute of the <tt>entitygroup.xml</tt> definitions in ofbiz:<br /> <entity-group group="org.ofbiz" entity="AcctgTagEnumType"/><br /> In <tt>entityengine.xml</tt>, you map a data source to each group:<br /> <delegator name="default" entity-model-reader="main" entity-group-reader="main" entity-eca-reader="main" distributed-cache-clear-enabled="false"><br /> <group-map group-name="org.ofbiz" datasource-name="localmysql"/><br /> </delegator><br /> <br /> So, we are basically following the entity engine from the delegator to the data source via the group.<br /> * Once we have the data source, we can create the SessionFactory from the hibernate.cfg.xml for that data source. For example, if your data source is "localmysql", we will create the SessionFactory from the <tt>localmysql.cfg.xml</tt> created by the <tt>HibernateContainer</tt><br /> <br /> The <tt>HibernateContainer</tt>, which loads on startup, will cause a SessionFactory to be loaded for the delegator in the <tt>delegator-name</tt> attribute. Once this SessionFactory is loaded, it will be available for future use. Additional session factories can be obtained later by calling the <tt>getSessionFactory</tt> directly.<br /> <br /> When the <tt>Infrastructure.getSession()</tt> method is called, it will use the delegator already in the Infrastructure object to open a JDBC connection first, and then use that JDBC connection and the SessionFactory for the delegator to return a Session.<br /> <br /> The <tt>Infrastructure.getSession()</tt> will return an <tt>org.opentaps.foundation.entity.hibernate.Session</tt>, which extends the hibernate Session with the following differences:<br /> * when the session is closed, the JDBC connection is also automatically closed<br /> * when a Query is created, this Session will check if the query is on an entity engine view entity and construct the Query from native SQL first<br /> <br /> === View Entities ===<br /> <br /> View entities are supported with @NamedNativeQuery annotations in the base entity Java classes, which are automatically generated by the opentaps POJO Generator.<br /> <br /> === Encryption ===<br /> <br /> The ofbiz delegator allows you to set a field to be encrypted in the database with the <tt>encrypt="true"</tt> attribute in the <tt>field</tt> tag of an entity definition. The opentaps hibernate will support the same encryption/decryption algorithm, so that encrypted values can be stored with the delegator and decrypted when it's retrieved with hibernate or vice versa. This is done by:<br /> # When an object is being stored, the <tt>EcaCommEvent.beforeSave</tt> Method will come for the object to an ofbiz GenericValue and then use the ofbiz delegator to encrypt it.<br /> # When an object is retrieved from the database, the <tt>Session.load</tt> will call the <tt>HibernateUtil.decryptField</tt> to decrypt it.<br /> <br /> === Transaction Management ===<br /> <br /> To maintain compatibility with the ofbiz entity engine's transaction manager and connection pool providers, we have defined transaction manager look up, transaction factory, and connection provider classes which use the ofbiz transaction manager and transaction factory to begin transactions. These are defined in the <tt>hibernate.cfg.xml</tt> configuration file. They allow you to mix delegator and hibernate transaction codes as in this following example:<br /> <pre><br /> UserTransaction tx = session.beginUserTransaction();<br /> TestEntity useIdentifierTestEntity = new TestEntity();<br /> useIdentifierTestEntity.setTestStringField("Use IdentifierGenerator string field");<br /> session.save(useIdentifierTestEntity);<br /> String getNextSeqIdTestEntityId = delegator.getNextSeqId("TestEntity");<br /> GenericValue useGetNextSeqIdTestEntity = delegator.create("TestEntity",<br /> UtilMisc.toMap("testId", getNextSeqIdTestEntityId, "testStringField", "Use getNextSeqId string field"));<br /> session.flush();<br /> tx.commit();<br /> </pre><br /> <br /> === Support for BLOBs ===<br /> <br /> To make the "BLOB" type work with postgresql, we made the following changes:<br /> # change blob field mapping to Java byte[] <br /> # avoid using the <tt>@Lob</tt> annotation<br /> # add this element in hibernate.cfg.xml<br /> <property name="hibernate.jdbc.use_streams_for_binary">true</property><br /> <br /> === Unit Tests ===<br /> <br /> Unit tests for hibernate are found in <tt>org.opentaps.tests.entity.HibernateTests</tt> in the opentaps-tests component.<br /> <br /> == Learning More ==<br /> <br /> The best way to learn more about how to use hibernate with opentaps is to look through the unit tests in <tt>org.opentaps.tests.entity.HibernateTests</tt> as an example.</div>

Spark https://docs.opentaps.org/docs/index.php?title=Opentaps_Hibernate_Integration&diff=5040 Opentaps Hibernate Integration 2009-11-21T04:00:51Z

<p>Spark: /* Caching */</p> <hr /> <div>Beginning with opentaps version 1.4, [http://www.hibernate.org Hibernate] will be available as a persistence tool alongside with the original ofbiz entity engine. Hibernate is a more object oriented persistence framework and better suited for the new [[Domain Driven Architecture]], while the ofbiz entity engine will continue to be supported for legacy features from both ofbiz and opentaps. In this document, we will review how the hibernate integration in opentaps works.<br /> <br /> == Working with Hibernate in opentaps ==<br /> <br /> === Generating Hibernate Configuration Files ===<br /> <br /> After changing or defining new entities in your <tt>entitymodel.xml</tt> files, you need to generate new Java classes for your entities with<br /> $ ant make-base-entities<br /> <br /> This command updates the Java classes defined in <tt>org.opentaps.domain.base.entities</tt>, including their hibernate annotations, and the <tt>hibernate.cfg.xml</tt> for integrating with hibernate. (If you use a repository management system, you must commit both and you Java classes and the updated <tt>hibernate.cfg.xml</tt> files.)<br /> <br /> {{note|Important|Be sure to reference the JARs from <tt>/hot-deploy/opentaps-common/lib/hibernate</tt> in your Ant build file, or else during build it will not be able to locate the appropriate Hibernate files.}}<br /> <br /> === Accessing Entities with Hibernate ===<br /> <br /> {{tip|Tip|If you are developing in Eclipse, when using Hibernate make sure to run the ant task <tt>make-base-entities</tt> immediately after you are done defining new entities. Also make sure you refresh the Eclipse project so that it picks up the new Hibernate POJOs for code-assist.}}<br /> <br /> <br /> <br /> To use hibernate to access your entities, you will need an <tt>org.opentaps.foundation.entity.hibernate.Session</tt>, which is an extension of the <tt>org.hibernate.Session</tt> class. You can obtain it from the Infrastructure class like this:<br /> session = infrastructure.getSession();<br /> <br /> The <tt>Infrastructure</tt> must be created from <tt>dispatcher</tt> in order to obtain the hibernate session.<br /> <br /> In situations where you are passing through the service engine the <tt>dispatcher</tt> is obtained from the <tt>DispatchContext</tt><br /> <br /> For example:<br /> <br /> public static Map myNewService(DispatchContext dctx, Map context) {<br /> LocalDispatcher dispatcher = dctx.getDispatcher();<br /> <br /> try {<br /> Infrastructure infrastructure = new Infrastructure(dispatcher);<br /> Session session = infrastructure.getSession();<br /> } catch (InfrastructureException e) {<br /> // TODO Auto-generated catch block<br /> e.printStackTrace();<br /> }<br /> }<br /> <br /> In situations where you are bypassing the service engine and accessing the Java method directly the <tt>dispatcher</tt> is obtained from <tt>HttpServletRequest</tt><br /> <br /> For example:<br /> <br /> public static Map myNewService(HttpServletRequest request, HttpServletResponse response) {<br /> LocalDispatcher dispatcher = (LocalDispatcher) request.getAttribute("dispatcher");<br /> <br /> try {<br /> Infrastructure infrastructure = new Infrastructure(dispatcher);<br /> Session session = infrastructure.getSession();<br /> } catch (InfrastructureException e) {<br /> // TODO Auto-generated catch block<br /> e.printStackTrace();<br /> }<br /> }<br /> <br /> Then, you can work with it as if it were a Hibernate <tt>Session</tt>:<br /> <br /> Transaction tx = session.beginTransaction();<br /> TestEntity newTestEntity = new TestEntity();<br /> newTestEntity.setTestStringField("testInsertTestEntity string field");<br /> newTestEntity.setCreatedStamp(UtilDateTime.nowTimestamp());<br /> session.save(newTestEntity);<br /> tx.commit();<br /> session.flush();<br /> // ...<br /> TestEntity loadEntity = (TestEntity) session.load(TestEntity.class, newTestEntity.getTestId());<br /> // ...<br /> String hql = "from TestEntity eo where eo.testId='" + testEntityId2 + "'";<br /> Query query = session.createQuery(hql);<br /> List<TestEntity> list = query.list()<br /> <br /> You do not need to close your JDBC connection manually with the opentaps Session, however. When you call<br /> session.close();<br /> It will do it for you automatically.<br /> <br /> === Traversing Related Entities ===<br /> <br /> opentaps will automatically create the relationship annotations, such as @OneToMany, @ManyToMany, and @Join, for your Java classes.<br /> <br /> To get related entities, use the hibernate query language (HQL):<br /> String hql = "from TestEntityItem eo where eo.testEntity.testId='" + testEntity.getTestId() + "'"<br /> + " and eo.testEntityItemSeqId in (" + testEntityItemSeqIds + ")";<br /> Query query = session.createQuery(hql);<br /> List<TestEntityItem> list = query.list();<br /> <br /> Or use the getter methods in the base entities:<br /> List<TestEntityItem> list = testEntity.getTestEntityItems();<br /> <br /> Note that hibernate will automatically load related entities for you, so the getRelated methods from Repository which were designed for the ofbiz entity engine are no longer needed when you work with hibernate.<br /> <br /> === Working with View Entities ===<br /> <br /> Once a view entity has been defined in <tt>entitymodel.xml</tt>, you can access it as any other Java object from hibernate, for example:<br /> Query query = session.createQuery("from TestEntityAndItem eo where eo.testId='" <br /> + testEntityId + "' order by eo.testEntityItemSeqId");<br /> List<TestEntityAndItem> list = query.list();<br /> <br /> The opentaps Session, which extends the hibernate Session, will automatically create the SQL for accessing the view entity.<br /> <br /> === Using Transactions ===<br /> <br /> You should use the transaction manager configured in the ofbiz entity engine through the <tt>[http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/transaction/UserTransaction.html UserTransaction]</tt> class. In the entity engine, the transaction manager is configured as:<br /> <transaction-factory class="org.ofbiz.geronimo.GeronimoTransactionFactory"/><br /> <br /> This is obtained from the ofbiz <tt>TransactionFactory</tt> by our <tt>Session</tt> and used the same way as a hibernate transaction:<br /> <pre><br /> UserTransaction tx = session.beginUserTransaction();<br /> // do something useful<br /> tx.commit();<br /> </pre><br /> <br /> === Auto Generating ID Values ===<br /> <br /> ofbiz keeps track of auto generated sequence IDs in an entity called <tt>SequenceValueItem</tt> To make sure that the auto generated sequence IDs from hibernate and the ofbiz entity engine work well together, we have created an <tt>OpentapsIdentifierGenerator</tt> which also uses the same <tt>SequenceValueItem</tt> to obtain the next sequential ID. This ID generator is wired to the base entity POJO Java objects with hibernate annotations, like this:<br /> <pre><br /> @org.hibernate.annotations.GenericGenerator(name="Party_GEN", strategy="org.opentaps.foundation.entity.hibernate.OpentapsIdentifierGenerator")<br /> @GeneratedValue(generator="Party_GEN") <br /> @Id<br /> <br /> @Column(name="PARTY_ID")<br /> <br /> private String partyId;<br /> </pre><br /> <br /> So that a <tt>partyId</tt> field is automatically set for you.<br /> <br /> You can also ask the <tt>Session</tt> to generate a particular sequence ID for you:<br /> String testEntityItemSeqId = session.getNextSeqId("TestEntityItemSeqId");<br /> <br /> This can be helpful when you have complex keys with several fields, and you want the secondary key fields to be auto sequenced as well.<br /> <br /> === Support for OFBIZ EECA's ===<br /> <br /> ofbiz EECA's are supported with custom event listeners which are registered with hibernate when <tt>Infrastructure.getSessionFactory(String delegatorName)</tt> is called, usually during the initial startup. These event listeners will run ofbiz services defined in <tt>eeca.xml</tt>'s when hibernate is used to update the same entities.<br /> <br /> === Caching ===<br /> Our caching system now support ofbiz <-> hibernate mutual cache clearing. It mean it will sync hibernate cache on you update GenericValue with ofbiz entity engine, and vice versa. The hibernate cache configuration is locate in HibernateCfg.ftl (it also in hibernate.cfg.xml) as following:<br /> <pre><br /> <property name="hibernate.search.worker.execution">async</property><br /> <property name="hibernate.cache.use_query_cache">true</property><br /> <property name="hibernate.cache.use_second_level_cache">true</property><br /> <property name="hibernate.search.worker.buffer_queue.max">5</property><br /> <property name="hibernate.search.worker.thread_pool.size">5</property><br /> </pre><br /> you can disable the caching feature by remove these lines (both HibernateCfg.ftl and hibernate.cfg.xml).<br /> <br/><br/><br /> {{note|Important|The entities of current open session will not update when it change by ofbiz entity engine, you must using open a new session to get fresh object. and the best practise is also close your session when it finish the job.}}<br /> <br /> === Using Hibernate without the OFBIZ Entity Engine ===<br /> <br /> You can also use hibernate without the ofbiz entity engine by adding your Java objects to the template opentaps uses to generate the hibernate configuration files, <tt>hot-deploy/opentaps-common/templates/HibernateCfg.ftl</tt>. Simply put your Java objects after the <br /> <pre><br /> <#list><br /> ...<br /> </#list><br /> </pre><br /> <br /> directives in the file, like in the following example: <br /> <br /> <pre><br /> <!DOCTYPE hibernate-configuration PUBLIC "-//Hibernate/Hibernate Configuration DTD 3.0//EN" "http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd"><br /> <br /> <hibernate-configuration><br /> <session-factory><br /> <property name="hibernate.connection.provider_class">org.opentaps.foundation.entity.hibernate.OpentapsConnectionProvider</property> <br /> <property name="hibernate.transaction.factory_class">org.opentaps.foundation.entity.hibernate.OpentapsTransactionFactory</property><br /> <property name="hibernate.transaction.manager_lookup_class">org.opentaps.foundation.entity.hibernate.OpentapsTransactionManagerLookup</property> <br /> <property name="hibernate.search.default.directory_provider">org.hibernate.search.store.FSDirectoryProvider</property><br /> <#list entities as entity><br /> <mapping class="org.opentaps.domain.base.entities.${entity}"/><br /> </#list><br /> <mapping class="org.opentaps.domain.base.entities.MyPojo1"/><br /> <mapping class="org.opentaps.domain.base.entities.MyPojo2"/><br /> </session-factory><br /> </hibernate-configuration><br /> </pre><br /> <br /> opentaps will then create the hibernate configuration file for each database and include your Java objects in it. However, you would not be able to access these Java objects as generic values from the ofbiz entity engine.<br /> <br /> == Under the Hood: How It Works ==<br /> <br /> === Base Class Annotations ===<br /> <br /> In opentaps version 1.4, the entity model XML from the ofbiz entity engine is still used as the base definition for all entities. The opentaps POJO generator is used to create [[Base Entity Classes|base Java objects]] automatically from these entity definitions. This POJO generator will also create the annotations which hibernate can then use to map those base objects to the database persistence layer. The definitions of the annotations can be found in <tt>BaseEntity.ftl</tt> file used by the POJO generator.<br /> <br /> === How Hibernate Configuration Files are Generated ===<br /> <br /> The POJO Generator will use <tt>hot-deploy/opentaps-common/templates/HibernateCfg.ftl</tt> to generate a base hibernate configuration file in <tt>hot-deploy/opentaps-common/config/hibernate.cfg.xml</tt> When opentaps is started, the following new container in <tt>framework/base/config/ofbiz-containers.xml</tt><br /> <pre><br /> <container name="hibernate-container" class="org.opentaps.common.container.HibernateContainer"><br /> <property name="delegator-name" value="default"/><br /> </container> <br /> </pre><br /> <br /> will generate all the hibernate configuration XML files in the <tt>hot-deploy/opentaps/config/</tt> directory for each data source in your entity engine XML file. For example, it will generate a <tt>localmysql.cfg.xml</tt>, a <tt>localpostgres.cfg.xml</tt><br /> <br /> === How We Get the Hibernate Session ===<br /> <br /> The opentaps <tt>Infrastructure</tt> Class maintains a Map of delegatorName and hibernate SessionFactory objects. Each SessionFactory is created for its corresponding delegatorName the first time it is requested from the <tt>Infrastructure.getSessionFactory(delegatorName)</tt> method. This SessionFactory is created from ofbiz entity engine configurations:<br /> * The <tt>HibernateContainer</tt> in <tt>ofbiz-containers.xml</tt> has a property called <tt>delegator-name</tt><br /> * From this delegator, we get the data source defined in <tt>entityengine.xml</tt> for the default group helper name. This is set to <tt>org.ofbiz</tt> by default in the <tt>Infrastructure</tt> class and is the <tt>group</tt> attribute of the <tt>entitygroup.xml</tt> definitions in ofbiz:<br /> <entity-group group="org.ofbiz" entity="AcctgTagEnumType"/><br /> In <tt>entityengine.xml</tt>, you map a data source to each group:<br /> <delegator name="default" entity-model-reader="main" entity-group-reader="main" entity-eca-reader="main" distributed-cache-clear-enabled="false"><br /> <group-map group-name="org.ofbiz" datasource-name="localmysql"/><br /> </delegator><br /> <br /> So, we are basically following the entity engine from the delegator to the data source via the group.<br /> * Once we have the data source, we can create the SessionFactory from the hibernate.cfg.xml for that data source. For example, if your data source is "localmysql", we will create the SessionFactory from the <tt>localmysql.cfg.xml</tt> created by the <tt>HibernateContainer</tt><br /> <br /> The <tt>HibernateContainer</tt>, which loads on startup, will cause a SessionFactory to be loaded for the delegator in the <tt>delegator-name</tt> attribute. Once this SessionFactory is loaded, it will be available for future use. Additional session factories can be obtained later by calling the <tt>getSessionFactory</tt> directly.<br /> <br /> When the <tt>Infrastructure.getSession()</tt> method is called, it will use the delegator already in the Infrastructure object to open a JDBC connection first, and then use that JDBC connection and the SessionFactory for the delegator to return a Session.<br /> <br /> The <tt>Infrastructure.getSession()</tt> will return an <tt>org.opentaps.foundation.entity.hibernate.Session</tt>, which extends the hibernate Session with the following differences:<br /> * when the session is closed, the JDBC connection is also automatically closed<br /> * when a Query is created, this Session will check if the query is on an entity engine view entity and construct the Query from native SQL first<br /> <br /> === View Entities ===<br /> <br /> View entities are supported with @NamedNativeQuery annotations in the base entity Java classes, which are automatically generated by the opentaps POJO Generator.<br /> <br /> === Encryption ===<br /> <br /> The ofbiz delegator allows you to set a field to be encrypted in the database with the <tt>encrypt="true"</tt> attribute in the <tt>field</tt> tag of an entity definition. The opentaps hibernate will support the same encryption/decryption algorithm, so that encrypted values can be stored with the delegator and decrypted when it's retrieved with hibernate or vice versa. This is done by:<br /> # When an object is being stored, the <tt>EcaCommEvent.beforeSave</tt> Method will come for the object to an ofbiz GenericValue and then use the ofbiz delegator to encrypt it.<br /> # When an object is retrieved from the database, the <tt>Session.load</tt> will call the <tt>HibernateUtil.decryptField</tt> to decrypt it.<br /> <br /> === Transaction Management ===<br /> <br /> To maintain compatibility with the ofbiz entity engine's transaction manager and connection pool providers, we have defined transaction manager look up, transaction factory, and connection provider classes which use the ofbiz transaction manager and transaction factory to begin transactions. These are defined in the <tt>hibernate.cfg.xml</tt> configuration file. They allow you to mix delegator and hibernate transaction codes as in this following example:<br /> <pre><br /> UserTransaction tx = session.beginUserTransaction();<br /> TestEntity useIdentifierTestEntity = new TestEntity();<br /> useIdentifierTestEntity.setTestStringField("Use IdentifierGenerator string field");<br /> session.save(useIdentifierTestEntity);<br /> String getNextSeqIdTestEntityId = delegator.getNextSeqId("TestEntity");<br /> GenericValue useGetNextSeqIdTestEntity = delegator.create("TestEntity",<br /> UtilMisc.toMap("testId", getNextSeqIdTestEntityId, "testStringField", "Use getNextSeqId string field"));<br /> session.flush();<br /> tx.commit();<br /> </pre><br /> <br /> === Support for BLOBs ===<br /> <br /> To make the "BLOB" type work with postgresql, we made the following changes:<br /> # change blob field mapping to Java byte[] <br /> # avoid using the <tt>@Lob</tt> annotation<br /> # add this element in hibernate.cfg.xml<br /> <property name="hibernate.jdbc.use_streams_for_binary">true</property><br /> <br /> === Unit Tests ===<br /> <br /> Unit tests for hibernate are found in <tt>org.opentaps.tests.entity.HibernateTests</tt> in the opentaps-tests component.<br /> <br /> == Learning More ==<br /> <br /> The best way to learn more about how to use hibernate with opentaps is to look through the unit tests in <tt>org.opentaps.tests.entity.HibernateTests</tt> as an example.</div>

Spark https://docs.opentaps.org/docs/index.php?title=Opentaps_Hibernate_Integration&diff=5039 Opentaps Hibernate Integration 2009-11-21T03:58:42Z

<p>Spark: /* Caching */</p> <hr /> <div>Beginning with opentaps version 1.4, [http://www.hibernate.org Hibernate] will be available as a persistence tool alongside with the original ofbiz entity engine. Hibernate is a more object oriented persistence framework and better suited for the new [[Domain Driven Architecture]], while the ofbiz entity engine will continue to be supported for legacy features from both ofbiz and opentaps. In this document, we will review how the hibernate integration in opentaps works.<br /> <br /> == Working with Hibernate in opentaps ==<br /> <br /> === Generating Hibernate Configuration Files ===<br /> <br /> After changing or defining new entities in your <tt>entitymodel.xml</tt> files, you need to generate new Java classes for your entities with<br /> $ ant make-base-entities<br /> <br /> This command updates the Java classes defined in <tt>org.opentaps.domain.base.entities</tt>, including their hibernate annotations, and the <tt>hibernate.cfg.xml</tt> for integrating with hibernate. (If you use a repository management system, you must commit both and you Java classes and the updated <tt>hibernate.cfg.xml</tt> files.)<br /> <br /> {{note|Important|Be sure to reference the JARs from <tt>/hot-deploy/opentaps-common/lib/hibernate</tt> in your Ant build file, or else during build it will not be able to locate the appropriate Hibernate files.}}<br /> <br /> === Accessing Entities with Hibernate ===<br /> <br /> {{tip|Tip|If you are developing in Eclipse, when using Hibernate make sure to run the ant task <tt>make-base-entities</tt> immediately after you are done defining new entities. Also make sure you refresh the Eclipse project so that it picks up the new Hibernate POJOs for code-assist.}}<br /> <br /> <br /> <br /> To use hibernate to access your entities, you will need an <tt>org.opentaps.foundation.entity.hibernate.Session</tt>, which is an extension of the <tt>org.hibernate.Session</tt> class. You can obtain it from the Infrastructure class like this:<br /> session = infrastructure.getSession();<br /> <br /> The <tt>Infrastructure</tt> must be created from <tt>dispatcher</tt> in order to obtain the hibernate session.<br /> <br /> In situations where you are passing through the service engine the <tt>dispatcher</tt> is obtained from the <tt>DispatchContext</tt><br /> <br /> For example:<br /> <br /> public static Map myNewService(DispatchContext dctx, Map context) {<br /> LocalDispatcher dispatcher = dctx.getDispatcher();<br /> <br /> try {<br /> Infrastructure infrastructure = new Infrastructure(dispatcher);<br /> Session session = infrastructure.getSession();<br /> } catch (InfrastructureException e) {<br /> // TODO Auto-generated catch block<br /> e.printStackTrace();<br /> }<br /> }<br /> <br /> In situations where you are bypassing the service engine and accessing the Java method directly the <tt>dispatcher</tt> is obtained from <tt>HttpServletRequest</tt><br /> <br /> For example:<br /> <br /> public static Map myNewService(HttpServletRequest request, HttpServletResponse response) {<br /> LocalDispatcher dispatcher = (LocalDispatcher) request.getAttribute("dispatcher");<br /> <br /> try {<br /> Infrastructure infrastructure = new Infrastructure(dispatcher);<br /> Session session = infrastructure.getSession();<br /> } catch (InfrastructureException e) {<br /> // TODO Auto-generated catch block<br /> e.printStackTrace();<br /> }<br /> }<br /> <br /> Then, you can work with it as if it were a Hibernate <tt>Session</tt>:<br /> <br /> Transaction tx = session.beginTransaction();<br /> TestEntity newTestEntity = new TestEntity();<br /> newTestEntity.setTestStringField("testInsertTestEntity string field");<br /> newTestEntity.setCreatedStamp(UtilDateTime.nowTimestamp());<br /> session.save(newTestEntity);<br /> tx.commit();<br /> session.flush();<br /> // ...<br /> TestEntity loadEntity = (TestEntity) session.load(TestEntity.class, newTestEntity.getTestId());<br /> // ...<br /> String hql = "from TestEntity eo where eo.testId='" + testEntityId2 + "'";<br /> Query query = session.createQuery(hql);<br /> List<TestEntity> list = query.list()<br /> <br /> You do not need to close your JDBC connection manually with the opentaps Session, however. When you call<br /> session.close();<br /> It will do it for you automatically.<br /> <br /> === Traversing Related Entities ===<br /> <br /> opentaps will automatically create the relationship annotations, such as @OneToMany, @ManyToMany, and @Join, for your Java classes.<br /> <br /> To get related entities, use the hibernate query language (HQL):<br /> String hql = "from TestEntityItem eo where eo.testEntity.testId='" + testEntity.getTestId() + "'"<br /> + " and eo.testEntityItemSeqId in (" + testEntityItemSeqIds + ")";<br /> Query query = session.createQuery(hql);<br /> List<TestEntityItem> list = query.list();<br /> <br /> Or use the getter methods in the base entities:<br /> List<TestEntityItem> list = testEntity.getTestEntityItems();<br /> <br /> Note that hibernate will automatically load related entities for you, so the getRelated methods from Repository which were designed for the ofbiz entity engine are no longer needed when you work with hibernate.<br /> <br /> === Working with View Entities ===<br /> <br /> Once a view entity has been defined in <tt>entitymodel.xml</tt>, you can access it as any other Java object from hibernate, for example:<br /> Query query = session.createQuery("from TestEntityAndItem eo where eo.testId='" <br /> + testEntityId + "' order by eo.testEntityItemSeqId");<br /> List<TestEntityAndItem> list = query.list();<br /> <br /> The opentaps Session, which extends the hibernate Session, will automatically create the SQL for accessing the view entity.<br /> <br /> === Using Transactions ===<br /> <br /> You should use the transaction manager configured in the ofbiz entity engine through the <tt>[http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/transaction/UserTransaction.html UserTransaction]</tt> class. In the entity engine, the transaction manager is configured as:<br /> <transaction-factory class="org.ofbiz.geronimo.GeronimoTransactionFactory"/><br /> <br /> This is obtained from the ofbiz <tt>TransactionFactory</tt> by our <tt>Session</tt> and used the same way as a hibernate transaction:<br /> <pre><br /> UserTransaction tx = session.beginUserTransaction();<br /> // do something useful<br /> tx.commit();<br /> </pre><br /> <br /> === Auto Generating ID Values ===<br /> <br /> ofbiz keeps track of auto generated sequence IDs in an entity called <tt>SequenceValueItem</tt> To make sure that the auto generated sequence IDs from hibernate and the ofbiz entity engine work well together, we have created an <tt>OpentapsIdentifierGenerator</tt> which also uses the same <tt>SequenceValueItem</tt> to obtain the next sequential ID. This ID generator is wired to the base entity POJO Java objects with hibernate annotations, like this:<br /> <pre><br /> @org.hibernate.annotations.GenericGenerator(name="Party_GEN", strategy="org.opentaps.foundation.entity.hibernate.OpentapsIdentifierGenerator")<br /> @GeneratedValue(generator="Party_GEN") <br /> @Id<br /> <br /> @Column(name="PARTY_ID")<br /> <br /> private String partyId;<br /> </pre><br /> <br /> So that a <tt>partyId</tt> field is automatically set for you.<br /> <br /> You can also ask the <tt>Session</tt> to generate a particular sequence ID for you:<br /> String testEntityItemSeqId = session.getNextSeqId("TestEntityItemSeqId");<br /> <br /> This can be helpful when you have complex keys with several fields, and you want the secondary key fields to be auto sequenced as well.<br /> <br /> === Support for OFBIZ EECA's ===<br /> <br /> ofbiz EECA's are supported with custom event listeners which are registered with hibernate when <tt>Infrastructure.getSessionFactory(String delegatorName)</tt> is called, usually during the initial startup. These event listeners will run ofbiz services defined in <tt>eeca.xml</tt>'s when hibernate is used to update the same entities.<br /> <br /> === Caching ===<br /> Our caching system now support ofbiz <-> hibernate mutual cache clearing. It mean it will sync hibernate cache on you update GenericValue with ofbiz entity engine, and vice versa. The hibernate cache configuration is locate in HibernateCfg.ftl (it also in hibernate.cfg.xml) as following:<br /> <pre><br /> <property name="hibernate.search.worker.execution">async</property><br /> <property name="hibernate.cache.use_query_cache">true</property><br /> <property name="hibernate.cache.use_second_level_cache">true</property><br /> <property name="hibernate.search.worker.buffer_queue.max">5</property><br /> <property name="hibernate.search.worker.thread_pool.size">5</property><br /> </pre><br /> you can disable the caching feature by remove these lines (both HibernateCfg.ftl and hibernate.cfg.xml).<br /> <br/><br/><br /> '''Note:''' the entities of current open session will not update when it change by ofbiz entity engine, you must using open a new session to get fresh object. and the best practise is also close your session when it finish the job.<br /> <br /> === Using Hibernate without the OFBIZ Entity Engine ===<br /> <br /> You can also use hibernate without the ofbiz entity engine by adding your Java objects to the template opentaps uses to generate the hibernate configuration files, <tt>hot-deploy/opentaps-common/templates/HibernateCfg.ftl</tt>. Simply put your Java objects after the <br /> <pre><br /> <#list><br /> ...<br /> </#list><br /> </pre><br /> <br /> directives in the file, like in the following example: <br /> <br /> <pre><br /> <!DOCTYPE hibernate-configuration PUBLIC "-//Hibernate/Hibernate Configuration DTD 3.0//EN" "http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd"><br /> <br /> <hibernate-configuration><br /> <session-factory><br /> <property name="hibernate.connection.provider_class">org.opentaps.foundation.entity.hibernate.OpentapsConnectionProvider</property> <br /> <property name="hibernate.transaction.factory_class">org.opentaps.foundation.entity.hibernate.OpentapsTransactionFactory</property><br /> <property name="hibernate.transaction.manager_lookup_class">org.opentaps.foundation.entity.hibernate.OpentapsTransactionManagerLookup</property> <br /> <property name="hibernate.search.default.directory_provider">org.hibernate.search.store.FSDirectoryProvider</property><br /> <#list entities as entity><br /> <mapping class="org.opentaps.domain.base.entities.${entity}"/><br /> </#list><br /> <mapping class="org.opentaps.domain.base.entities.MyPojo1"/><br /> <mapping class="org.opentaps.domain.base.entities.MyPojo2"/><br /> </session-factory><br /> </hibernate-configuration><br /> </pre><br /> <br /> opentaps will then create the hibernate configuration file for each database and include your Java objects in it. However, you would not be able to access these Java objects as generic values from the ofbiz entity engine.<br /> <br /> == Under the Hood: How It Works ==<br /> <br /> === Base Class Annotations ===<br /> <br /> In opentaps version 1.4, the entity model XML from the ofbiz entity engine is still used as the base definition for all entities. The opentaps POJO generator is used to create [[Base Entity Classes|base Java objects]] automatically from these entity definitions. This POJO generator will also create the annotations which hibernate can then use to map those base objects to the database persistence layer. The definitions of the annotations can be found in <tt>BaseEntity.ftl</tt> file used by the POJO generator.<br /> <br /> === How Hibernate Configuration Files are Generated ===<br /> <br /> The POJO Generator will use <tt>hot-deploy/opentaps-common/templates/HibernateCfg.ftl</tt> to generate a base hibernate configuration file in <tt>hot-deploy/opentaps-common/config/hibernate.cfg.xml</tt> When opentaps is started, the following new container in <tt>framework/base/config/ofbiz-containers.xml</tt><br /> <pre><br /> <container name="hibernate-container" class="org.opentaps.common.container.HibernateContainer"><br /> <property name="delegator-name" value="default"/><br /> </container> <br /> </pre><br /> <br /> will generate all the hibernate configuration XML files in the <tt>hot-deploy/opentaps/config/</tt> directory for each data source in your entity engine XML file. For example, it will generate a <tt>localmysql.cfg.xml</tt>, a <tt>localpostgres.cfg.xml</tt><br /> <br /> === How We Get the Hibernate Session ===<br /> <br /> The opentaps <tt>Infrastructure</tt> Class maintains a Map of delegatorName and hibernate SessionFactory objects. Each SessionFactory is created for its corresponding delegatorName the first time it is requested from the <tt>Infrastructure.getSessionFactory(delegatorName)</tt> method. This SessionFactory is created from ofbiz entity engine configurations:<br /> * The <tt>HibernateContainer</tt> in <tt>ofbiz-containers.xml</tt> has a property called <tt>delegator-name</tt><br /> * From this delegator, we get the data source defined in <tt>entityengine.xml</tt> for the default group helper name. This is set to <tt>org.ofbiz</tt> by default in the <tt>Infrastructure</tt> class and is the <tt>group</tt> attribute of the <tt>entitygroup.xml</tt> definitions in ofbiz:<br /> <entity-group group="org.ofbiz" entity="AcctgTagEnumType"/><br /> In <tt>entityengine.xml</tt>, you map a data source to each group:<br /> <delegator name="default" entity-model-reader="main" entity-group-reader="main" entity-eca-reader="main" distributed-cache-clear-enabled="false"><br /> <group-map group-name="org.ofbiz" datasource-name="localmysql"/><br /> </delegator><br /> <br /> So, we are basically following the entity engine from the delegator to the data source via the group.<br /> * Once we have the data source, we can create the SessionFactory from the hibernate.cfg.xml for that data source. For example, if your data source is "localmysql", we will create the SessionFactory from the <tt>localmysql.cfg.xml</tt> created by the <tt>HibernateContainer</tt><br /> <br /> The <tt>HibernateContainer</tt>, which loads on startup, will cause a SessionFactory to be loaded for the delegator in the <tt>delegator-name</tt> attribute. Once this SessionFactory is loaded, it will be available for future use. Additional session factories can be obtained later by calling the <tt>getSessionFactory</tt> directly.<br /> <br /> When the <tt>Infrastructure.getSession()</tt> method is called, it will use the delegator already in the Infrastructure object to open a JDBC connection first, and then use that JDBC connection and the SessionFactory for the delegator to return a Session.<br /> <br /> The <tt>Infrastructure.getSession()</tt> will return an <tt>org.opentaps.foundation.entity.hibernate.Session</tt>, which extends the hibernate Session with the following differences:<br /> * when the session is closed, the JDBC connection is also automatically closed<br /> * when a Query is created, this Session will check if the query is on an entity engine view entity and construct the Query from native SQL first<br /> <br /> === View Entities ===<br /> <br /> View entities are supported with @NamedNativeQuery annotations in the base entity Java classes, which are automatically generated by the opentaps POJO Generator.<br /> <br /> === Encryption ===<br /> <br /> The ofbiz delegator allows you to set a field to be encrypted in the database with the <tt>encrypt="true"</tt> attribute in the <tt>field</tt> tag of an entity definition. The opentaps hibernate will support the same encryption/decryption algorithm, so that encrypted values can be stored with the delegator and decrypted when it's retrieved with hibernate or vice versa. This is done by:<br /> # When an object is being stored, the <tt>EcaCommEvent.beforeSave</tt> Method will come for the object to an ofbiz GenericValue and then use the ofbiz delegator to encrypt it.<br /> # When an object is retrieved from the database, the <tt>Session.load</tt> will call the <tt>HibernateUtil.decryptField</tt> to decrypt it.<br /> <br /> === Transaction Management ===<br /> <br /> To maintain compatibility with the ofbiz entity engine's transaction manager and connection pool providers, we have defined transaction manager look up, transaction factory, and connection provider classes which use the ofbiz transaction manager and transaction factory to begin transactions. These are defined in the <tt>hibernate.cfg.xml</tt> configuration file. They allow you to mix delegator and hibernate transaction codes as in this following example:<br /> <pre><br /> UserTransaction tx = session.beginUserTransaction();<br /> TestEntity useIdentifierTestEntity = new TestEntity();<br /> useIdentifierTestEntity.setTestStringField("Use IdentifierGenerator string field");<br /> session.save(useIdentifierTestEntity);<br /> String getNextSeqIdTestEntityId = delegator.getNextSeqId("TestEntity");<br /> GenericValue useGetNextSeqIdTestEntity = delegator.create("TestEntity",<br /> UtilMisc.toMap("testId", getNextSeqIdTestEntityId, "testStringField", "Use getNextSeqId string field"));<br /> session.flush();<br /> tx.commit();<br /> </pre><br /> <br /> === Support for BLOBs ===<br /> <br /> To make the "BLOB" type work with postgresql, we made the following changes:<br /> # change blob field mapping to Java byte[] <br /> # avoid using the <tt>@Lob</tt> annotation<br /> # add this element in hibernate.cfg.xml<br /> <property name="hibernate.jdbc.use_streams_for_binary">true</property><br /> <br /> === Unit Tests ===<br /> <br /> Unit tests for hibernate are found in <tt>org.opentaps.tests.entity.HibernateTests</tt> in the opentaps-tests component.<br /> <br /> == Learning More ==<br /> <br /> The best way to learn more about how to use hibernate with opentaps is to look through the unit tests in <tt>org.opentaps.tests.entity.HibernateTests</tt> as an example.</div>

Spark https://docs.opentaps.org/docs/index.php?title=Opentaps_Hibernate_Integration&diff=5038 Opentaps Hibernate Integration 2009-11-21T03:58:03Z

<p>Spark: /* Caching */</p> <hr /> <div>Beginning with opentaps version 1.4, [http://www.hibernate.org Hibernate] will be available as a persistence tool alongside with the original ofbiz entity engine. Hibernate is a more object oriented persistence framework and better suited for the new [[Domain Driven Architecture]], while the ofbiz entity engine will continue to be supported for legacy features from both ofbiz and opentaps. In this document, we will review how the hibernate integration in opentaps works.<br /> <br /> == Working with Hibernate in opentaps ==<br /> <br /> === Generating Hibernate Configuration Files ===<br /> <br /> After changing or defining new entities in your <tt>entitymodel.xml</tt> files, you need to generate new Java classes for your entities with<br /> $ ant make-base-entities<br /> <br /> This command updates the Java classes defined in <tt>org.opentaps.domain.base.entities</tt>, including their hibernate annotations, and the <tt>hibernate.cfg.xml</tt> for integrating with hibernate. (If you use a repository management system, you must commit both and you Java classes and the updated <tt>hibernate.cfg.xml</tt> files.)<br /> <br /> {{note|Important|Be sure to reference the JARs from <tt>/hot-deploy/opentaps-common/lib/hibernate</tt> in your Ant build file, or else during build it will not be able to locate the appropriate Hibernate files.}}<br /> <br /> === Accessing Entities with Hibernate ===<br /> <br /> {{tip|Tip|If you are developing in Eclipse, when using Hibernate make sure to run the ant task <tt>make-base-entities</tt> immediately after you are done defining new entities. Also make sure you refresh the Eclipse project so that it picks up the new Hibernate POJOs for code-assist.}}<br /> <br /> <br /> <br /> To use hibernate to access your entities, you will need an <tt>org.opentaps.foundation.entity.hibernate.Session</tt>, which is an extension of the <tt>org.hibernate.Session</tt> class. You can obtain it from the Infrastructure class like this:<br /> session = infrastructure.getSession();<br /> <br /> The <tt>Infrastructure</tt> must be created from <tt>dispatcher</tt> in order to obtain the hibernate session.<br /> <br /> In situations where you are passing through the service engine the <tt>dispatcher</tt> is obtained from the <tt>DispatchContext</tt><br /> <br /> For example:<br /> <br /> public static Map myNewService(DispatchContext dctx, Map context) {<br /> LocalDispatcher dispatcher = dctx.getDispatcher();<br /> <br /> try {<br /> Infrastructure infrastructure = new Infrastructure(dispatcher);<br /> Session session = infrastructure.getSession();<br /> } catch (InfrastructureException e) {<br /> // TODO Auto-generated catch block<br /> e.printStackTrace();<br /> }<br /> }<br /> <br /> In situations where you are bypassing the service engine and accessing the Java method directly the <tt>dispatcher</tt> is obtained from <tt>HttpServletRequest</tt><br /> <br /> For example:<br /> <br /> public static Map myNewService(HttpServletRequest request, HttpServletResponse response) {<br /> LocalDispatcher dispatcher = (LocalDispatcher) request.getAttribute("dispatcher");<br /> <br /> try {<br /> Infrastructure infrastructure = new Infrastructure(dispatcher);<br /> Session session = infrastructure.getSession();<br /> } catch (InfrastructureException e) {<br /> // TODO Auto-generated catch block<br /> e.printStackTrace();<br /> }<br /> }<br /> <br /> Then, you can work with it as if it were a Hibernate <tt>Session</tt>:<br /> <br /> Transaction tx = session.beginTransaction();<br /> TestEntity newTestEntity = new TestEntity();<br /> newTestEntity.setTestStringField("testInsertTestEntity string field");<br /> newTestEntity.setCreatedStamp(UtilDateTime.nowTimestamp());<br /> session.save(newTestEntity);<br /> tx.commit();<br /> session.flush();<br /> // ...<br /> TestEntity loadEntity = (TestEntity) session.load(TestEntity.class, newTestEntity.getTestId());<br /> // ...<br /> String hql = "from TestEntity eo where eo.testId='" + testEntityId2 + "'";<br /> Query query = session.createQuery(hql);<br /> List<TestEntity> list = query.list()<br /> <br /> You do not need to close your JDBC connection manually with the opentaps Session, however. When you call<br /> session.close();<br /> It will do it for you automatically.<br /> <br /> === Traversing Related Entities ===<br /> <br /> opentaps will automatically create the relationship annotations, such as @OneToMany, @ManyToMany, and @Join, for your Java classes.<br /> <br /> To get related entities, use the hibernate query language (HQL):<br /> String hql = "from TestEntityItem eo where eo.testEntity.testId='" + testEntity.getTestId() + "'"<br /> + " and eo.testEntityItemSeqId in (" + testEntityItemSeqIds + ")";<br /> Query query = session.createQuery(hql);<br /> List<TestEntityItem> list = query.list();<br /> <br /> Or use the getter methods in the base entities:<br /> List<TestEntityItem> list = testEntity.getTestEntityItems();<br /> <br /> Note that hibernate will automatically load related entities for you, so the getRelated methods from Repository which were designed for the ofbiz entity engine are no longer needed when you work with hibernate.<br /> <br /> === Working with View Entities ===<br /> <br /> Once a view entity has been defined in <tt>entitymodel.xml</tt>, you can access it as any other Java object from hibernate, for example:<br /> Query query = session.createQuery("from TestEntityAndItem eo where eo.testId='" <br /> + testEntityId + "' order by eo.testEntityItemSeqId");<br /> List<TestEntityAndItem> list = query.list();<br /> <br /> The opentaps Session, which extends the hibernate Session, will automatically create the SQL for accessing the view entity.<br /> <br /> === Using Transactions ===<br /> <br /> You should use the transaction manager configured in the ofbiz entity engine through the <tt>[http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/transaction/UserTransaction.html UserTransaction]</tt> class. In the entity engine, the transaction manager is configured as:<br /> <transaction-factory class="org.ofbiz.geronimo.GeronimoTransactionFactory"/><br /> <br /> This is obtained from the ofbiz <tt>TransactionFactory</tt> by our <tt>Session</tt> and used the same way as a hibernate transaction:<br /> <pre><br /> UserTransaction tx = session.beginUserTransaction();<br /> // do something useful<br /> tx.commit();<br /> </pre><br /> <br /> === Auto Generating ID Values ===<br /> <br /> ofbiz keeps track of auto generated sequence IDs in an entity called <tt>SequenceValueItem</tt> To make sure that the auto generated sequence IDs from hibernate and the ofbiz entity engine work well together, we have created an <tt>OpentapsIdentifierGenerator</tt> which also uses the same <tt>SequenceValueItem</tt> to obtain the next sequential ID. This ID generator is wired to the base entity POJO Java objects with hibernate annotations, like this:<br /> <pre><br /> @org.hibernate.annotations.GenericGenerator(name="Party_GEN", strategy="org.opentaps.foundation.entity.hibernate.OpentapsIdentifierGenerator")<br /> @GeneratedValue(generator="Party_GEN") <br /> @Id<br /> <br /> @Column(name="PARTY_ID")<br /> <br /> private String partyId;<br /> </pre><br /> <br /> So that a <tt>partyId</tt> field is automatically set for you.<br /> <br /> You can also ask the <tt>Session</tt> to generate a particular sequence ID for you:<br /> String testEntityItemSeqId = session.getNextSeqId("TestEntityItemSeqId");<br /> <br /> This can be helpful when you have complex keys with several fields, and you want the secondary key fields to be auto sequenced as well.<br /> <br /> === Support for OFBIZ EECA's ===<br /> <br /> ofbiz EECA's are supported with custom event listeners which are registered with hibernate when <tt>Infrastructure.getSessionFactory(String delegatorName)</tt> is called, usually during the initial startup. These event listeners will run ofbiz services defined in <tt>eeca.xml</tt>'s when hibernate is used to update the same entities.<br /> <br /> === Caching ===<br /> Our caching system now support ofbiz <-> hibernate mutual cache clearing. It mean it will sync hibernate cache on you update GenericValue with ofbiz entity engine, and vice versa. The hibernate cache configuration is locate in HibernateCfg.ftl (it also in hibernate.cfg.xml) as following:<br /> <pre><br /> <property name="hibernate.search.worker.execution">async</property><br /> <property name="hibernate.cache.use_query_cache">true</property><br /> <property name="hibernate.cache.use_second_level_cache">true</property><br /> <property name="hibernate.search.worker.buffer_queue.max">5</property><br /> <property name="hibernate.search.worker.thread_pool.size">5</property><br /> </pre><br /> you can disable the caching feature by remove these lines (both HibernateCfg.ftl and hibernate.cfg.xml).<br /> <br><br /> Note: the entities of current open session will not update when it change by ofbiz entity engine, you must using open a new session to get fresh object. and the best practise is also close your session when it finish the job.<br /> <br /> === Using Hibernate without the OFBIZ Entity Engine ===<br /> <br /> You can also use hibernate without the ofbiz entity engine by adding your Java objects to the template opentaps uses to generate the hibernate configuration files, <tt>hot-deploy/opentaps-common/templates/HibernateCfg.ftl</tt>. Simply put your Java objects after the <br /> <pre><br /> <#list><br /> ...<br /> </#list><br /> </pre><br /> <br /> directives in the file, like in the following example: <br /> <br /> <pre><br /> <!DOCTYPE hibernate-configuration PUBLIC "-//Hibernate/Hibernate Configuration DTD 3.0//EN" "http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd"><br /> <br /> <hibernate-configuration><br /> <session-factory><br /> <property name="hibernate.connection.provider_class">org.opentaps.foundation.entity.hibernate.OpentapsConnectionProvider</property> <br /> <property name="hibernate.transaction.factory_class">org.opentaps.foundation.entity.hibernate.OpentapsTransactionFactory</property><br /> <property name="hibernate.transaction.manager_lookup_class">org.opentaps.foundation.entity.hibernate.OpentapsTransactionManagerLookup</property> <br /> <property name="hibernate.search.default.directory_provider">org.hibernate.search.store.FSDirectoryProvider</property><br /> <#list entities as entity><br /> <mapping class="org.opentaps.domain.base.entities.${entity}"/><br /> </#list><br /> <mapping class="org.opentaps.domain.base.entities.MyPojo1"/><br /> <mapping class="org.opentaps.domain.base.entities.MyPojo2"/><br /> </session-factory><br /> </hibernate-configuration><br /> </pre><br /> <br /> opentaps will then create the hibernate configuration file for each database and include your Java objects in it. However, you would not be able to access these Java objects as generic values from the ofbiz entity engine.<br /> <br /> == Under the Hood: How It Works ==<br /> <br /> === Base Class Annotations ===<br /> <br /> In opentaps version 1.4, the entity model XML from the ofbiz entity engine is still used as the base definition for all entities. The opentaps POJO generator is used to create [[Base Entity Classes|base Java objects]] automatically from these entity definitions. This POJO generator will also create the annotations which hibernate can then use to map those base objects to the database persistence layer. The definitions of the annotations can be found in <tt>BaseEntity.ftl</tt> file used by the POJO generator.<br /> <br /> === How Hibernate Configuration Files are Generated ===<br /> <br /> The POJO Generator will use <tt>hot-deploy/opentaps-common/templates/HibernateCfg.ftl</tt> to generate a base hibernate configuration file in <tt>hot-deploy/opentaps-common/config/hibernate.cfg.xml</tt> When opentaps is started, the following new container in <tt>framework/base/config/ofbiz-containers.xml</tt><br /> <pre><br /> <container name="hibernate-container" class="org.opentaps.common.container.HibernateContainer"><br /> <property name="delegator-name" value="default"/><br /> </container> <br /> </pre><br /> <br /> will generate all the hibernate configuration XML files in the <tt>hot-deploy/opentaps/config/</tt> directory for each data source in your entity engine XML file. For example, it will generate a <tt>localmysql.cfg.xml</tt>, a <tt>localpostgres.cfg.xml</tt><br /> <br /> === How We Get the Hibernate Session ===<br /> <br /> The opentaps <tt>Infrastructure</tt> Class maintains a Map of delegatorName and hibernate SessionFactory objects. Each SessionFactory is created for its corresponding delegatorName the first time it is requested from the <tt>Infrastructure.getSessionFactory(delegatorName)</tt> method. This SessionFactory is created from ofbiz entity engine configurations:<br /> * The <tt>HibernateContainer</tt> in <tt>ofbiz-containers.xml</tt> has a property called <tt>delegator-name</tt><br /> * From this delegator, we get the data source defined in <tt>entityengine.xml</tt> for the default group helper name. This is set to <tt>org.ofbiz</tt> by default in the <tt>Infrastructure</tt> class and is the <tt>group</tt> attribute of the <tt>entitygroup.xml</tt> definitions in ofbiz:<br /> <entity-group group="org.ofbiz" entity="AcctgTagEnumType"/><br /> In <tt>entityengine.xml</tt>, you map a data source to each group:<br /> <delegator name="default" entity-model-reader="main" entity-group-reader="main" entity-eca-reader="main" distributed-cache-clear-enabled="false"><br /> <group-map group-name="org.ofbiz" datasource-name="localmysql"/><br /> </delegator><br /> <br /> So, we are basically following the entity engine from the delegator to the data source via the group.<br /> * Once we have the data source, we can create the SessionFactory from the hibernate.cfg.xml for that data source. For example, if your data source is "localmysql", we will create the SessionFactory from the <tt>localmysql.cfg.xml</tt> created by the <tt>HibernateContainer</tt><br /> <br /> The <tt>HibernateContainer</tt>, which loads on startup, will cause a SessionFactory to be loaded for the delegator in the <tt>delegator-name</tt> attribute. Once this SessionFactory is loaded, it will be available for future use. Additional session factories can be obtained later by calling the <tt>getSessionFactory</tt> directly.<br /> <br /> When the <tt>Infrastructure.getSession()</tt> method is called, it will use the delegator already in the Infrastructure object to open a JDBC connection first, and then use that JDBC connection and the SessionFactory for the delegator to return a Session.<br /> <br /> The <tt>Infrastructure.getSession()</tt> will return an <tt>org.opentaps.foundation.entity.hibernate.Session</tt>, which extends the hibernate Session with the following differences:<br /> * when the session is closed, the JDBC connection is also automatically closed<br /> * when a Query is created, this Session will check if the query is on an entity engine view entity and construct the Query from native SQL first<br /> <br /> === View Entities ===<br /> <br /> View entities are supported with @NamedNativeQuery annotations in the base entity Java classes, which are automatically generated by the opentaps POJO Generator.<br /> <br /> === Encryption ===<br /> <br /> The ofbiz delegator allows you to set a field to be encrypted in the database with the <tt>encrypt="true"</tt> attribute in the <tt>field</tt> tag of an entity definition. The opentaps hibernate will support the same encryption/decryption algorithm, so that encrypted values can be stored with the delegator and decrypted when it's retrieved with hibernate or vice versa. This is done by:<br /> # When an object is being stored, the <tt>EcaCommEvent.beforeSave</tt> Method will come for the object to an ofbiz GenericValue and then use the ofbiz delegator to encrypt it.<br /> # When an object is retrieved from the database, the <tt>Session.load</tt> will call the <tt>HibernateUtil.decryptField</tt> to decrypt it.<br /> <br /> === Transaction Management ===<br /> <br /> To maintain compatibility with the ofbiz entity engine's transaction manager and connection pool providers, we have defined transaction manager look up, transaction factory, and connection provider classes which use the ofbiz transaction manager and transaction factory to begin transactions. These are defined in the <tt>hibernate.cfg.xml</tt> configuration file. They allow you to mix delegator and hibernate transaction codes as in this following example:<br /> <pre><br /> UserTransaction tx = session.beginUserTransaction();<br /> TestEntity useIdentifierTestEntity = new TestEntity();<br /> useIdentifierTestEntity.setTestStringField("Use IdentifierGenerator string field");<br /> session.save(useIdentifierTestEntity);<br /> String getNextSeqIdTestEntityId = delegator.getNextSeqId("TestEntity");<br /> GenericValue useGetNextSeqIdTestEntity = delegator.create("TestEntity",<br /> UtilMisc.toMap("testId", getNextSeqIdTestEntityId, "testStringField", "Use getNextSeqId string field"));<br /> session.flush();<br /> tx.commit();<br /> </pre><br /> <br /> === Support for BLOBs ===<br /> <br /> To make the "BLOB" type work with postgresql, we made the following changes:<br /> # change blob field mapping to Java byte[] <br /> # avoid using the <tt>@Lob</tt> annotation<br /> # add this element in hibernate.cfg.xml<br /> <property name="hibernate.jdbc.use_streams_for_binary">true</property><br /> <br /> === Unit Tests ===<br /> <br /> Unit tests for hibernate are found in <tt>org.opentaps.tests.entity.HibernateTests</tt> in the opentaps-tests component.<br /> <br /> == Learning More ==<br /> <br /> The best way to learn more about how to use hibernate with opentaps is to look through the unit tests in <tt>org.opentaps.tests.entity.HibernateTests</tt> as an example.</div>

Spark https://docs.opentaps.org/docs/index.php?title=Opentaps_Hibernate_Integration&diff=5037 Opentaps Hibernate Integration 2009-11-21T03:56:58Z

<p>Spark: </p> <hr /> <div>Beginning with opentaps version 1.4, [http://www.hibernate.org Hibernate] will be available as a persistence tool alongside with the original ofbiz entity engine. Hibernate is a more object oriented persistence framework and better suited for the new [[Domain Driven Architecture]], while the ofbiz entity engine will continue to be supported for legacy features from both ofbiz and opentaps. In this document, we will review how the hibernate integration in opentaps works.<br /> <br /> == Working with Hibernate in opentaps ==<br /> <br /> === Generating Hibernate Configuration Files ===<br /> <br /> After changing or defining new entities in your <tt>entitymodel.xml</tt> files, you need to generate new Java classes for your entities with<br /> $ ant make-base-entities<br /> <br /> This command updates the Java classes defined in <tt>org.opentaps.domain.base.entities</tt>, including their hibernate annotations, and the <tt>hibernate.cfg.xml</tt> for integrating with hibernate. (If you use a repository management system, you must commit both and you Java classes and the updated <tt>hibernate.cfg.xml</tt> files.)<br /> <br /> {{note|Important|Be sure to reference the JARs from <tt>/hot-deploy/opentaps-common/lib/hibernate</tt> in your Ant build file, or else during build it will not be able to locate the appropriate Hibernate files.}}<br /> <br /> === Accessing Entities with Hibernate ===<br /> <br /> {{tip|Tip|If you are developing in Eclipse, when using Hibernate make sure to run the ant task <tt>make-base-entities</tt> immediately after you are done defining new entities. Also make sure you refresh the Eclipse project so that it picks up the new Hibernate POJOs for code-assist.}}<br /> <br /> <br /> <br /> To use hibernate to access your entities, you will need an <tt>org.opentaps.foundation.entity.hibernate.Session</tt>, which is an extension of the <tt>org.hibernate.Session</tt> class. You can obtain it from the Infrastructure class like this:<br /> session = infrastructure.getSession();<br /> <br /> The <tt>Infrastructure</tt> must be created from <tt>dispatcher</tt> in order to obtain the hibernate session.<br /> <br /> In situations where you are passing through the service engine the <tt>dispatcher</tt> is obtained from the <tt>DispatchContext</tt><br /> <br /> For example:<br /> <br /> public static Map myNewService(DispatchContext dctx, Map context) {<br /> LocalDispatcher dispatcher = dctx.getDispatcher();<br /> <br /> try {<br /> Infrastructure infrastructure = new Infrastructure(dispatcher);<br /> Session session = infrastructure.getSession();<br /> } catch (InfrastructureException e) {<br /> // TODO Auto-generated catch block<br /> e.printStackTrace();<br /> }<br /> }<br /> <br /> In situations where you are bypassing the service engine and accessing the Java method directly the <tt>dispatcher</tt> is obtained from <tt>HttpServletRequest</tt><br /> <br /> For example:<br /> <br /> public static Map myNewService(HttpServletRequest request, HttpServletResponse response) {<br /> LocalDispatcher dispatcher = (LocalDispatcher) request.getAttribute("dispatcher");<br /> <br /> try {<br /> Infrastructure infrastructure = new Infrastructure(dispatcher);<br /> Session session = infrastructure.getSession();<br /> } catch (InfrastructureException e) {<br /> // TODO Auto-generated catch block<br /> e.printStackTrace();<br /> }<br /> }<br /> <br /> Then, you can work with it as if it were a Hibernate <tt>Session</tt>:<br /> <br /> Transaction tx = session.beginTransaction();<br /> TestEntity newTestEntity = new TestEntity();<br /> newTestEntity.setTestStringField("testInsertTestEntity string field");<br /> newTestEntity.setCreatedStamp(UtilDateTime.nowTimestamp());<br /> session.save(newTestEntity);<br /> tx.commit();<br /> session.flush();<br /> // ...<br /> TestEntity loadEntity = (TestEntity) session.load(TestEntity.class, newTestEntity.getTestId());<br /> // ...<br /> String hql = "from TestEntity eo where eo.testId='" + testEntityId2 + "'";<br /> Query query = session.createQuery(hql);<br /> List<TestEntity> list = query.list()<br /> <br /> You do not need to close your JDBC connection manually with the opentaps Session, however. When you call<br /> session.close();<br /> It will do it for you automatically.<br /> <br /> === Traversing Related Entities ===<br /> <br /> opentaps will automatically create the relationship annotations, such as @OneToMany, @ManyToMany, and @Join, for your Java classes.<br /> <br /> To get related entities, use the hibernate query language (HQL):<br /> String hql = "from TestEntityItem eo where eo.testEntity.testId='" + testEntity.getTestId() + "'"<br /> + " and eo.testEntityItemSeqId in (" + testEntityItemSeqIds + ")";<br /> Query query = session.createQuery(hql);<br /> List<TestEntityItem> list = query.list();<br /> <br /> Or use the getter methods in the base entities:<br /> List<TestEntityItem> list = testEntity.getTestEntityItems();<br /> <br /> Note that hibernate will automatically load related entities for you, so the getRelated methods from Repository which were designed for the ofbiz entity engine are no longer needed when you work with hibernate.<br /> <br /> === Working with View Entities ===<br /> <br /> Once a view entity has been defined in <tt>entitymodel.xml</tt>, you can access it as any other Java object from hibernate, for example:<br /> Query query = session.createQuery("from TestEntityAndItem eo where eo.testId='" <br /> + testEntityId + "' order by eo.testEntityItemSeqId");<br /> List<TestEntityAndItem> list = query.list();<br /> <br /> The opentaps Session, which extends the hibernate Session, will automatically create the SQL for accessing the view entity.<br /> <br /> === Using Transactions ===<br /> <br /> You should use the transaction manager configured in the ofbiz entity engine through the <tt>[http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/transaction/UserTransaction.html UserTransaction]</tt> class. In the entity engine, the transaction manager is configured as:<br /> <transaction-factory class="org.ofbiz.geronimo.GeronimoTransactionFactory"/><br /> <br /> This is obtained from the ofbiz <tt>TransactionFactory</tt> by our <tt>Session</tt> and used the same way as a hibernate transaction:<br /> <pre><br /> UserTransaction tx = session.beginUserTransaction();<br /> // do something useful<br /> tx.commit();<br /> </pre><br /> <br /> === Auto Generating ID Values ===<br /> <br /> ofbiz keeps track of auto generated sequence IDs in an entity called <tt>SequenceValueItem</tt> To make sure that the auto generated sequence IDs from hibernate and the ofbiz entity engine work well together, we have created an <tt>OpentapsIdentifierGenerator</tt> which also uses the same <tt>SequenceValueItem</tt> to obtain the next sequential ID. This ID generator is wired to the base entity POJO Java objects with hibernate annotations, like this:<br /> <pre><br /> @org.hibernate.annotations.GenericGenerator(name="Party_GEN", strategy="org.opentaps.foundation.entity.hibernate.OpentapsIdentifierGenerator")<br /> @GeneratedValue(generator="Party_GEN") <br /> @Id<br /> <br /> @Column(name="PARTY_ID")<br /> <br /> private String partyId;<br /> </pre><br /> <br /> So that a <tt>partyId</tt> field is automatically set for you.<br /> <br /> You can also ask the <tt>Session</tt> to generate a particular sequence ID for you:<br /> String testEntityItemSeqId = session.getNextSeqId("TestEntityItemSeqId");<br /> <br /> This can be helpful when you have complex keys with several fields, and you want the secondary key fields to be auto sequenced as well.<br /> <br /> === Support for OFBIZ EECA's ===<br /> <br /> ofbiz EECA's are supported with custom event listeners which are registered with hibernate when <tt>Infrastructure.getSessionFactory(String delegatorName)</tt> is called, usually during the initial startup. These event listeners will run ofbiz services defined in <tt>eeca.xml</tt>'s when hibernate is used to update the same entities.<br /> <br /> === Caching ===<br /> Our caching system now support ofbiz <-> hibernate mutual cache clearing. It mean it will sync hibernate cache on you update GenericValue with ofbiz entity engine, and vice versa. The hibernate cache configuration is locate in HibernateCfg.ftl (it also in hibernate.cfg.xml) as following:<br /> <pre><br /> <property name="hibernate.search.worker.execution">async</property><br /> <property name="hibernate.cache.use_query_cache">true</property><br /> <property name="hibernate.cache.use_second_level_cache">true</property><br /> <property name="hibernate.search.worker.buffer_queue.max">5</property><br /> <property name="hibernate.search.worker.thread_pool.size">5</property><br /> </pre><br /> you can disable the caching feature by remove these lines (both HibernateCfg.ftl and hibernate.cfg.xml).<br /> Note: the entities of current open session will not update when it change by ofbiz entity engine, you must using open a new session to get fresh object. and the best practise is also close your session when it finish the job.<br /> <br /> === Using Hibernate without the OFBIZ Entity Engine ===<br /> <br /> You can also use hibernate without the ofbiz entity engine by adding your Java objects to the template opentaps uses to generate the hibernate configuration files, <tt>hot-deploy/opentaps-common/templates/HibernateCfg.ftl</tt>. Simply put your Java objects after the <br /> <pre><br /> <#list><br /> ...<br /> </#list><br /> </pre><br /> <br /> directives in the file, like in the following example: <br /> <br /> <pre><br /> <!DOCTYPE hibernate-configuration PUBLIC "-//Hibernate/Hibernate Configuration DTD 3.0//EN" "http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd"><br /> <br /> <hibernate-configuration><br /> <session-factory><br /> <property name="hibernate.connection.provider_class">org.opentaps.foundation.entity.hibernate.OpentapsConnectionProvider</property> <br /> <property name="hibernate.transaction.factory_class">org.opentaps.foundation.entity.hibernate.OpentapsTransactionFactory</property><br /> <property name="hibernate.transaction.manager_lookup_class">org.opentaps.foundation.entity.hibernate.OpentapsTransactionManagerLookup</property> <br /> <property name="hibernate.search.default.directory_provider">org.hibernate.search.store.FSDirectoryProvider</property><br /> <#list entities as entity><br /> <mapping class="org.opentaps.domain.base.entities.${entity}"/><br /> </#list><br /> <mapping class="org.opentaps.domain.base.entities.MyPojo1"/><br /> <mapping class="org.opentaps.domain.base.entities.MyPojo2"/><br /> </session-factory><br /> </hibernate-configuration><br /> </pre><br /> <br /> opentaps will then create the hibernate configuration file for each database and include your Java objects in it. However, you would not be able to access these Java objects as generic values from the ofbiz entity engine.<br /> <br /> == Under the Hood: How It Works ==<br /> <br /> === Base Class Annotations ===<br /> <br /> In opentaps version 1.4, the entity model XML from the ofbiz entity engine is still used as the base definition for all entities. The opentaps POJO generator is used to create [[Base Entity Classes|base Java objects]] automatically from these entity definitions. This POJO generator will also create the annotations which hibernate can then use to map those base objects to the database persistence layer. The definitions of the annotations can be found in <tt>BaseEntity.ftl</tt> file used by the POJO generator.<br /> <br /> === How Hibernate Configuration Files are Generated ===<br /> <br /> The POJO Generator will use <tt>hot-deploy/opentaps-common/templates/HibernateCfg.ftl</tt> to generate a base hibernate configuration file in <tt>hot-deploy/opentaps-common/config/hibernate.cfg.xml</tt> When opentaps is started, the following new container in <tt>framework/base/config/ofbiz-containers.xml</tt><br /> <pre><br /> <container name="hibernate-container" class="org.opentaps.common.container.HibernateContainer"><br /> <property name="delegator-name" value="default"/><br /> </container> <br /> </pre><br /> <br /> will generate all the hibernate configuration XML files in the <tt>hot-deploy/opentaps/config/</tt> directory for each data source in your entity engine XML file. For example, it will generate a <tt>localmysql.cfg.xml</tt>, a <tt>localpostgres.cfg.xml</tt><br /> <br /> === How We Get the Hibernate Session ===<br /> <br /> The opentaps <tt>Infrastructure</tt> Class maintains a Map of delegatorName and hibernate SessionFactory objects. Each SessionFactory is created for its corresponding delegatorName the first time it is requested from the <tt>Infrastructure.getSessionFactory(delegatorName)</tt> method. This SessionFactory is created from ofbiz entity engine configurations:<br /> * The <tt>HibernateContainer</tt> in <tt>ofbiz-containers.xml</tt> has a property called <tt>delegator-name</tt><br /> * From this delegator, we get the data source defined in <tt>entityengine.xml</tt> for the default group helper name. This is set to <tt>org.ofbiz</tt> by default in the <tt>Infrastructure</tt> class and is the <tt>group</tt> attribute of the <tt>entitygroup.xml</tt> definitions in ofbiz:<br /> <entity-group group="org.ofbiz" entity="AcctgTagEnumType"/><br /> In <tt>entityengine.xml</tt>, you map a data source to each group:<br /> <delegator name="default" entity-model-reader="main" entity-group-reader="main" entity-eca-reader="main" distributed-cache-clear-enabled="false"><br /> <group-map group-name="org.ofbiz" datasource-name="localmysql"/><br /> </delegator><br /> <br /> So, we are basically following the entity engine from the delegator to the data source via the group.<br /> * Once we have the data source, we can create the SessionFactory from the hibernate.cfg.xml for that data source. For example, if your data source is "localmysql", we will create the SessionFactory from the <tt>localmysql.cfg.xml</tt> created by the <tt>HibernateContainer</tt><br /> <br /> The <tt>HibernateContainer</tt>, which loads on startup, will cause a SessionFactory to be loaded for the delegator in the <tt>delegator-name</tt> attribute. Once this SessionFactory is loaded, it will be available for future use. Additional session factories can be obtained later by calling the <tt>getSessionFactory</tt> directly.<br /> <br /> When the <tt>Infrastructure.getSession()</tt> method is called, it will use the delegator already in the Infrastructure object to open a JDBC connection first, and then use that JDBC connection and the SessionFactory for the delegator to return a Session.<br /> <br /> The <tt>Infrastructure.getSession()</tt> will return an <tt>org.opentaps.foundation.entity.hibernate.Session</tt>, which extends the hibernate Session with the following differences:<br /> * when the session is closed, the JDBC connection is also automatically closed<br /> * when a Query is created, this Session will check if the query is on an entity engine view entity and construct the Query from native SQL first<br /> <br /> === View Entities ===<br /> <br /> View entities are supported with @NamedNativeQuery annotations in the base entity Java classes, which are automatically generated by the opentaps POJO Generator.<br /> <br /> === Encryption ===<br /> <br /> The ofbiz delegator allows you to set a field to be encrypted in the database with the <tt>encrypt="true"</tt> attribute in the <tt>field</tt> tag of an entity definition. The opentaps hibernate will support the same encryption/decryption algorithm, so that encrypted values can be stored with the delegator and decrypted when it's retrieved with hibernate or vice versa. This is done by:<br /> # When an object is being stored, the <tt>EcaCommEvent.beforeSave</tt> Method will come for the object to an ofbiz GenericValue and then use the ofbiz delegator to encrypt it.<br /> # When an object is retrieved from the database, the <tt>Session.load</tt> will call the <tt>HibernateUtil.decryptField</tt> to decrypt it.<br /> <br /> === Transaction Management ===<br /> <br /> To maintain compatibility with the ofbiz entity engine's transaction manager and connection pool providers, we have defined transaction manager look up, transaction factory, and connection provider classes which use the ofbiz transaction manager and transaction factory to begin transactions. These are defined in the <tt>hibernate.cfg.xml</tt> configuration file. They allow you to mix delegator and hibernate transaction codes as in this following example:<br /> <pre><br /> UserTransaction tx = session.beginUserTransaction();<br /> TestEntity useIdentifierTestEntity = new TestEntity();<br /> useIdentifierTestEntity.setTestStringField("Use IdentifierGenerator string field");<br /> session.save(useIdentifierTestEntity);<br /> String getNextSeqIdTestEntityId = delegator.getNextSeqId("TestEntity");<br /> GenericValue useGetNextSeqIdTestEntity = delegator.create("TestEntity",<br /> UtilMisc.toMap("testId", getNextSeqIdTestEntityId, "testStringField", "Use getNextSeqId string field"));<br /> session.flush();<br /> tx.commit();<br /> </pre><br /> <br /> === Support for BLOBs ===<br /> <br /> To make the "BLOB" type work with postgresql, we made the following changes:<br /> # change blob field mapping to Java byte[] <br /> # avoid using the <tt>@Lob</tt> annotation<br /> # add this element in hibernate.cfg.xml<br /> <property name="hibernate.jdbc.use_streams_for_binary">true</property><br /> <br /> === Unit Tests ===<br /> <br /> Unit tests for hibernate are found in <tt>org.opentaps.tests.entity.HibernateTests</tt> in the opentaps-tests component.<br /> <br /> == Learning More ==<br /> <br /> The best way to learn more about how to use hibernate with opentaps is to look through the unit tests in <tt>org.opentaps.tests.entity.HibernateTests</tt> as an example.</div>

Spark https://docs.opentaps.org/docs/index.php?title=Upgrading_from_opentaps_1.0_to_opentaps_1.4&diff=4368 Upgrading from opentaps 1.0 to opentaps 1.4 2009-09-15T23:36:06Z

<p>Spark: </p> <hr /> <div>__TOC__<br /> <br /> == Data Changes ==<br /> <br /> * Run the service <tt>opentaps.setSupplementalDataForAllParties</tt> to populate primary contact data for all parties.<br /> * Configuration of GL accounts for invoice writeoffs have been changed. Instead of using <tt>GlAccountTypeDefault</tt>, they are now configured with <tt>InvoiceAdjustmentGlAccount</tt> with the adjustment type "WRITEOFF"<br /> * If you have custom UI labels, they may be loaded by adding them to <tt>LabelConfiguration.properties</tt> in <tt>opentaps-common/config/</tt><br /> ** If previously you were using <tt>UtilMessage.registerLabelMap()</tt> to load custom labels, you may now remove all calls to this function as it is no longer needed.<br /> * Run the upgrade SQL script in hot-deploy/opentaps-common/scripts/sql for the following:<br /> ** <tt>ProductAverageCost</tt> has been re-factored to use a single productAverageCostId as its primary key. The script will alter the table and automatically fill in its values and update <tt>SequenceValueItem</tt> so that opentaps will generate correct future keys.<br /> * Add the following to your custom component's build.xml:<br /> <fileset dir="${ofbiz.dir}/hot-deploy/opentaps-common/lib" includes="*.jar"/><br /> <fileset dir="${ofbiz.dir}/hot-deploy/opentaps-common/lib/hibernate" includes="*.jar"/><br /> * Set <tt>SupplierProduct.supplierPrefOrderId</tt> to '''10_MAIN_SUPPL''' where it is null.<br /> <br /> == Coding Changes ==<br /> <br /> Changes in the ofbiz framework would require the following changes to your code:<br /> <br /> === URL Parameter Security ===<br /> <br /> You can no longer pass parameters to a service request directly in the URL. These requests must be part of a POST form. To make buttons work as before, you need to change them to forms and then activate them with javascript. For example, in earlier versions, you could have a button to delete a lead like this:<br /> <#assign update_options = update_options + "<a class='subMenuButtonDangerous' <br /> href='deleteLead?leadPartyId=" + partySummary.partyId + "'>" + uiLabelMap.CommonDelete + "</a>" /><br /> <br /> In opentaps 1.4, you must do it this way:<br /> <form name="deleteLeadForm" method="post" action="<@ofbizUrl>deleteLead</@ofbizUrl>"/><br /> <@inputHidden name="leadPartyId" value="${partySummary.partyId}"/><br /> </form><br /> <#assign update_options = update_options + "<a class='subMenuButtonDangerous' <br /> href='javascript:document.deleteLeadForm.submit()'>" + uiLabelMap.CommonDelete + "</a>" /><br /> <br /> === Controller redirects ===<br /> <br /> Redirects have been changed, now ''request-redirect'' will only copy the parameters that were in the URL string by default. To forward posted or service output parameter, use the ''redirect-parameter'' elements (one per parameter).<br /> <response name="success" type="request-redirect" value="viewAccount"><br /> <redirect-parameter name="partyId"/><br /> </response><br /> Also ''request-redirect-filter-param'' is now considered deprecated.<br /> <br /> === Js dateTime format ===<br /> <br /> Js dataTime format in ftl have been changed, now the format will return html encode string which will cause the parse exception, you should use StringUtil.wrapString to avoid this issue. For example, in earlier versions, you could have define a js dataTime format variable like this:<br /> <br /> <#assign dateFormat = Static["org.opentaps.common.util.UtilDate"].getJsDateTimeFormat(Static["org.opentaps.common.util.UtilDate"].getDateFormat(locale))/><br /> <br /> In opentaps 1.4, you must do it this way:<br /> <br /> <#assign dateFormat = StringUtil.wrapString(Static["org.opentaps.common.util.UtilDate"].getJsDateTimeFormat(Static["org.opentaps.common.util.UtilDate"].getDateFormat(locale)))/></div>

Spark https://docs.opentaps.org/docs/index.php?title=Upgrading_from_opentaps_1.0_to_opentaps_1.4&diff=4367 Upgrading from opentaps 1.0 to opentaps 1.4 2009-09-15T23:35:01Z

<p>Spark: /* Js dateTime format */</p> <hr /> <div>__TOC__<br /> <br /> == Data Changes ==<br /> <br /> * Run the service <tt>opentaps.setSupplementalDataForAllParties</tt> to populate primary contact data for all parties.<br /> * Configuration of GL accounts for invoice writeoffs have been changed. Instead of using <tt>GlAccountTypeDefault</tt>, they are now configured with <tt>InvoiceAdjustmentGlAccount</tt> with the adjustment type "WRITEOFF"<br /> * If you have custom UI labels, they may be loaded by adding them to <tt>LabelConfiguration.properties</tt> in <tt>opentaps-common/config/</tt><br /> ** If previously you were using <tt>UtilMessage.registerLabelMap()</tt> to load custom labels, you may now remove all calls to this function as it is no longer needed.<br /> * Run the upgrade SQL script in hot-deploy/opentaps-common/scripts/sql for the following:<br /> ** <tt>ProductAverageCost</tt> has been re-factored to use a single productAverageCostId as its primary key. The script will alter the table and automatically fill in its values and update <tt>SequenceValueItem</tt> so that opentaps will generate correct future keys.<br /> * Add the following to your custom component's build.xml:<br /> <fileset dir="${ofbiz.dir}/hot-deploy/opentaps-common/lib" includes="*.jar"/><br /> <fileset dir="${ofbiz.dir}/hot-deploy/opentaps-common/lib/hibernate" includes="*.jar"/><br /> * Set <tt>SupplierProduct.supplierPrefOrderId</tt> to '''10_MAIN_SUPPL''' where it is null.<br /> <br /> == Coding Changes ==<br /> <br /> Changes in the ofbiz framework would require the following changes to your code:<br /> <br /> === URL Parameter Security ===<br /> <br /> You can no longer pass parameters to a service request directly in the URL. These requests must be part of a POST form. To make buttons work as before, you need to change them to forms and then activate them with javascript. For example, in earlier versions, you could have a button to delete a lead like this:<br /> <#assign update_options = update_options + "<a class='subMenuButtonDangerous' <br /> href='deleteLead?leadPartyId=" + partySummary.partyId + "'>" + uiLabelMap.CommonDelete + "</a>" /><br /> <br /> In opentaps 1.4, you must do it this way:<br /> <form name="deleteLeadForm" method="post" action="<@ofbizUrl>deleteLead</@ofbizUrl>"/><br /> <@inputHidden name="leadPartyId" value="${partySummary.partyId}"/><br /> </form><br /> <#assign update_options = update_options + "<a class='subMenuButtonDangerous' <br /> href='javascript:document.deleteLeadForm.submit()'>" + uiLabelMap.CommonDelete + "</a>" /><br /> <br /> === Controller redirects ===<br /> <br /> Redirects have been changed, now ''request-redirect'' will only copy the parameters that were in the URL string by default. To forward posted or service output parameter, use the ''redirect-parameter'' elements (one per parameter).<br /> <response name="success" type="request-redirect" value="viewAccount"><br /> <redirect-parameter name="partyId"/><br /> </response><br /> Also ''request-redirect-filter-param'' is now considered deprecated.<br /> <br /> === Js dateTime format ===<br /> <br /> Js dataTime format in ftl have been changed, now the format will return html encode string which will cause the parse exception, you should use StringUtil.wrapString to avoid this issue. For example, in earlier versions, you could have define a js dataTime format variable like this:<br /> <br /> <#assign dateFormat = Static["org.opentaps.common.util.UtilDate"].getJsDateTimeFormat(Static["org.opentaps.common.util.UtilDate"].getDateFormat(locale))/><br /> <br /> In opentaps 1.4, you must do it this way:<br /> <br /> <#assign dateFormat = StringUtil.wrapString(Static["org.opentaps.common.util.UtilDate"]<br /> .getJsDateTimeFormat(Static["org.opentaps.common.util.UtilDate"].getDateFormat(locale)))/></div>

Spark https://docs.opentaps.org/docs/index.php?title=Upgrading_from_opentaps_1.0_to_opentaps_1.4&diff=4366 Upgrading from opentaps 1.0 to opentaps 1.4 2009-09-15T23:34:05Z

<p>Spark: /* Js dateTime format */</p> <hr /> <div>__TOC__<br /> <br /> == Data Changes ==<br /> <br /> * Run the service <tt>opentaps.setSupplementalDataForAllParties</tt> to populate primary contact data for all parties.<br /> * Configuration of GL accounts for invoice writeoffs have been changed. Instead of using <tt>GlAccountTypeDefault</tt>, they are now configured with <tt>InvoiceAdjustmentGlAccount</tt> with the adjustment type "WRITEOFF"<br /> * If you have custom UI labels, they may be loaded by adding them to <tt>LabelConfiguration.properties</tt> in <tt>opentaps-common/config/</tt><br /> ** If previously you were using <tt>UtilMessage.registerLabelMap()</tt> to load custom labels, you may now remove all calls to this function as it is no longer needed.<br /> * Run the upgrade SQL script in hot-deploy/opentaps-common/scripts/sql for the following:<br /> ** <tt>ProductAverageCost</tt> has been re-factored to use a single productAverageCostId as its primary key. The script will alter the table and automatically fill in its values and update <tt>SequenceValueItem</tt> so that opentaps will generate correct future keys.<br /> * Add the following to your custom component's build.xml:<br /> <fileset dir="${ofbiz.dir}/hot-deploy/opentaps-common/lib" includes="*.jar"/><br /> <fileset dir="${ofbiz.dir}/hot-deploy/opentaps-common/lib/hibernate" includes="*.jar"/><br /> * Set <tt>SupplierProduct.supplierPrefOrderId</tt> to '''10_MAIN_SUPPL''' where it is null.<br /> <br /> == Coding Changes ==<br /> <br /> Changes in the ofbiz framework would require the following changes to your code:<br /> <br /> === URL Parameter Security ===<br /> <br /> You can no longer pass parameters to a service request directly in the URL. These requests must be part of a POST form. To make buttons work as before, you need to change them to forms and then activate them with javascript. For example, in earlier versions, you could have a button to delete a lead like this:<br /> <#assign update_options = update_options + "<a class='subMenuButtonDangerous' <br /> href='deleteLead?leadPartyId=" + partySummary.partyId + "'>" + uiLabelMap.CommonDelete + "</a>" /><br /> <br /> In opentaps 1.4, you must do it this way:<br /> <form name="deleteLeadForm" method="post" action="<@ofbizUrl>deleteLead</@ofbizUrl>"/><br /> <@inputHidden name="leadPartyId" value="${partySummary.partyId}"/><br /> </form><br /> <#assign update_options = update_options + "<a class='subMenuButtonDangerous' <br /> href='javascript:document.deleteLeadForm.submit()'>" + uiLabelMap.CommonDelete + "</a>" /><br /> <br /> === Controller redirects ===<br /> <br /> Redirects have been changed, now ''request-redirect'' will only copy the parameters that were in the URL string by default. To forward posted or service output parameter, use the ''redirect-parameter'' elements (one per parameter).<br /> <response name="success" type="request-redirect" value="viewAccount"><br /> <redirect-parameter name="partyId"/><br /> </response><br /> Also ''request-redirect-filter-param'' is now considered deprecated.<br /> <br /> === Js dateTime format ===<br /> <br /> Js dataTime format in ftl have been changed, now the format will return html encode string which will cause the parse exception, you should use StringUtil.wrapString to avoid this issue. For example, in earlier versions, you could have define a js dataTime format variable like this:<br /> <#assign dateFormat = Static["org.opentaps.common.util.UtilDate"].getJsDateTimeFormat(Static["org.opentaps.common.util.UtilDate"].getDateFormat(locale))/><br /> <br /> In opentaps 1.4, you must do it this way:<br /> <#assign dateFormat = StringUtil.wrapString(Static["org.opentaps.common.util.UtilDate"]<br /> .getJsDateTimeFormat(Static["org.opentaps.common.util.UtilDate"].getDateFormat(locale)))/></div>

Spark https://docs.opentaps.org/docs/index.php?title=Upgrading_from_opentaps_1.0_to_opentaps_1.4&diff=4365 Upgrading from opentaps 1.0 to opentaps 1.4 2009-09-15T23:33:16Z

<p>Spark: </p> <hr /> <div>__TOC__<br /> <br /> == Data Changes ==<br /> <br /> * Run the service <tt>opentaps.setSupplementalDataForAllParties</tt> to populate primary contact data for all parties.<br /> * Configuration of GL accounts for invoice writeoffs have been changed. Instead of using <tt>GlAccountTypeDefault</tt>, they are now configured with <tt>InvoiceAdjustmentGlAccount</tt> with the adjustment type "WRITEOFF"<br /> * If you have custom UI labels, they may be loaded by adding them to <tt>LabelConfiguration.properties</tt> in <tt>opentaps-common/config/</tt><br /> ** If previously you were using <tt>UtilMessage.registerLabelMap()</tt> to load custom labels, you may now remove all calls to this function as it is no longer needed.<br /> * Run the upgrade SQL script in hot-deploy/opentaps-common/scripts/sql for the following:<br /> ** <tt>ProductAverageCost</tt> has been re-factored to use a single productAverageCostId as its primary key. The script will alter the table and automatically fill in its values and update <tt>SequenceValueItem</tt> so that opentaps will generate correct future keys.<br /> * Add the following to your custom component's build.xml:<br /> <fileset dir="${ofbiz.dir}/hot-deploy/opentaps-common/lib" includes="*.jar"/><br /> <fileset dir="${ofbiz.dir}/hot-deploy/opentaps-common/lib/hibernate" includes="*.jar"/><br /> * Set <tt>SupplierProduct.supplierPrefOrderId</tt> to '''10_MAIN_SUPPL''' where it is null.<br /> <br /> == Coding Changes ==<br /> <br /> Changes in the ofbiz framework would require the following changes to your code:<br /> <br /> === URL Parameter Security ===<br /> <br /> You can no longer pass parameters to a service request directly in the URL. These requests must be part of a POST form. To make buttons work as before, you need to change them to forms and then activate them with javascript. For example, in earlier versions, you could have a button to delete a lead like this:<br /> <#assign update_options = update_options + "<a class='subMenuButtonDangerous' <br /> href='deleteLead?leadPartyId=" + partySummary.partyId + "'>" + uiLabelMap.CommonDelete + "</a>" /><br /> <br /> In opentaps 1.4, you must do it this way:<br /> <form name="deleteLeadForm" method="post" action="<@ofbizUrl>deleteLead</@ofbizUrl>"/><br /> <@inputHidden name="leadPartyId" value="${partySummary.partyId}"/><br /> </form><br /> <#assign update_options = update_options + "<a class='subMenuButtonDangerous' <br /> href='javascript:document.deleteLeadForm.submit()'>" + uiLabelMap.CommonDelete + "</a>" /><br /> <br /> === Controller redirects ===<br /> <br /> Redirects have been changed, now ''request-redirect'' will only copy the parameters that were in the URL string by default. To forward posted or service output parameter, use the ''redirect-parameter'' elements (one per parameter).<br /> <response name="success" type="request-redirect" value="viewAccount"><br /> <redirect-parameter name="partyId"/><br /> </response><br /> Also ''request-redirect-filter-param'' is now considered deprecated.<br /> <br /> === Js dateTime format ===<br /> <br /> Js dataTime format in ftl have been changed, now the format will return html encode string which will cause the parse exception, you should use StringUtil.wrapString to avoid this issue. For example, in earlier versions, you could have define a js dataTime format variable like this:<br /> <#assign dateFormat = Static["org.opentaps.common.util.UtilDate"].getJsDateTimeFormat(Static["org.opentaps.common.util.UtilDate"].getDateFormat(locale))/><br /> <br /> In opentaps 1.4, you must do it this way:<br /> <#assign dateFormat = StringUtil.wrapString(Static["org.opentaps.common.util.UtilDate"].getJsDateTimeFormat(Static["org.opentaps.common.util.UtilDate"].getDateFormat(locale)))/></div>

Spark https://docs.opentaps.org/docs/index.php?title=Opentaps_Hibernate_Integration&diff=3836 Opentaps Hibernate Integration 2009-04-02T10:24:13Z

<p>Spark: /* How We Get the Hibernate Session */</p> <hr /> <div>Beginning with opentaps version 1.4, [http://www.hibernate.org Hibernate] will be available as a persistence tool alongside with the original ofbiz entity engine. Hibernate is a more object oriented persistence framework and better suited for the new [[Domain Driven Architecture]], while the ofbiz entity engine will continue to be supported for legacy features from both ofbiz and opentaps. In this document, we will review how the hibernate integration in opentaps works.<br /> <br /> == Working with Hibernate in opentaps ==<br /> <br /> === Generating Hibernate Configuration Files ===<br /> <br /> After changing or defining new entities in your <tt>entitymodel.xml</tt> files, you need to generate new Java classes for your entities with<br /> $ ant make-base-entities<br /> <br /> This command updates the Java classes defined in <tt>org.opentaps.domain.base.entities</tt>, including their hibernate annotations, and the <tt>hibernate.cfg.xml</tt> for integrating with hibernate. (If you use a repository management system, you must commit both and you Java classes and the updated <tt>hibernate.cfg.xml</tt> files.)<br /> <br /> === Accessing Entities with Hibernate ===<br /> <br /> To use hibernate to access your entities, you will need an <tt>org.opentaps.foundation.entity.hibernate.Session</tt>, which is an extension of the <tt>org.hibernate.Session</tt> class. You can obtain it from the Infrastructure class like this:<br /> session = infrastructure.getSession();<br /> <br /> Then, you can work with it as if it were a Hibernate <tt>Session</tt>:<br /> <br /> Transaction tx = session.beginTransaction();<br /> TestEntity newTestEntity = new TestEntity();<br /> newTestEntity.setTestStringField("testInsertTestEntity string field");<br /> newTestEntity.setCreatedStamp(UtilDateTime.nowTimestamp());<br /> session.save(newTestEntity);<br /> tx.commit();<br /> session.flush();<br /> // ...<br /> TestEntity loadEntity = (TestEntity) session.load(TestEntity.class, newTestEntity.getTestId());<br /> // ...<br /> String hql = "from TestEntity eo where eo.testId='" + testEntityId2 + "'";<br /> Query query = session.createQuery(hql);<br /> List<TestEntity> list = query.list()<br /> <br /> You do not need to close your JDBC connection manually with the opentaps Session, however. When you call<br /> session.close();<br /> It will do it for you automatically.<br /> <br /> === Traversing Related Entities ===<br /> <br /> opentaps will automatically create the relationship annotations, such as @OneToMany, @ManyToMany, and @Join, for your Java classes.<br /> <br /> To get related entities, use the hibernate query language (HQL):<br /> String hql = "from TestEntityItem eo where eo.testEntity.testId='" + testEntity.getTestId() + "'"<br /> + " and eo.testEntityItemSeqId in (" + testEntityItemSeqIds + ")";<br /> Query query = session.createQuery(hql);<br /> List<TestEntityItem> list = query.list();<br /> <br /> Or use the getter methods in the base entities:<br /> List<TestEntityItem> list = testEntity.getTestEntityItems();<br /> <br /> Note that hibernate will automatically load related entities for you, so the getRelated methods from Repository which were designed for the ofbiz entity engine are no longer needed when you work with hibernate.<br /> <br /> === Working with View Entities ===<br /> <br /> Once a view entity has been defined in <tt>entitymodel.xml</tt>, you can access it as any other Java object from hibernate, for example:<br /> Query query = session.createQuery("from TestEntityAndItem eo where eo.testId='" <br /> + testEntityId + "' order by eo.testEntityItemSeqId");<br /> List<TestEntityAndItem> list = query.list();<br /> <br /> The opentaps Session, which extends the hibernate Session, will automatically create the SQL for accessing the view entity.<br /> <br /> === Using Transactions ===<br /> <br /> You should use the transaction manager configured in the ofbiz entity engine through the <tt>[http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/transaction/UserTransaction.html UserTransaction]</tt> class. In the entity engine, the transaction manager is configured as:<br /> <transaction-factory class="org.ofbiz.geronimo.GeronimoTransactionFactory"/><br /> <br /> This is obtained from the ofbiz <tt>TransactionFactory</tt> by our <tt>Session</tt> and used the same way as a hibernate transaction:<br /> <pre><br /> UserTransaction tx = session.beginUserTransaction();<br /> // do something useful<br /> tx.commit();<br /> </pre><br /> <br /> === Auto Generating ID Values ===<br /> <br /> ofbiz keeps track of auto generated sequence IDs in an entity called <tt>SequenceValueItem</tt> To make sure that the auto generated sequence IDs from hibernate and the ofbiz entity engine work well together, we have created an <tt>OpentapsIdentifierGenerator</tt> which also uses the same <tt>SequenceValueItem</tt> to obtain the next sequential ID. This ID generator is wired to the base entity POJO Java objects with hibernate annotations, like this:<br /> <pre><br /> @org.hibernate.annotations.GenericGenerator(name="Party_GEN", strategy="org.opentaps.foundation.entity.hibernate.OpentapsIdentifierGenerator")<br /> @GeneratedValue(generator="Party_GEN") <br /> @Id<br /> <br /> @Column(name="PARTY_ID")<br /> <br /> private String partyId;<br /> </pre><br /> <br /> So that a <tt>partyId</tt> field is automatically set for you.<br /> <br /> === Support for OFBIZ EECA's ===<br /> <br /> ofbiz EECA's are supported with custom event listeners which are registered with hibernate when <tt>Infrastructure.getSessionFactory(String delegatorName)</tt> is called, usually during the initial startup. These event listeners will run ofbiz services defined in <tt>eeca.xml</tt>'s when hibernate is used to update the same entities.<br /> <br /> == Under the Hood: How It Works ==<br /> <br /> === Base Class Annotations ===<br /> <br /> In opentaps version 1.4, the entity model XML from the ofbiz entity engine is still used as the base definition for all entities. The opentaps POJO generator is used to create [[Base Entity Classes|base Java objects]] automatically from these entity definitions. This POJO generator will also create the annotations which hibernate can then use to map those base objects to the database persistence layer. The definitions of the annotations can be found in <tt>BaseEntity.ftl</tt> file used by the POJO generator.<br /> <br /> === How Hibernate Configuration Files are Generated ===<br /> <br /> The POJO Generator will use <tt>hot-deploy/opentaps-common/templates/HibernateCfg.ftl</tt> to generate a base hibernate configuration file in <tt>hot-deploy/opentaps-common/config/hibernate.cfg.xml</tt> When opentaps is started, the following new container in <tt>framework/base/config/ofbiz-containers.xml</tt><br /> <pre><br /> <container name="hibernate-container" class="org.opentaps.common.container.HibernateContainer"><br /> <property name="delegator-name" value="default"/><br /> </container> <br /> </pre><br /> <br /> will generate all the hibernate configuration XML files in the <tt>hot-deploy/opentaps/config/</tt> directory for each data source in your entity engine XML file. For example, it will generate a <tt>localmysql.cfg.xml</tt>, a <tt>localpostgres.cfg.xml</tt><br /> <br /> === How We Get the Hibernate Session ===<br /> <br /> The opentaps <tt>Infrastructure</tt> Class maintains a Map of delegatorName and hibernate SessionFactory objects. Each SessionFactory is created for its corresponding delegatorName the first time it is requested from the <tt>Infrastructure.getSessionFactory(delegatorName)</tt> method. This SessionFactory is created from ofbiz entity engine configurations:<br /> * The <tt>HibernateContainer</tt> in <tt>ofbiz-containers.xml</tt> has a property called <tt>delegator-name</tt><br /> * From this delegator, we get the data source defined in <tt>entityengine.xml</tt> for the default group helper name. This is set to <tt>org.ofbiz</tt> by default in the <tt>Infrastructure</tt> class and is the <tt>group</tt> attribute of the <tt>entitygroup.xml</tt> definitions in ofbiz:<br /> <entity-group group="org.ofbiz" entity="AcctgTagEnumType"/><br /> In <tt>entityengine.xml</tt>, you map a data source to each group:<br /> <delegator name="default" entity-model-reader="main" entity-group-reader="main" entity-eca-reader="main" distributed-cache-clear-enabled="false"><br /> <group-map group-name="org.ofbiz" datasource-name="localmysql"/><br /> </delegator><br /> <br /> So, we are basically following the entity engine from the delegator to the data source via the group.<br /> * Once we have the data source, we can create the SessionFactory from the hibernate.cfg.xml for that data source. For example, if your data source is "localmysql", we will create the SessionFactory from the <tt>localmysql.cfg.xml</tt> created by the <tt>HibernateContainer</tt><br /> <br /> The <tt>HibernateContainer</tt>, which loads on startup, will cause a SessionFactory to be loaded for the delegator in the <tt>delegator-name</tt> attribute. Once this SessionFactory is loaded, it will be available for future use. Additional session factories can be obtained later by calling the <tt>getSessionFactory</tt> directly.<br /> <br /> When the <tt>Infrastructure.getSession()</tt> method is called, it will use the delegator already in the Infrastructure object to open a JDBC connection first, and then use that JDBC connection and the SessionFactory for the delegator to return a Session.<br /> <br /> The <tt>Infrastructure.getSession()</tt> will return an <tt>org.opentaps.foundation.entity.hibernate.Session</tt>, which extends the hibernate Session with the following differences:<br /> * when the session is closed, the JDBC connection is also automatically closed<br /> * when a Query is created, this Session will check if the query is on an entity engine view entity and construct the Query from native SQL first<br /> <br /> === View Entities ===<br /> <br /> View entities are supported with @NamedNativeQuery annotations in the base entity Java classes, which are automatically generated by the opentaps POJO Generator.<br /> <br /> === Unit Tests ===<br /> <br /> Unit tests for hibernate are found in <tt>org.opentaps.tests.entity.hibernate.HibernateTests</tt> in the opentaps-tests component.</div>

Spark https://docs.opentaps.org/docs/index.php?title=Opentaps_Hibernate_Integration&diff=3835 Opentaps Hibernate Integration 2009-04-02T10:23:24Z

<p>Spark: /* Auto Generating ID Values */</p> <hr /> <div>Beginning with opentaps version 1.4, [http://www.hibernate.org Hibernate] will be available as a persistence tool alongside with the original ofbiz entity engine. Hibernate is a more object oriented persistence framework and better suited for the new [[Domain Driven Architecture]], while the ofbiz entity engine will continue to be supported for legacy features from both ofbiz and opentaps. In this document, we will review how the hibernate integration in opentaps works.<br /> <br /> == Working with Hibernate in opentaps ==<br /> <br /> === Generating Hibernate Configuration Files ===<br /> <br /> After changing or defining new entities in your <tt>entitymodel.xml</tt> files, you need to generate new Java classes for your entities with<br /> $ ant make-base-entities<br /> <br /> This command updates the Java classes defined in <tt>org.opentaps.domain.base.entities</tt>, including their hibernate annotations, and the <tt>hibernate.cfg.xml</tt> for integrating with hibernate. (If you use a repository management system, you must commit both and you Java classes and the updated <tt>hibernate.cfg.xml</tt> files.)<br /> <br /> === Accessing Entities with Hibernate ===<br /> <br /> To use hibernate to access your entities, you will need an <tt>org.opentaps.foundation.entity.hibernate.Session</tt>, which is an extension of the <tt>org.hibernate.Session</tt> class. You can obtain it from the Infrastructure class like this:<br /> session = infrastructure.getSession();<br /> <br /> Then, you can work with it as if it were a Hibernate <tt>Session</tt>:<br /> <br /> Transaction tx = session.beginTransaction();<br /> TestEntity newTestEntity = new TestEntity();<br /> newTestEntity.setTestStringField("testInsertTestEntity string field");<br /> newTestEntity.setCreatedStamp(UtilDateTime.nowTimestamp());<br /> session.save(newTestEntity);<br /> tx.commit();<br /> session.flush();<br /> // ...<br /> TestEntity loadEntity = (TestEntity) session.load(TestEntity.class, newTestEntity.getTestId());<br /> // ...<br /> String hql = "from TestEntity eo where eo.testId='" + testEntityId2 + "'";<br /> Query query = session.createQuery(hql);<br /> List<TestEntity> list = query.list()<br /> <br /> You do not need to close your JDBC connection manually with the opentaps Session, however. When you call<br /> session.close();<br /> It will do it for you automatically.<br /> <br /> === Traversing Related Entities ===<br /> <br /> opentaps will automatically create the relationship annotations, such as @OneToMany, @ManyToMany, and @Join, for your Java classes.<br /> <br /> To get related entities, use the hibernate query language (HQL):<br /> String hql = "from TestEntityItem eo where eo.testEntity.testId='" + testEntity.getTestId() + "'"<br /> + " and eo.testEntityItemSeqId in (" + testEntityItemSeqIds + ")";<br /> Query query = session.createQuery(hql);<br /> List<TestEntityItem> list = query.list();<br /> <br /> Or use the getter methods in the base entities:<br /> List<TestEntityItem> list = testEntity.getTestEntityItems();<br /> <br /> Note that hibernate will automatically load related entities for you, so the getRelated methods from Repository which were designed for the ofbiz entity engine are no longer needed when you work with hibernate.<br /> <br /> === Working with View Entities ===<br /> <br /> Once a view entity has been defined in <tt>entitymodel.xml</tt>, you can access it as any other Java object from hibernate, for example:<br /> Query query = session.createQuery("from TestEntityAndItem eo where eo.testId='" <br /> + testEntityId + "' order by eo.testEntityItemSeqId");<br /> List<TestEntityAndItem> list = query.list();<br /> <br /> The opentaps Session, which extends the hibernate Session, will automatically create the SQL for accessing the view entity.<br /> <br /> === Using Transactions ===<br /> <br /> You should use the transaction manager configured in the ofbiz entity engine through the <tt>[http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/transaction/UserTransaction.html UserTransaction]</tt> class. In the entity engine, the transaction manager is configured as:<br /> <transaction-factory class="org.ofbiz.geronimo.GeronimoTransactionFactory"/><br /> <br /> This is obtained from the ofbiz <tt>TransactionFactory</tt> by our <tt>Session</tt> and used the same way as a hibernate transaction:<br /> <pre><br /> UserTransaction tx = session.beginUserTransaction();<br /> // do something useful<br /> tx.commit();<br /> </pre><br /> <br /> === Auto Generating ID Values ===<br /> <br /> ofbiz keeps track of auto generated sequence IDs in an entity called <tt>SequenceValueItem</tt> To make sure that the auto generated sequence IDs from hibernate and the ofbiz entity engine work well together, we have created an <tt>OpentapsIdentifierGenerator</tt> which also uses the same <tt>SequenceValueItem</tt> to obtain the next sequential ID. This ID generator is wired to the base entity POJO Java objects with hibernate annotations, like this:<br /> <pre><br /> @org.hibernate.annotations.GenericGenerator(name="Party_GEN", strategy="org.opentaps.foundation.entity.hibernate.OpentapsIdentifierGenerator")<br /> @GeneratedValue(generator="Party_GEN") <br /> @Id<br /> <br /> @Column(name="PARTY_ID")<br /> <br /> private String partyId;<br /> </pre><br /> <br /> So that a <tt>partyId</tt> field is automatically set for you.<br /> <br /> === Support for OFBIZ EECA's ===<br /> <br /> ofbiz EECA's are supported with custom event listeners which are registered with hibernate when <tt>Infrastructure.getSessionFactory(String delegatorName)</tt> is called, usually during the initial startup. These event listeners will run ofbiz services defined in <tt>eeca.xml</tt>'s when hibernate is used to update the same entities.<br /> <br /> == Under the Hood: How It Works ==<br /> <br /> === Base Class Annotations ===<br /> <br /> In opentaps version 1.4, the entity model XML from the ofbiz entity engine is still used as the base definition for all entities. The opentaps POJO generator is used to create [[Base Entity Classes|base Java objects]] automatically from these entity definitions. This POJO generator will also create the annotations which hibernate can then use to map those base objects to the database persistence layer. The definitions of the annotations can be found in <tt>BaseEntity.ftl</tt> file used by the POJO generator.<br /> <br /> === How Hibernate Configuration Files are Generated ===<br /> <br /> The POJO Generator will use <tt>hot-deploy/opentaps-common/templates/HibernateCfg.ftl</tt> to generate a base hibernate configuration file in <tt>hot-deploy/opentaps-common/config/hibernate.cfg.xml</tt> When opentaps is started, the following new container in <tt>framework/base/config/ofbiz-containers.xml</tt><br /> <pre><br /> <container name="hibernate-container" class="org.opentaps.common.container.HibernateContainer"><br /> <property name="delegator-name" value="default"/><br /> </container> <br /> </pre><br /> <br /> will generate all the hibernate configuration XML files in the <tt>hot-deploy/opentaps/config/</tt> directory for each data source in your entity engine XML file. For example, it will generate a <tt>localmysql.cfg.xml</tt>, a <tt>localpostgres.cfg.xml</tt><br /> <br /> === How We Get the Hibernate Session ===<br /> <br /> The opentaps <tt>Infrastructure</tt> Class maintains a Map of delegatorName and hibernate SessionFactory objects. Each SessionFactory is created for its corresponding delegatorName the first time it is requested from the <tt>Infrastructure.getSessionFactory(delegatorName)</tt> method. This SessionFactory is created from ofbiz entity engine configurations:<br /> * The <tt>HibernateContainer</tt> in <tt>ofbiz-containers.xml</tt> has a property called <tt>delegator-name</tt><br /> * From this delegator, we get the data source defined in <tt>entityengine.xml</tt> for the default group helper name. This is set to <tt>org.ofbiz</tt> by default in the <tt>Infrastructure</tt> class and is the <tt>group</tt> attribute of the <tt>entitygroup.xml</tt> definitions in ofbiz:<br /> <entity-group group="org.ofbiz" entity="AcctgTagEnumType"/><br /> In <tt>entityengine.xml</tt>, you map a data source to each group:<br /> <delegator name="default" entity-model-reader="main" entity-group-reader="main" entity-eca-reader="main" distributed-cache-clear-enabled="false"><br /> <group-map group-name="org.ofbiz" datasource-name="localmysql"/><br /> </delegator><br /> <br /> So, we are basically following the entity engine from the delegator to the data source via the group.<br /> * Once we have the data source, we can create the SessionFactory from the hibernate.cfg.xml for that data source. For example, if your data source is "localmysql", we will create the SessionFactory from the <tt>localmysql.cfg.xml</tt> created by the <tt>HibernateContainer</tt><br /> <br /> The <tt>HibernateContainer</tt>, which loads on startup, will cause a SessionFactory to be loaded for the delegator in the <tt>delegator-name</tt> attribute. Once this SessionFactory is loaded, it will be available for future use. Additional session factories can be obtained later by calling the <tt>getSessionFactory</tt> directly.<br /> <br /> When the <tt>Infrastructure.getSession()</tt> method is called, it will use the delegator already in the Infrastructure object to open a JDBC connection first, and then use that JDBC connection and the SessionFactory for the delegator to return a Session.<br /> <br /> The <tt>Infrastructure.getSession()</tt> will return an <tt>org.opentaps.foundation.infrastructure.Session</tt>, which extends the hibernate Session with the following differences:<br /> * when the session is closed, the JDBC connection is also automatically closed<br /> * when a Query is created, this Session will check if the query is on an entity engine view entity and construct the Query from native SQL first<br /> <br /> === View Entities ===<br /> <br /> View entities are supported with @NamedNativeQuery annotations in the base entity Java classes, which are automatically generated by the opentaps POJO Generator.<br /> <br /> === Unit Tests ===<br /> <br /> Unit tests for hibernate are found in <tt>org.opentaps.tests.entity.hibernate.HibernateTests</tt> in the opentaps-tests component.</div>

Spark https://docs.opentaps.org/docs/index.php?title=Opentaps_Hibernate_Integration&diff=3834 Opentaps Hibernate Integration 2009-04-02T10:22:56Z

<p>Spark: /* Accessing Entities with Hibernate */</p> <hr /> <div>Beginning with opentaps version 1.4, [http://www.hibernate.org Hibernate] will be available as a persistence tool alongside with the original ofbiz entity engine. Hibernate is a more object oriented persistence framework and better suited for the new [[Domain Driven Architecture]], while the ofbiz entity engine will continue to be supported for legacy features from both ofbiz and opentaps. In this document, we will review how the hibernate integration in opentaps works.<br /> <br /> == Working with Hibernate in opentaps ==<br /> <br /> === Generating Hibernate Configuration Files ===<br /> <br /> After changing or defining new entities in your <tt>entitymodel.xml</tt> files, you need to generate new Java classes for your entities with<br /> $ ant make-base-entities<br /> <br /> This command updates the Java classes defined in <tt>org.opentaps.domain.base.entities</tt>, including their hibernate annotations, and the <tt>hibernate.cfg.xml</tt> for integrating with hibernate. (If you use a repository management system, you must commit both and you Java classes and the updated <tt>hibernate.cfg.xml</tt> files.)<br /> <br /> === Accessing Entities with Hibernate ===<br /> <br /> To use hibernate to access your entities, you will need an <tt>org.opentaps.foundation.entity.hibernate.Session</tt>, which is an extension of the <tt>org.hibernate.Session</tt> class. You can obtain it from the Infrastructure class like this:<br /> session = infrastructure.getSession();<br /> <br /> Then, you can work with it as if it were a Hibernate <tt>Session</tt>:<br /> <br /> Transaction tx = session.beginTransaction();<br /> TestEntity newTestEntity = new TestEntity();<br /> newTestEntity.setTestStringField("testInsertTestEntity string field");<br /> newTestEntity.setCreatedStamp(UtilDateTime.nowTimestamp());<br /> session.save(newTestEntity);<br /> tx.commit();<br /> session.flush();<br /> // ...<br /> TestEntity loadEntity = (TestEntity) session.load(TestEntity.class, newTestEntity.getTestId());<br /> // ...<br /> String hql = "from TestEntity eo where eo.testId='" + testEntityId2 + "'";<br /> Query query = session.createQuery(hql);<br /> List<TestEntity> list = query.list()<br /> <br /> You do not need to close your JDBC connection manually with the opentaps Session, however. When you call<br /> session.close();<br /> It will do it for you automatically.<br /> <br /> === Traversing Related Entities ===<br /> <br /> opentaps will automatically create the relationship annotations, such as @OneToMany, @ManyToMany, and @Join, for your Java classes.<br /> <br /> To get related entities, use the hibernate query language (HQL):<br /> String hql = "from TestEntityItem eo where eo.testEntity.testId='" + testEntity.getTestId() + "'"<br /> + " and eo.testEntityItemSeqId in (" + testEntityItemSeqIds + ")";<br /> Query query = session.createQuery(hql);<br /> List<TestEntityItem> list = query.list();<br /> <br /> Or use the getter methods in the base entities:<br /> List<TestEntityItem> list = testEntity.getTestEntityItems();<br /> <br /> Note that hibernate will automatically load related entities for you, so the getRelated methods from Repository which were designed for the ofbiz entity engine are no longer needed when you work with hibernate.<br /> <br /> === Working with View Entities ===<br /> <br /> Once a view entity has been defined in <tt>entitymodel.xml</tt>, you can access it as any other Java object from hibernate, for example:<br /> Query query = session.createQuery("from TestEntityAndItem eo where eo.testId='" <br /> + testEntityId + "' order by eo.testEntityItemSeqId");<br /> List<TestEntityAndItem> list = query.list();<br /> <br /> The opentaps Session, which extends the hibernate Session, will automatically create the SQL for accessing the view entity.<br /> <br /> === Using Transactions ===<br /> <br /> You should use the transaction manager configured in the ofbiz entity engine through the <tt>[http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/transaction/UserTransaction.html UserTransaction]</tt> class. In the entity engine, the transaction manager is configured as:<br /> <transaction-factory class="org.ofbiz.geronimo.GeronimoTransactionFactory"/><br /> <br /> This is obtained from the ofbiz <tt>TransactionFactory</tt> by our <tt>Session</tt> and used the same way as a hibernate transaction:<br /> <pre><br /> UserTransaction tx = session.beginUserTransaction();<br /> // do something useful<br /> tx.commit();<br /> </pre><br /> <br /> === Auto Generating ID Values ===<br /> <br /> ofbiz keeps track of auto generated sequence IDs in an entity called <tt>SequenceValueItem</tt> To make sure that the auto generated sequence IDs from hibernate and the ofbiz entity engine work well together, we have created an <tt>OpentapsIdentifierGenerator</tt> which also uses the same <tt>SequenceValueItem</tt> to obtain the next sequential ID. This ID generator is wired to the base entity POJO Java objects with hibernate annotations, like this:<br /> <pre><br /> @org.hibernate.annotations.GenericGenerator(name="Party_GEN", strategy="org.opentaps.foundation.infrastructure.OpentapsIdentifierGenerator")<br /> @GeneratedValue(generator="Party_GEN") <br /> @Id<br /> <br /> @Column(name="PARTY_ID")<br /> <br /> private String partyId;<br /> </pre><br /> <br /> So that a <tt>partyId</tt> field is automatically set for you.<br /> <br /> === Support for OFBIZ EECA's ===<br /> <br /> ofbiz EECA's are supported with custom event listeners which are registered with hibernate when <tt>Infrastructure.getSessionFactory(String delegatorName)</tt> is called, usually during the initial startup. These event listeners will run ofbiz services defined in <tt>eeca.xml</tt>'s when hibernate is used to update the same entities.<br /> <br /> == Under the Hood: How It Works ==<br /> <br /> === Base Class Annotations ===<br /> <br /> In opentaps version 1.4, the entity model XML from the ofbiz entity engine is still used as the base definition for all entities. The opentaps POJO generator is used to create [[Base Entity Classes|base Java objects]] automatically from these entity definitions. This POJO generator will also create the annotations which hibernate can then use to map those base objects to the database persistence layer. The definitions of the annotations can be found in <tt>BaseEntity.ftl</tt> file used by the POJO generator.<br /> <br /> === How Hibernate Configuration Files are Generated ===<br /> <br /> The POJO Generator will use <tt>hot-deploy/opentaps-common/templates/HibernateCfg.ftl</tt> to generate a base hibernate configuration file in <tt>hot-deploy/opentaps-common/config/hibernate.cfg.xml</tt> When opentaps is started, the following new container in <tt>framework/base/config/ofbiz-containers.xml</tt><br /> <pre><br /> <container name="hibernate-container" class="org.opentaps.common.container.HibernateContainer"><br /> <property name="delegator-name" value="default"/><br /> </container> <br /> </pre><br /> <br /> will generate all the hibernate configuration XML files in the <tt>hot-deploy/opentaps/config/</tt> directory for each data source in your entity engine XML file. For example, it will generate a <tt>localmysql.cfg.xml</tt>, a <tt>localpostgres.cfg.xml</tt><br /> <br /> === How We Get the Hibernate Session ===<br /> <br /> The opentaps <tt>Infrastructure</tt> Class maintains a Map of delegatorName and hibernate SessionFactory objects. Each SessionFactory is created for its corresponding delegatorName the first time it is requested from the <tt>Infrastructure.getSessionFactory(delegatorName)</tt> method. This SessionFactory is created from ofbiz entity engine configurations:<br /> * The <tt>HibernateContainer</tt> in <tt>ofbiz-containers.xml</tt> has a property called <tt>delegator-name</tt><br /> * From this delegator, we get the data source defined in <tt>entityengine.xml</tt> for the default group helper name. This is set to <tt>org.ofbiz</tt> by default in the <tt>Infrastructure</tt> class and is the <tt>group</tt> attribute of the <tt>entitygroup.xml</tt> definitions in ofbiz:<br /> <entity-group group="org.ofbiz" entity="AcctgTagEnumType"/><br /> In <tt>entityengine.xml</tt>, you map a data source to each group:<br /> <delegator name="default" entity-model-reader="main" entity-group-reader="main" entity-eca-reader="main" distributed-cache-clear-enabled="false"><br /> <group-map group-name="org.ofbiz" datasource-name="localmysql"/><br /> </delegator><br /> <br /> So, we are basically following the entity engine from the delegator to the data source via the group.<br /> * Once we have the data source, we can create the SessionFactory from the hibernate.cfg.xml for that data source. For example, if your data source is "localmysql", we will create the SessionFactory from the <tt>localmysql.cfg.xml</tt> created by the <tt>HibernateContainer</tt><br /> <br /> The <tt>HibernateContainer</tt>, which loads on startup, will cause a SessionFactory to be loaded for the delegator in the <tt>delegator-name</tt> attribute. Once this SessionFactory is loaded, it will be available for future use. Additional session factories can be obtained later by calling the <tt>getSessionFactory</tt> directly.<br /> <br /> When the <tt>Infrastructure.getSession()</tt> method is called, it will use the delegator already in the Infrastructure object to open a JDBC connection first, and then use that JDBC connection and the SessionFactory for the delegator to return a Session.<br /> <br /> The <tt>Infrastructure.getSession()</tt> will return an <tt>org.opentaps.foundation.infrastructure.Session</tt>, which extends the hibernate Session with the following differences:<br /> * when the session is closed, the JDBC connection is also automatically closed<br /> * when a Query is created, this Session will check if the query is on an entity engine view entity and construct the Query from native SQL first<br /> <br /> === View Entities ===<br /> <br /> View entities are supported with @NamedNativeQuery annotations in the base entity Java classes, which are automatically generated by the opentaps POJO Generator.<br /> <br /> === Unit Tests ===<br /> <br /> Unit tests for hibernate are found in <tt>org.opentaps.tests.entity.hibernate.HibernateTests</tt> in the opentaps-tests component.</div>

Spark https://docs.opentaps.org/docs/index.php?title=Unit_Testing&diff=3793 Unit Testing 2009-03-19T10:14:50Z

<p>Spark: </p> <hr /> <div>__TOC__<br /> <br /> <br /> ==How to Write Unit Tests==<br /> ===opentaps 1.0===<br /> For opentaps 1.0, you would write a set of Junit tests in a class, then define it in an XML testdef file like this:<br /> <pre><br /> <test-suite suite-name="entitytests"<br /> xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" <br /> xsi:noNamespaceSchemaLocation="http://www.ofbiz.org/dtds/test-suite.xsd"><br /> <test-case case-name="security-tests"><junit-test-suite class-name="com.opensourcestrategies.crmsfa.test.SecurityTests"/></test-case><br /> </test-suite><br /> </pre> <br /> <br /> You can define multiple tests per testdef xml file. Then, add the testdef file to your ofbiz-component.xml, like this:<br /> <br /> <test-suite loader="main" location="testdef/crmsfa_tests.xml"/><br /> <br /> Then, when you do<br /> $ ant run-tests<br /> your tests will be run.<br /> ===opentaps 0.9===<br /> In opentaps 0.9, you would write your Junit tests class and add your it to the base/config/test-containers.xml file, in the "junit-container" at the bottom, like this:<br /> <pre><br /> <container name="junit-container" class="org.ofbiz.base.container.JunitContainer"><br /> <property name="base-test" value="org.ofbiz.base.test.BaseUnitTests"/><br /> <property name="entity-test" value="org.ofbiz.entity.test.EntityTestSuite"/><br /> <property name="service-test" value="org.ofbiz.service.test.ServiceEngineTests"/><br /> <property name="crm-security" value="com.opensourcestrategies.crmsfa.test.SecurityTests"/> <br /> <br /> </container><br /> </pre><br /> Then you would do<br /> $ ant run-tests<br /> <br /> Your tests will run alongside the existing OFBIZ test suites.<br /> <br /> '''IMPORTANT''': <br /> * Use a "test" delegator to point your tests to a separate database, and make sure it is defined in framework/entity/config/entityengine.xml is set to the right database.<br /> * The opentaps tests are commented out in hot-deploy/component-load.xml by default so don't forget to activate them.<br /> <br /> ==Where are the Unit Tests?==<br /> <br /> All opentaps unit tests are located in hot-deploy/opentaps-tests<br /> <br /> There are also a small number of unit tests from ofbiz in their respective modules, such as framework/entity for the entity engine unit tests.<br /> <br /> ==Setting Up For Unit Testing==<br /> <br /> We recommend that you create a separate database on the same database server for testing purposes and install all demo data into the testing database. Let's say that this database is called "opentaps_testing". Then, edit the file framework/entity/config/entityengine.xml and define opentaps_testing as a new datasource, called "localmysltesting" or "localpostgrestesting". Next, initiate the demo data into the testing database by editing the default delegator:<br /> <br /> <pre><br /> <delegator name="default" entity-model-reader="main" entity-group-reader="main" entity-eca-reader="main" distributed-cache-clear-enabled="false"><br /> <group-map group-name="org.ofbiz" datasource-name="localXXXtesting"/><br /> </delegator><br /> </pre><br /> <br /> Then do an<br /> <br /> $ ant run-install<br /> <br /> to install all the seed and demo data into the testing database. Then you can edit the default delegator back to your original delegator, and set the '''test''' delegator to the testing database:<br /> <pre><br /> <br /> <delegator name="test" entity-model-reader="main" entity-group-reader="main" entity-eca-reader="main"><br /> <group-map group-name="org.ofbiz" datasource-name="localXXXtesting"/><br /> </delegator><br /> </pre><br /> <br /> All unit tests should be run to use the test delegator. This can be done by instantiating the the "test" delegator by name and using that delegator to instantiate a dispatcher. Or you can just write a test suite which extends the OpentapsTests base class, which does it for you.<br /> <br /> If you need to modify port settings for the testing instance, you should edit the file framework/base/config/test-containers.xml.<br /> <br /> ==Unit Testing Strategies==<br /> <br /> These are some strategies for unit testing:<br /> <br /> * Transaction comparison - Compare the transaction produced with a sample transaction, possibly pre-loaded into the system. For example, posting a paycheck to the ledger and then comparing with test data of a correct ledger transaction to make sure that they are equivalent. Equivalence is a very important concept: it is not possible that two sets of transactions are identical, since at a minimum they would have different ID numbers, and they would probably reference other transactions with different IDs. For example, each order would have a different orderId and different inventory item Ids reserved against it. However, two orders may be considered equivalent if they have the same set of items, prices, shipping methods, customer, addresses, tax and promotional amounts, etc.<br /> * State change - Compare the state of the system before and after a transaction has occurred. For example, check the inventry of an item, then ship an order, and check the resulting inventory to make sure that it is correctly decremented. This could get very complex: Shipping an order could cause customer balances, invoices, ledger postings, and inventory changes. Multiple tests could be run off the same transaction event.<br /> * Absolute state check - At all times, certain relationships must hold. For example, the sum of all debits must equal sum of all credits.<br /> <br /> Tests should be written against the services that create the original data. For example, if you are writing tests against CRMSFA activity, you can use users from the demo data set, but you should use the CRMSFA activity services to create or update your activities. Otherwise, if you create those activities with some other method, future changes to the services to create activities will not be covered by your unit tests.<br /> <br /> Tests should be run against a dedicated testing database with demo and seed data rather than production data. Therefore, the tests generally should set up their own initial conditions and run to completion, but they do not need to "tear down" and remove all data created by the tests. (This would be very impractical: imagine creating and shipping an order. To tear it down would involve reverting order data, customer information, inventory data, shipment data, invoices and payments, and accounting entries.) A good test for the tests is that if you ran the test suite in succession multiple times, they should pass during the second and third runs as well as the first run.<br /> <br /> ==A Unit Testing Tutorial==<br /> <br /> <pre><br /> IMPORTANT: Each unit test method must start with the word "test" -- it must be called testXXX(), not tryXXX() or verifyXXX().<br /> </pre><br /> <br /> Now let's walk through a particular unit test and see how it works. The one that we're looking at is the ProductionRunTests.java's testProductionRunTransactions method. This particular test verifies that a standard manufacturing process is working correctly and checks the inventory results and financial statements. As you read through the code, you will notice that it does the following<br /> <br /> # Sets up by first receiving the raw materials (MAT_A_COST and MAT_B_COST) into inventory<br /> # Checks the initial state by getting the GL account balances and the initial inventory quantities, both ATP and QOH<br /> # Runs through the production run<br /> # Checks the final state by getting the GL account balances and the inventory quantities for raw materials and the finished product. <br /> # Verify the following:<br /> ## The change in inventory quantities is correct: raw materials are used, so their quantities are reduced, and finished product's quantity is increased because it is produced.<br /> ## The change in GL account balances are correct: inventory value increases and are offset by raw materials and manufacturing expenses.<br /> ## The financial statements are in balance at all times.<br /> ## The financial transactions created by this production run is in agreement with the reference transactions MFGTEST-1, -2, -3. This is done by finding all new financial transactions after the production run has been begun, as they should only be generated by the production run.<br /> ## The unit value of the finished product is correct.<br /> <br /> Along the way, the tests will verify that all the services are run correctly and return success as well.<br /> <br /> The test case uses the classes InventoryAsserts and FinancialAsserts to obtain information and run tests on the inventory balances and financial statement values. This is a common "delegation" pattern to separate the code for testing assertions to new classes. It also uses methods such as assertMapDifferenceCorrect and assertTransactionEquivalence which are inherited from the OpentapsTestCase and FinancialsTestCase base classes.<br /> <br /> For comparisons of GL account changes, we have set a convention so that increases in the balances of debit GL accounts are positive, and increases in the balances of credit GL accounts are negative values. So, if a transaction caused an inventory GL account to increase by 100 and accounts payable to increase by 100 as well, the GL account changes would be {INVENTORY: 100, ACCOUNTS_PAYABLE: -100}<br /> <br /> Note that in this case we used the receiveInventoryProduct service to receive inventory, called the various production run services, and then compared the results versus pre-stored AcctgTrans and AcctgTransEntries. With other tests, such as those for invoices and payments, we have used pre-existing Invoice and Payment records stored in the hot-deploy/opentaps-tests component and merely changed their status codes to verify the results. This brings up an interesting question--what should be done during the service, and what with existing data?<br /> <br /> Our recommendation is this:<br /> * What you are testing must be done with the services that you would normally use as part of your application. For example, when we are testing GL postings, the user does not actually call the "postInvoiceToGl" service anywhere on the screen. Instead, she would set the invoice status, and the services would run behind the scenes. Therefore, it would not do to run the "postInvoiceToGl" test, or worse, manually create the results of that service in the database. Instead, we should be calling the service to set invoice status, which is the same one accessed via the controller. <br /> * For everything else, do whatever is easiest to set up the pre-conditions for testing. Calling receiveInventoryProduct is pretty easy compared to storing InventoryItem and InventoryItemDetail, so we decided to use that. Calling createInvoice and createInvoiceItem would have been many lines of code, so we just stored an invoice in the database.<br /> <br /> ==Creating Reference Data Sets==<br /> <br /> In many tests you will see comparisons against pre-stored AcctgTrans and AcctgTransEntries. These are reference data sets which are used to compare actual transactions' results and make sure that they are consistent with the reference. Reference data sets are created in the following way:<br /> # Run through a set of business transactions, such as creating an invoice and marking it as READY.<br /> # Go to Webtools > XML Data Export and select the entities to export. In this case, it might be the Invoice, InvoiceItem, AcctgTrans, AcctgTransEntry entities. Export them either to a file or to a browser and copy them to a file.<br /> # Edit the file of transactions and change the following:<br /> ## All IDs from the system-generated 100xx to something like "XXX-TEST-###" so that they would not cause primary key conflicts.<br /> ## For AcctgTrans, change the glFiscalTypeId of all the AcctgTrans to "REFERENCE" from "ACTUAL" so they would not interfere with actual records.<br /> ## Remove references to entities which would not be part of the reference set. For example, the invoice might be part of the reference set, but workEffortId, inventoryItemId, etc. referenced by AcctgTransEntry would not be.<br /> ## Test by loading the new entity XML into your dedicated testing database. It should cause no conflicts.<br /> ## Add it to the opentaps-tests component's ofbiz-component.xml so that it would load for future tests and commit it!<br /> <br /> ==Running a Unit Test from Beanshell==<br /> <br /> After you have written a lot of unit tests, running all of them could take a long time. Fortunately, you can use beanshell to run just one unit test at a time to speed up your development. To do this, you would need to telnet into your beanshell port, then instantiate an object of the unit tests class, and run your test method:<br /> <br /> <pre><br /> si-chens-computer:~ sichen$ telnet localhost 9990<br /> Trying ::1...<br /> Connected to localhost.<br /> Escape character is '^]'.<br /> BeanShell 2.0b4 - by Pat Niemeyer (pat@pat.net)<br /> bsh % import org.opentaps.tests.purchasing.MrpTests;<br /> bsh % mrpTests = new MrpTests();<br /> bsh % mrpTests.testMrpPurchasedProduct();<br /> bsh %<br /> </pre><br /> <br /> If the test succeeded, you would see no messages on your beanshell console. If it failed, you would see a stack trace. In both cases, you should see the log messages in runtime/logs/ofbiz.log or runtime/logs/console.log<br /> <br /> To make your life even simpler, you use [[Image:Tests.bsh.zip]] as a starting point and modify it for your test, then just call it with the source method from the beanshell console:<br /> <br /> <pre><br /> bsh % source("tests.bsh");<br /> </pre><br /> <br /> ==Debugging Unit Tests with IntelliJ==<br /> <br /> The default task for tests will do a global compile. To skip this, you can redefine the run-tests target in build.xml as follows,<br /> <br /> <pre><br /> <target name="run-tests"><br /> <java jar="ofbiz.jar" fork="true"><br /> <arg value="test"/><br /> </java><br /> </target><br /> </pre><br /> <br /> Using a debugger can help speed up development of the unit tests. You can enable debugging by specifying the JVM arguments for your debugging system. For instance, if you have the [http://www.jetbrains.com/idea/ IntelliJ IDE], the run-tests target becomes,<br /> <br /> <pre><br /> <target name="run-tests"><br /> <java jar="ofbiz.jar" fork="true"><br /> <jvmarg value="${memory.max.param}"/><br /> <jvmarg value="-Xdebug"/><br /> <jvmarg value="-Xnoagent"/><br /> <jvmarg value="-Djava.compiler=NONE "/><br /> <jvmarg value="-Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=5005"/><br /> <arg value="test"/><br /> </java><br /> </target><br /> </pre><br /> <br /> You should be able to attach the debugger immediately after running '''ant run-tests'''. Don't forget to recompile the component where your tests live.<br /> <br /> Another tip is to comment out all unnecessary test suites. Unfortunately, this involves searching every ofbiz-component.xml. One way to find them, if you're on a POSIX OS, is to use find,<br /> <br /> <pre><br /> $ find . -name ofbiz-component.xml -exec grep test-suite {} \; -print<br /> </pre><br /> <br /> ==Dealing with Concurrency==<br /> <br /> Since each test method runs in a separate thread, there may be concurrency issues when you are using demo or test data in a test. For example, if you are testing whether a certain number of commission invoices are being generated for sales invoices, another thread could be generating additional ones at the same time. This leads to unexpected results which can seem very mysterious.<br /> <br /> To avoid concurrency issues, ensure that your tests are using generated data for comparison purposes. For example, rather than using <tt>DemoCustomer</tt> as the target of a sales invoice, you can create a copy of <tt>DemoCustomer</tt>,<br /> <br /> <pre><br /> String customerPartyId = createPartyFromTemplate("DemoCustomer");<br /> // create invoice for customerPartyId<br /> </pre><br /> <br /> From this point, any data that relies on the partyId is sure to be specific to that test only. An example would be when we're checking the customer balance against <tt>customerPartyId</tt>. If we were checking the balance of <tt>DemoCustomer</tt>, then we might be thrown off if another thread happens to create an invoice for <tt>DemoCustomer</tt> at the same time.<br /> <br /> ==Warning about running Unit Tests in MySQL==<br /> <br /> When running unit tests in MySQL that use transactions please be aware that an assert failure can issue a rollback on the transaction leaving the data on the database in an inconsistent state, potentially allowing the test to pass even if in reality it failed.<br /> <br /> MySQL does not store timestamps with a greater than 1 second precision. Therefore, it could lead to some primary key violations when several attempts to store data with a timestamp as part of the primary key take place within the same second. For example, if you update the status of an invoice several times during the same second in a test, the InvoiceStatus could experience primary key violations because one of its primary key fields is a timestamp. To work around this problem, put pauses inside of your test:<br /> pause("product average calculation");<br /> <br /> When runnig a long time test in MYSQL that might cause lock wait timeout error, so we need change the MYSQL innodb_lock_wait_timeout parameter to avoid this issue. See [[Database_Tips#Mysql_Tips]]</div>

Spark https://docs.opentaps.org/docs/index.php?title=Database_Tips&diff=3792 Database Tips 2009-03-19T10:07:22Z

<p>Spark: </p> <hr /> <div>__TOC__<br /> <br /> ==General==<br /> <br /> * [http://www.javaworld.com/jw-07-2000/jw-0714-transaction.html J2EE Transaction Management]<br /> * [http://publib.boulder.ibm.com/infocenter/txformp/v5r1/index.jsp?topic=/com.ibm.txseries510.doc/aetgpw0055.htm Nested Transactions]<br /> * [http://www.precisejava.com/javaperf/j2ee/JDBC.htm JDBC Best Practices]<br /> <br /> <br /> ==PostgreSQL Tips==<br /> <br /> * [http://wiki.postgresql.org/wiki/Performance_Optimization PostgreSQL Wiki Article on Performance Optimization]<br /> * [http://www.phpbuilder.com/columns/smith20010821.php3 Optimizing PostgreSQL]<br /> ===Monitoring PostgreSQL Deadlocks===<br /> <br /> You can monitor any database locks using the Entity SQL Processor in '''Webtools -> Entity SQL Processor''' with the following query,<br /> <br /> <pre><br /> select pg_class.relname, pg_locks.mode, pg_locks.relation, pg_locks.transaction, pg_locks.pid<br /> from pg_class, pg_locks <br /> where pg_class.relfilenode = pg_locks.relation <br /> order by pid<br /> </pre><br /> <br /> This will show what kinds of locks are active on what entities. If there is an exclusive lock on a table followed by a bunch of pids that are waiting for it, then you have a deadlock.<br /> <br /> ===Checking Open PostgreSQL Connections===<br /> <br /> Run this query:<br /> select datname, numbackends from pg_stat_database;<br /> <br /> to see the number of open connections to each of your databases. See [http://bytes.com/forum/thread616677.html How to Know Number of Connections Made with Database - PostgreSQL]<br /> <br /> If you are running out of connections, edit the file <tt>framework/entity/config/entityengine.xml</tt> and increase the number of connections available.<br /> <br /> ==MySQL Tips==<br /> <br /> ===Table Name Case Sensitivity===<br /> <br /> If you use Linux or Unix for your MySQL server, the table names may be case sensitive, so PRODUCT and product are not the same table. You can turn this off by configuring mysqld on startup to ignore table names with the lower-case-table-names flag, such as this example from /etc/init.d/mysql:<br /> $bindir/mysqld_safe --datadir=$datadir --lower-case-table-names=1 --pid-file=$server_pid_file $other_args >/dev/null 2>&1 &<br /> <br /> See [http://dev.mysql.com/doc/refman/5.0/en/identifier-case-sensitivity.html MySQL manual on identifier case sentivity]<br /> <br /> ===UTF-8 Support===<br /> <br /> By default, MySQL supports the Latin1 character set, which is intended for European languages such as English. If you wish to use MySQL for other language types, you may need to set up a database or UTF-8 character set encoding. To do this, you would need to create your database using UTF-8 first:<br /> <br /> <pre><br /> mysql> create database opentaps default character set utf8 collate utf8_general_ci;<br /> </pre><br /> <br /> Then you would need to set your framework/entity/config/entityengine.xml file for the MySQL database to use the UTF-8 character set:<br /> <br /> <pre><br /> character-set="utf8"<br /> collate="utf8_general_ci" <br /> </pre><br /> <br /> Note that it is not clear that my SQL supports case sensitive UTF-8 coalition at this point, although you may be able to [http://forums.mysql.com/read.php?103,156527,198794#msg-198794 use UTF-8 binary collation].<br /> <br /> ===Lock Timeout===<br /> <br /> ==DB2 Tips==<br /> <br /> ===DB2 Basics===<br /> <br /> You must configure DB2 to have tablespaces of 8K or more. This can be done when you create the database from the Control Center:<br /> [[Image:DB2_tablespace.PNG]]<br /> <br /> If you get an error message from DB2, you will get a SQLCODE like below:<br /> <pre><br /> DB2 SQL Error: SQLCODE=-270, SQLSTATE=42997, SQLERRMC=63, DRIVER=3.50.152<br /> </pre><br /> <br /> To figure out what it is, you have to run db2 from the command line:<br /> <pre><br /> $ db2 ? sql-270<br /> </pre><br /> <br /> Some of the more popular codes are:<br /> * SQL-204: <name> not recognized. Most likely, you are referencing a table that doesn't exist.<br /> * SQL-270: Function not supported. See the SQLERRMC for the message code. If you get sql-270 with sqlerrmc=63, it means that you are trying to select a CLOB/BLOB type with a scroll insensitive cursor.<br /> * SQL-286: insufficient page size for CREATE TABLE<br /> * SQL-530: foreign key violation<br /> * SQL-803: operation violates a unique value constraint <br /> <br /> === Making DB2 Work ===<br /> <br /> There are three issues with using DB2 and opentaps:<br /> <br /> # You must define a <tt>fieldtypedb2.xml</tt> file for your <tt>framework/entity/fieldtype/</tt> directory. You can Start with the field type XML from another database, such as MySQL. Most of the [http://www.informit.com/content/images/0672326132/downloads/appc.pdf valid DB2 field types] are similar, but DB2 does not have a "NUMERIC" type. It is called "DECIMAL" instead of must be used for floating-point and currency field types.<br /> # On startup, the ofbiz entity engine does a check of the database against the entity model definitions. Part of the check is to verify that the primary keys of all the tables are correctly defined, but the entity engine attempts to obtain the primary key information for all the tables of the database at once, which is not supported by DB2. To make this feature work, you need to modify DatabaseUtil.java to have the entity engine check the primary keys one table at a time. <br /> # The biggest problem with DB2 is that it does not support SELECT operations which include CLOB/BLOB fields when the [http://java.sun.com/j2se/1.3/docs/guide/jdbc/spec2/jdbc2.1.frame5.html ResultSet is scroll insensitive] (See [http://publib.boulder.ibm.com/infocenter/db2luw/v8/index.jsp?topic=/com.ibm.db2.udb.doc/ad/tjvrsush.htm].) The solution is not as simple as just changing the result set type, because DB2 also does not support (i) SELECT operations on views or with JOIN using scroll sensitive cursor or (ii) moving around with .absolute(i) or .relative(i) operations on a ResultSet of TYPE_FORWARD_ONLY. This means that the view entities which include CLOB/BLOB types cannot be SELECTED (because you cannot use a scroll insensitive ResultSet), or that the EntityListIterator.getPartialList method will not work (because you cannot use .absolute and .relative), so the ofbiz form widget's list form will not paginate correctly. There is no solution for this problem, but the following workarounds exist:<br /> ## Since the majority of the large object (LOB) types are CLOB for long character strings, you can redefine the field type for your blob and very-long to be the longest possible VARCHAR instead of using CLOB.<br /> ## You can avoid using the getPartialList feature and instead use findAll or findByAnd to return a Java list, and then use the sublist() method on it. These queries are done with TYPE_FORWARD_ONLY and return the entire list at once, but the drawback is that a Java list has a limited capacity of about 65,000 records.<br /> ## If neither of these workarounds are acceptable, you would have to rewrite certain features (like surveys with long text responses) to conform to DB2's restrictions.<br /> <br /> In practice, most ERP-related uses of opentaps would not require CLOB's, so the first option should suffice. Only with content management features would such field types be required, and those features would need to be rewritten for DB2 compatibility.<br /> <br /> ==Mysql Tips==<br /> <br /> You must change [http://dev.mysql.com/doc/refman/5.0/en/innodb-parameters.html#sysvar_innodb_lock_wait_timeout innodb_lock_wait_timeout] parameter , else you might get error like these:<br /> <br /> Lock wait timeout exceeded; try restarting transaction<br /> <br /> You can add this line in your mysql config (Windows: [MYSQL_HOME]\my.ini, Linux: /etc/my.cnf)<br /> <br /> <pre><br /> #set lock timeout 300s, default is 50s<br /> innodb_lock_wait_timeout=300<br /> </pre></div>

Spark https://docs.opentaps.org/docs/index.php?title=Opentaps_Asterisk_Integration&diff=3783 Opentaps Asterisk Integration 2009-03-18T11:17:25Z

<p>Spark: </p> <hr /> <div>opentaps can be integrated with the [http://www.asterisk.org Asterisk open source PBX] which allows to call from opentaps using Asterisk and to be automatically redirected to the inbound caller in opentaps. This short tutorial teaches you how to configure the opentaps-Asterisk integration and how to use Asterisk from opentaps.<br /> <br /> == Configuring the opentaps Asterisk Integration ==<br /> <br /> To configure this, first edit the file <tt>/etc/asterisk/manager.conf</tt> and add follow lines to create an manager account for opentaps connect: <br /> ;login account<br /> [eventsdaemon]<br /> ;login password<br /> secret = pa55w0rd321<br /> ;permit network area<br /> permit = 0.0.0.0/0.0.0.0<br /> ;listen events<br /> read = system,call,log,verbose,command,agent,user<br /> ;write events<br /> write = system,call,log,verbose,command,agent,user<br /> next edit the file <tt>hot-deploy/opentaps-common/config/asterisk.properties</tt> and follow these steps:<br /> * Turn on asterisk integration by changing <tt>asterisk.enabled</tt> from N to Y<br /> asterisk.enabled = Y<br /> * Set up the asterisk server address and login credentials:<br /> asterisk.host = asterisk.host.org<br /> asterisk.username = eventsdaemon<br /> asterisk.password = password<br /> * Enter the telephone number associated with your asterisk server. This should be a Plain Old Telephone System (POTS) phone number that someone from the outside could call you on:<br /> asterisk.countryCode = 1<br /> asterisk.areaCode = 310<br /> asterisk.phoneNumber = 9876543<br /> * Now configure your outbound dialing prefrences. You need the outbound dialing prefix and additional prefix for calling long distance and foreign phone numbers:<br /> asterisk.outbound.prev = 9<br /> asterisk.outbound.area = 1<br /> asterisk.outbound.foreign = 011<br /> * In some places such as Los Angeles, you must always dial the area code, even when the phone number you are calling is in the same area code. These properties configure whether you must always dial the country or area code:<br /> asterisk.alwaysDialCountryCode = Y<br /> asterisk.alwaysDialAreaCode = Y<br /> * Finally, this property configures how frequently opentaps should check for new inbound calls from the asterisk server. By default, it's set to every three seconds:<br /> asterisk.checkFrequencySeconds = 3<br /> <br /> Next, you would need to set up the extensions on the Asterisk PBX server for your opentaps users. In opentaps, you can assign a different user login to each unique extension. This can be done by modifying the <tt>AsteriskUser</tt> entity in Web tools or its equivalent <tt>ASTERISK_USER</tt> table in your database. You would need to enter the user login ID, the extension, and the effective dates, like this:<br /> <br /> [[Image:AsteriskUser_values.PNG]]<br /> <br /> Now you are ready. Restart opentaps, and let's see what it does!<br /> <br /> == Using Asterisk from opentaps ==<br /> <br /> === Outbound Calls ===<br /> <br /> Making outbound calls is easy. Wherever you see a phone number with a link underneath it, you can click on the link, and opentaps will call out from your Asterisk servers using the extension associated with your user login. This should cause the Asterisk server to ring the handset configured to your extension:<br /> [[Image:Asterisk_outbound_call_1.PNG]]<br /> <br /> All you have to do is pick up your phone, and the call is establish. If you are in the opentaps CRM application, opentaps will then take you to the screen for logging the call so that you can record this call:<br /> [[Image:Asterisk_outbound_call_2.PNG]]<br /> <br /> === Inbound Calls ===<br /> <br /> When an inbound call rings to your Asterisk extension, an opentaps widget will display in the upper right-hand corner of your screen:<br /> [[Image:Asterisk_inbound_call_1.PNG]]<br /> <br /> Click on the link in the widget, and opentaps will take you to a page with the caller's information:<br /> [[Image:Asterisk_inbound_call_2.PNG]]<br /> <br /> == Configuring Asterisk on Amazon Elastic Computing (EC2) Cloud ==<br /> <br /> If you don't have an asterisk server, you can use one of the AMI images from [http://resvoip.com/2009/02/19/resvoip-ec2-build-3/ resvoip]. We used ami-2ec62147. This image sets up a virtual Linux server with asterisk preinstalled.<br /> <br /> The only special configuration we found necessary when using Asterisk on the Amazon EC2 cloud was to edit the <tt>/etc/asterisk/sip_general_custom.conf</tt> file to configure both the external and internal IP addresses:<br /> <pre><br /> # your Amazon EC2 Internet IP<br /> externip = 174.123.456.789<br /> # your Amazon EC2 local network setting <br /> localnet= 10.254.234.123/255.255.254.0 <br /> </pre><br /> <br /> Also, the following ports need to be opened:<br /> <pre><br /> udp 10000-20000, 4569, 5036, 5060<br /> tcp 5060, 5038<br /> tcp 22, 80 <br /> </pre><br /> <br /> Then, your opentaps instance can connect to the Asterisk server on Amazon EC2 through an SSH tunnel, like this:<br /> <pre><br /> $ ssh -i ~/ec2/asterisktest.pem -L 5038:ec2-174-123-456-789.compute-1.amazonaws.com:5038 root@ec2-174-123-456-789.compute-1.amazonaws.com<br /> </pre><br /> <br /> Test your connection with:<br /> <pre><br /> $ telnet localhost 5038<br /> </pre><br /> <br /> If it's successful, then you should set your <tt>asterisk.host</tt> in <tt>asterisk.properties</tt> to '''localhost''' when configuring opentaps for Asterisk integration. (See above.)</div>

Spark https://docs.opentaps.org/docs/index.php?title=Opentaps_Asterisk_Integration&diff=3782 Opentaps Asterisk Integration 2009-03-18T11:14:24Z

<p>Spark: </p> <hr /> <div>opentaps can be integrated with the [http://www.asterisk.org Asterisk open source PBX] which allows to call from opentaps using Asterisk and to be automatically redirected to the inbound caller in opentaps. This short tutorial teaches you how to configure the opentaps-Asterisk integration and how to use Asterisk from opentaps.<br /> <br /> == Configuring the opentaps Asterisk Integration ==<br /> <br /> To configure this, first edit the file <tt>/etc/asterisk/manager.conf</tt> and add follow lines: <br /> ;login account<br /> [eventsdaemon]<br /> ;login password<br /> secret = pa55w0rd321<br /> ;permit network area<br /> permit = 0.0.0.0/0.0.0.0<br /> ;listen events<br /> read = system,call,log,verbose,command,agent,user<br /> ;write events<br /> write = system,call,log,verbose,command,agent,user<br /> next edit the file <tt>hot-deploy/opentaps-common/config/asterisk.properties</tt> and follow these steps:<br /> * Turn on asterisk integration by changing <tt>asterisk.enabled</tt> from N to Y<br /> asterisk.enabled = Y<br /> * Set up the asterisk server address and login credentials:<br /> asterisk.host = asterisk.host.org<br /> asterisk.username = eventsdaemon<br /> asterisk.password = password<br /> * Enter the telephone number associated with your asterisk server. This should be a Plain Old Telephone System (POTS) phone number that someone from the outside could call you on:<br /> asterisk.countryCode = 1<br /> asterisk.areaCode = 310<br /> asterisk.phoneNumber = 9876543<br /> * Now configure your outbound dialing prefrences. You need the outbound dialing prefix and additional prefix for calling long distance and foreign phone numbers:<br /> asterisk.outbound.prev = 9<br /> asterisk.outbound.area = 1<br /> asterisk.outbound.foreign = 011<br /> * In some places such as Los Angeles, you must always dial the area code, even when the phone number you are calling is in the same area code. These properties configure whether you must always dial the country or area code:<br /> asterisk.alwaysDialCountryCode = Y<br /> asterisk.alwaysDialAreaCode = Y<br /> * Finally, this property configures how frequently opentaps should check for new inbound calls from the asterisk server. By default, it's set to every three seconds:<br /> asterisk.checkFrequencySeconds = 3<br /> <br /> Next, you would need to set up the extensions on the Asterisk PBX server for your opentaps users. In opentaps, you can assign a different user login to each unique extension. This can be done by modifying the <tt>AsteriskUser</tt> entity in Web tools or its equivalent <tt>ASTERISK_USER</tt> table in your database. You would need to enter the user login ID, the extension, and the effective dates, like this:<br /> <br /> [[Image:AsteriskUser_values.PNG]]<br /> <br /> Now you are ready. Restart opentaps, and let's see what it does!<br /> <br /> == Using Asterisk from opentaps ==<br /> <br /> === Outbound Calls ===<br /> <br /> Making outbound calls is easy. Wherever you see a phone number with a link underneath it, you can click on the link, and opentaps will call out from your Asterisk servers using the extension associated with your user login. This should cause the Asterisk server to ring the handset configured to your extension:<br /> [[Image:Asterisk_outbound_call_1.PNG]]<br /> <br /> All you have to do is pick up your phone, and the call is establish. If you are in the opentaps CRM application, opentaps will then take you to the screen for logging the call so that you can record this call:<br /> [[Image:Asterisk_outbound_call_2.PNG]]<br /> <br /> === Inbound Calls ===<br /> <br /> When an inbound call rings to your Asterisk extension, an opentaps widget will display in the upper right-hand corner of your screen:<br /> [[Image:Asterisk_inbound_call_1.PNG]]<br /> <br /> Click on the link in the widget, and opentaps will take you to a page with the caller's information:<br /> [[Image:Asterisk_inbound_call_2.PNG]]<br /> <br /> == Configuring Asterisk on Amazon Elastic Computing (EC2) Cloud ==<br /> <br /> If you don't have an asterisk server, you can use one of the AMI images from [http://resvoip.com/2009/02/19/resvoip-ec2-build-3/ resvoip]. We used ami-2ec62147. This image sets up a virtual Linux server with asterisk preinstalled.<br /> <br /> The only special configuration we found necessary when using Asterisk on the Amazon EC2 cloud was to edit the <tt>/etc/asterisk/sip_general_custom.conf</tt> file to configure both the external and internal IP addresses:<br /> <pre><br /> # your Amazon EC2 Internet IP<br /> externip = 174.123.456.789<br /> # your Amazon EC2 local network setting <br /> localnet= 10.254.234.123/255.255.254.0 <br /> </pre><br /> <br /> Also, the following ports need to be opened:<br /> <pre><br /> udp 10000-20000, 4569, 5036, 5060<br /> tcp 5060, 5038<br /> tcp 22, 80 <br /> </pre><br /> <br /> Then, your opentaps instance can connect to the Asterisk server on Amazon EC2 through an SSH tunnel, like this:<br /> <pre><br /> $ ssh -i ~/ec2/asterisktest.pem -L 5038:ec2-174-123-456-789.compute-1.amazonaws.com:5038 root@ec2-174-123-456-789.compute-1.amazonaws.com<br /> </pre><br /> <br /> Test your connection with:<br /> <pre><br /> $ telnet localhost 5038<br /> </pre><br /> <br /> If it's successful, then you should set your <tt>asterisk.host</tt> in <tt>asterisk.properties</tt> to '''localhost''' when configuring opentaps for Asterisk integration. (See above.)</div>

Spark https://docs.opentaps.org/docs/index.php?title=Opentaps_Asterisk_Integration&diff=3563 Opentaps Asterisk Integration 2008-11-26T10:58:37Z

<p>Spark: Protected "Asterisk Integration": Sysop page [edit=sysop:move=sysop]</p> <hr /> <div>opentaps can integrate [http://www.asterisk.org asterisk system] which allows your users to click-to-call or pop customer inforamtion on calling in. If you would like to use this feature, edit the file hot-deploy/opentaps-common/config/asterisk.properties and change the settings to the following fields:<br /> <br /> <pre><br /> # if enable asterisk support<br /> asterisk.enabled = N<br /> # asterisk server host ip<br /> asterisk.host = 192.168.0.99<br /> # asterisk manager username,defined in /etc/asterisk/manager.conf<br /> asterisk.username = asteriskuser<br /> # asterisk manager password<br /> asterisk.password = password<br /> # out dial prev code<br /> asterisk.outbound.prev = 9<br /> </pre></div>

Spark https://docs.opentaps.org/docs/index.php?title=Opentaps_Asterisk_Integration&diff=3562 Opentaps Asterisk Integration 2008-11-26T10:58:35Z

<p>Spark: New page: opentaps can integrate [http://www.asterisk.org asterisk system] which allows your users to click-to-call or pop customer inforamtion on calling in. If you would like to use this feature, ...</p> <hr /> <div>opentaps can integrate [http://www.asterisk.org asterisk system] which allows your users to click-to-call or pop customer inforamtion on calling in. If you would like to use this feature, edit the file hot-deploy/opentaps-common/config/asterisk.properties and change the settings to the following fields:<br /> <br /> <pre><br /> # if enable asterisk support<br /> asterisk.enabled = N<br /> # asterisk server host ip<br /> asterisk.host = 192.168.0.99<br /> # asterisk manager username,defined in /etc/asterisk/manager.conf<br /> asterisk.username = asteriskuser<br /> # asterisk manager password<br /> asterisk.password = password<br /> # out dial prev code<br /> asterisk.outbound.prev = 9<br /> </pre></div>

Spark https://docs.opentaps.org/docs/index.php?title=Opentaps_VoIP_Setup&diff=3554 Opentaps VoIP Setup 2008-11-24T06:09:50Z

<p>Spark: /* VoIP Integration */</p> <hr /> <div>==VoIP Integration==<br /> * [[Asterisk Integration]]<br /> * [[FacetPhone Integration]]</div>

Spark https://docs.opentaps.org/docs/index.php?title=Asteriks_Integration&diff=3553 Asteriks Integration 2008-11-24T06:08:15Z

<p>Spark: </p> <hr /> <div>opentaps can integrate [http://www.asterisk.org asterisk system] which allows your users to click-to-call or pop customer inforamtion on calling in. If you would like to use this feature, edit the file hot-deploy/opentaps-common/config/asterisk.properties and change the settings to the following fields:<br /> <br /> <pre><br /> # if enable asterisk support<br /> asterisk.enabled = N<br /> # asterisk server host ip<br /> asterisk.host = 192.168.0.99<br /> # asterisk manager username,defined in /etc/asterisk/manager.conf<br /> asterisk.username = asteriskuser<br /> # asterisk manager password<br /> asterisk.password = password<br /> # out dial prev code<br /> asterisk.outbound.prev = 9<br /> </pre></div>

Spark