Clarios Technology Pty. Ltd. Intelligent Reporter€¦ · Add a new application link. 4. Enter the...
Transcript of Clarios Technology Pty. Ltd. Intelligent Reporter€¦ · Add a new application link. 4. Enter the...
Clarios Technology Pty. Ltd.
1
Installation Guide
Installing Intelligent Reports JIRA plugin
The Intelligent Reports plugin for JIRA is available through the Atlassian Marketplace. Follow the
normal procedures you use to install Atlassian Marketplace plugins for your version of JIRA.
Once the plugin is installed an administrator must visit the configuration page to agree to the End
User License Agreement and enter the address at which Intelligent Reporter Server is (or will be)
running. You can also manage the plugin license from the configuration screen in older versions of
JIRA. You can navigate to the configuration page using the configure link or button in the entry for
Intelligent Reports in the plugin section of JIRA administration.
Installing Intelligent Reporter server
You will need to install Intelligent Reporter on a computer that is always on and connected to your
network. From this point onwards, this computer will be referred to as the server.
Your server will need Microsoft Windows XP, Mac OS X 10.6 or Ubuntu 12.04 desktop operating
system or later to run Intelligent Reporter. For supplementary instructions to run Intelligent
Reporter server on Ubuntu 12.04 server see
http://www.clariostechnology.com/intelligentreports/howto/install/commandline.
Before starting you will need:
The installation file for your operating system (Provided by Clarios Technology)
IntelligentReporterSetup-version.exe (Windows)
IntelligentReporter-version.pkg (Mac)
intelligentreporter-version.tar.gz (Ubuntu)
(You can get these files from http://www.clariostechnology.com/intelligentreports/install)
The license.key file (Provided by Clarios Technology)
Intelligent Reporter
Intelligent Reporter – Installation guide
2
(If you do not have a license.key file, you can obtain one from
http://www.clariostechnology.com/intelligentreports/install)
An internet connection to register your copy of Intelligent Reporter. Note that you do
not need to connect your server to the internet to register your copy of Intelligent
Reporter. You can use an internet connected client computer accessing the server
through a web browser to register your copy of Intelligent Reporter.
Follow these steps to install your copy of Intelligent Reporter server.
1. Install the downloaded file
Windows
Double click the IntelligentReporterSetup-version.exe file on your server. Follow the
onscreen instructions of the Intelligent Reporter setup wizard to install Intelligent Reporter
server. Launch Intelligent Reporter from the Start menu once installation is complete.
Note: If Intelligent Reporter gives an error about a file named MSVCP90.dll or an error
stating that its side-by-side configuration is incorrect, please download and install the file
from Microsoft found at http://www.microsoft.com/en-us/download/details.aspx?id=29.
Use exactly this version; do not install a “newer” version.
Mac
Double click the IntelligentReporter-version.pkg file on your server. Follow the onscreen
instructions to install Intelligent Reporter. By default Intelligent Reporter will be installed
into your Applications folder. Find Intelligent Reporter and double click to launch it.
Ubuntu
Copy the intelligentreporter-version.tar.gz file to the directory where you want to install it
(typically your home directory or /opt). Untar the file:
tar xf intelligentreporter-version.tar.gz
Execute Intelligent Reporter:
intelligentreporter/intelligentreporter
Clarios Technology Pty. Ltd.
3
2. You will be prompted to provide a license file. If you do not have a license.key file, you can
obtain one from http://www.clariostechnology.com/intelligentreports/install. Once you
have selected the license, check the details of the license. If there are any problems with the
license file, please contact Clarios Technology.
3. Answer the rest of the questions in the setup wizard to configure Intelligent Reporter server.
You can change the configuration later through the Setup dialog.
4. Once you see the following screen, Intelligent Reporter server is ready to run. Click the Start
Server button to start the Intelligent Reporter server.
5. Click the Browser button to launch the Intelligent Reporter client interface. Intelligent
Reporter is a web-based application, so you will need one of the following supported web
browsers to access Intelligent Reporter: Internet Explorer 8 or 9, Google Chrome, Firefox or
Safari.
6. You will be prompted to log in. Log in using the following username and password.
Username: admin
Password: Reporter1
7. You be prompted to change your password. Follow the directions to change your password.
Setup JIRA Application Link
The Intelligent Reporter server uses OAuth to access JIRA data on behalf of users to generate
reports. To allow Intelligent Reporter to use OAuth, you must set up an application link in JIRA.
To set up the application link in JIRA:
Intelligent Reporter – Installation guide
4
1. Ensure the Intelligent Reporter server is running.
2. Navigate to the Application Links area of JIRA administration.
3. Add a new application link.
4. Enter the address of the Intelligent Reporter server and click next.
Clarios Technology Pty. Ltd.
5
5. Enter the application name as Intelligent Reporter and the application type as a Generic
Application, and click create.
Intelligent Reporter – Installation guide
6
6. You should now see an Intelligent Reporter application link. Click Configure to configure this
application link.
7. Click Incoming Authentication in the Configure Dialog to show the OAuth configuration
screen.
Clarios Technology Pty. Ltd.
7
8. The details needed to fill in the JIRA OAuth configuration screen are available in the
Intelligent Reporter server setup dialog. To see these details, Stop the Intelligent Reporter
server and then click the Setup button. Click on the OAuth tab in the setup dialog and you
can see the OAuth details you need to configure JIRA.
Intelligent Reporter – Installation guide
8
9. Fill in the details in the JIRA configuration screen from the Intelligent Reporter setup dialog,
and then click the Save button.
10. Close the dialog, and your application link is complete.
Synchronize Intelligent Reporter server with JIRA
Intelligent Reporter needs information on the fields and custom fields in issues in your installation of
JIRA. Synchronizing Intelligent Reporter with JIRA allows it to obtain this information.
Synchronization is required after installing Intelligent Reporter, and again later if you modify custom
fields on issues or a JIRA upgrade changes the fields available on issues.
To synchronize Intelligent Reporter with JIRA:
1. Ensure both Intelligent Reporter server and JIRA are running.
2. Ensure that the Intelligent Reporter application link has been setup in JIRA
Clarios Technology Pty. Ltd.
9
3. Log in to Intelligent Reporter
4. Click the Synchronize with JIRA button
5. Enter your JIRA username and click Synchronize
6. If requested, allow Intelligent Reports access to your JIRA account
7. Synchronization should now complete successfully.
Intelligent Reporter – Installation guide
10
Generate Your First Report
The Intelligent Reporter server is used to create and modify report templates. Reports are
generated from within JIRA. Reports only contain data accessible by the user generating the report.
Jira users do not need Intelligent Reporter server usernames and passwords to generate reports,
Intelligent Reporter server user accounts are only needed to modify the report templates in
Intelligent Reporter server.
To generate your first report:
1. Navigate to the Intelligent Reports tab within any JIRA project
2. Select one of the reports in the One Off Report section
3. Fill in the required details (if any)
4. Press download
Backups
Creating a backup
You should create regular backups of your database in case the server computer fails. If you lose
your copy of the Intelligent Reporter software, it can be re installed, however we cannot replace
your database.
Clarios Technology Pty. Ltd.
11
The Intelligent Reporter database is a file in the file system of the server computer, so it can be
backed up in the same way that you back up your other data on the server computer. You can find
the location of the database file by clicking the Setup button in Intelligent Reporter main window.
Now click the Database tab, click the Browse button to find the location of the database file.
Alternatively, you can follow these steps to save a backup copy of your database:
1. Stop the Intelligent Reporter server if it is running.
2. Click the Backup button.
3. Choose a location to save your back up to and click the Save button.
4. Wait until Intelligent Reporter displays the message “Backup completed successfully”.
Backup the file to a safe location as you would backup your other data.
Intelligent Reporter – Installation guide
12
Restoring your database from a backup
Follow these steps to restore your database from a backup.
1. Check that the server is not running. Click the Setup button in the Intelligent Reporter main
screen.
2. Click on the Database tab.
Click the Browse button and select your backup database file.
3. Click the Test Database Connection button. Now click the OK button. The next time you
start your server, Intelligent Reporter will be using the file you selected as its database. This
means that all changes will be saved to this file. If you do not want your backup to change,
you should use a copy of the backup file instead of the original backup file.
© Clarios Technology Pty. Ltd. 2012. All rights reserved.
Microsoft Windows and Microsoft Word are registered trademarks of Microsoft Corporation in the
United States and other countries.