iPhone and iPad application

You can download and install XStudio's iPhone and iPad application from the AppleStore.
To have these mobile applications to work, you will need to setup the XStudio REST-API server and make it publically accessible. This server is an HTTP server so does not normally need specific firewall rules..

Setup of the REST-API Server

You will need to install Tomcat (or any other application container) and deploy the web service available in the XStudio web package in your Tomcat instance. This way, the iPhone/iPad application will be able to connect to this server and retrieve all the data necessary.

The deployment simply consists in connecting to your Tomcat app manager (something like http://<server name>:8080/manager/html/list), select xstudio.war from the web-package and click on Deploy.

(Alternatively you can also do it manually by copying the content of the apiserver folder from the web-package in /var/lib/tomcat7/webapps/xstudio)



Once this is deployed, you will also need to manually copy:
  • some valid configurations (xstudio.conf and bugtracking.conf) in /var/lib/tomcat7/webapps/xstudio
  • your JDBC driver (i.e. mysql-connector-java-5.1.12-bin.jar) to /var/lib/tomcat7/webapps/xstudio/WEB-INF/lib/

The content of the /var/lib/tomcat7/webapps/xstudio/ folder should look like:


     


If you're hosting Tomcat on a linux server, this script (or a similar script) will make this for you:


   echo "stopping tomcat7..."
   service tomcat7 stop
   echo "uninstalling the old REST-API server if any..."
   rm -rf /var/lib/tomcat7/webapps/xstudio
   echo "deploying the REST-API server..."
   cp -rf /var/www/xstudio/apiserver/* /var/lib/tomcat7/webapps/xstudio/
   cp -rf /var/www/xstudio/bin/*.conf /var/lib/tomcat7/webapps/xstudio/
   cp -rf /var/www/xstudio/bin/jdbc/mysql-connector-java-5.1.18/* /var/lib/tomcat7/webapps/xstudio/WEB-INF/lib/
   echo "starting tomcat7..."
   service tomcat7 start



To check if your REST-API Server is working well, open a browser and open the URL:
   http://<server name>:8080/xstudio/api?command=authenticate&username=admin&password=<password>


You should get a success message such as
   {"result": "success", "userid": 10}


In case of problem, you may want to check /var/lib/tomcat7/logs/catalina.out.

Install iPhone/iPad application

Run the AppStore application and search for XStudio.
The applications are both free.


From the iPhone/iPad application's login page, you'll need to provide the credentials to connect to your REST-API server. The information to provide should look similar to:

URLhttp://<server name>:8080/xstudio/api
UsernameA username in XStudio having all the rights (i.e. "admin")
PasswordUser's password