Prerequisites

To install a XStudio Server from scratch, you'll need a Linux Server or a Windows server with a network connection, enough storage and memory. For more details check the minimal requirements.




Install the Servlet Container


A Servlet Container is web-server able to run web services and web sites. It will be used to host:
  • XStudio (JNLP version),
  • XStudio.web (Web version),
  • REST-API web service that gives you the possibility to query the database programmatically
  • JIRA plugin front-end (necessary only if you use JIRA and wish a both-way integration)


Please click on the appropriate option below:

The server is a Linux computer

The server is a Windows computer





Install the Database Server

Before installing the software, please ensure you have enough physical storage on the database server to host all the data that you're going to create.



Please click on the appropriate options below:

The server is a Linux computer

The server is a Windows computer





Install XStudio

This is where we are going to install XStudio application in the servlet container.



Please click on the appropriate option below:

The server is a Linux computer

The server is a Windows computer





Configure XStudio

Database

Upload the JDBC drivers



Please click on the appropriate option below:
The Database server is...

MySql

MariaDb

SQL Server

Oracle





Install SQLyog Community Edition

A this stage, we strongly suggest to install a tool so that you can manage your Database Server remotely.

To do so, you can install:
  • either a web management tool (i.e. PhpMyAdmin) on the server and connect from any client using a simple browser
  • or a Database management tool (i.e. SQLyog) on any client (NOT the server!). You can install it on your own personal computer as it's very light.


In the following we'll use SQLyog Community Edition (to connect to a MySql/MariaDb Database Server) as it's free, light to install, very simple to use and powerful at the same time (but you can use any another tool such as Toad if you prefer).

This must be installed on your computer, not on the server!

  • Download SQLyog Community Edition from https://github.com/webyog/sqlyog-community or directly from our own repository:
    SQLyog Community Edition for Windows 32bits
    SQLyog Community Edition for Windows 64bits

  • Execute the setup program (i.e. SQLyog-12.0.9-0.x64Community.exe)

    Choose the default options except when specified.














  • Execute SQLyog and connect to the remote Database Server:


    Click on the Create a new connection button



    Provide a name for that connection



    Provide the IP address (or name) of the database server as well as the credentials to connect as root on the remote Database Server (i.e. rootpwd)
    Test the connection, Save it and Connect






    You're now connected to your remote database server and you can manage it.




Create an empty database

  • Keep the SQLyog connection open


    Select the Database > Create Database menu item



    Provide a name for the database: xstudio_db



    You have now a new empty xstudio_db database



    Open the User Manager



    Create the user xstudio (ensure you have % selected in the Host combobox!)
    and provide a password for this user (i.e. xstudiopwd)



    Open the User Manager



    Grant all the rights to xstudio@% on the newly created xstudio_db database


You have now a remote Database Server up and running, including an empty xstudio_db database accessible by the user xstudio from ANY computer.

For security reason, this xstudio account has rights only on the xstudio_db database.

XStudio will internally query the database only with this account.




Server Settings

Configure the JNLP access



Please click on the appropriate option below:

The server is a Linux computer

The server is a Windows computer

