cattaDoc Installation Guide

You install and make cattaDoc ready to use by following the steps described below.

First, make sure that all cattaDoc requirements are in place - see cattaDoc requirements.

Second, download the cattaDoc files - see cattaDoc download files.

Copy the cattaDoc files

Back to the top

Extract the cattaDoc files from the download file and copy them to a directory accessible by your web server. It is important that you keep the relative directory structure in the download file.

Make sure that file permissions are correct:

Create a cattaDoc database

Back to the top

Create a new database in MySQL for cattaDoc:

Both scripts do the same:

1. Create a MySQL database with the name cattadoc
   Note: If you want another database name, you'll have to change the name in 3 files:
   • The script / command file, createdatabase(.bat)
   • The database creation file, createcddb.sql
   • The users file, createuser.sql

2. Create 3 MySQL users with the following roles / permissions:
   • cda: System administrator
   • cdw: Normal user with read and write permissions
   • cdr: A read-only user
   Note: I will strongly advise you to change the default passwords for the 3 MySQL users. Do it in the input file createuser.sql before running the script.

3. Create the cattaDoc database structure with tables, initial values, etc.

Create a cattaDoc document repository

Back to the top

cattaDoc stores documents in a separate folder accessible by the web server. It can be part of the cattaDoc folder structure, but need not be so. The current document repository folder can be changed over time, e.g. each year, or quarterly, or monthly, dependant on your needs and requirements (backup etc.).

For example, create a folder cdfiles - the cattaDoc document root - in the root web folder, and a sub-folder - the current path - for the first year, e.g. 2006, ref. below: The cattaDoc configuration files.

Check file and folder permissions for the repository folder. The web server process user, e.g. for Linux / Apache: wwwrun, shall have both read and write access, whereas others only shall have read access or no access at all.

The cattaDoc document repository folder should only be accessible through the cattaDoc application. Therefore, it is recommended:

• NOT to make the cattaDoc document repository folder accessible as a shared file service - or part of shared drive
• NOT to allow directory listing of the folder in a web browser (in Apache, define Options -Indexes for the folder).

If you want to use the new publishing feature, you will also have to create a web publishing folder, e.g. /pubfiles.

Modify the cattaDoc configuration files

Back to the top

cattaDoc includes a number of configuration files located in the system sub-folder. You will have to adapt these before using cattaDoc. The meaning of the configuration elements are explained as comments in the files.

1. cdAuthConst.php: cattaDoc authentication constants
   CDHOSTNAME: Enter the computername of the server hosting cattaDoc.
   You can keep the default values for the rest of the constants - or change them if you like.

2. cdMaxInact.php: Maximum inactivity allowed before system logoff
   You can keep the default value.

3. cdStart.inc.php: Starting point for almost all cattaDoc screens
   Calls cdStart2.inc.php.
   There should be no need to change anything in cdStart.inc.php.
   In the end are a number of constants for linking to an external resource document repository. See more about this in the developer's page. You can use cattaDoc without an external resource document repository.

4. cdStart2.inc.php: Reads cookie for username - if not set, prompt for logon
   Calls cdStart3.inc.php.
   There should be no need to change anything in cdStart2.inc.php.

5. cdStart3.inc.php: Defines a number of system constants and reads cookie for security group.
   Calls cdStart4.inc.php.
   CDHOSTNAME: Enter the computername of the server hosting cattaDoc.
   CDDOCROOT: Path to the document root, ie. for storing documents, as the operating system will see it, ref. above: The cattaDoc document repository.
   CDWDOCROOT: The document root, ie for storing documents, as the web server will see it.
   CDDOCPATH: The current path below the document root, ref. above: The cattaDoc document repository.
   If you use the publishing feature, ref. above, you will have to define the path to the publishing folder in CDPUBLISHPATH.
   CDEXTENSIONS: Set this constant to '1' to enable the extensions (plug-in) interface - or keep the default '0'.
   You can keep the rest of the values as is.

6. cdStart4.inc.php: Defines advamced security settings as well as cattaDoc root folder and calls incLangConst.php.
   CDROOT: Enter the path to the root directory for the cattaDoc source files - as the operating system will see it.

