Install OpenProdoc

In order to install OpenProdoc you should follow the next steps:

1. Create an user in the database
2. Uncompress OpenProdoc files
3. Install OpenProdoc Swing Client for administration
4. Create data OPD data structure
5. Install any other client required
6. Post Installation tasks

1 - Create an user in the database

First, should be selected the kind of system to store all the OPD structure and metadata of the documents. On the selected database, after install it if is a new installation, it should be created an user with the permissions:

• Create, delete and alter table
• Create, delete and alter indexes
• Insert, delete and update records on the tables
• and of course, connect and search.

The orders can change depending on database and management interface, but will be more similar to:

The previous orders are a simple EXAMPLE and more restrictive permissions must be granted for a productive system.

2 - Uncompress OpenProdoc files

It should be uncompresed the zip files in a the selectd folder of the computer, with the folders structure of the zip file.

3 - Install OpenProdoc Swing Client for administration

This OPD client must be installed at least one time for administration and additionally, be installed for the users requiring a thick client. It's necessary to start the shell script Install.sh or Install.bat (Depending of the operative System) and fill the data asked in the form.

When installing in Linux, depending of version, user and configuration, it should be needed to change the permissions of Install.sh or Setup.sh (after the creationo) assigning execution permissions with: "chmod 777 Install.sh" or using other tools or commands.

The program will assign the language of the computer if it's supported in the version, otherwise will be used english (EN). It's possible to force a language, using as parameter the two characters language code when starting the application (IE. Install.sh EN). View Languages support

• DDBB connection user: Name of the user used to connect to the DDBB and created in the previous step. (required)
• BBDD user password: Password of the user in the DDBB. (required)
• DDBB server url: Url in JDBC format of the database server (IE.:"jdbc:mysql://localhost:3306/Prodoc?serverTimezone=UTC", "jdbc:mysql://127.0.0.1:3306/Prodoc", "jdbc:derby://localhost:1527/Prodoc", "jdbc:oracle:thin:@127.0.0.1:1521:Prodoc", "jdbc:postgresql://127.0.0.1:5432/Prodoc"). (required)
• Kind of conection: Kind of connection to use. (In this version only JDBC, in the future, other systems as non SQL DDBB). (required)
• Java class to use: Name of the classes used for connection (JDBC) (IE.:"org.apache.derby.jdbc.ClientDriver", "com.mysql.cj.jdbc.Driver", "com.mysql.jdbc.Driver", "com.ibm.db2jcc.DBDriver", "org.postgresql.Driver"). (required)
• Aditional Classpath: Classpath where the connection classes and any required library is stored besides the folder ".\lib". The classpath must include the path to the JDBC driver libraries.

It's possible to execute this program without showing user Interface (i.e.: Terminal installation only). You should call the install program with the parameters "NO_UI" and the name of a file (Ej."Install.sh NO_UI Install.properties") with the correct parameters (same parameters and options that used in interactive mode). In the installation package is included an example file that should be modify according to the installation environment.

With the previous data, the install program will create a config file (Prodoc.properties) and a script Prodoc.sh or Prodoc.bat depending on Operative System. This files can be copied and used in any computer with the conditions:

• The computers have connection to the DDBB and not through ProdocWeb and
• The computers have the same classptah and drivers installed.

otherwise it will be necessary to use the install program or change manually the configuration file (Prodoc.properties).

If you want to use Amazon S3 repository, you must donaload and install the WAS S3 libraries and add to the classpath.

IMPORTANT: For the instalation and for normal operation, it's important than the DDBB server (or at least the session "DDBB connection user" used to connect OPD) be in mode "AutoCommit=off", that is, there is no information commited or canceled while OPD not send an order "commit transaction" o "cancel transaction".

4 - Create data OPD data structure

After the instalation of the Swing Client, it must be started the script for creation of the data structure Setup.sh or Setup.bat (Depending of the operative System), filling the form displayed by the application.

The program will assign the language of the computer if it's supported in the version, otherwise will be used english (EN). It's possible to force a language, using as parameter the two characters language code when starting the application (IE. Setup.sh ES). View Languages support

