reso-odata-server v0.0.0

reso-odata-server

A Reso Compliant OData Server - Currently a work in progress

Example

The server can be run from a script with the following:

var resoODataServer = require("reso-odata-server");
resoODataServer();

Setup

The following procedure should be followed to setup the server:

• Install server using NPM:

npm install reso-odata-server

• Create a configuration file or use the sample file supplied by the distribution:

cp ./node_modules/reso-odata-server/samples/server.conf .

• Configure the server using the guide below in the Configuration section.

• Create a directory in the root directory of you project called "ssl" to hold the certificates needed to support https.

mkdir ssl

• Move three certificates into the "ssl" to support https. These files hould be called:

• ca.crt

• server.crt

• server.key

• Create an execution javascript file for node.js or use the test file supplied by the distribution:

vim ./node_modules/reso-odata-server/example/index.js

• Add desired login information to "index.js" withing the "authFunc" function to allow users to use the server.

• Add desired post processing information to "test.js" withing the "postProcessFunc" function. This function is useful for gathering usage metrics.

• Run the server:

node example

Configuration

A text configuration file should be located in the root directory of your project. The default name of the file is "service.conf", but this name can be overriden when calling the resoServer() method. A sample of the configuration file called "service.conf" can be found in the samples directory of this distribution.

SERVER_DOMAIN: The dns name of the computer that will be running the server.

SERVER_PORT: The port that the server will be listening on.

Notes

• The console may generate messages with the format "Shutdown Wait for 99999999999999". This is an important message indicating that the server is timing out while waiting for results to be returned from the underlying database. The PROCESS_WAIT (measeured in ms) should be increased. This can be done by adding a PROCESS_WAIT line to the configuration file. A line such as "PROCESS_WAIT: 25" would set the wait time to 25 ms.

License

(The MIT License)

Copyright (c) 2013 Retsly Software Inc support@rets.ly

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.