Home
The installation of the Database Query Plugin, version 2.0 is simple. This involves having Admin privileges in your Jive application and the ability to restart your instance of Jive SBS.
To install the plugin, follow the instructions below:
- Download the JAR from the Jive Community or here:
- Navigate to Admin Console > System > Plugins > Add Plugin
- Navigate and choose the database-query-plugin-2.jar file.
- Restart Jive SBS.
Once installed and restarted, you should see the plugin installed under the Plugins tab:
This plugin allows you to perform any SELECT SQL query that you would like to against the Jive application and analytics databases. With this power comes great responsibility. This plugin allows the following to occur once installed:
- You can only perform SELECT queries against the database.
- You will not see more than 50 rows on a single page of results. Otherwise, your application would have the great opportunity to crash.
- Exporting a CSV file in the application will only return the first 1,000 rows. This is to prevent the application from crashing from memory issues.
You can perform a query against the application database by simply going to System > Run Database Queries > Application Database. You will then see a screen similar to the following, where you can run your query:
To perform the query and view the results on the same page, select Query. To export the query to a CSV format, select Export.
The same operations can be applied to the Analytics database by navigating to System > Run Database Queries > Analytics Database. It is required that you have your application configured with Jive's out of the box analytics package.
The results of the query performed can be seen in sets of 10, 20, 30, 40, or 50. You can change the number of rows to see per page at the bottom of the result set window. Here is what a sample result set of options will look like:
Although the plugin is strict with its query rules, you do have the opportunity to make some configuration changes to how it works. Below are some properties that you have the option to alter:
staleylabs.csv.limit
This property is used for setting the amount of rows to return in an exporting CSV file. The default value for this property is set to 1000. Changing this property will require a restart of the Jive SBS application.
staleylabs.csv.writeBOM
This property is used for Microsoft Excel encoding with CSV files. The default value for this property is false. Changing this property does not require a full restart of the Jive application.
The plugin has many phrase keys that you make use of. All of the possible phrase substitutions can be found here.