ScarletDME - User contributions [en]

PHP Native API

2016-09-05T12:00:53Z

Diccon: /* News */

The PHP native API uses a socket connection to directly connect to an open and functioning QM API socket.

This single PHP script file can be dropped in on any PHP compatible web server and allow developer to use a series of function calls to access a QM Database with all the functionality that the QMClient API allows.

It is currently in the developing Alpha stages:

Make sure you have followed the [[QM-API_Server|QM Client Server setup guide]]

==News==

*[[User:Diccon|Diccon]] 09:15, 25 June 2013‎ Gene kindly moved the code storage over to GIT. PHP API lib is now stored for download there. Again it still works well with ScarletDME and probably will work with modern Commercial QM if the protocol hasn't changed.

*[[User:Diccon|Diccon]] 11:05, 6 April 2009 (UTC) Development has been paused until JD3 is fully assessed and it is determined if QMCLient is to continue getting my attention. This lib still works, others are welcome to develop on the SVN repo. Ask for commit access.
* [[User:Diccon|Diccon]] 15:27, 9 March 2009 (UTC) Conditional Handling code is in, needs proper testing. Now have 34/46 command done, QMCall and a few others will be last because they take a bit of time/effort.
*[[User:Diccon|Diccon]] 18:41, 16 February 2009 (UTC) '''Solved''' Fixed this, not 100% sure what was really happening, but i rewrote the way the login packet is constructed, to make it clearer. This fixed it. Go, Play!
*[[User:Diccon|Diccon]] 19:36, 27 January 2009 (UTC) <strike>'''Warning''' Active bug found, i believe username padding is not working, some odd length usernames may cause a QMERROR 3000 for line 902, when trying to write to $LOGINS. I'm working on it.</strike>

