Onyx Web

Top  Previous  Next


The Web interface, Onyx Web, is a separate application that is installed as a Windows service.  It uses the same database settings that Onyx uses and it has to be installed on the Client Master.


By default is operates on port 80 and 443 (the standard HTTP and HTTPS ports) so this might be an issue if you already run a web server.  If this is the case you will need to temporarily close your other webserver, allowing you to log into Onyx Web where you can change the ports.  Onyx Web comes with a self signed SSL certificate allowing you to use secure connections for your data, though you might want to use standard HTTP on your local area network.  All access to Onyx Web is controlled through usernames and passwords and Onyx user permissions (user administration is carried out in Onyx).


Once logged into Onyx you must be sure to log out otherwise your account will not automatically log out for a further 20 minutes, during which you won't be able to log into Onyx Web, and a user licence will be marked as in use, preventing you using it in Onyx Client or OnyxMobile.


Before you can use OnyxWeb, you need to create a user, this is automatically done for you if you select Maintenance->More->View Slave Connection Details, and then click the web link (in this example




Alternatively, or to add further users:


To add a user




Here we're adding John



Now set the password (it must follow the password policy as it needs to be secure)




Now edit John's permissions




Be sure to set 'Can use Web Interface'




Now John can log into the web interface





And once logged in




When you use Onyx Web, please do NOT use the back button, you should use Onyx Web almost as if it were a standard application.  Except for the main screen, most screens will have a small close button in the upper right corner (just like a normal Window's app).  Whilst you can open two browser instances, each one will add to the total user count (which is 1 unless you purchase additional licences).


Below is an example of an Onyx Web screen, with a close button in the top right corner.




As within Onyx, there are some settings that are global and some that are set on a per-user basis, for this reason it is probably useful to visit Onyx Web's settings page, this can be accessed from the front screen via Commands->Options->View Options and looks like this