HOME

PROJECT

CONTACT

 

 

 
 
   
  CONTENTS  

  Introduction  
  Key functions  
  Public web area  

Home Page

About

Contact

Contact

  Initial user setup
  Search and edit
  Submissions  
  List manager  
  Message board  
  Data backup  
  Data backup  
  About  
  Summary Info.  
  Cost of system  
  System Spec.  



 

 
LITERATURE RESEARCH ONLINE
 

Introduction
Literature researchers can now have access to a tool that allows research projects to be developed irrespective of where the individual researchers are based. All that is required is an internet connection to gain access to the tool. The system permits numerous researchers to be working at the same time using a central database. Different levels of security access can be given to each user to restrict access to certain functions of the system.

Top of Page 
Key Functions Top of Page

User login to administration panel using username and password

Main administration panel

Edit project details screen

Add new records screen

Edit and delete existing records screen

Comprehensive search utility to find records to edit

Categorise records as Articles, Books or E-Documents

Message board to communicate with other researchers on same project

List manager - add items to drop down lists that appear on the screens

Data backup facility

Comprehensive user management screen

Assign security access levels to users through user screen

Search project facility available on public website

Project display analysis tool

General web users can submit articles directly to the project

Project users can accept or reject public submissions to a project

Help facility through this screen

General Overview
Literature Research Online is divided into two areas - the public website area and the restricted user administration area. Users with valid usernames and passwords can enter the restricted administration area and can only gain access if they have projects assigned to them by the project administrator.

Top of Page

Information and Tools Available to the Public
The public website contains information concerning individual projects. 

Home Page

The home page includes an introduction and a login screen to enter the secure administration area for the project. If an incorrect login is given or an error occurs during a session the user will be taken back to this page

 

About

A link is provided to this page. While in the administration area the user has access to a Help link that links to this page.

 

Contact

Link provided to basic contact details to obtain more information on the system.

 

Projects

The general web user can click on the Project. Only the records that the project team have marked for public viewing are available on this page.

 

The project has three button options - Project Display, Search and Contribute

 

The Project Display is an analysis tool listing specific sub categories for each project. After project completion or during compilation of the records, the project team define a list of categories specific to the project. The project display allows the user to view and select a subcategory to view the list of records included by the project team. The listing may only illustrate a selection of records in a subcategory for illustration and display purposes.

 

The Search button gives the user the option to perform a details such on the project records. A selection of criteria such as Title, Keywords, Author... are provided. There is also a drop down list for the sort order and selction of category (book, article or edocument).

 

The Contribution button is also provided to allow anyone to submit a book, article or edocument to a specific project. The submission will be received by the project administrator for review and possible inclusion on the database for public viewing. Boxes are provided on the contribution for to provide the submitter's details such as email address and a message to assist the project team when reviewing the contribution.

Top of Page

Initial User Setup
The system is provided with one default administrator user account and one default project already configured. Once logged in as the default user other users can be assigned using the User Management Screen. The default user can be changed to something more appropraite at this stage. Users can be added making sure that atleast one user has administrative privleges (level 0) to gain access to all functions including the user management screen.

Top of Page

 Add New Record 
Records are added using the Add New Record. The project the user is working on is clearly shown. Data can be added according to literature standards ie. publisher, city, author... Other non standard input boxes such as country, related links, keywords... are provided for conveniences. There is also a check box called Accepted. If check the record will be available for public viewing through the main website. For example complete details may not be available and the record is requried to be withheld from public viewing.

When a record is added to the database by clicking Save Record a new empty add screen appears with a message stating the last record has been saved. For convenience a check box is provided to copy some essential details from the previous save page to the new record entry screen to save typing information in if the new record to be entered is similar to the prevous saved record.

Top of Page

Record Search and Edit 
To edit a record the user selects Search and Edit on the main administration panel to access a search screen. A search facility using various criteria such as keywords, title, author. On clicking go the results are displayed on the same page. Records can be clicked to enter the main edit screen to make modifications to the record. A delete button is provided to delete specific records. When a record is saved the system records the last user that made the modification together the the time and date.

Each record can be identified by the Record ID shown as part of the each search listing and the top of the Edit screen for the record for example "Book 123", "Article 80"... . Each record in the database whatever the type of record it is, is assigned a unique Record ID to identify the record in the database. The Record ID can be used to go directly to a record in edit mode when posting a new message (see message board)

The user can choose a particular search order for the seach list results such as by Title or Author. Searching by Author can produce unpredictable results when sorting by Author under All Categories. Articles and Books/Edocument are in essence different entities with separate authors. The system currently does not support full searching for mixed category authors due to the different author types for books and articles. If you require a valid sort order you should nominate a category prior to sorting by Author.