7. There are 3 configuration files with connect strings for each of the MySQL users created with the database creation script, ref. above The cattaDoc database:
   • cdLogonC.inc.php: For users with system administrator access
   • cdLogonW.inc.php: For users with read+write access
   • cdLogonR.inc.php: For users with read-only access
   In each of these you will have to:
   • Define the absolute path to your installation of ADODB, ref. the cattaDoc requirements
   • Define the connect string to the cattaDoc database
     Note: If you changed the username and/or the password in the database creation scripts, ref. above The cattaDoc database, you will also have to change them here.

8. incLangConst.php: In the configuration file with language constants for gettext support (see cattaDoc requirements) you can change the default language in the cattaDoc user interface from English to - say - Danish by replacing $language = 'en' with $language = 'da_DK'.

9. cdSpecialFiles.php: Definition of cattaDoc special files folders for HTML document, ie. a global image folder and a global CSS (cascading style sheets) folder.

10. inc/DocStart.js: In the inc sub-folder, enter the absolute web server path to the cattaDoc source files, e.g. '/cattadoc'

Logon to cattaDoc and create users

Back to the top

You should now be able to logon to cattaDoc using the default cattaDoc system administrator user.

1. In your web browser, enter the URL to your cattaDoc installation, eg http://localhost/cattadoc/index.php
2. In the cattaDoc logon screen, enter cdadmin as the username
3. Enter cdadmin as the password
4. Click on the Logon button
5. After successful logon, you enter the cattaDoc search screen.

As your initial task in cattaDoc, you will have to create the cattaDoc users. This requires you first to create a company, ie your own company or organisation, and one or more contact persons:

6. Select 'Create company' from the New object drop-down box in the top of the search screen
7. Enter the company details in the Create Company screen
   Note: Required fields are indicated with a '*' to the right, the rest are optional.
   Tip: If the company has a web site, use its domain name as the company short-name - and as name enter the company full name, including blanks, correct uppercase/lowercase etc.
8. Click the Save button when complete
   Tip: There are keyboard shortcuts for the buttons, eg Alt-S + Enter for Save.
9. From the Company screen with the new company, select 'Create contact person' from the New event drop-down box in the top
10. Enter the contact person / user details in the Create Person screen
    Note: The company short name is already entered, as you started the creation from the company screen.
    Tip: Use initials or e-mail name as short-name for the person.
11. Click the Save button when complete
12. Repeat the previous steps for other users you want to create initially
    Tip: Click the left arrow <-- to the right of the company short-name in the Person screen to enter the Company screen.

Now you shall define the newly created persons as cattaDoc users.

13. Click the Search button to enter the Search screen
14. Click the System button to enter the System administration menu
15. Select 'Create/admin. user' in the User administration section
16. Click the Select button to list all persons / users
17. Select the person you want to define as cattaDoc user
18. Enter the user details:
    • Define User: Yes
    • Define Security group, eg Read+Write
    • Enter initial / New password
    • Repeat new password
    • Set Change password to Yes, if you want the user to be prompted to change his password during first logon
19. Click the Update button when complete
20. Repeat the previous steps for other persons you want to define as users.

Consider revoking the default system administrator user, cdadmin, or at least change the password.

Note: You need to keep at least one system administrator user in order to perform system administration tasks.

Adding an extension (plug-in)

Back to the top

An extensions interface was added in cattaDoc version 1.2.

You need to enable extensions by setting the constant CDEXTENSIONS to '1' in system/cdStart3.inc.php, ref. above the configuration files. This will enable the display of an extensions selection drop-down menu in the search screen.

You then need to define your extension(s) in your catteDoc:

1. Downlaod a cattaDoc extension - or develop one yourself
2. Copy the extension files to your extensions folder, default: /ext
3. In cattaDoc, select System (administration)
4. Select Extensions under Base data
5. Enter the data in the Create Extension screen:
   • Name: Give the extension a display name for the menu
   • Extension file name: Enter the file name of the file first file to be called, typically a form file, e.g. searchVersForm.php for the Search Version extension
   • Security group: Enter the security group(s) allowed to use the extension - 1, 2 or 3
   • Click Save
6. Check the defined extensions by selecting Extensions under Lists in the System administration menu.

7. If you support a local language, say German or Danish, remember to translate the extension's menu name given above into this language. This is done in the file /ext/incSwitchExtName.php.

NB: Security group is hierarchical: Entering '1' means that all users have access to the extension. '2' means that users with Author and System administrator permissions can use it, but not users with Reader permission.