iReport
IReport Version 3.1
Admin
Console Quick Reference
The diagram below shows a screenshot of the iReport Admin Console,
together with information about which section of this admin-guide contains
information about the particular console item; to find the page number, please
refer to the section titles in the Contents. If you are viewing this guide
online, please click on the section title to follow the link to it.
Table of Contents
Changing the Default Responsible User
Introduction
This document is the
reference guide for iReport Administrators.
It gives instructions on how to perform all of the administrative tasks,
and also has some extra information about configuring the standard reporting
tools, which is an advanced task.
Most administrators will be able to use the iReport Admin Console without
reading this document first; however, the document should be referred to if you
encounter any problems using the Admin system.
Initial (‘Base’) Data
The iReport system comes preloaded with some initial ‘base’ data that
allows you to login to the system and begin setting it up as you want. Some of the base data can be changed; other
bits of it cannot be. The data cannot be
changed are the error-types (reasons for issues being raised – see below), the
priorities (the importance of an issue – see below) and the user-types, which
indicate whether a user is an administrator or not.
The data that can be changed are the default group and users. The system comes with one group, called
BASE_DATA, and one user, the ADMINISTRATOR.
(The database actually contains another user, the ‘Unknown’ user, but it
is impossible to login as this user).
The ADMINISTRATOR has a password of ‘default’ (without the quotes), and
it is as this user that you should first login to iReport.
Once logged in, you should change the ADMINISTRATOR password and begin
creating new groups and users as required.
The Admin
Console
The Admin Console is the
primary administration tool in the system and can only be accessed by users who
have been set up with the ‘Admin’ user type.
To access the console, log in to the system (as described in the iReport User Guide) and then click on
the Admin Console link in the main menu on the right hand side of the
screen. The browser will be redirected
to the Admin Console.
The screen should display a
list of links corresponding to the tasks detailed below, and one extra link,
‘Return to Main Menu’. Once you have
finished with your administrative tasks, click on this link to return to the
Overview screen.
User
Administration
Adding a User
To add a user, click on the ‘Add a User’ link in the Admin Console; this
will redirect you to the ‘Add User’ page.
The information required for user creation, together with an explanation
of why it is required, is shown below:
|
|
|
Editing a User
|
|
To edit a user, first click on the ‘Edit a User’ link in the Admin
Console. In the screen that appears, select the user you wish to edit from the
list and click the Select button. The user’s current data will appear in a form on the screen. You can edit all of the data except the user’s username, as this is
their unique identifier in the system.
Once you have finished editing the data, click the Update button to
save the data back in the database. |
Removing a User
|
|
To remove a user, first click on the ‘Remove a User’ link in the Admin
Console. In the screen that appears, select the user that you wish to remove
from the list provided, and then click the Select button. This will delete the user from the
system. As a part of the deletion process, the following events occur:
Any issues created by the
user have their ownership changed to the ‘Unknown’ user. This is a special user record created by
the system that is used to represent deleted users. |
Project
Administration
Adding a Project
|
|
To add a new Project, click on the ‘Add a Project’ link in the Admin
Console. The browser will be redirected
to the Add Project page. Enter a name and description for the project, and select a default
responsible user from the list provided.
This user will automatically be given permission to access the
project. Once all of the information has been entered, click on the Create
button in order to create your project.
The browser will now be redirected back to the Admin Console. |
Changing the
Default Responsible User
|
|
To change a project’s default responsible user, click the ‘Change
Project Default Responsible User’ link in the Admin Console. Select the project whose user you want to change from the list
provided, and click the Select button.
From the new list that appears, select the user who you want to take
over as default responsible user for the project, and click the Select
button. This will alter the project’s
database record, and redirect you back to the Admin Console. |
Changing Project
Permissions
|
|
To change a project’s permissions, first click on the ‘Change Project
Permissions’ link in the Admin Console.
Select the project whose permissions you want to change from the list
provided, and then click the Select button.
You will be presented with a new screen, as shown to the left. The two lists shown indicate which users have permissions to access
the project; the list on the left shows the users that don’t have access, the
list on the right shows those that do.
Users can be moved between the two lists by selecting them in the list
and using the arrow buttons provided.
The meaning of the arrow buttons is shown below:
Users can also be added to the list by granting permissions to
groups. Clicking on the link near the top of the screen (“To add a whole group
of users to the list, please click here.”) opens the group selection
page. Select the group that you want to add from the list, and click the
Select button. The system will take
all the users belonging to the group you selected and add them to the list of
permitted users. This is particularly
useful if, for example, your organisation is made up of a number of small
teams who tend to work on separate projects.
By configuring the system so that every team has its own group, and
all the members of the team have user-accounts in that group, project
permissions can be quickly assigned without having to add them on a ‘per
user’ basis. |
Why
Can’t I Delete A Project?
iReport does not currently allow the deletion of projects, primarily
because of the fact that if a project is deleted, all of its attached issues
and reports must be deleted too, leading to a loss of useful historical
data. However, this topic is under
review and some form of project deletion may be allowed in the future.
Group
Administration
Adding a Group
|
|
To add a group to the system, first click on the ‘Create a Group’ link
in the Admin Console. In the screen
that appears, enter a name for the group, and then click the Create
button. The group will be created and
the browser directed back to the Admin Console. |
Removing a Group
|
|
To remove a group from the system, first click the ‘Remove a Group’
link in the Admin Console. In the
screen that appears, select the group that you want to delete from the
list. Only groups that have no users appear in the list! Once you have selected the group you want to delete, click the Remove
button. The group will be removed from
the system and the browser directed back to the Admin Console. |
Entity
Listing Tools
In the context of iReport, entities are objects that may be
administered, There are several types of entities. These are:- Users, Groups,
Projects, Error Types, Priorities and User Types.
iReport allows administrators to list the entities of each type that currently
exist in the system, as it is easier to use the entity listing tools than to browse
the database records manually. The
current version of iReport allows you to view the names all of the different
entities (except issues and reports, which are obviously viewed elsewhere), and
also allows you to view the lists of users in each group.
Standard Entity
Listing
|
|
To list the instances of one of the standard entity types, first click
the ‘List Entities in Database’ link in the Admin Console. In the screen that appears, select the entity whose instances you wish
to view, and then click the Select button.
The titles/names of the instances will be displayed in list format on
the next screen. Use the link at the top to list another entity type. |
Listing Users by
Group
|
|
To list the users contained in a given group, first click the ‘View Users
For Group’ link in the Admin Console. In the screen that appears, select the group whose users you wish to
view and click the Select button. The
browser will be redirected to a new screen showing the list of users in the
group you selected. |
