Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. JDBC driver with Java applications

  2. ODATA protocol for the tool of your choice (lime MS Power BI, Tableau, etc.).

...

Configuration

SQL Cloud is a 100% JavaScript database. Therefore a browser an HTML page is always required to run it.

As it is an app for Jira, a user must be logged in to Jira to view the page and connect to it.

The SQL Cloud - Query Server page is displayed below:

...

The The page to run the database and able to accept third-party connections is the SQL Cloud - Query Server page:

...

Some steps are required in order to get this working:

Security Level 1: Log in Jira

The Query Server page can be viewed only if you are logged in Jira. In other words, none can connect to your data until you log in Jira before.

Security Level 2: SQL Cloud Global permission

You cannot see the SQL Cloud - Query Server action menu nor the page until your Jira administrator grants you explicitly with the SQL Cloud Connect global permission.

Without the Jira administrator’s explicit grant no connections are allowed.

Security Level 3: Enable the Query Server feature

By default, this feature is disabled for all the users and every user must explicitly enable if after they have been granted by the Jira administrator and before to start accepting any third-party connection.

Without the Jira user’s explicit grant no connections are allowed.

Security level 4: Set a Query Server password

The Query Server will authenticate the remote user’s credentials before accepting any connection.

These credentials are not the same to the Jira user’s credentials!! One is for you to connect Jira and the other is for anyone else to connect to your SQL Cloud database instance.

In this way, only the remote users that knows this password (created by YOU) can connect.

By default, a random password is created. But you can edit and change it.

The username is the same name than your Jira Cloud instance name and it cannot be changed (read-only).

Image Added

Connections life cycle

The Query Server page displays the database connection status in real-time always:

  • Status
    colour

...

  • Red
    title

...

  • DISABLED

...

  • This is the initial state and must be manually changed by the user as described above. The server will reject any connection attempt.

  • Status
    titleDisconnected

...

  • Once the service has been enabled, this is the default state. The server is ready and waiting for connections. Please, keep in mind that you may have more than one Query Server page opened, but one only can be connected to the same tool at time. The rest will be in this disconnected status.

  • Status
    colourYellow
    titleCONNECTING
    Once the page has been loaded, the Query Server

...

  • page is connecting to the third-party tool.

  • Status
    colourGreen
    titleCONNECTED
    The remote user has been authenticated and the server is connected and listening to incoming user's queries

...

Status
colourRed
titleDISABLED
Query server is disabled, so it will not be possible to connect to it in any way.

The limit to connect is 10 seconds. If the threshold is reached then a timeout exception will be raised.

The database username is the Jira instance name (same as in the URL).

...

  • . After closing the connection the page status will automatically change to Disconnected.

How it works?

You may see how a Query Server page is automatically opened and connected to the tool.

This will happen everything that the third-party tool asks for Jira data and there is not a SQL Cloud database connection opened yet.

Why? Since SQL Cloud is a 100% JavaScript database running on a HTML page some restrictions are inherited from he bowser security sandbox like opening a TCP/IP port listening to connections is forbidden. This introduces some behavior different to the rest of the database servers.

You, as user, do not have to care about all theses details as they are automatically managed in some way behind the scene.

When a Query Server page is automatically opened it receives the full context to:

  1. Start a new instance of the SQL Cloud database

  2. Authenticate the remote user

  3. Connect to the third-party tool and start serving Jira data (answering the remote user’s queries).