Server Setup
RaptorXML must be licensed on the machine on which it is installed. This installation can then be accessed via an HTTP REST Interface. To correctly set up RaptorXML+XBRL Server, do the following. We assume that RaptorXML+XBRL Server has already been correctly installed and licensed.
1.RaptorXML+XBRL Server must be either started as a service or an application in order for it to be correctly accessed via HTTP or HTTPS. How to do this differs according to operating system and is described here: on Windows, on Linux, on macOS.
2.Use the initial server configuration to test the connection to the server. (The initial server configuration is the default configuration you get on installation.) You can use a simple HTTP GET request like http://localhost:8087/v1/version to test the connection. (The request can also be typed in the address bar of a browser window.) If the service is running you must get a response to an HTTP test request such as the version request above .
3.Look at the server configuration file, server_config.xml. If you wish to change any settings in the file, edit the server configuration file and save the changes. HTTPS is disabled by default, and will need to be enabled in the configuration file.
4.If you have edited the server configuration file, then restart RaptorXML+XBRL Server as a service so that the new configuration settings are applied. Test the connection again to make sure that the service is running and accessible.
| Note: | Server startup errors, the server configuration file that is used, and license errors are reported in the system log. So, refer to the system log if there are problems with the server. |
For more information about HTTPS, see the section HTTPS Settings.