Tools are provided in the Edit and Add screens to assist in entering details of similar type. The City and Publisher box have java coding to provide an autocomplete function when completing the boxes. Type in the first letters and a list of already entered words appears to select from.

Top of Page

 Submission Manager 
As set out above under Projects above, any member of the public using the website can submit a record for a project for possible inclusion on the database. All submission will have by default the Available to Public unchecked. The submission manager allows the user to view all the records that are currently unchecked. They can either be edited or deleted.

Top of Page

 List Manager 
The list manager can be accessed by clicking the button on the administration panel. List items can be added to the lists using this facility. The list contents can be seen on the same screen to view the additions. The contents of the lists will become available the next time the user adds or edits a record. A delete button is provided to delete an item.

Top of Page

 Message Board 
For convenience in communicating with fellow researchers an advanced message board is provided. The number of messages within the last 24 hours are shown on most of the screens, to see any new messages that appear while working on a project. The board can be accessed through the administration panel. 

The principle of the message board is that  a user can start a new message thread by posting a new message, which includes a subject title, text message and priority. This message appears clearly on the message board display with other relevant details such as priority and a link to a record in edit mode if provided. Users with access to the project can reply to this main message and the reply listings appear below the main message heading. An unlimited number of replies can be posted against a particular message until the user that created the orginal message message decides to close the post to remove the message from view.

To start a new message thread you need to include as a minimum a Subject in the box provided. Add some message text and there is a check box to indicate if the message is urgent. If the urgent box is not ticked the message will be marked priority: low. 

There is also a box to enter the Record ID number. Each record in the database whatever the type of record it is, is assigned a unique Record ID to identify the record in the database. When you edit a record you will see the Record ID clearly marked in red at the top of the screen. The Search and Edit list also shows the Record ID and each listing will begin for example "Book 123", "Article 80"... 

The function of the Record ID box on the Post New Message is to save the Record ID against that message and generate a link directly to the record in edit mode. A small blue arrow appears at the end of the message displayed on the message board. This saves you from entering details of the book or article you wish the reader of the message to work on. If there is no Record ID provided no icon will appear as part of the message.

It is important to use the Record ID Edit Link box carefully as there is currently no code to check to see if the record exists before opening a link. The onus is on the user posting the message to enter a correct Record ID. If you put some text or punctuation in the Record ID box or a number that does not correspond to an actual record, the link created for the reader of the message will be incorrect and the system will not be able to find the link. 

When you have completed your message entry click Post Message. The screen will be reloaded and your message will appear at the top Message Board.

To reply to the message. You will see an entry box under each message and any replies that have been sent concerning a particular message. Just fill in the box and click Reply. Each message is provided with a reply entry and Reply click button. 

When the message has been actionned or no longer required the user that actually created the orginal message can check the Close Post box on a message and click Reply. This will remove the message from all views. When a message is closed it is not deleted but remains in the database. If a user that did not create the orginal message tries to check the close box the request will be rejected and a message displayed. 

Note that the functionality of the message board for client actions requires that Java Script be running on the client browser.

Top of Page

 Data Backup 
A user with administrative privileges can perform a data backup of the entire database. All records for all projects will be backed up. The backup file is in in the form of .txt.gz file compressed using GZIP. The database is a MySql database and the backup file contains all the commands and data to recreate the database on any MySql server (recent version of MySql is required). A service to automatically email the file to a nominated address can be provided on request.

Top of Page

 Language Support 
The system is equipped to work in different languages. On the user management screen the user can be asssigned a default language from the drop down list. When the user logs on the screens are shown in the language. Currently only English has been installed. Should a customer wish to have another  language added, this can be arranged.

Top of Page

 About 
The License Link on the administration panel links to the software license agreement. All users of the restricted administration area must agree to this end user license agreement (EULA). This is to prevent unauthoriesed copying of the system and contains other conditions including limitations on liability and warranty.

Top of Page

 Summary Information
The administration panel also displays some useful information such as last backup date and how many hits on the home page. A reset counter is provided to reset the home page counter and "from date".

Top of Page

Cost of System
Please contact Innovetec for further information. Each system can be tailored to specific requirements of the company or organisation.

Top of Page
 

 System Specification

Top of Page

Primary programming language - PHP version 4 and HTML

Secondary language - Java script for dynamic functionality

MySql database version 4.0.16

Web space requirement under 1MB not including data

 

Copyright 2006 Innovetec

Contact Legal

Website developed by Innovetec