Install

Use the following steps to install the Web Service API:

1. Download the latest Windows or Linux installers here.
2. Make sure your antivirus software is disabled and run the installation wizard as an Administrator. Continue from here with the steps for your respective operating system: either Windows or Linux

Note

The Web Service API must be installed on the same server and web site as the Exago Web Application.

For Windows

3. Click the Web Service button.
4. Click Next to bring up the ‘Select Installation Location’ menu.
5. In this menu specify the web site, virtual directory and physical directory where you want Exago installed. Click Next.
6. Confirm your location selections by clicking Next.
7. Monitor the installation and click Finish when it is complete.

For Linux

3. Run ./installExago.sh as root.
4. Follow the prompts in the installer, or use the command line parameters outlined in the in Installing Exago on Linux article to select the Web Service API for installation. For example:

   sudo ./installExago.sh -i WEBAPI -D -y

   Note

   The installer will create the sub directory WebServiceApi in your previously specified install path.

Configure and Enable

1. Edit the file WebReportsApi.xml which is located in the Config subdirectory where the Web Service API is installed. By default this is C:\Program Files\Exago\ExagoWebAPI on Windows or /opt/Exago/WebServiceApi on Linux.

   Set the following items:

   • apppath – Add the file path to the Exago Web Application installation (e.g., "C:\Exago" or "/opt/Exago"):

   <apppath>C:\Exago</apppath>

   <apppath>/opt/Exago</apppath>

   • throwexceptiononerror – Set to true if you want to catch exceptions in your application thrown by Exago:

   <throwexceptiononerror>true</throwexceptiononerror>

   • writelog – To turn on logging for the web service, set this to true. Then configure log4net by adding a log4net.config file to the \Config folder, as described in this article. Set web service logging to the INFO level unless directed otherwise.

   <writelog>true</writelog>

   • webreportsbaseurl – Add the <webreportsbaseurl> tags, if they do not already exist, and set its property to the virtual directory where Exago BI is installed ("http://server/Exago/"):

   <webreportsbaseurl>http://server/Exago/</webreportsbaseurl>

   Note

   Grant write permissions to the ASP.NET app pool user for the log file directory.

2. Enable the REST Web Service API. Follow the steps in the Enable REST section of the Getting Started with REST article to do so.
3. Optionally enable authorization. Follow the steps in the Authentication section of the Introduction to REST article to do so.