Users Manual
Easyndexer
by Ral Diez
This is version 1.0 of the Easyndexer users manual.
This work is licensed under the Creative Commons Attribution 3.0 Unported License.
To view a copy of this license, visit http://creativecommons.org/licenses/by/3.0/.
2012, 2013 Ral Diez
Table of contents
1. Introduction ........................................................................................................................ 4
2. Starting Easyndexer ............................................................................................................ 5
2.1. Language selection ........................................................................................................ 5
2.2. Login ............................................................................................................................ 7
2.3. Roles in the system ....................................................................................................... 8
3. Administration Panel ......................................................................................................... 10
4. Users Manager ................................................................................................................... 11
4.1. Editing an existing user ............................................................................................... 13
5. Databases manager ............................................................................................................ 14
5.1. Creating a new database .............................................................................................. 16
5.2. Change users settings ................................................................................................. 17
5.3. Edit database .............................................................................................................. 18
6. Inside of a database ........................................................................................................... 19
6.1. Reading a table............................................................................................................ 20
6.2. Create new table ......................................................................................................... 21
6.3. Copy of a table............................................................................................................ 23
6.4. Delete a table .............................................................................................................. 24
7. Managing tables ................................................................................................................. 25
7.1 Add dir ........................................................................................................................ 27
7.2 Image view .................................................................................................................. 28
7.3. Edit an entry ............................................................................................................... 30
8. Languages management ..................................................................................................... 31
9. Practical example ............................................................................................................... 33
1. Introduction
Easyndexer is a web application for creating and managing databases with scanned
documents. Its interface is friendly and it use is very easy, to provide to the common
user a tool to create these databases without advanced knowledge of the field.
This document describes the use of the first version of the program.
2.
Starting Easyndexer
To run the application, it is necessary first to have running in the Apache Server. For
those who installed XAMPP, it is only necessary to run XAMPP control manager and
to ensure the Apache process is running.
In the server machine, it is possible to run the application with the icon on the desktop
or typing on the web browser localhost/easyndexer.
To run in a client machine, it is necessary to have configured the Local Area Network
(LAN) to access to the folder of the webpages of the server. After, it can be accessed
by typing on the web browser localhost/easyndexer or if you copied the file
Easyndexer client on your computer, by clicking on it.
2.1.
Language selection
When the application runs, this is the first screen that appears on the screen in the web
browser.
2.2. Login
After select the language, there is a login form. The system asks you about typing the
user name1 and the password.
If you press the Reset button, the typed data will be erased.
The username and the real name of the user are different things. The username is provided by the
administrator. If you have any doubts, please contact the administrator.
1
To sum up, here there is a couple of tables that show the privileges of each type of
user. The first one corresponds to the functionalities the user can use, and the second
one represents the databases that can be accessed.
Translator
No
No
Yes
The pre-installed languages are not editable by nobody. The translation management panel is just a
tool to help to spread out the application.
Type of User
Administrator
Manager
User
Guest
Translator
Own
Others
Others
databases
Public
Semi-private
(No matters
databases
databases
privacy)
Read/Write
Read/Write
Read/Write
Read/Write
Read/Write
Read
Read/Write
Read
Forbidden
Read
Forbidden
Forbidden
Forbidden
Table 2.3.2: Privileges on the databases
Others
Private
databases
Read/Write
Forbidden
Forbidden
Forbidden
Forbidden
3. Administration Panel
When an administrator is logged, this is the main panel he can see:
10
4. Users Manager
The Users Manager panel is a tool used to create new users accounts, edit existing
users and delete existing users with their databases.
This is the main window of the Users Manager:
As it can be observed in the figure, the data are showed in a table, where each row
represents a user and every column a parameter of users. These parameters are:
1.
2.
3.
4.
5.
6.
There are also two extra columns in the table. These columns are for editing the user
(1) or to delete it (2). If you press the link Edit in the row of an existing user, the
system will show a form to edit the parameters of the user, as it is showed in the
Section 4.1. If the link Delete is clicked, the user and all his databases will be deleted.
11
It is possible to create a new user by entering the data3 in the last row of the table (3),
choosing the type of user and pushing the button Create. If the button Reset is
clicked, the typed data in the form will be erased without creating the new user. When
a new user is created, the system gives to him an automatic ID number, unique in the
whole system. This number can be checked in the first column of the table.
To come back to the administration panel or to close the session, you can use the
navigation buttons on the top right-hand corner (4).
It is very much recommended to type all data without spaces between the characters.
12
13
5. Databases manager
The databases manager is a tool to create, manage and view the databases created by
the user. The next figure shows this panel.
Apart from these parameters, there are represented in the table three columns more
with the options of the databases. If you press the Access button, the system opens
the database and shows another page with the information and the options to manage
or view the database (Section 6: Inside of a database). If the Edit button is pressed,
automatically the system redirects to a form with a form to edit the name and the
visibility of the database (Section 5.3: Edit database). If the Delete button is clicked, the
system shows another page to ask the user if this is really the action he want to do, and
if the user accept the operation, the system deletes the database.
15
After giving the main parameters the user can accept to create the database or cancel
to come back without saving. If there is any fail creating the database, the system will
show an error message after pressing the button of accept, and the database will not be
created. When a database is created, its empty. It means that there is no table in the
database.
16
17
18
6. Inside of a database
When the user presses the button to access a database, the system shows the next
screen.
Like the other panels, it is possible to come back to the Databases Manager or to close
the session with the navigation buttons on the top-right handed buttons (4).
19
20
Integer
Float
Yes/No (Boolean)
Text (0-20 characters)
Long text (0-256 characters)
After select the fields, the user can accept the parameters and create the empty table or
to cancel, coming back to the database panel without saving the changes.
21
22
23
24
7. Managing tables
When a table is opened with writing privileges, the user access to a view where can do
several operations with the table, as it is showed in the next figure.
If the user pushes See (3), the system will open another view with the
document.
If the user pushes Edit (4), the system opens a form to edit the entry of the
document. To know more about this option, please check the Section 7.3: Edit
an entry. It is also possible to edit an entry of the table with the Image view, as
it is showed on Section 7.2: Image view.
If the user pushes Delete (5), the entry is automatically deleted from the
table.
25
At the bottom of the table (6), there is also a form where the user can add some
documents or entries without documents to the table. If the user wants to add an entry
with a document, he has to type the route of the file in the field Document. If the
user does not type rightly the document route, the message File not allowed will be
showed. It is possible to type another kind of file; and in that case the system will
create a link to the file. All the files have to be in the server. It is also possible to leave
this field empty, and in this case the system will show the message No file on the
cell.
The formats of file of scanned documents that are suitable with the application are:
-
Like almost in all the screens of the application, it is possible to come back to the
previous panel or to close the session using the navigation buttons on the top-right
handed corner (7).
26
27
28
29
30
8. Languages management
This is a module apart from the application to help the people to translate this
program into minority languages. When a translator is logged in the system or an
administrator selects the Languages management button, the system shows the
following form:
31
32
9. Practical example
To show better the use of Easyndexer, lets see a practical example.
9.1. Background
Imagine a city hall in a small town. They want to digitalize their files such as birth
certificates. They have in a store, boxes and boxes with the printed and signed
certificates, classified by month and year.
They pretend to create a database to access to the information easily, allowing looking
for the documents by name, surname, month or year.
9.2. Process
To do this using Easyndexer, the first step that they have to do is to scan the
documents and to save them in the corresponding folder (Easyndexer/scanned).
33
34
35
36