Generate the server settings

  • Start a web browser from any computer on the network, open the URL:
    http://<IP address>:8080/xqual/xstudio/ and click on the XStudio button



  • An error message appears complaining about the network settings




    This is not surprising as we have not specified anywhere how to connect to the Database Server.


    Then, the Application Settings screen appears so that you can provide the database connection information




    Field Description
    Database server type This indicates which database server you're using:

    • MySql
    • MariaDB
    • Oracle
    • SQL Server
    driver jar path This indicates where XStudio can find the JDBC driver to connect to the database. This field must indicates the relative path from <Install_folder>\bin\jdbc folder to the jar file.

    • MySql:  mariadb-java-client-1.1.5/mariadb-java-client-1.1.5.jar (we advise using the MariaDb JDBC driver even with MySql)
    • MariaDB:  mariadb-java-client-1.1.5/mariadb-java-client-1.1.5.jar
    • Oracle:  oracle-11g-R2/ojdbc6.jar
    • SQL Server:  sqljdbc_3.0/enu/sqljdbc4.jar
    driver class path Classpath to instantiate the driver from the JAR file.

    • MySql:  org.mariadb.jdbc.Driver
    • MariaDB:  org.mariadb.jdbc.Driver
    • Oracle: oracle.jdbc.driver.OracleDriver
    • SQL Server: com.microsoft.sqlserver.jdbc.SQLServerDriver
    database server This indicates the IP address or the name of the database server.
    database name The name of the database (i.e. xstudio_db)
    connection template Connection template to use the JDBC driver.

    WARNING: do NOT replace database_server and database_name fields in the connection template.
    They will be automatically replaced by the system with what you specified in database server and database name fields.

    For instance:

    • MySql:  jdbc:mysql://database_server:3306/database_name
    • MariaDB:  jdbc:mysql://database_server:3306/database_name
    • Oracle:  jdbc:oracle:thin:@//database_server:1521/database_name
    • SQL Server: jdbc:sqlserver://database_server;databaseName=database_name;
    username Username to connect to the database (i.e. xstudio)
    password Password corresponding to the user account (i.e. xstudiopwd)
    Max number of connections
    (default 64)
    This defines how many connections can be opened by each client.
    Usually, this never exceeds 10.
    For instance: 64


    You can leave all the other setting as-is for now.



    NOTE: you can also configure your server so that all the clients connect through ssh.
    In that case, you do not need to open your database server port (i.e. 3306 if you're using MySql) which will facilitate the install if your company have strict firewall rules.

    In addition, if you do so, all the communications are then encrypted which is great in terms of security/confidentiality if you're connecting to a remote server and do not use VPN.

    You can find all the details about how to configure your system with ssh in the connecting through ssh section of the documentation.


  • Submit your changes (you will be asked where you want to save the configuration files)


    3 configuration files (xstudio.conf, requirement.conf and bugtracking.conf) are saved locally on the client.



  • Upload the 3 configuration files on the server so that they are applied

    Please click on the appropriate option below:

    The server is a Linux computer

    The server is a Windows computer



  • Re-open the URL: http://<IP address>:8080/xqual/xstudio/ and click on the XStudio button

  • If your settings are correct, the system will then initialize the database


  • After the database is initialized, you will be able to Authenticate to XStudio using the default credentials:
    Username:admin
    Password:password



  • A couple of warnings will popup to indicate that you're missing a license and that 2 major features that are enabled in the configuration have been automatically disabled:
    • The test case procedure Grid Editor
    • The ability to use rich-texts in the test case procedures




    It also summarizes the limitations of the community version:



  • XStudio's GUI appears on the screen.






Configure the REST API server


Please click on the appropriate option below:

The server is a Linux computer

The server is a Windows computer





Check the install

Now that the install is completed, let's check your server is fully operational.


Start XStudio from any computer

  • Open the URL: http://<IP address>:8080/xqual/xstudio/ and click on the XStudio button

  • Authenticate to XStudio using the default credentials:
    Username:admin
    Password:password



  • A couple of warnings will popup to indicate that you're missing a license and that 2 major features that are enabled in the configuration have been automatically disabled:
    • The test case procedure Grid Editor
    • The ability to use rich-texts in the test case procedures




    It also summarizes the limitations of the community version:



  • XStudio's GUI appears on the screen.


Start XStudio.web from any computer

This must be done AFTER you've executed XStudio first at least once.
  • Open the URL: http://<IP address>:8080/xqual/xstudio.web/ and login

  • Authenticate to XStudio using the default credentials:
    Username:admin
    Password:password



  • XStudio's GUI appears on the screen.


Try the REST API

You can access programmatically the XStudio REST-API server using the following URL:
http://<IP address>:8080/xqual/api?<query>

For instance, you can browse the URL:
http://<IP address>:8080/xqual/api?command=getInfo

This should return a json string containing information about the server:
i.e. {"application_title":"XStudio","application_copyright":"(c) copyright XQual",
"application_version":"3.0sp7", "database_schema_version":"78"}


For more information on the types of queries you can post please refer to the REST API documentation.




Request a license

At this stage, you have XStudio Community Edition installed (with all its limitations).


If you wish to try one of the commercial editions, please send us an email requesting a trial license key for free and we'll be happy to send it back to you by email.

Your email needs to include:
  • The license type you wish to try (Professional, Business or Enterprise)
  • The IP address (or name) of your server (set in the database server setting)
  • The name of your database (set in the database name setting)

After you install your license key, all the limitations will be removed and all the additional features will be enabled automatically.