==How to use==
[[#Download|Download]] from the GIT repo from below.

Place this file in the same directory as the file that intends to use it, or place it in the library path for your PHP configuration.

In your php code Enter the following line at the top
include "PHPQMLib.php"

The first you need to call the connect function, something like this;
qmconnect("my.qm.server.com", "4243", "testuser", "testpass", "QMTESTACCOUNT");
or
qmconnect("192.168.1.1", "4243", "testuser", "testpass", "QMTESTACC");

You can now use the variety of PHPQM functions like qmread(),
qmdelete(), etc as you wish.
When you are done, for tidiness issue a;
qmdisconnect();
command, tidlying closing the socket.

Each page/script will need to (re)connect. Connection persistence and pooling is
a bit bigger than this simple lib for now.

Check out qmLastClause() QMPHPClient function to cater for commands
hitting ELSE, LOCKED, etc conditions

Generally you can follow the QMClient docs in terms of server functionality.
Using the below defines() as what is and is not implemented.
Better PHP specific docs will be written later, when we go Beta

==Supported Features==
QMPHPClient supports (24/46);
* Qm Quit
* GetError
* Set account
* Open
* Close
* Read
* ReadL (Untested)
* ReadLW (Untested/partial)
* ReadU (Untested)
* ReadUL(Untested/partial)
* Select
* ReadNext
* ClearSelect
* ReadList
* Release
* Write
* WriteU
* Delete
* DeleteU
* Execute
* Respond
* Logon

==Download==
If you want a copy, it is released under the LGPL (i.e. can be used within commercial products, but is GPL itself). It is available on github here:

https://github.com/geneb/PHPQMClient

==Todo Shortlist==
# Design and handle Conditional Execution, e.g. ELSE, LOCKED, ERROR, etc
# Finish implementing all simple commands/function (24/46 Done)
# Clean up error reporting

PHP Native API

2016-09-05T12:00:32Z

Diccon: /* News */ Updated download news

The PHP native API uses a socket connection to directly connect to an open and functioning QM API socket.

This single PHP script file can be dropped in on any PHP compatible web server and allow developer to use a series of function calls to access a QM Database with all the functionality that the QMClient API allows.

It is currently in the developing Alpha stages:

Make sure you have followed the [[QM-API_Server|QM Client Server setup guide]]

==News==

*[[User:Diccon|Diccon]] 09:15, 25 June 2013‎ Glen kindly moved the code storage over to GIT. PHP API lib is now stored for download there. Again it still works well with ScarletDME and probably will work with modern Commercial QM if the protocol hasn't changed.

*[[User:Diccon|Diccon]] 11:05, 6 April 2009 (UTC) Development has been paused until JD3 is fully assessed and it is determined if QMCLient is to continue getting my attention. This lib still works, others are welcome to develop on the SVN repo. Ask for commit access.
* [[User:Diccon|Diccon]] 15:27, 9 March 2009 (UTC) Conditional Handling code is in, needs proper testing. Now have 34/46 command done, QMCall and a few others will be last because they take a bit of time/effort.
*[[User:Diccon|Diccon]] 18:41, 16 February 2009 (UTC) '''Solved''' Fixed this, not 100% sure what was really happening, but i rewrote the way the login packet is constructed, to make it clearer. This fixed it. Go, Play!
*[[User:Diccon|Diccon]] 19:36, 27 January 2009 (UTC) <strike>'''Warning''' Active bug found, i believe username padding is not working, some odd length usernames may cause a QMERROR 3000 for line 902, when trying to write to $LOGINS. I'm working on it.</strike>

==How to use==
[[#Download|Download]] from the GIT repo from below.

Place this file in the same directory as the file that intends to use it, or place it in the library path for your PHP configuration.

In your php code Enter the following line at the top
include "PHPQMLib.php"

The first you need to call the connect function, something like this;
qmconnect("my.qm.server.com", "4243", "testuser", "testpass", "QMTESTACCOUNT");
or
qmconnect("192.168.1.1", "4243", "testuser", "testpass", "QMTESTACC");

You can now use the variety of PHPQM functions like qmread(),
qmdelete(), etc as you wish.
When you are done, for tidiness issue a;
qmdisconnect();
command, tidlying closing the socket.

Each page/script will need to (re)connect. Connection persistence and pooling is
a bit bigger than this simple lib for now.

Check out qmLastClause() QMPHPClient function to cater for commands
hitting ELSE, LOCKED, etc conditions

Generally you can follow the QMClient docs in terms of server functionality.
Using the below defines() as what is and is not implemented.
Better PHP specific docs will be written later, when we go Beta

==Supported Features==
QMPHPClient supports (24/46);
* Qm Quit
* GetError
* Set account
* Open
* Close
* Read
* ReadL (Untested)
* ReadLW (Untested/partial)
* ReadU (Untested)
* ReadUL(Untested/partial)
* Select
* ReadNext
* ClearSelect
* ReadList
* Release
* Write
* WriteU
* Delete
* DeleteU
* Execute
* Respond
* Logon

==Download==
If you want a copy, it is released under the LGPL (i.e. can be used within commercial products, but is GPL itself). It is available on github here:

https://github.com/geneb/PHPQMClient

==Todo Shortlist==
# Design and handle Conditional Execution, e.g. ELSE, LOCKED, ERROR, etc
# Finish implementing all simple commands/function (24/46 Done)
# Clean up error reporting

PHP Native API

2016-09-05T11:57:16Z

Diccon: /* How to use */

The PHP native API uses a socket connection to directly connect to an open and functioning QM API socket.

This single PHP script file can be dropped in on any PHP compatible web server and allow developer to use a series of function calls to access a QM Database with all the functionality that the QMClient API allows.

It is currently in the developing Alpha stages:

Make sure you have followed the [[QM-API_Server|QM Client Server setup guide]]

==News==
*[[User:Diccon|Diccon]] 11:05, 6 April 2009 (UTC) Development has been paused until JD3 is fully assessed and it is determined if QMCLient is to continue getting my attention. This lib still works, others are welcome to develop on the SVN repo. Ask for commit access.
* [[User:Diccon|Diccon]] 15:27, 9 March 2009 (UTC) Conditional Handling code is in, needs proper testing. Now have 34/46 command done, QMCall and a few others will be last because they take a bit of time/effort.
*[[User:Diccon|Diccon]] 18:41, 16 February 2009 (UTC) '''Solved''' Fixed this, not 100% sure what was really happening, but i rewrote the way the login packet is constructed, to make it clearer. This fixed it. Go, Play!
*[[User:Diccon|Diccon]] 19:36, 27 January 2009 (UTC) <strike>'''Warning''' Active bug found, i believe username padding is not working, some odd length usernames may cause a QMERROR 3000 for line 902, when trying to write to $LOGINS. I'm working on it.</strike>

==How to use==
[[#Download|Download]] from the GIT repo from below.

Place this file in the same directory as the file that intends to use it, or place it in the library path for your PHP configuration.

In your php code Enter the following line at the top
include "PHPQMLib.php"

The first you need to call the connect function, something like this;
qmconnect("my.qm.server.com", "4243", "testuser", "testpass", "QMTESTACCOUNT");
or
qmconnect("192.168.1.1", "4243", "testuser", "testpass", "QMTESTACC");

You can now use the variety of PHPQM functions like qmread(),
qmdelete(), etc as you wish.
When you are done, for tidiness issue a;
qmdisconnect();
command, tidlying closing the socket.

Each page/script will need to (re)connect. Connection persistence and pooling is
a bit bigger than this simple lib for now.

Check out qmLastClause() QMPHPClient function to cater for commands
hitting ELSE, LOCKED, etc conditions

Generally you can follow the QMClient docs in terms of server functionality.
Using the below defines() as what is and is not implemented.
Better PHP specific docs will be written later, when we go Beta

==Supported Features==
QMPHPClient supports (24/46);
* Qm Quit
* GetError
* Set account
* Open
* Close
* Read
* ReadL (Untested)
* ReadLW (Untested/partial)
* ReadU (Untested)
* ReadUL(Untested/partial)
* Select
* ReadNext
* ClearSelect
* ReadList
* Release
* Write
* WriteU
* Delete
* DeleteU
* Execute
* Respond
* Logon

==Download==
If you want a copy, it is released under the LGPL (i.e. can be used within commercial products, but is GPL itself). It is available on github here:

https://github.com/geneb/PHPQMClient

==Todo Shortlist==
# Design and handle Conditional Execution, e.g. ELSE, LOCKED, ERROR, etc
# Finish implementing all simple commands/function (24/46 Done)
# Clean up error reporting

JavaQM-API SuportedFeatures

2011-06-06T22:28:37Z

Diccon:

There are two lists of features. Things that the QMClient system is capable of, marked with which of them the Java API supports. Then second is a list of additional tools and features the Java API provides for helping you work with MultiValu data, etc.

== Protocol Features Supported ==
The Java API library supports the following features that the qmclient protocol provides;
* 1 Quit
* 2 Get extended error text
* 3 Set account
* 4 Open file
* 5 Close file
* 6 Read record (READ)
* 7 Read record (READL)
* 8 Read record (READL, waiting)
* 9 Read record (READU)
* 10 Read record (READU, waiting)
* 11 Select file
* 12 Read next id from select list
* 13 Clear select list
* 14 Read select list
* 15 Release lock
* 16 Write record
* 17 Write record, retaining lock
* 18 Delete record
* 19 Delete record, retaining lock
* 20 Call catalogued subroutine
* 21 Execute command
* 22 Response to input
* 23 End command '''Not Implemented'''
* 24 Network login
* 25 QMLocal login '''Not Implemented'''
* 26 Select index
* 27 Enter licensed package '''Not Implemented'''
* 28 Exit licensed package '''Not Implemented'''
* 29 Open QMNet file '''Not Implemented'''
* 30 Lock a record
* 31 Clearfile '''Not Implemented'''
* 32 Get file lock '''Not Implemented'''
* 33 Release file lock '''Not Implemented'''
* 34 Test lock '''Not Supported'''
* 35 Fetch information about indices '''Not Implemented'''
* 36 Fetch information about an index '''Not Implemented'''
* 37 Select file and return list
* 38 Select index, returning indexed values
* 39 Select index, returning keys for value
* 40 Perform FILEINFO() action '''Not Implemented'''
* 41 READV and variants '''Not Implemented'''
* 42 Set index at extreme left
* 43 Set index at extreme right
* 44 Scan index to left
* 45 Scan index to right
* 46 Enable/disable mark mapping '''Not Implemented'''

== Java Multivalue Utilities ==
Non implemented
* QMExtract()
* QMReplace()
* QMIns()
* QMDel()
* QMLocate()
* QMChange()
* QMDcount()
* QMField()
* QMMatch()
* QMMatchfield()

Branding tasks

2011-01-24T11:42:38Z

Diccon: Undo Bot inserted revision 524 by LoraTrump (Talk)

Things that need to be done to change the branding from 'QM' or 'OpenQM' to the new name (yet to be decided as of time of writing).

Note: I have characterized tasks as 'important' and 'less important', but of course this is subjective. The items in the first category are things I think we should change before a release, whereas the second lot can be left until later if necessary.

==System Changes==
===Important===
* Change the @QMSYS at-var (note: change in F-type VOC entries, too). Change to '@SYS'? '@SYSPATH'/'@SYS.PATH'?
* Change '/usr/qmsys' to something more appropriate.
* Change 'QM.VOCLIB' to 'VOCLIB'.
* Change '/etc/qmconfig' to something more appropriate. ([[User:Diccon|Diccon]] gotit)
* Change the various program names from 'qm*' (except QMClient?).

===Less Important===
* Change all the source 'qm*.c's (except QMClient?).
* Change the VOC entry 'QM.ACCOUNTS' to something else (what?)
* Remove the 'gpl' bit from 'GPL.BP', 'gplsrc', 'gplobj' etc.
* Rename QMPKG (is this much used?)
* Rename QMClient?
* Create an 'OpenQM Compatibility Mode'? (e.g. equate @QMSYS to @SYSPATH)

==Code Changes==
===Important===
* Change the welcome message to something more appropriate.
* Change the QM Started message

===Less Important===
* Change the info in the headers in GPL.BP and gplsrc.
* Rename internal references to 'qm' (e.g. function names).

==Documentation==
We need some!

==Website Changes==
===Important===
* New domain name.
* New logo (get a temporary one quickly; permanent one can come later).

===Less Important===
* Change references to QM in Wiki.

Main Page

2010-08-07T13:42:32Z

Diccon: Remove "Name change" ref. Old news now

Welcome to ScarletDME.org. [[ScarletDME]] is a OpenSource [[multivalue|MultiValue]] database, a community fork of [[OpenQM]] originally developed by [[Ladybridge]]. This project was founded on the 28th November 2008 to independently develop future versions of [[ScarletDME]] and contribute to [[OpenQM]]. While there are no longer regular official releases from [[Ladybridge]] we aim to support and develop for Scarlet to help our commercial sister, While providing a Free and open platform for Multi value development.

Submissions to this project must be under the GPL version 2, with the option to use a later version if the licensee wishes. Or they can be licensed under the LGPL if you wish to encourage and allow incorporation into proprietary products. Contributors to [[ScarletDME]] are welcome to submit changes back to Ladybridge as well, for inclusion in Commercial QM. See [[Commercial submissions]] for details. We encourage submission to Ladybridge, the founder of this MultiValue database. We do recognise their processes are not as easy as traditional GPL projects. So we simply offer an easier forum for development with less stringent controls on contribution and participation.

The server is a VMWare Server 2 Virtual Machine located in a high-bandwidth datacentre in Amsterdam, Netherlands. It is hosted by [[User:SteveB|SteveB]] who maintains a daily backup to a secondary datacentre in Amsterdam. If you can provide a stable high bandwidth backup mirror, please contact him.

'''This server is DOWN/SLOW around 04:00GMT nightly for 15mins while backing up.'''

==For Users==
*[[Downloads]]: Source tarball and package builds for key platforms
*[[Guides & HOWTOs]] - Index of useful guides and HOWTO's on this Wiki
*[[QMBASIC Enhancements]] - QMBASIC features that are custom or were not part of the original GPL release.
*[http://www.scarletdme.org/bugzilla Bugzilla] reporting and tracking bugs:
*[[Documentation]] - Documented differences from the Commercial Documentation (Check here first, then below)
*[http://www.openqm.org/docs/ Documentation] (Commercial Version)
*General support email group: [http://groups.google.co.uk/group/scarletdme Register] then mailto:scarletdme@googlegroups.com
*IRC Chat: irc://irc.efnet.org/openqm or java client http://www.scarletdme.org/chat/

====Supporting Projects====
Various external projects that provide tools for or API's into OpenQM
* [http://billabong-services.co.uk/anji Billabong Services' Anji] - an open web based file browser and reporter. Eventually to become a RAD system. Pre-alpha grade of code.
*[[PHP_Native_API|PHP Native API module]]
*[[C++ Wrapper]]
*Steve Bush's [[Cygwin Port]] - Is it worth considering a MinGW port? - Would have to replace some posix bits which MinGW doesnt have.
* [http://www.tridentinfosys.com/ Kevin Powick's Trident Delphi wrapper]

==For Developers==
For those that want to contribute to OpenQM GPL project.
*Subversion repository: https://scarletdme.org/svn/qmvdb/ - [[HOWTO]]
*Development email group: [http://www.scarletdme.org/mailman/listinfo/openqm-dev Register] then mailto:openqm-dev@dev.scarletdme.org
*[[Development snapshots]] - How to obtain, build, and upgrade using the snapshots.
*[[QM Client API]] - Documentation and Available API's for the QM remote protocol.
*[[Wish list]] - Things that you want & that we need contributors/devs for (lots of small things)
*[[Dynamic linking]] - Calling objects written in other languages.
*[[Installers]] - Installing scripts/programs or package systems
*[[Commercial submissions]] - Sending stuff to Ladybridge

== How do I use this site? ==

If you have a question on USAGE of the community version of Scarlet, then send it to the [http://groups.google.co.uk/group/scarletdme general email support group].

If you want to discuss DEVELOPMENT of the community version of Scarlet (eg. php5 module) then send it to the [http://www.scarletdme.org/mailman/listinfo/openqm-dev development email group].

While the email lists are best for getting attention, permanent changes in this wiki will have a longer term impact so feel free to add or change ANYTHING in this wiki.

=== External Resources ===
* [[Installations]] - Places where GPL OpenQM is in use (I'm attempting to create a new section for this) - http://capersqm.dnsalias.net/
* [http://www.rushflat.co.nz/downloads.shtml Brian Speir's Installation instructions and other downloads ]
* [http://openqm.blackflute.com/ Tom Delombard's old QM page.] Includes details of the tape utilities and the PHP4 module (C Wrapper)
* [http://sourceforge.net/projects/jd3 JD3] is a socket based server for D3 ported to QM
* [http://www.billabong-services.co.uk/jd3/jd3php.html David Patterson's guide to using PHP with JD3] David's original page has disappeared (unable to contact), so here's the google cache
* [http://www.billabong-services.co.uk/jd3/jd3java.html David Patterson's guide to using Java with JD3] google cache again

--[[Administration]]

JavaQM-API

2009-10-16T15:31:31Z

Diccon: /* Commercial Support */ updated Tesson weblink

JavaQM-API SuportedFeatures

2009-09-14T12:24:50Z

Diccon: New page: There are two lists of features. Things that the QMClient system is capable of, marked with which of them the Java API supports. Then second is a list of additional tools and features the ...

There are two lists of features. Things that the QMClient system is capable of, marked with which of them the Java API supports. Then second is a list of additional tools and features the Java API provides for helping you work with MultiValu data, etc.

== Java Multivalue Utilities ==

== Protocol Features Supported ==
The Java API library supports the following features that the qmclient protocol provides;
* 1 Quit
* 2 Get extended error text
* 3 Set account
* 4 Open file
* 5 Close file
* 6 Read record (READ)
* 7 Read record (READL)
* 8 Read record (READL, waiting)
* 9 Read record (READU)
* 10 Read record (READU, waiting)
* 11 Select file
* 12 Read next id from select list
* 13 Clear select list
* 14 Read select list
* 15 Release lock
* 16 Write record
* 17 Write record, retaining lock
* 18 Delete record
* 19 Delete record, retaining lock
* 20 Call catalogued subroutine
* 21 Execute command
* 22 Response to input
* 23 End command '''Not Supported'''
* 24 Network login
* 25 QMLocal login '''Not Supported'''
* 26 Select index
* 27 Enter licensed package '''Not Supported'''
* 28 Exit licensed package '''Not Supported'''
* 29 Open QMNet file '''Not Supported'''
* 30 Lock a record
* 31 Clearfile '''Not Supported'''
* 32 Get file lock '''Not Supported'''
* 33 Release file lock '''Not Supported'''
* 34 Test lock '''Not Supported'''
* 35 Fetch information about indices '''Not Supported'''
* 36 Fetch information about an index '''Not Supported'''
* 37 Select file and return list
* 38 Select index, returning indexed values
* 39 Select index, returning keys for value
* 40 Perform FILEINFO() action '''Not Supported'''
* 41 READV and variants '''Not Supported'''
* 42 Set index at extreme left
* 43 Set index at extreme right
* 44 Scan index to left
* 45 Scan index to right
* 46 Enable/disable mark mapping '''Not Supported'''

JavaQM-API

2009-09-14T12:21:50Z

Diccon: /* Supported Protocol Features */ removed list, and put link to seperate page

JavaQM-API

2009-09-14T12:18:57Z

Diccon: /* Download */

This Java API library is a native Java library, which allows you to access QM via the QMClient network interface.

All you need is QMClient running on the server, the IP address, a valid username and password and the Account you want to access.

==Download==
Binary (Jar) download is available here: [http://www.scarletdme.org/downloads/JavaQMConnect-0.8.jar JavaQMConnect-0.8.jar]

To use simply download the Jar file and place it in the ClassPath or same directory as your own Java Program. See the example below for more details.

===Source code===
LGPL licenced source code for this library are available in the following locations:

The latest Source is available from the subversion repo [https://scarletdme.org/svn/qmvdb/JavaQMClient https://ScarletDME.org/svn/qmvdb/JavaQMClient]
svn checkout https://scarletdme.org/svn/qmvdb/JavaQMClient/trunk

Or as a source tar ball if you don't want to use Subversion [http://www.scarletdme.org/downloads/JavaQMConnect-0.8.tar.gz JavaQMConnect-0.8.tar.gz]

Both of the above are structured by Netbeans IDE. It is not necessary to use Netbeans if you don't want to, thought I do recommend it. A simple text editor and the Ant build utility would be enough. Or other IDE's like Eclipse will import this structure fine.

==Commercial Support==
For commercial support or new features Contact Adrian Tesson Associates (http://Tesson.co.uk)

==Supported Protocol Features==
The Java API library supports the following features that the qmclient protocol provides;
* 1 Quit
* 2 Get extended error text
* 3 Set account
* 4 Open file
* 5 Close file
* 6 Read record (READ)
* 7 Read record (READL)
* 8 Read record (READL, waiting)
* 9 Read record (READU)
* 10 Read record (READU, waiting)
* 11 Select file
* 12 Read next id from select list
* 13 Clear select list
* 14 Read select list
* 15 Release lock
* 16 Write record
* 17 Write record, retaining lock
* 18 Delete record
* 19 Delete record, retaining lock
* 20 Call catalogued subroutine
* 21 Execute command
* 22 Response to input
* 23 End command '''Not Supported'''
* 24 Network login
* 25 QMLocal login '''Not Supported'''
* 26 Select index
* 27 Enter licensed package '''Not Supported'''
* 28 Exit licensed package '''Not Supported'''
* 29 Open QMNet file '''Not Supported'''
* 30 Lock a record
* 31 Clearfile '''Not Supported'''
* 32 Get file lock '''Not Supported'''
* 33 Release file lock '''Not Supported'''
* 34 Test lock '''Not Supported'''
* 35 Fetch information about indices '''Not Supported'''
* 36 Fetch information about an index '''Not Supported'''
* 37 Select file and return list
* 38 Select index, returning indexed values
* 39 Select index, returning keys for value
* 40 Perform FILEINFO() action '''Not Supported'''
* 41 READV and variants '''Not Supported'''
* 42 Set index at extreme left
* 43 Set index at extreme right
* 44 Scan index to left
* 45 Scan index to right
* 46 Enable/disable mark mapping '''Not Supported'''

==Example==
Here is an example of how to use the JavaQM API Lib. Simply place the Jar in the library path or same directory as your classes or Jar file.

<pre>
import com.openqm.qmconnect.*;

/** Example program that accesses QM with the Java API */
public class Example {
Example() {
try {

/* Initialise the connection */
QmConnection connection = QmConnection.create("localhost",4243);

/* Tell it to log in */
connection.connect("testuser", "password", "QMSYS");

/* Open Up the VOC file as an example */
QmFile vocFile = connection.open("VOC");

/* Read from the Opened VOC file */
String record = connection.read(vocFile, "MESSAGES");

System.out.println("This is the MESSAGES Record from the VOC file: " + record);

} catch (QMException e) {
System.err.println("Error occurred connecting to QM");
}
}
}
</pre>

JavaQM-API

2009-09-14T12:15:59Z

Diccon: Added supported features

This Java API library is a native Java library, which allows you to access QM via the QMClient network interface.

All you need is QMClient running on the server, the IP address, a valid username and password and the Account you want to access.

==Download==
Binary (Jar) download is available here: [http://www.scarletdme.org/downloads/JavaQMConnect-0.8.jar JavaQMConnect-0.8.jar]

===Source code===
LGPL licenced source code for this library are available in the following locations:

The latest Source is available from the subversion repo [https://scarletdme.org/svn/qmvdb/JavaQMClient https://ScarletDME.org/svn/qmvdb/JavaQMClient]
svn checkout https://scarletdme.org/svn/qmvdb/JavaQMClient/trunk

Or as a source tar ball if you don't want to use Subversion [http://www.scarletdme.org/downloads/JavaQMConnect-0.8.tar.gz JavaQMConnect-0.8.tar.gz]

Both of the above are structured by Netbeans IDE. It is not necessary to use Netbeans if you don't want to, thought I do recommend it. A simple text editor and the Ant build utility would be enough. Or other IDE's like Eclipse will import this structure fine.

==Commercial Support==
For commercial support or new features Contact Adrian Tesson Associates (http://Tesson.co.uk)

==Supported Protocol Features==
The Java API library supports the following features that the qmclient protocol provides;
* 1 Quit
* 2 Get extended error text
* 3 Set account
* 4 Open file
* 5 Close file
* 6 Read record (READ)
* 7 Read record (READL)
* 8 Read record (READL, waiting)
* 9 Read record (READU)
* 10 Read record (READU, waiting)
* 11 Select file
* 12 Read next id from select list
* 13 Clear select list
* 14 Read select list
* 15 Release lock
* 16 Write record
* 17 Write record, retaining lock
* 18 Delete record
* 19 Delete record, retaining lock
* 20 Call catalogued subroutine
* 21 Execute command
* 22 Response to input
* 23 End command '''Not Supported'''
* 24 Network login
* 25 QMLocal login '''Not Supported'''
* 26 Select index
* 27 Enter licensed package '''Not Supported'''
* 28 Exit licensed package '''Not Supported'''
* 29 Open QMNet file '''Not Supported'''
* 30 Lock a record
* 31 Clearfile '''Not Supported'''
* 32 Get file lock '''Not Supported'''
* 33 Release file lock '''Not Supported'''
* 34 Test lock '''Not Supported'''
* 35 Fetch information about indices '''Not Supported'''
* 36 Fetch information about an index '''Not Supported'''
* 37 Select file and return list
* 38 Select index, returning indexed values
* 39 Select index, returning keys for value
* 40 Perform FILEINFO() action '''Not Supported'''
* 41 READV and variants '''Not Supported'''
* 42 Set index at extreme left
* 43 Set index at extreme right
* 44 Scan index to left
* 45 Scan index to right
* 46 Enable/disable mark mapping '''Not Supported'''

==Example==
Here is an example of how to use the JavaQM API Lib. Simply place the Jar in the library path or same directory as your classes or Jar file.

<pre>
import com.openqm.qmconnect.*;

/** Example program that accesses QM with the Java API */
public class Example {
Example() {
try {

/* Initialise the connection */
QmConnection connection = QmConnection.create("localhost",4243);

/* Tell it to log in */
connection.connect("testuser", "password", "QMSYS");

/* Open Up the VOC file as an example */
QmFile vocFile = connection.open("VOC");

/* Read from the Opened VOC file */
String record = connection.read(vocFile, "MESSAGES");

System.out.println("This is the MESSAGES Record from the VOC file: " + record);

} catch (QMException e) {
System.err.println("Error occurred connecting to QM");
}
}
}
</pre>

QM Client API

2009-09-11T15:58:16Z

Diccon: /* API library's */ updated Java lib status

==Overview==
QM provides a remote API access to any client system that can get to the server via socket 4243, and obeys the protocol.

==Server Setup==
QM is technically able to handle API connections about of the box. However your server will need some configuring. (RPM will do this for you in near future).

[[QM-API Server | QM API Server setup guide]]

==Protocol==
The following is a guide to the protocol that the server responds to.

''Currently a working document, far from perfect, but you get the idea:''

[http://www.scarletdme.org/downloads/QMClient-Protocol.v0.3.alpha.pdf QMClient-Protocol.v0.3.alpha.pdf]

==News==
*[[User:Diccon|Diccon]] 15 Jan 2009 '''Update''' - The packet header docs have been updated, and the whole login process is pretty clean. The docs are missing a large number of the simpler commands, but they are pretty easy to figure out from the VBSRVR basic code in GPL.BP. I will write them out progressivly.
*[[User:Diccon|Diccon]] 12 Jan 2009 '''Resolved''' - Turns out it was the new server environment. However the Documentation is slightly wrong for the login protocol. Login is actually a server command not a special case. Will try and update the docs and debug the further issues on the test server environment.
*[[User:Diccon|Diccon]] 8 Dec 2008 '''Confirmed''' - Functioning Java-QM client for 2.4.17 does not work on 2.6.6. Exact reason why has yet to be determined. Should have some answers soon, new year 2009 has a need for the Java API on 266.
*[[User:Diccon|Diccon]] 7 December 2008 '''Warning:''' I have suspicions that the protocol changed for login quite dramatically for 2-6-6, as opposed to 2-4-17 which this Spec doc was originally based on.

==API library's==
* C - native - Released
* Visual Basic - native - released (library only released with commercial?)
* [[JavaQM-API|Java API]] - native - Beta, stable working. LGPL release
* Delphi - Wrapper - (native expected Q1 2009)
* PHP - wrapper - Beta (TomDel)
* [[PHP Native API]] - Alpha stages but alive and kicking
* [[C++ Wrapper]]

Qmlnxd

2009-08-29T14:42:34Z

Diccon: New page: The daemon that manages Inter process communication and locking for all client sessions/processes. Launched by the -start option at command line. == Startup == When it launches it close...

The daemon that manages Inter process communication and locking for all client sessions/processes.

Launched by the -start option at command line.

== Startup ==
When it launches it closes all potentially open files.

Documentation

2009-08-29T14:31:57Z

Diccon: update format, added qmlnxd

Any features, fixes or changes from the Last Ladybridge GPL release

==Differences with OpenQM GPL==
Documentation on any changes since OpenQM 2.6-6 and LadyBridges documentation.

*QMBASIC Enhancements - QMBASIC features that are custom or were not part of the original GPL release.

==Developers documentation==
Documentation of the inner workings of Scarlet. Covers both existing OpenQM design and new features.

[[Error messages]]

[[B-Trees]] (no changes, just dev docs)

[[qmlnxd]] The Server/Daemon that all Client processes communicate/co-ordinate with.

Main Page

2009-08-28T18:39:13Z

Diccon: updated intro wording

Welcome to ScarletDME.org. [[ScarletDME]] is a OpenSource [[multivalue|MultiValue]] database, a community fork of [[OpenQM]] originally developed by [[Ladybridge]]. This project was founded on the 28th November 2008 to independently develop future versions of [[ScarletDME]] and contribute to [[OpenQM]].

Submissions to this project must be under the GPL version 2, with the option to use a later version if the licensee wishes. Or they can be licensed under the LGPL if you wish to encourage and allow incorporation into proprietary products. Contributors to [[ScarletDME]] are welcome to submit changes back to Ladybridge as well, for inclusion in Commercial QM. See [[Commercial submissions]] for details. We encourage submission to Ladybridge, the founder of this MultiValue database. We do recognise their processes are not as easy as traditional GPL projects. So we simply offer an easier forum for development with less stringent controls on contribution and participation.

'''Name change''' ''Some of you may have noticed The new Logo (to your left) With the new Brand name, ScarletDME (Data Management Environment). This is to be the new name for the GPL project based on Ladybridges GPL OpenQM; something to distinguish GPL from commercial. Changing every name reference will take a little time to complete, until then the names GPL OpenQM and Scarlet/ScarletDME will be synonymous. You can reach this site via [http://www.scarletdme.org www.scarletdme.org].
The server is a VMWare Server 2 Virtual Machine located in a high-bandwidth datacentre in Amsterdam, Netherlands. It is hosted by [[User:SteveB|SteveB]] who maintains a daily backup to a secondary datacentre in Amsterdam. If you can provide a stable high bandwidth backup mirror, please contact him.

'''This server is DOWN/SLOW around 04:00GMT nightly for 15mins while backing up.'''

==For Users==
*[[Downloads]]: Source tarball and package builds for key platforms
*[[Guides & HOWTOs]] - Index of useful guides and HOWTO's on this Wiki
*[[QMBASIC Enhancements]] - QMBASIC features that are custom or were not part of the original GPL release.
*[http://www.scarletdme.org/bugzilla Bugzilla] reporting and tracking bugs:
*[[Documentation]] - Documented differences from the Commercial Documentation (Check here first, then below)
*[http://www.openqm.org/docs/ Documentation] (Commercial Version)
*General support email group: [http://groups.google.co.uk/group/openqm-opensource Register] then mailto:openqm-opensource@googlegroups.com
*IRC Chat: irc://irc.efnet.org/openqm or java client http://www.scarletdme.org/chat/

====Supporting Projects====
Various external projects that provide tools for or API's into OpenQM
* [http://billabong-services.co.uk/anji Billabong Services' Anji] - an open web based file browser and reporter. Eventually to become a RAD system. Pre-alpha grade of code.
*[[PHP_Native_API|PHP Native API module]]
*[[C++ Wrapper]]
*Steve Bush's [[Cygwin Port]] - Is it worth considering a MinGW port? - Would have to replace some posix bits which MinGW doesnt have.
* [http://www.tridentinfosys.com/ Kevin Powick's Trident Delphi wrapper]

==For Developers==
For those that want to contribute to OpenQM GPL project.
*Subversion repository: https://scarletdme.org/svn/qmvdb/ - [[HOWTO]]
*Development email group: [http://www.scarletdme.org/mailman/listinfo/openqm-dev Register] then mailto:openqm-dev@dev.scarletdme.org
*[[Development snapshots]] - How to obtain, build, and upgrade using the snapshots.
*[[QM Client API]] - Documentation and Available API's for the QM remote protocol.
*[[Wish list]] - Things that you want & that we need contributors/devs for (lots of small things)
*[[Dynamic linking]] - Calling objects written in other languages.
*[[Installers]] - Installing scripts/programs or package systems
*[[Commercial submissions]] - Sending stuff to Ladybridge

== How do I use this site? ==

If you have a question on USAGE of the community version of OpenQM, then send it to the [http://groups.google.co.uk/group/openqm-opensource general email support group].

If you want to discuss DEVELOPMENT of the community version of OpenQM (eg. php5 module) then send it to the [http://www.scarletdme.org/mailman/listinfo/openqm-dev development email group].

While the email lists are best for getting attention, permanent changes in this wiki will have a longer term impact so feel free to add or change ANYTHING in this wiki.

=== External Resources ===
* [[Installations]] - Places where GPL OpenQM is in use (I'm attempting to create a new section for this) - http://capersqm.dnsalias.net/
* [http://www.rushflat.co.nz/downloads.shtml Brian Speir's Installation instructions and other downloads ]
* [http://openqm.blackflute.com/ Tom Delombard's old QM page.] Includes details of the tape utilities and the PHP4 module (C Wrapper)
* [http://sourceforge.net/projects/jd3 JD3] is a socket based server for D3 ported to QM
* [http://www.djpatterson.com/jd3php.html] David Patterson's guide to using PHP with JD3

--[[Administration]]

JavaQM-API

2009-08-27T16:48:16Z

Diccon: /* Download */ added source links

This Java API library is a native Java library, which allows you to access QM via the QMClient network interface.

All you need is QMClient running on the server, the IP address, a valid username and password and the Account you want to access.

==Features==
Currently the API supports almost all of the Documented QMClient commands. Access to them is controlled by the main class QMConnection.

==Download==
Binary (Jar) download is available here: [http://www.scarletdme.org/downloads/JavaQMConnect-0.8.jar JavaQMConnect-0.8.jar]

===Source code===
LGPL licenced source code for this library are available in the following locations:

The latest Source is available from the subversion repo [https://scarletdme.org/svn/qmvdb/JavaQMClient https://ScarletDME.org/svn/qmvdb/JavaQMClient]
svn checkout https://scarletdme.org/svn/qmvdb/JavaQMClient/trunk

Or as a source tar ball if you don't want to use Subversion [http://www.scarletdme.org/downloads/JavaQMConnect-0.8.tar.gz JavaQMConnect-0.8.tar.gz]

Both of the above are structured by Netbeans IDE. It is not necessary to use Netbeans if you don't want to, thought I do recommend it. A simple text editor and the Ant build utility would be enough. Or other IDE's like Eclipse will import this structure fine.

==Commercial Support==
For commercial support or new features Contact Adrian Tesson Associates (http://Tesson.co.uk)

==Example==
Here is an example of how to use the JavaQM API Lib. Simply place the Jar in the library path or same directory as your classes or Jar file.

<pre>
import com.openqm.qmconnect.*;

/** Example program that accesses QM with the Java API */
public class Example {
Example() {
try {

/* Initialise the connection */
QmConnection connection = QmConnection.create("localhost",4243);

/* Tell it to log in */
connection.connect("testuser", "password", "QMSYS");

/* Open Up the VOC file as an example */
QmFile vocFile = connection.open("VOC");

/* Read from the Opened VOC file */
String record = connection.read(vocFile, "MESSAGES");

System.out.println("This is the MESSAGES Record from the VOC file: " + record);

} catch (QMException e) {
System.err.println("Error occurred connecting to QM");
}
}
}
</pre>

Main Page

2009-08-19T23:51:11Z

Diccon: fixed gpl.openqm links to scarletdme ones :( sad day Martin broke them

Welcome to ScarletDME.org. [[ScarletDME]] is a OpenSource [[multivalue|MultiValue]] database, a community fork of [[OpenQM]] originally developed by [[Ladybridge]]. We aim to provide an environment where anyone can acquire, study and contribute to the [[ScarletDME]] project.

'''Name change''' ''Some of you may have noticed The new Logo (to your left) With the new Brand name, ScarletDME (Data Management Environment). This is to be the new name for the GPL project based on Ladybridges GPL OpenQM; something to distinguish GPL from commercial. Changing every name reference will take a little time to complete, until then the names GPL OpenQM and Scarlet/ScarletDME will be synonymous. You can reach this site via [http://www.scarletdme.org www.scarletdme.org].

This project was founded on the 28th November 2008 to independently develop future versions of [[OpenQM]].

Submissions to this project must be under the GPL version 2, with the option to use a later version if the licensee wishes. Or they can be licensed under the LGPL. Naturally, contributors to [[ScarletDME]] are welcome to submit any changes that they may make back to Ladybridge as well for inclusion in Commercial QM. See [[Commercial submissions]] for details.

The server is a VMWare Server 2 Virtual Machine located in a high-bandwidth datacentre in Amsterdam, Netherlands. It is hosted by [[User:SteveB|SteveB]] who maintains a daily backup to a secondary datacentre in Amsterdam. If you can provide a stable high bandwidth backup mirror, please contact him.

'''This server is DOWN/SLOW around 04:00GMT nightly for 15mins while backing up.'''

==For Users==
*[[Downloads]]: Source tarball and package builds for key platforms
*[[Guides & HOWTOs]] - Index of useful guides and HOWTO's on this Wiki
*[[QMBASIC Enhancements]] - QMBASIC features that are custom or were not part of the original GPL release.
*[http://www.scarletdme.org/bugzilla Bugzilla] reporting and tracking bugs:
*[[Documentation]] - Documented differences from the Commercial Documentation (Check here first, then below)
*[http://www.openqm.org/docs/ Documentation] (Commercial Version)
*General support email group: [http://groups.google.co.uk/group/ Register] then mailto:openqm-opensource@googlegroups.com
*IRC Chat: irc://irc.efnet.org/openqm or java client http://www.scarletdme.org/chat/

====Supporting Projects====
Various external projects that provide tools for or API's into OpenQM
* [http://billabong-services.co.uk/anji Billabong Services' Anji] - an open web based file browser and reporter. Eventually to become a RAD system. Pre-alpha grade of code.
*[[PHP_Native_API|PHP Native API module]]
*[[C++ Wrapper]]
*Steve Bush's [[Cygwin Port]] - Is it worth considering a MinGW port? - Would have to replace some posix bits which MinGW doesnt have.
* [http://www.tridentinfosys.com/ Kevin Powick's Trident Delphi wrapper]

==For Developers==
For those that want to contribute to OpenQM GPL project.
*Subversion repository: https://scarletdme.org/svn/qmvdb/ - [[HOWTO]]
*Development email group: [http://gpl.openqm.com/mailman/listinfo/openqm-dev Register] then mailto:openqm-dev@gpl.openqm.com
*[[Development snapshots]] - How to obtain, build, and upgrade using the snapshots.
*[[QM Client API]] - Documentation and Available API's for the QM remote protocol.
*[[Wish list]] - Things that you want & that we need contributors/devs for (lots of small things)
*[[Dynamic linking]] - Calling objects written in other languages.
*[[Installers]] - Installing scripts/programs or package systems
*[[Commercial submissions]] - Sending stuff to Ladybridge

== How do I use this site? ==

If you have a question on USAGE of the community version of OpenQM, then send it to the [http://groups.google.co.uk/group/openqm-opensource general email support group].

If you want to discuss DEVELOPMENT of the community version of OpenQM (eg. php5 module) then send it to the [http://gpl.openqm.com/mailman/listinfo/openqm-dev development email group].

While the email lists are best for getting attention, permanent changes in this wiki will have a longer term impact so feel free to add or change ANYTHING in this wiki.

=== External Resources ===
* [[Installations]] - Places where GPL OpenQM is in use (I'm attempting to create a new section for this) - http://capersqm.dnsalias.net/
* [http://www.rushflat.co.nz/downloads.shtml Brian Speir's Installation instructions and other downloads ]
* [http://openqm.blackflute.com/ Tom Delombard's old QM page.] Includes details of the tape utilities and the PHP4 module (C Wrapper)
* [http://sourceforge.net/projects/jd3 JD3] is a socket based server for D3 ported to QM
* [http://www.djpatterson.com/jd3php.html] David Patterson's guide to using PHP with JD3

--[[Administration]]

JavaQM-API

2009-08-19T16:14:39Z

Diccon: Added support

This Java API library is a native Java library, which allows you to access QM via the QMClient network interface.

All you need is QMClient running on the server, the IP address, a valid username and password and the Account you want to access.

==Features==
Currently the API supports almost all of the Documented QMClient commands. Access to them is controlled by the main class QMConnection.

==Download==
For now, until we comb the code and put the LGPL into effect for the source a prevew Binary download is avaliable here: [http://www.scarletdme.org/downloads/JavaQMConnect-Preview.jar JavaQMConnect-Preview.jar]

==Commercial Support==
For commercial support or new features Contact Adrian Tesson Associates (http://Tesson.co.uk)

==Example==
Here is an example of how to use the JavaQM API Lib. Simply place the Jar in the library path or same directory as your classes or Jar file.

<pre>
import com.openqm.qmconnect.*;

/** Example program that accesses QM with the Java API */
public class Example {
Example() {
try {

/* Initialise the connection */
QmConnection connection = QmConnection.create("localhost",4243);

/* Tell it to log in */
connection.connect("testuser", "password", "QMSYS");

/* Open Up the VOC file as an example */
QmFile vocFile = connection.open("VOC");

/* Read from the Opened VOC file */
String record = connection.read(vocFile, "MESSAGES");

System.out.println("This is the MESSAGES Record from the VOC file: " + record);

} catch (QMException e) {
System.err.println("Error occurred connecting to QM");
}
}
}
</pre>

JavaQM-API

2009-08-19T16:01:58Z

Diccon: added download preview

This Java API library is a native Java library, which allows you to access QM via the QMClient network interface.

All you need is QMClient running on the server, the IP address, a valid username and password and the Account you want to access.

==Features==
Currently the API supports almost all of the Documented QMClient commands. Access to them is controlled by the main class QMConnection.

==Download==
For now, until we comb the code and put the LGPL into effect for the source a prevew Binary download is avaliable here: [http://www.scarletdme.org/downloads/JavaQMConnect-Preview.jar JavaQMConnect-Preview.jar]

==Example==
Here is an example of how to use the JavaQM API Lib. Simply place the Jar in the library path or same directory as your classes or Jar file.

<pre>
import com.openqm.qmconnect.*;

/** Example program that accesses QM with the Java API */
public class Example {
Example() {
try {

/* Initialise the connection */
QmConnection connection = QmConnection.create("localhost",4243);

/* Tell it to log in */
connection.connect("testuser", "password", "QMSYS");

/* Open Up the VOC file as an example */
QmFile vocFile = connection.open("VOC");

/* Read from the Opened VOC file */
String record = connection.read(vocFile, "MESSAGES");

System.out.println("This is the MESSAGES Record from the VOC file: " + record);

} catch (QMException e) {
System.err.println("Error occurred connecting to QM");
}
}
}
</pre>

JavaQM-API

2009-08-18T16:49:41Z

Diccon: created

This Java API library is a native Java library, which allows you to access QM via the QMClient network interface.

All you need is QMClient running on the server, the IP address, a valid username and password and the Account you want to access.

==Features==
Currently the API supports almost all of the Documented QMClient commands. Access to them is controlled by the main class QMConnection.

==Example==
Here is an example of how to use the JavaQM API Lib

<pre>
import com.openqm.qmconnect.*;

/** Example program that accesses QM with the Java API */
public class Example {
Example() {
try {

/* Initialise the connection */
QmConnection connection = QmConnection.create("localhost",4243);

/* Tell it to log in */
connection.connect("testuser", "password", "QMSYS");

/* Open Up the VOC file as an example */
QmFile vocFile = connection.open("VOC");

/* Read from the Opened VOC file */
String record = connection.read(vocFile, "MESSAGES");

System.out.println("This is the MESSAGES Record from the VOC file: " + record);

} catch (QMException e) {
System.err.println("Error occurred connecting to QM");
}
}
}
</pre>

QM Client API

2009-08-18T16:10:22Z

Diccon: /* API library's */ Added link to JavaQMAPI page

==Overview==
QM provides a remote API access to any client system that can get to the server via socket 4243, and obeys the protocol.

==Server Setup==
QM is technically able to handle API connections about of the box. However your server will need some configuring. (RPM will do this for you in near future).

[[QM-API Server | QM API Server setup guide]]

==Protocol==
The following is a guide to the protocol that the server responds to.

''Currently a working document, far from perfect, but you get the idea:''

[http://gpl.openqm.com/downloads/QMClient-Protocol.v0.3.alpha.pdf QMClient-Protocol.v0.3.alpha.pdf]

==News==
*[[User:Diccon|Diccon]] 15 Jan 2009 '''Update''' - The packet header docs have been updated, and the whole login process is pretty clean. The docs are missing a large number of the simpler commands, but they are pretty easy to figure out from the VBSRVR basic code in GPL.BP. I will write them out progressivly.
*[[User:Diccon|Diccon]] 12 Jan 2009 '''Resolved''' - Turns out it was the new server environment. However the Documentation is slightly wrong for the login protocol. Login is actually a server command not a special case. Will try and update the docs and debug the further issues on the test server environment.
*[[User:Diccon|Diccon]] 8 Dec 2008 '''Confirmed''' - Functioning Java-QM client for 2.4.17 does not work on 2.6.6. Exact reason why has yet to be determined. Should have some answers soon, new year 2009 has a need for the Java API on 266.
*[[User:Diccon|Diccon]] 7 December 2008 '''Warning:''' I have suspicions that the protocol changed for login quite dramatically for 2-6-6, as opposed to 2-4-17 which this Spec doc was originally based on.

==API library's==
* C - native - Released
* Visual Basic - native - released (library only released with commercial?)
* [[JavaQM-API|Java API]] - native - Alpha stage
* Delphi - Wrapper - (native expected Q1 2009)
* PHP - wrapper - Beta (TomDel)
* [[PHP Native API]] - Alpha stages but alive and kicking
* [[C++ Wrapper]]

B-Trees

2009-08-18T11:32:35Z

Diccon: New page: The system uses B-Trees or Binary Tree indexing structure for multiple uses. Primarily for indexing nominated fields in any given file (See CREATE.INDEX) They are also used internally for ...

The system uses B-Trees or Binary Tree indexing structure for multiple uses. Primarily for indexing nominated fields in any given file (See CREATE.INDEX) They are also used internally for many areas that require sorting. Constructing a B-Tree from a list of items and then reading them off in order. Using the B-Tree as a sorting algorithm.

An example of the use of the systems sorting technique is SSELECT (Programs/code called in order):
*op_dio4.c/op_sselect()
*GPL.BP/_SSELECT
*op_sort.c/op_sortinit()
*op_sort.c/op_sortadd()
*op_sort.c/op_sortdata()
*op_sort.c/op_sortclear()

Documentation

2009-08-18T10:49:52Z

Diccon: /* Developers documentation */

Any features, fixes or changes from the Last Ladybridge GPL release

*QMBASIC Enhancements - QMBASIC features that are custom or were not part of the original GPL release.

==Developers documentation==
[[Error messages]]

[[B-Trees]] (no changes, just dev docs)

Documentation

2009-08-18T10:49:34Z

Diccon: /* Developers documentation */

ScarletDME

2009-08-10T16:13:54Z

Diccon: New page: ScarletDME a MultiValue Data Management Environment. ==Data Management Environment== Scarlet is a Database management environment. A name to describe the close link of the powerful progr...

ScarletDME a MultiValue Data Management Environment.

==Data Management Environment==
Scarlet is a Database management environment. A name to describe the close link of the powerful programming language built into the Database system itself. As well as many other fundamental principles such as distinct Meta data Dictionaries and it's MultiValue capabilities. Placing it as more than just a database. It owes many of its features to its grandfather system PICK, for which OpenQM was designed to be a direct modern replacement. Combining and enhancing it's legacy Scarlet seek to evolve some excellent principles such as MultiValue into a modern environment, invoking a powerful and yet easy to use development platform.

==History==
Forked from OpenQM on the 28th November 2008 to independently develop future versions of the Database system, Scarlet is a community based GPL product. The Name Scarlet was chosen 6th months after the original fork to aid in the distinction between the Open Source community product and Ladybridges GPL code.

Downloads

2009-08-09T11:28:25Z

Diccon: /* Source */ Updated svn hint to point to trunk, not root

Files, sources, packages and apps for OpenQM

==Packages==
*RPM package - [http://gpl.openqm.com/downloads/openqm-2.6-6.i386.rpm openqm-2.6-6.i386.rpm]
*Debian Package - [http://gpl.openqm.com/downloads/openqm-gpl_2.6.6_all.deb openqm-gpl_2.6.6_all.deb] (Note: this needs testing for upgrades)
*Debian Package - [http://gpl.openqm.com/downloads/openqm_2.4.17_all.deb openqm_2.4.17_all.deb]

==Source==
Original Ladybridge Source Tarballs

*[http://gpl.openqm.com/downloads/qmsrc_2-6-6.tgz qmsrc_2-6-6.tgz]
*[http://gpl.openqm.com/downloads/qmsrc_2-4-4.tgz qmsrc_2-4-4.tgz]

For latest build, issue this command in Linux for OpenQMVDB build ('''''Recommended''''')
svn checkout https://gpl.openqm.com/svn/qmvdb/openqm/trunk/
''(Requires subversion client)''

==Applications==
*Coyote PICK webserver - [http://gpl.openqm.com/downloads/qmweb-gpl-2006-03-11.tar.gz qmweb-gpl-2006-03-11.tar.gz] - N.B. The source code for the daemon is missing.

Downloads

2009-08-09T11:27:08Z

Diccon: /* Packages */ Changed order of .deb's so latest is above oldest

Files, sources, packages and apps for OpenQM

==Packages==
*RPM package - [http://gpl.openqm.com/downloads/openqm-2.6-6.i386.rpm openqm-2.6-6.i386.rpm]
*Debian Package - [http://gpl.openqm.com/downloads/openqm-gpl_2.6.6_all.deb openqm-gpl_2.6.6_all.deb] (Note: this needs testing for upgrades)
*Debian Package - [http://gpl.openqm.com/downloads/openqm_2.4.17_all.deb openqm_2.4.17_all.deb]

==Source==
Original Ladybridge Source Tarballs

*[http://gpl.openqm.com/downloads/qmsrc_2-6-6.tgz qmsrc_2-6-6.tgz]
*[http://gpl.openqm.com/downloads/qmsrc_2-4-4.tgz qmsrc_2-4-4.tgz]

For latest build, issue this command in Linux for OpenQMVDB build ('''''Recommended''''')
svn checkout https://gpl.openqm.com/svn/qmvdb
''(Requires subversion client)''

==Applications==
*Coyote PICK webserver - [http://gpl.openqm.com/downloads/qmweb-gpl-2006-03-11.tar.gz qmweb-gpl-2006-03-11.tar.gz] - N.B. The source code for the daemon is missing.

Main Page

2009-08-09T11:24:05Z

Diccon: updating into to Scarletish intro

Welcome to ScarletDME.org. [[ScarletDME]] is a OpenSource [[multivalue|MultiValue]] database, a community fork of [[OpenQM]] originally developed by [[Ladybridge]]. We aim to provide an environment where anyone can acquire, study and contribute to the [[ScarletDME]] project.

'''Name change''' ''Some of you may have noticed The new Logo (to your left) With the new Brand name, ScarletDME (Data Management Environment). This is to be the new name for the GPL project based on Ladybridges GPL OpenQM. Something to distinguish GPL from commercial. Changing every name reference will take a little time to complete, until then the name OpenQM and Scarlet(DME) will be synonymous. You can reach this site via [http://www.scarletdme.org www.scarletdme.org] or continue to use [http://gpl.openqm.com gpl.openqm.com].''

This project was founded on the 28th November 2008 to independently develop future versions of [[OpenQM]].

Submissions to this project must be under the GPL version 2, with the option to use a later version if the licensee wishes. Or they can be licensed under the LGPL. Naturally, contributors to [[ScarletDME]] are welcome to submit any changes that they may make back to Ladybridge as well for inclusion in Commercial QM. See [[Commercial submissions]] for details.

The server is a VMWare Server 2 Virtual Machine located in a high-bandwidth datacentre in Amsterdam, Netherlands. It is hosted by [[User:SteveB|SteveB]] who maintains a daily backup to a secondary datacentre in Amsterdam. If you can provide a stable high bandwidth backup mirror, please contact him.

'''This server is DOWN/SLOW around 04:00GMT nightly for 15mins while backing up.'''

==For Users==
*[[Downloads]]: Source tarball and package builds for key platforms
*[[Guides & HOWTOs]] - Index of useful guides and HOWTO's on this Wiki
*[[QMBASIC Enhancements]] - QMBASIC features that are custom or were not part of the original GPL release.
*[http://gpl.openqm.com/bugzilla Bugzilla] reporting and tracking bugs:
*[[Documentation]] - Documented differences from the Commercial Documentation (Check here first, then below)
*[http://www.openqm.org/docs/ Documentation] (Commercial Version)
*General support email group: [http://groups.google.co.uk/group/openqm-opensource Register] then mailto:openqm-opensource@googlegroups.com
*IRC Chat: irc://irc.efnet.org/openqm or java client http://gpl.openqm.com/chat/
====Supporting Projects====
Various external projects that provide tools for or API's into OpenQM
* [http://billabong-services.co.uk/anji Billabong Services' Anji] - an open web based file browser and reporter. Eventually to become a RAD system. Pre-alpha grade of code.
*[[PHP_Native_API|PHP Native API module]]
*[[C++ Wrapper]]
*Steve Bush's [[Cygwin Port]] - Is it worth considering a MinGW port? - Would have to replace some posix bits which MinGW doesnt have.
* [http://www.tridentinfosys.com/ Kevin Powick's Trident Delphi wrapper]

==For Developers==
For those that want to contribute to OpenQM GPL project.
*Subversion repository: https://gpl.openqm.com/svn/qmvdb/ - [[HOWTO]]
*Development email group: [http://gpl.openqm.com/mailman/listinfo/openqm-dev Register] then mailto:openqm-dev@gpl.openqm.com
*[[Development snapshots]] - How to obtain, build, and upgrade using the snapshots.
*[[QM Client API]] - Documentation and Available API's for the QM remote protocol.
*[[Wish list]] - Things that you want & that we need contributors/devs for (lots of small things)
*[[Dynamic linking]] - Calling objects written in other languages.
*[[Installers]] - Installing scripts/programs or package systems
*[[Commercial submissions]] - Sending stuff to Ladybridge

== How do I use this site? ==

If you have a question on USAGE of the community version of OpenQM, then send it to the [http://groups.google.co.uk/group/openqm-opensource general email support group].

If you want to discuss DEVELOPMENT of the community version of OpenQM (eg. php5 module) then send it to the [http://gpl.openqm.com/mailman/listinfo/openqm-dev development email group].

While the email lists are best for getting attention, permanent changes in this wiki will have a longer term impact so feel free to add or change ANYTHING in this wiki.

=== External Resources ===
* [[Installations]] - Places where GPL OpenQM is in use (I'm attempting to create a new section for this) - http://capersqm.dnsalias.net/
* [http://www.rushflat.co.nz/downloads.shtml Brian Speir's Installation instructions and other downloads ]
* [http://openqm.blackflute.com/ Tom Delombard's old QM page.] Includes details of the tape utilities and the PHP4 module (C Wrapper)
* [http://sourceforge.net/projects/jd3 JD3] is a socket based server for D3 ported to QM
* [http://www.djpatterson.com/jd3php.html] David Patterson's guide to using PHP with JD3

--[[Administration]]

Main Page

2009-08-08T16:27:36Z

Diccon:

'''Name change''' Some of you may have noticed The new Logo (to your left) With the new Brand name, ScarletDME (Data Management Environment). This is to be the new name for the GPL project based on Ladybridges GPL OpenQM. Something to distinguish GPL from commercial. Changing every name reference will take a little time to complete, until then the name OpenQM and Scarlet(DME) will be synonymous. You can reach this site via [http://www.scarletdme.org www.scarletdme.org] or continue to use [http://gpl.openqm.com gpl.openqm.com]

gpl.openqm.com is dedicated to the development of a community distribution of [[OpenQM]], by providing an environment where anyone can acquire, study and contribute to the [[OpenQM]] [[multivalue]] database.

This project is focussed purely upon the GPL implementation of [[OpenQM]], originally developed by [[Ladybridge]]. This project was founded on the 28th November 2008 to independently develop future versions of [[OpenQM]]. Naturally, contributors to [[OpenQM]] are welcome to submit any changes that they may make back to Ladybridge for inclusion in Commercial QM.

Submissions to this project must be under the GPL version 2, with the option to use a later version if the licensee wishes. Or they can be licensed under the LGPL. There may be links on this site to non-conforming software, but that does not include them in this project.

The subdomain that points to this website is granted by [[Ladybridge]], however the server hosting this project, and it's content is neither their responsibility, or under their control. The server is a VMWare Server 2 Virtual Machine located in a high-bandwidth datacentre in Amsterdam, Netherlands. It is hosted by [[User:SteveB|SteveB]] who maintains a daily backup to a secondary datacentre in Amsterdam. If you can provide a stable high bandwidth backup mirror, please contact him.

'''This server is DOWN/SLOW around 04:00GMT nightly for 15mins while backing up.'''

==For Users==
*[[Downloads]]: Source tarball and package builds for key platforms
*[[Guides & HOWTOs]] - Index of useful guides and HOWTO's on this Wiki
*[[QMBASIC Enhancements]] - QMBASIC features that are custom or were not part of the original GPL release.
*[http://gpl.openqm.com/bugzilla Bugzilla] reporting and tracking bugs:
*[[Documentation]] - Documented differences from the Commercial Documentation (Check here first, then below)
*[http://www.openqm.org/docs/ Documentation] (Commercial Version)
*General support email group: [http://groups.google.co.uk/group/openqm-opensource Register] then mailto:openqm-opensource@googlegroups.com
*IRC Chat: irc://irc.efnet.org/openqm or java client http://gpl.openqm.com/chat/
====Supporting Projects====
Various external projects that provide tools for or API's into OpenQM
* [http://billabong-services.co.uk/anji Billabong Services' Anji] - an open web based file browser and reporter. Eventually to become a RAD system. Pre-alpha grade of code.
*[[PHP_Native_API|PHP Native API module]]
*[[C++ Wrapper]]
*Steve Bush's [[Cygwin Port]] - Is it worth considering a MinGW port? - Would have to replace some posix bits which MinGW doesnt have.
* [http://www.tridentinfosys.com/ Kevin Powick's Trident Delphi wrapper]

==For Developers==
For those that want to contribute to OpenQM GPL project.
*Subversion repository: https://gpl.openqm.com/svn/qmvdb/ - [[HOWTO]]
*Development email group: [http://gpl.openqm.com/mailman/listinfo/openqm-dev Register] then mailto:openqm-dev@gpl.openqm.com
*[[Development snapshots]] - How to obtain, build, and upgrade using the snapshots.
*[[QM Client API]] - Documentation and Available API's for the QM remote protocol.
*[[Wish list]] - Things that you want & that we need contributors/devs for (lots of small things)
*[[Dynamic linking]] - Calling objects written in other languages.
*[[Installers]] - Installing scripts/programs or package systems
*[[Commercial submissions]] - Sending stuff to Ladybridge

== How do I use this site? ==

If you have a question on USAGE of the community version of OpenQM, then send it to the [http://groups.google.co.uk/group/openqm-opensource general email support group].

If you want to discuss DEVELOPMENT of the community version of OpenQM (eg. php5 module) then send it to the [http://gpl.openqm.com/mailman/listinfo/openqm-dev development email group].

While the email lists are best for getting attention, permanent changes in this wiki will have a longer term impact so feel free to add or change ANYTHING in this wiki.

=== External Resources ===
* [[Installations]] - Places where GPL OpenQM is in use (I'm attempting to create a new section for this) - http://capersqm.dnsalias.net/
* [http://www.rushflat.co.nz/downloads.shtml Brian Speir's Installation instructions and other downloads ]
* [http://openqm.blackflute.com/ Tom Delombard's old QM page.] Includes details of the tape utilities and the PHP4 module (C Wrapper)
* [http://sourceforge.net/projects/jd3 JD3] is a socket based server for D3 ported to QM
* [http://www.djpatterson.com/jd3php.html] David Patterson's guide to using PHP with JD3

--[[Administration]]

Main Page

2009-08-08T16:20:03Z

Diccon: added ScarletDME announcement/explanation

'''Name change''' Some of you may have noticed The new Logo (to your left) With the new Brand name, ScarletDME (Data Management Environment). This is to be the new name for the GPL project based on Ladybridges GPL OpenQM. Something to distinguish GPL from commercial. Changing every name reference will take a little time to complete, until then the name OpenQM and Scarlet(DME) will be synonymous.

gpl.openqm.com is dedicated to the development of a community distribution of [[OpenQM]], by providing an environment where anyone can acquire, study and contribute to the [[OpenQM]] [[multivalue]] database.

This project is focussed purely upon the GPL implementation of [[OpenQM]], originally developed by [[Ladybridge]]. This project was founded on the 28th November 2008 to independently develop future versions of [[OpenQM]]. Naturally, contributors to [[OpenQM]] are welcome to submit any changes that they may make back to Ladybridge for inclusion in Commercial QM.

Submissions to this project must be under the GPL version 2, with the option to use a later version if the licensee wishes. Or they can be licensed under the LGPL. There may be links on this site to non-conforming software, but that does not include them in this project.

The subdomain that points to this website is granted by [[Ladybridge]], however the server hosting this project, and it's content is neither their responsibility, or under their control. The server is a VMWare Server 2 Virtual Machine located in a high-bandwidth datacentre in Amsterdam, Netherlands. It is hosted by [[User:SteveB|SteveB]] who maintains a daily backup to a secondary datacentre in Amsterdam. If you can provide a stable high bandwidth backup mirror, please contact him.

'''This server is DOWN/SLOW around 04:00GMT nightly for 15mins while backing up.'''

==For Users==
*[[Downloads]]: Source tarball and package builds for key platforms
*[[Guides & HOWTOs]] - Index of useful guides and HOWTO's on this Wiki
*[[QMBASIC Enhancements]] - QMBASIC features that are custom or were not part of the original GPL release.
*[http://gpl.openqm.com/bugzilla Bugzilla] reporting and tracking bugs:
*[[Documentation]] - Documented differences from the Commercial Documentation (Check here first, then below)
*[http://www.openqm.org/docs/ Documentation] (Commercial Version)
*General support email group: [http://groups.google.co.uk/group/openqm-opensource Register] then mailto:openqm-opensource@googlegroups.com
*IRC Chat: irc://irc.efnet.org/openqm or java client http://gpl.openqm.com/chat/
====Supporting Projects====
Various external projects that provide tools for or API's into OpenQM
* [http://billabong-services.co.uk/anji Billabong Services' Anji] - an open web based file browser and reporter. Eventually to become a RAD system. Pre-alpha grade of code.
*[[PHP_Native_API|PHP Native API module]]
*[[C++ Wrapper]]
*Steve Bush's [[Cygwin Port]] - Is it worth considering a MinGW port? - Would have to replace some posix bits which MinGW doesnt have.
* [http://www.tridentinfosys.com/ Kevin Powick's Trident Delphi wrapper]

==For Developers==
For those that want to contribute to OpenQM GPL project.
*Subversion repository: https://gpl.openqm.com/svn/qmvdb/ - [[HOWTO]]
*Development email group: [http://gpl.openqm.com/mailman/listinfo/openqm-dev Register] then mailto:openqm-dev@gpl.openqm.com
*[[Development snapshots]] - How to obtain, build, and upgrade using the snapshots.
*[[QM Client API]] - Documentation and Available API's for the QM remote protocol.
*[[Wish list]] - Things that you want & that we need contributors/devs for (lots of small things)
*[[Dynamic linking]] - Calling objects written in other languages.
*[[Installers]] - Installing scripts/programs or package systems
*[[Commercial submissions]] - Sending stuff to Ladybridge

== How do I use this site? ==

If you have a question on USAGE of the community version of OpenQM, then send it to the [http://groups.google.co.uk/group/openqm-opensource general email support group].

If you want to discuss DEVELOPMENT of the community version of OpenQM (eg. php5 module) then send it to the [http://gpl.openqm.com/mailman/listinfo/openqm-dev development email group].

While the email lists are best for getting attention, permanent changes in this wiki will have a longer term impact so feel free to add or change ANYTHING in this wiki.

=== External Resources ===
* [[Installations]] - Places where GPL OpenQM is in use (I'm attempting to create a new section for this) - http://capersqm.dnsalias.net/
* [http://www.rushflat.co.nz/downloads.shtml Brian Speir's Installation instructions and other downloads ]
* [http://openqm.blackflute.com/ Tom Delombard's old QM page.] Includes details of the tape utilities and the PHP4 module (C Wrapper)
* [http://sourceforge.net/projects/jd3 JD3] is a socket based server for D3 ported to QM
* [http://www.djpatterson.com/jd3php.html] David Patterson's guide to using PHP with JD3

--[[Administration]]

Error messages

2009-08-04T15:09:37Z

Diccon: New page: Programs covered by this note: *k_error *sysmsg When something goes wrong the C code generally calls k_error (in src/k_error.c) with a text message pulled from the Pick file MESSAGES by s...

Programs covered by this note:
*k_error
*sysmsg

When something goes wrong the C code generally calls k_error (in src/k_error.c) with a text message pulled from the Pick file MESSAGES by sysmsg() (src/messages.c).

Each entry in MESSAGES is keyed by the QM internal error code. These messages contain C style printf codes (eg %d for an integer %s for a char string) which can be passed into k_error as additional params and will be inserted into these messages. This method allows a generic message to be displayed with circumstantial information inserted.

Ironically it does mean the Messages in the data file are fairly well tied to the hard coded number and type of params that are passed to k_error.

When changing messages beware not to alter the %'s such that places you aren't working on can still call k_error meaningfully.

Documentation

2009-08-04T14:57:26Z

Diccon: added dev docs, and error message

Documentation

2009-06-09T22:00:37Z

Diccon: New page: Any features, fixes or changes from the Last Ladybridge GPL release *QMBASIC Enhancements - QMBASIC features that are custom or were not part of the original GPL release.

Any features, fixes or changes from the Last Ladybridge GPL release

*QMBASIC Enhancements - QMBASIC features that are custom or were not part of the original GPL release.

Main Page

2009-06-09T21:58:53Z

Diccon: Added Documentation

gpl.openqm.com is dedicated to the development of a community distribution of [[OpenQM]], by providing an environment where anyone can acquire, study and contribute to the [[OpenQM]] [[multivalue]] database.

This project is focussed purely upon the GPL implementation of [[OpenQM]], originally developed by [[Ladybridge]]. This project was founded on the 28th November 2008 to independently develop future versions of [[OpenQM]]. Naturally, contributors to [[OpenQM]] are welcome to submit any changes that they may make back to Ladybridge for inclusion in Commercial QM.

Submissions to this project must be under the GPL version 2, with the option to use a later version if the licensee wishes. Or they can be licensed under the LGPL. There may be links on this site to non-conforming software, but that does not include them in this project.

The subdomain that points to this website is granted by [[Ladybridge]], however the server hosting this project, and it's content is neither their responsibility, or under their control. The server is a VMWare Server 2 Virtual Machine located in a high-bandwidth datacentre in Amsterdam, Netherlands. It is hosted by [[User:SteveB|SteveB]] who maintains a daily backup to a secondary datacentre in Amsterdam. If you can provide a stable high bandwidth backup mirror, please contact him.

'''This server is DOWN/SLOW around 04:00GMT nightly for 15mins while backing up.'''

==For Users==
*[[Downloads]]: Source tarball and package builds for key platforms
*[[Guides & HOWTOs]] - Index of useful guides and HOWTO's on this Wiki
*[[QMBASIC Enhancements]] - QMBASIC features that are custom or were not part of the original GPL release.
*[http://gpl.openqm.com/bugzilla Bugzilla] reporting and tracking bugs:
*[[Documentation]] - Documented differences from the Commercial Documentation (Check here first, then below)
*[http://www.openqm.org/docs/ Documentation] (Commercial Version)
*General support email group: [http://groups.google.co.uk/group/openqm-opensource Register] then mailto:openqm-opensource@googlegroups.com
*IRC Chat: irc://irc.efnet.org/openqm or java client http://gpl.openqm.com/chat/
====Supporting Projects====
Various external projects that provide tools for or API's into OpenQM
* [http://billabong-services.co.uk/anji Billabong Services' Anji] - an open web based file browser and reporter. Eventually to become a RAD system. Pre-alpha grade of code.
*[[PHP_Native_API|PHP Native API module]]
*[[C++ Wrapper]]
*Steve Bush's [[Cygwin Port]] - Is it worth considering a MinGW port? - Would have to replace some posix bits which MinGW doesnt have.
* [http://www.tridentinfosys.com/ Kevin Powick's Trident Delphi wrapper]

==For Developers==
For those that want to contribute to OpenQM GPL project.
*Subversion repository: https://gpl.openqm.com/svn/qmvdb/ - [[HOWTO]]
*Development email group: [http://gpl.openqm.com/mailman/listinfo/openqm-dev Register] then mailto:openqm-dev@gpl.openqm.com
*[[Development snapshots]] - How to obtain, build, and upgrade using the snapshots.
*[[QM Client API]] - Documentation and Available API's for the QM remote protocol.
*[[Wish list]] - Things that you want & that we need contributors/devs for (lots of small things)
*[[Dynamic linking]] - Calling objects written in other languages.
*[[Installers]] - Installing scripts/programs or package systems
*[[Commercial submissions]] - Sending stuff to Ladybridge

== How do I use this site? ==

If you have a question on USAGE of the community version of OpenQM, then send it to the [http://groups.google.co.uk/group/openqm-opensource general email support group].

If you want to discuss DEVELOPMENT of the community version of OpenQM (eg. php5 module) then send it to the [http://gpl.openqm.com/mailman/listinfo/openqm-dev development email group].

While the email lists are best for getting attention, permanent changes in this wiki will have a longer term impact so feel free to add or change ANYTHING in this wiki.

=== External Resources ===
* [[Installations]] - Places where GPL OpenQM is in use (I'm attempting to create a new section for this) - http://capersqm.dnsalias.net/
* [http://www.rushflat.co.nz/downloads.shtml Brian Speir's Installation instructions and other downloads ]
* [http://openqm.blackflute.com/ Tom Delombard's old QM page.] Includes details of the tape utilities and the PHP4 module (C Wrapper)
* [http://sourceforge.net/projects/jd3 JD3] is a socket based server for D3 ported to QM
* [http://www.djpatterson.com/jd3php.html] David Patterson's guide to using PHP with JD3

--[[Administration]]

Branding tasks

2009-05-16T17:22:43Z

Diccon: /* Important */ added one

Talk:Branding tasks

2009-05-15T01:35:57Z

Diccon:

Change the @QMSYS at-var (note: change in F-type VOC entries, too). Change to '@SYS'?

:[[User:Diccon|Diccon]] @SYS sounds fine to me, either that or @SYSDIR
::[[User:Diccon|Diccon]] 01:35, 15 May 2009 (UTC) This one is going to be a bastard, 56 matches by grep, in both text source files, and impressivly it found references in Binary files like the VOC too (Yeay Grep).

Change '/usr/qmsys' to something more appropriate.

:[[User:Diccon|Diccon]] Suggestions? /usr/scarlet /usr/scarletsys, easy and very subjective, as it depends on the config file. Only applicable to installers and packages.

Change '/etc/qmconfig' to something more appropriate. [[User:Diccon|Diccon]] I got this one

:[[User:Diccon|Diccon]] Suggests /etc/scarlet.conf, more in line with traditional Linux conf names

::[[User:Diccon|Diccon]] 01:18, 15 May 2009 (UTC) Also needs QMCONF environment variable renaming, going for SCARLET_CONF for now.

Change the various program names from 'qm*' (except QMClient?).

:[[User:Diccon|Diccon]]Trickey one this, to what? i suggest short names. "scarlet", "scrlt", "sdme"??

Branding tasks

2009-05-15T01:26:44Z

Diccon: /* Important */ marked qmconfig as mine

Things that need to be done to change the branding from 'QM' or 'OpenQM' to the new name (yet to be decided as of time of writing).

Note: I have characterized tasks as 'important' and 'less important', but of course this is subjective. The items in the first category are things I think we should change before a release, whereas the second lot can be left until later if necessary.

==System Changes==
===Important===
* Change the @QMSYS at-var (note: change in F-type VOC entries, too). Change to '@SYS'? '@SYSPATH'/'@SYS.PATH'?
* Change '/usr/qmsys' to something more appropriate.
* Change 'QM.VOCLIB' to 'VOCLIB'.
* Change '/etc/qmconfig' to something more appropriate. ([[User:Diccon|Diccon]] gotit)
* Change the various program names from 'qm*' (except QMClient?).

===Less Important===
* Change all the source 'qm*.c's (except QMClient?).
* Change the VOC entry 'QM.ACCOUNTS' to something else (what?)
* Remove the 'gpl' bit from 'GPL.BP', 'gplsrc', 'gplobj' etc.
* Rename QMPKG (is this much used?)
* Rename QMClient?
* Create an 'OpenQM Compatibility Mode'? (e.g. equate @QMSYS to @SYSPATH)

==Code Changes==
===Important===
* Change the welcome message to something more appropriate.

===Less Important===
* Change the info in the headers in GPL.BP and gplsrc.
* Rename internal references to 'qm' (e.g. function names).

==Documentation==
We need some!

==Website Changes==
===Important===
* New domain name.
* New logo (get a temporary one quickly; permanent one can come later).

===Less Important===
* Change references to QM in Wiki.

Talk:Branding tasks

2009-05-15T01:26:12Z

Diccon:

Change the @QMSYS at-var (note: change in F-type VOC entries, too). Change to '@SYS'?

:[[User:Diccon|Diccon]] @SYS sounds fine to me, either that or @SYSDIR

Change '/usr/qmsys' to something more appropriate.

:[[User:Diccon|Diccon]] Suggestions? /usr/scarlet /usr/scarletsys, easy and very subjective, as it depends on the config file. Only applicable to installers and packages.

Change '/etc/qmconfig' to something more appropriate. [[User:Diccon|Diccon]] I got this one

:[[User:Diccon|Diccon]] Suggests /etc/scarlet.conf, more in line with traditional Linux conf names

::[[User:Diccon|Diccon]] 01:18, 15 May 2009 (UTC) Also needs QMCONF environment variable renaming, going for SCARLET_CONF for now.

Change the various program names from 'qm*' (except QMClient?).

:[[User:Diccon|Diccon]]Trickey one this, to what? i suggest short names. "scarlet", "scrlt", "sdme"??

Talk:Branding tasks

2009-05-15T01:18:36Z

Diccon:

Change the @QMSYS at-var (note: change in F-type VOC entries, too). Change to '@SYS'?

:[[User:Diccon|Diccon]] @SYS sounds fine to me, either that or @SYSDIR

Change '/usr/qmsys' to something more appropriate.

:[[User:Diccon|Diccon]] Suggestions? /usr/scarlet /usr/scarletsys, easy and very subjective, as it depends on the config file. Only applicable to installers and packages.

Change '/etc/qmconfig' to something more appropriate.

:[[User:Diccon|Diccon]] Suggests /etc/scarlet.conf, more in line with traditional Linux conf names

::[[User:Diccon|Diccon]] 01:18, 15 May 2009 (UTC) Also needs QMCONF environment variable renaming, going for SCARLET_CONF for now.

Change the various program names from 'qm*' (except QMClient?).

:[[User:Diccon|Diccon]]Trickey one this, to what? i suggest short names. "scarlet", "scrlt", "sdme"??

Talk:Branding tasks

2009-05-15T01:12:10Z

Diccon: New page: Change the @QMSYS at-var (note: change in F-type VOC entries, too). Change to '@SYS'? :~~~ @SYS sounds fine to me, either that or @SYSDIR Change '/usr/qmsys' to something more appropri...

Change the @QMSYS at-var (note: change in F-type VOC entries, too). Change to '@SYS'?

:[[User:Diccon|Diccon]] @SYS sounds fine to me, either that or @SYSDIR

Change '/usr/qmsys' to something more appropriate.

:[[User:Diccon|Diccon]] Suggestions? /usr/scarlet /usr/scarletsys, easy and very subjective, as it depends on the config file. Only applicable to installers and packages.

Change '/etc/qmconfig' to something more appropriate.

:[[User:Diccon|Diccon]] Suggests /etc/scarlet.conf, more in line with traditional Linux conf names

Change the various program names from 'qm*' (except QMClient?).

:[[User:Diccon|Diccon]]Trickey one this, to what? i suggest short names. "scarlet", "scrlt", "sdme"??

Talk:Using your own editor

2009-05-01T12:05:28Z

Diccon:

[[User:Diccon|Diccon]] 12:16, 27 April 2009 (UTC) - Few suggestions Tom.

#Since this is not specific to VIM, can you generalise the var names and the command itself. I know it ultimately calls vim as it is, but simply exchanging the command var means it can be anything as I understand your code (Nano, vi, hell Kate if you have X windows). Called it EDITOR in mine, which is too long a name IMO, and of course EDIT and ED exist :) Any other good names would be good (suggestions?).
#It currently screams if you do not have the syntax highlighting qmbasic.vim file there. Either note that the file is not optional or reduce the screaming warning volume. This could break the above mentioned generic nature too, perhaps parametrise it? I've not looked at that bit of code.
#Can we have a fail-over question asked if you don't provide details, in a QM Style. Ie no file name, then ask Filename?.. etc. Partly to be consistent, but also because it smooths the CLI flow if you miss a step. ? query function at this point is too much to ask IMO at this time.

Given the above i think it's idea to go into workdevbranch1.

:[[User:Karaken12|karaken12]] 13:18, 27 April 2009 (UTC) - The reason for the name is mostly historical -- I wrote this thing so I could use Vim, without thinking about anything else. Personally I'd rather keep it as Vim for now, and you can rename it if you want to use something else. For #2, I agree this is wrong. What it should do is check if the file exists, and then only add the extra bit to the line if it's there. Easily done, but I haven't done it because I never needed to -- see point 1. :o) For point three, that might be a good idea, if that's what people want to do. I rather thought it already did that, but I guess not.

[[User:Diccon|Diccon]] 12:43, 27 April 2009 (UTC) Also i have some ideas about Dynamic files. Simply Write a BASIC precursor that copies the indervidual record being requested to a TEMP Directory file. When the editor finishes copy back the temp file over the record. If nothing has been altered and the external prog just exited, then you will be copying back an identicle record. If it was altered then the edits are copied in. No clever detection of alterations are needed. This can even implement record locking if you lock before the shell execute and the BASIC prog returns and releases after you exit.

:[[User:Karaken12|karaken12]] 13:18, 27 April 2009 (UTC) - This is, in fact, exactly what it already does. :o) But I'm working on some sneaky things that might render this question moot. *taps side of nose*
:: [[User:Diccon|Diccon]] 12:05, 1 May 2009 (UTC) - I Quote: ''"DISCLAIMER: If you use this program to edit a non-directory file, it will overwrite it when you have finished editing. It is very unsafe,...etc"''. From this i thought you were suggesting it overwrites the whole dynamic file, instead of overwriting the indervidual record. Which is what I'm suggesting. Addmittedly I stared at the mass of code and havent read it through.

Talk:Using your own editor

2009-05-01T12:05:03Z

Diccon:

[[User:Diccon|Diccon]] 12:16, 27 April 2009 (UTC) - Few suggestions Tom.

#Since this is not specific to VIM, can you generalise the var names and the command itself. I know it ultimately calls vim as it is, but simply exchanging the command var means it can be anything as I understand your code (Nano, vi, hell Kate if you have X windows). Called it EDITOR in mine, which is too long a name IMO, and of course EDIT and ED exist :) Any other good names would be good (suggestions?).
#It currently screams if you do not have the syntax highlighting qmbasic.vim file there. Either note that the file is not optional or reduce the screaming warning volume. This could break the above mentioned generic nature too, perhaps parametrise it? I've not looked at that bit of code.
#Can we have a fail-over question asked if you don't provide details, in a QM Style. Ie no file name, then ask Filename?.. etc. Partly to be consistent, but also because it smooths the CLI flow if you miss a step. ? query function at this point is too much to ask IMO at this time.

Given the above i think it's idea to go into workdevbranch1.

:[[User:Karaken12|karaken12]] 13:18, 27 April 2009 (UTC) - The reason for the name is mostly historical -- I wrote this thing so I could use Vim, without thinking about anything else. Personally I'd rather keep it as Vim for now, and you can rename it if you want to use something else. For #2, I agree this is wrong. What it should do is check if the file exists, and then only add the extra bit to the line if it's there. Easily done, but I haven't done it because I never needed to -- see point 1. :o) For point three, that might be a good idea, if that's what people want to do. I rather thought it already did that, but I guess not.

[[User:Diccon|Diccon]] 12:43, 27 April 2009 (UTC) Also i have some ideas about Dynamic files. Simply Write a BASIC precursor that copies the indervidual record being requested to a TEMP Directory file. When the editor finishes copy back the temp file over the record. If nothing has been altered and the external prog just exited, then you will be copying back an identicle record. If it was altered then the edits are copied in. No clever detection of alterations are needed. This can even implement record locking if you lock before the shell execute and the BASIC prog returns and releases after you exit.

:[[User:Karaken12|karaken12]] 13:18, 27 April 2009 (UTC) - This is, in fact, exactly what it already does. :o) But I'm working on some sneaky things that might render this question moot. *taps side of nose*
:: [[User:Diccon|Diccon]] 12:05, 1 May 2009 (UTC) - I Quote: ''"DISCLAIMER: If you use this program to edit a non-directory file, it will overwrite it when you have finished editing. It is very unsafe,...etc"''. From this i thought you were suggesting it overwrites the whole directory file, instead of overwriting the indervidual record. Which is what I'm suggesting. Addmittedly I stared at the mass of code and havent read it through.

Talk:Using your own editor

2009-04-27T12:43:04Z

Diccon:

Talk:Using your own editor

2009-04-27T12:16:53Z

Diccon: New page: ~~~~ - Few suggestions Tom. #Since this is not specific to VIM, can you generalise the var names and the command itself. I know it ultimately calls vim as it is, but simply exchanging th...

PHP Native API

2009-04-06T11:05:47Z

Diccon: News

The PHP native API uses a socket connection to directly connect to an open and functioning QM API socket.

This single PHP script file can be dropped in on any PHP compatible web server and allow developer to use a series of function calls to access a QM Database with all the functionality that the QMClient API allows.

It is currently in the developing Alpha stages:

Make sure you have followed the [[QM-API_Server|QM Client Server setup guide]]

==News==
*[[User:Diccon|Diccon]] 11:05, 6 April 2009 (UTC) Development has been paused until JD3 is fully assessed and it is determined if QMCLient is to continue getting my attention. This lib still works, others are welcome to develop on the SVN repo. Ask for commit access.
* [[User:Diccon|Diccon]] 15:27, 9 March 2009 (UTC) Conditional Handling code is in, needs proper testing. Now have 34/46 command done, QMCall and a few others will be last because they take a bit of time/effort.
*[[User:Diccon|Diccon]] 18:41, 16 February 2009 (UTC) '''Solved''' Fixed this, not 100% sure what was really happening, but i rewrote the way the login packet is constructed, to make it clearer. This fixed it. Go, Play!
*[[User:Diccon|Diccon]] 19:36, 27 January 2009 (UTC) <strike>'''Warning''' Active bug found, i believe username padding is not working, some odd length usernames may cause a QMERROR 3000 for line 902, when trying to write to $LOGINS. I'm working on it.</strike>

==How to use==
[[#Download|Download]] from the SVN from below.

Place this file in the same directory as the file that intends to use it, or place it in the library path for your PHP configuration.

In your php code Enter the following line at the top
include "PHPQMLib.php"

The first you need to call the connect function, something like this;
qmconnect("my.qm.server.com", "4243", "testuser", "testpass", "QMTESTACCOUNT");
or
qmconnect("192.168.1.1", "4243", "testuser", "testpass", "QMTESTACC");

You can now use the variety of PHPQM functions like qmread(),
qmdelete(), etc as you wish.
When you are done, for tidyness issue a;
qmdisconnect();
command, tidlying closing the socket.

Each page/script will need to (re)connect. Connection persistance and pooling is
a bit bigger than this simple lib for now.

Check out qmLastClause() QMPHPClient function to cater for commands
hitting ELSE, LOCKED, etc conditions

Generally you can follow the QMClient docs in terms of server functionality.
Using the below defines() as what is and is not implimented.
Better PHP specific docs will be written later, when we go Beta

==Supported Features==
QMPHPClient supports (24/46);
* Qm Quit
* GetError
* Set account
* Open
* Close
* Read
* ReadL (Untested)
* ReadLW (Untested/partial)
* ReadU (Untested)
* ReadUL(Untested/partial)
* Select
* ReadNext
* ClearSelect
* ReadList
* Release
* Write
* WriteU
* Delete
* DeleteU
* Execute
* Respond
* Logon

==Download==
If you want a copy, it is released under the LGPL (i.e. can be used within commercial products, but is GPL itself). It is available on the gpl.openqm Subversion repository; ''(Just click the link people, its not scairy, you just download the file[s])''

[http://gpl.openqm.com/svn/qmvdb/PHPQMLib/trunk/ http://gpl.openqm.com/svn/qmvdb/PHPQMLib/trunk/]

==Todo Shortlist==
# Design and handle Conditional Execution, eg ELSE, LOCKED, ERROR, etc
# Finish implimenting all simple commands/function (24/46 Done)
# Clean up error reporting

Creating your own command

2009-03-18T23:42:52Z

Diccon: New page: rough notes for now, keeping tabs for myself ~~~ But should become guide for others soon. *Create file in GPL.BP/MYCOMMAND *Put $internal in first line * put $catalog $MYCOMMAND *qm -int...

rough notes for now, keeping tabs for myself [[User:Diccon|Diccon]]

But should become guide for others soon.

*Create file in GPL.BP/MYCOMMAND
*Put $internal in first line
* put $catalog $MYCOMMAND
*qm -internal BASIC GPL.BP MYCOMMAND
*Make entry in voc called MY.COMMAND
V
CA
$MYCOMMAND

Prefix:
$ for command line command _for internal subroutine

Guides & HOWTOs

2009-03-18T23:20:53Z

Diccon: added "guide to adding command to QM"

==Installation==

=== Fedora ===
*[http://www.geneb.org/qm/fedora_notes.txt http://www.geneb.org/qm/fedora_notes.txt] - Guide to installing and configuring QM from source on Fedora (useful scripts and configs)

=== Ubuntu ===

*[http://www.rushflat.co.nz/files/UbuntuInstall.pdf http://www.rushflat.co.nz/files/UbuntuInstall.pdf] Installing the GPL Version of OpenQM on Ubuntu (aimed at Linux newbies)

==Development==

*[[Recompiling QM]] - How to recompile QM's system C code and BASIC code
*[[HOWTO|SVN Howto]] - How to use Subversion to check out code and commit it back (Windows and Linux)
*[[Creating your own command]] - Guide to how to add features and commands to QM

==Using OpenQM==

*[[Using your own editor]] - How to use your favorite editor from within OpenQM

Installers

2009-03-14T20:02:59Z

Diccon: New page: Development of installation assiters or binary distribution packages. ===RPM=== It exists, it need documenting and making into a auto build process on the gpl.openqm server. Contact ~~~ f...

Development of installation assiters or binary distribution packages.

===RPM===
It exists, it need documenting and making into a auto build process on the gpl.openqm server. Contact [[User:Diccon|Diccon]] for info.

===Deb===
For Ubuntu, Debian, and other debian based distros.

Debian package, a classic one exists. It can be done again. GlenB is the contact for this.

===Distro neutral script===
This is an idea at the moment, mainley aimed at developers. If you have an install of QM already you might want to quickly setup multiple QM directorys/version on one server, to allow you to play around.

To achieve this a distro neutral script could be written to se the current dir of QM to be the current running one.
*Move out QM.config in /etc, place an apropriate one for current dir
*check for groups, qm, and qmdev, create if missing.
*move or link to /usr/bin/qm (and other binarys)

This should be non destructive and able allow reinstantiation of previous installs.

Main Page

2009-03-14T19:54:45Z

Diccon: /* For Developers */ added installers

gpl.openqm.com is dedicated to the development of a community distribution of [[OpenQM]], by providing an environment where anyone can acquire, study and contribute to the [[OpenQM]] [[multivalue]] database.

This project is focussed purely upon the GPL implementation of [[OpenQM]], originally developed by [[Ladybridge]]. This project was founded on the 28th November 2008 to independently develop future versions of [[OpenQM]]. Naturally, contributors to [[OpenQM]] are welcome to submit any changes that they may make back to Ladybridge for inclusion in Commercial QM.

Submissions to this project must be under the GPL version 2, with the option to use a later version if the licensee wishes. Or they can be licensed under the LGPL. There may be links on this site to non-conforming software, but that does not include them in this project.

The subdomain that points to this website is granted by [[Ladybridge]], however the server hosting this project, and it's content is neither their responsibility, or under their control. The server is a VMWare Server 2 Virtual Machine located in a high-bandwidth datacentre in Amsterdam, Netherlands. It is hosted by [[User:SteveB|SteveB]] who maintains a daily backup to a secondary datacentre in Amsterdam. If you can provide a stable high bandwidth backup mirror, please contact him.

'''This server is DOWN/SLOW around 04:00GMT nightly for 15mins while backing up.'''

==For Users==
*[[Downloads]]: Source tarball and package builds for key platforms
*[[Guides & HOWTOs]] - Index of useful guides and HOWTO's on this Wiki
*[http://gpl.openqm.com/bugzilla Bugzilla] reporting and tracking bugs:
*[http://www.openqm.org/docs/ Documentation] (Commercial Version)
*General support email group: [http://groups.google.co.uk/group/openqm-opensource Register] then mailto:openqm-opensource@googlegroups.com
*IRC Chat: irc://irc.efnet.org/openqm
====Supporting Projects====
Various external projects that provide tools for or API's into OpenQM
* [http://billabong-services.co.uk/anji Billabong Services' Anji] - an open web based file browser and reporter. Eventually to become a RAD system. Pre-alpha grade of code.
*[[PHP_Native_API|PHP Native API module]]
*[[C++ Wrapper]]
*Steve Bush's [[Cygwin Port]] - Is it worth considering a MinGW port? - Would have to replace some posix bits which MinGW doesnt have.
* [http://www.tridentinfosys.com/ Kevin Powick's Trident Delphi wrapper]

==For Developers==
For those that want to contribute to OpenQM GPL project.
*Subversion repository: https://gpl.openqm.com/svn/qmvdb/ - [[HOWTO]]
*Development email group: [http://gpl.openqm.com/mailman/listinfo/openqm-dev Register] then mailto:openqm-dev@gpl.openqm.com
*[[QM Client API]] - Documentation and Available API's for the QM remote protocol.
*[[Wish list]] - Things that you want & that we need contributors/devs for (lots of small things)
*[[Dynamic linking]] - Calling objects written in other languages.
*[[Installers]] - Installing scripts/programs or package systems

== How do I use this site? ==

If you have a question on USAGE of the community version of OpenQM, then send it to the [http://groups.google.co.uk/group/openqm-opensource general email support group].

If you want to discuss DEVELOPMENT of the community version of OpenQM (eg. php5 module) then send it to the [http://gpl.openqm.com/mailman/listinfo/openqm-dev development email group].

While the email lists are best for getting attention, permanent changes in this wiki will have a longer term impact so feel free to add or change ANYTHING in this wiki.

=== External Resources ===
* [[Installations]] - Places where GPL OpenQM is in use (I'm attempting to create a new section for this) - http://capersqm.dnsalias.net/
* [http://www.rushflat.co.nz/downloads.shtml Brian Speir's Installation instructions and other downloads ]
* [http://openqm.blackflute.com/ Tom Delombard's old QM page.] Includes details of the tape utilities and the PHP4 module (C Wrapper)

--[[Administration]]

PHP Native API

2009-03-09T16:05:37Z

Diccon:

The PHP native API uses a socket connection to directly connect to an open and functioning QM API socket.

This single PHP script file can be dropped in on any PHP compatible web server and allow developer to use a series of function calls to access a QM Database with all the functionality that the QMClient API allows.

It is currently in the developing Alpha stages:

Make sure you have followed the [[QM-API_Server|QM Client Server setup guide]]

==News==

* [[User:Diccon|Diccon]] 15:27, 9 March 2009 (UTC) Conditional Handling code is in, needs proper testing. Now have 34/46 command done, QMCall and a few others will be last because they take a bit of time/effort.
*[[User:Diccon|Diccon]] 18:41, 16 February 2009 (UTC) '''Solved''' Fixed this, not 100% sure what was really happening, but i rewrote the way the login packet is constructed, to make it clearer. This fixed it. Go, Play!
*[[User:Diccon|Diccon]] 19:36, 27 January 2009 (UTC) <strike>'''Warning''' Active bug found, i believe username padding is not working, some odd length usernames may cause a QMERROR 3000 for line 902, when trying to write to $LOGINS. I'm working on it.</strike>

==How to use==
[[#Download|Download]] from the SVN from below.

Place this file in the same directory as the file that intends to use it, or place it in the library path for your PHP configuration.

In your php code Enter the following line at the top
include "PHPQMLib.php"

The first you need to call the connect function, something like this;
qmconnect("my.qm.server.com", "4243", "testuser", "testpass", "QMTESTACCOUNT");
or
qmconnect("192.168.1.1", "4243", "testuser", "testpass", "QMTESTACC");

You can now use the variety of PHPQM functions like qmread(),
qmdelete(), etc as you wish.
When you are done, for tidyness issue a;
qmdisconnect();
command, tidlying closing the socket.

Each page/script will need to (re)connect. Connection persistance and pooling is
a bit bigger than this simple lib for now.

Check out qmLastClause() QMPHPClient function to cater for commands
hitting ELSE, LOCKED, etc conditions

Generally you can follow the QMClient docs in terms of server functionality.
Using the below defines() as what is and is not implimented.
Better PHP specific docs will be written later, when we go Beta

==Supported Features==
QMPHPClient supports (24/46);
* Qm Quit
* GetError
* Set account
* Open
* Close
* Read
* ReadL (Untested)
* ReadLW (Untested/partial)
* ReadU (Untested)
* ReadUL(Untested/partial)
* Select
* ReadNext
* ClearSelect
* ReadList
* Release
* Write
* WriteU
* Delete
* DeleteU
* Execute
* Respond
* Logon

==Download==
If you want a copy, it is released under the LGPL (i.e. can be used within commercial products, but is GPL itself). It is available on the gpl.openqm Subversion repository; ''(Just click the link people, its not scairy, you just download the file[s])''

[http://gpl.openqm.com/svn/qmvdb/PHPQMLib/trunk/ http://gpl.openqm.com/svn/qmvdb/PHPQMLib/trunk/]

==Todo Shortlist==
# Design and handle Conditional Execution, eg ELSE, LOCKED, ERROR, etc
# Finish implimenting all simple commands/function (24/46 Done)
# Clean up error reporting