PrimeBase Open Server Plug-ins

PrimeBase Open Server Plug-ins
------------------------------

Open Server plug-ins enable the PrimeBase Open Server to access the specific type of data source for which the plug-in was written. The extent to which the plug-in supports the PrimeBase Open Server API. and/or the SQL syntax is plug-in dependent. Before using any plug-in be sure to read the plug-in specific "readme" to find out the limitations of the plug-in and any plug-in specific commands that it may support. 

Open Server Plug-in registration:
---------------------------------

Registration keys issued for the PrimeBase Open Server are plug-in specific. Some plug-ins are free, requiring no plug-in specific registration key, while other plug-ins such as the ODBC plug-in, require a plug-in specific activation key for the Open Server. All plug-ins will work with a time limited demonstration key.

Check the documentation for the plug-in to find out if it requires a registration key.


Installing an Open Server plug-in
---------------------------------

1) To install a plug-in, copy the plug-in into the setup/plugins directory in the Open Server's working directory.

2) Start 'pbee', the PrimeBase Environment Editor, and select the PrimeBase Open Server's environment file from this list displayed.

3) Set the environment variable 1505 to the name of the PBOS plug-in. For example if the plug-in was called 'foobar.so' then you would set the environment variable by entering the command:
set 1505 foobar.so
Do not inclose the plug-in name in quotes.

5) Quit 'pbee' by entering 'quit'.

6) Restart the Open Server. 

The Open Server will load the plug-in automatically and display the plug-in's name and version in the initial output to the console window. 

If the plug-in fails to load check the following:
-------------------------------------------------

1) Verify that the plug-in is in the correct location and its name agrees with the name specified in the PBOS's environment file.

2) Check the Open Server's registration key is valid for the plug-in being loaded. Development keys are valid for all plug-ins.

3) Check that there is not an Open Server with the same name or activation key all ready running.

4) Check the plug-in's documentation to make sure that all system requirements for the plug-in have been met and that any libraries or system software required by the plug-in is available.

5) If the Open Server still fails to start or load the plug-in, try starting the Open Server from the command line with the '-d' option, "pbos -d". This will start the Open Server in the foreground with out the PrimeBase console. In this mode you may be able to see a low level error message which would not be displayed on the console.

6) If all else fails report your problem to Support@Primebase.com along with a complete description of the problem including Open Server and plug-in versions and the Operating system that it was being run on.