• Administrator Password: Password for user administrator "root" created during installation. It is possible to define several users with several administrator permissions, "root" is only the default administrator. (required)
• Default Language Code: ISO code two character for language for the default customization. (PT, ES, EN, CT) (required)
• Timestamp Format: Format to display and read timestamp fields in default customization, according to formats of the Java formatter. (IE. "yyyy-MM-dd HH:mm:ss" )(required)
• Date Format: Format to display and read date fields in default customization, according to formats of the Java formatter. (IE. "dd/MM/yyyy" )(required)
• Main key: Main key used to encrypt several elements in OPD, including document repositories without native support for encription. It should contain characters with lower and upper case and numbers, with a size big enough to offer a reasonable security. (required)
• Repository Name: Descriptive name of the default documents repository. Later it will be possible to create additional repositories with different characteristics. (required)
• Encrypted Repository: Boolean value, when checked, the documents in the repository will be encrypted.
• Url Repositorio: IP or URI of the repository (depending on the kind of repository can be a local mounted path, a database, and ftp, etc..). It must be visible using the same name(URI) for any "client"(that is installation of a Web o Swing Client.(required)
• Repository User: User with permissions for the repository.(required depending on Repository type)
• Repository Password: Password of the User with permissions for the repository. Both fields will be empty if the repository is a Filesystem. (required depending on Repository type)
• Repository Type: One of the supported Repository Types (required)
  • FS: Filesystem (can be a mounted disk or server) identified by a path
  • FTP: Ftp Server
  • BLOB: Storing of documents as BLOB field in a Database that can be the same used to store metadata or another one.
• -Additional parameters: Additional parameters that can be different depending on the repository type (required depending on Repository type). For BLOB it is: "JDBC Driver name;Table Name" Ie.: com.mysql.jdbc.Driver;TableBlob

This proccess will create all the tables structure and elements necessary for OPD. Later, it will be possible to define new document types or folders, creating the required elements.

It's possible to execute this program without showing user Interface (i.e.: Terminal installation only). You should call the install program with the parameters "NO_UI" and the name of a file (Ej."Setup.sh NO_UI Setup.properties") with the correct parameters (same parameters and options that used in interactive mode). In the installation package is included an example file that should be modify according to the installation environment.

It is convenient to check the trace configuration file log4j.properties to adjust it to the project needs and to the desired folders. Remember that the trace level is centralized in the Prodoc.properties configuration file.

5 - Installation of other client

After the creation of the core structure, it's necessary to install OPD clients for the users.

For users with Swing client, just copy the folder after the first installation. It will contains the references to the server.

If the access for some the users is through the Web Client, it is necessary to install the Web Client in a J2EE server. This client is deployed as a WAR application. The process for install the WAR aplication can be different for every J2EE server. Check that the maximum upload file for the server is bigger than the war size (for Tomcat you must check the file tomcat\webapps\manager\WEB-INF\web.xml and verify the values in <multipart-config> ). Also, you should copy to the "lib" folder, where the application jars as Prodoc.jar are included, the files or jar for the JDBC driver selected. After the installation of the War application, it's necessary to edit the configuration file: Prodoc.properties (that will use the Web client) with the Install program or copying and editing an existing properties file.

As a last step, define a system/public environment variable OPDWeb referencing the folder of the file OPDWeb.properties (i.e.: OPDWeb=/OpenProdoc/Web/Conf ), and edit the line that contains the absolute path to the file Prodoc.properties

Another way to configure the J2EE application is: in the home directory of the user (Ie.: /home/J_Smith) with which it's executed the J2EE server, it must be copied the file OPDWeb.properties, editing the line that contains the absolute path to Prodoc.properties

Another option is to create a subfolder named "conf" contained in the folder in which the application is executed, within which the Prodoc.properties file can be copied.

6 - Post Installation tasks

The installation process DO NOT create a Full Text repository. If you are interested in using the Full Text Search you MUST create the full text repository in your selected filesystem AND activate (or create new) full text events. The installation program creates 3 task but they are DEACTIVATED. AFTER creating the FT repository you can activate them or create new ones.

The installation process define RIS document types but they are not created. If you want to use RIS, you should create/activate the defined document types or new ones. Beware with record size and DDBB capacities because the limits are very different and also in some DDBB, using UTF8 can limit the size by two. So adjust the metadata definitions to your needs and environment.

It should be reviewed the activation of Scheduled Tasks or Tasks related to Events. It should be defined the computers in which geerate or run the task, and uncomment in them the related values in Prodoc.properties, adjusting to new values if needed.