=================================
Maarch Capture Connector - Server
=================================

:Version: 1.1 Stable
:Release date: 2011/06/13
:Copyright: Copyright (c) 2011 Maarch
:Contact: Maarch <dev@maarch.org>
:License:

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

    Other components:

    PHP GTK is released under LGPL (see ./tools/php-gtk2/README.txt)


Contents of this file : 

1. Introduction
2. Package structure
3. Installation
4. Configuration details

1. Introduction
============

This is Maarch Capture Connector Server. It is intended to work with 
Maarch Capture Connector Client.


History
-------

Maarch Capture Connector (MCC) is the replacement for Maarch Scansnap 
Connector (MSC). MSC has been entirely rewritten in PHP. There are 
multiple for that :

* Because of its name, MSC was (too) often considered to be only compatible
  with Fujitsu Scansnap scanners
* It was written in VB6, which is neither free (as in "free speech"), nor
  supported by Microsoft
* It was not portable

So here is the good news:

- MCC is fully compatible with any scanner, and any PDF-Generators 
  (such as `PDF Creator`_)
- MCC can (in theory) work on Windows, Linux and MacOS X
- It has some great new features :

  * Support for Proxies
  * Support for secured protocol (HTTPS)
  * A new "Form Mode": if enabled, you will be prompted for a few basic 
    information after your document is scanned, and before it is sent to 
    the server. You can set the form with form.xml
  * A new mass upload mode: upload several documents to the server at once. 
    You can prepare the stream for mass import AutoImport using the file structrure.xml

.. _PDF Creator: http://www.pdfforge.org/

2 Package structure
=================

File listing for the MCC Server::

  MCC_Server/
  |-- config/
  |    -- config_mass.xml.default   # A sample config file for MCC server with mass scan mode
  |    -- config_mcc.xml.default    # A sample config file for MCC server with entreprise application
  |    -- config_mlb.xml.default    # A sample config file for MCC server with letterbox application
  |    -- form.dtd                  # DTD of form.xml
  |    -- form.xml.default          # A sample form for entreprise application
  |    -- form_mlb.xml.default      # A sample form for letterbox application
  |    -- structure.xml.default     # A sample structure AutoImport for entreprise application
  |    -- structure_mlb.xml.default # A sample structure AutoImport for letterbox application
  |-- outcome/                      # In mass scan mode, processed files are 
  |                                 #    backed up here
  |-- logs/
  |-- class_db.php                  # Class to handle connections to the database
  |-- get_datas.php                 # Script to exchange informations with MCC Client
  `-- mcc_server.php                # Main script
 
3 Installation
============

1. Extract this archive on your server. It must be available through the 
   web, so place it in the www-root of your server.
2. Copy config/config_XXX.xml.default to config/config_XXX.xml

3. Edit config_XXX.xml, and set it up according to your environment
4. If you want to use form mode and/or mass upload, you have to copy and set config/form_XXX.xml.default and config/structure_XXX.xml.default to config/form_XXX.xml and config/structure_XXX.xml.Then you must set up Maarch AutoImport to 
   inject documents from the outcome folder into the application database.
   In single document mode, you do not need this step.

4 Configuration details
=====================


Set up config_XXX.xml
---------------------

Main configuration is done in the <CONFIG> section. Here are the
available configuration tags :

* CONFIG_NAME: The name of the config -> config_XXX.xml, You must enter XXX in the tag CONFIG_NAME 
* MCC_PATH: The path to the folder you install MCC Server in. - 
  ex: C:\\xampp\\htdocs\\MCC_server\\
* MAARCH_TMP_PATH: Path to the tmp folder of your application. You can 
  find this path in the main config.xml of any Maarch application. - 
  ex: C:\\xampp\\htdocs\\entreprise\\apps\\maarch_entreprise\\tmp\\
* TARGET_PATH: The folder where the MCC Server copies the files it 
  receives - ex: C:\\xampp\\htdocs\\mcc\\server\\outcome\\
* FORM: the path of the form configuration file (only on form mode or mass upload)
  ex: C:\\xampp\\htdocs\\MCC_server\\config\\form_XXX.xml
* CREATE_INDEX: Put true if you want to create an index file for the AutoImport (only on form mode or mass upload)
* STRUCTURE_FILE: The path of the index configuration file for the AutoImport (only on form mode or mass upload)
  ex: C:\\xampp\\htdocs\\MCC_server\\config\\structure_XXX.xml

The rest is database configuration. You must set up server and credentials 
to access the database of the application in which you intend to record 
documents with MCC (Maarch LetterBox or Maarch Framework-based 
applications, like Maarch Entreprise).

Set up form_XXX.xml
-------------------
First you have to change the location of the DTD:

<!DOCTYPE ROOT SYSTEM "http://127.0.0.1/mcc/server/config/form.dtd">

You can set the general structure of the form with:

<FORM>

    <TITLE>Maarch Capture Connector</TITLE>

    <WIDTH>455</WIDTH>

    <HEIGHT>350</HEIGHT>

    <CENTER>true</CENTER>

You can edit/create fields with:

* list of fixed values:

<INPUT>

    <TYPE>comboBox</TYPE>

    <ID>status</ID>

    <LABEL>Statut</LABEL>

    <AUTOCOMPLETE>false</AUTOCOMPLETE>

    <VALUES>

        <VALUE><ID>NEW</ID><LABEL>Nouveau document</LABEL></VALUE>

        <VALUE><ID>VAL</ID><LABEL>A valider</LABEL></VALUE>

        <VALUE><ID>END</ID><LABEL>Cloturé</LABEL></VALUE>

        <VALUE><ID>TRT</ID><LABEL>A traiter</LABEL></VALUE>

    </VALUES>

    <DEFAULT_VALUE>NEW</DEFAULT_VALUE>

    <SHOW_ID>true</SHOW_ID>

    <MANDATORY>true</MANDATORY>

</INPUT>

* list of values in a Maarch application database:

<INPUT>

    <TYPE>comboBox</TYPE>

    <ID>folders</ID>

    <LABEL>Dossiers</LABEL>

    <AUTOCOMPLETE>true</AUTOCOMPLETE>

    <TABLE>


        <TABLE_NAME>folders</TABLE_NAME>

        
        <FOREIGN_KEY>folders_system_id</FOREIGN_KEY>


        <FOREIGN_LABEL>folder_name</FOREIGN_LABEL>


        <WHERE_CLAUSE>status = 'NEW'</WHERE_CLAUSE>


        <ORDER>order by folder_name</ORDER>

    
    </TABLE>

    <DEFAULT_VALUE></DEFAULT_VALUE>

    <SHOW_ID>false</SHOW_ID>

    <MANDATORY>false</MANDATORY>

</INPUT>

Set up structure_XXX.xml
------------------------
You can prepare the stream for mass import AutoImport using the file structrure_XXX.xml


<ROOT>

    
    <FIELDS>

        
        <TYPEID>'9999'</TYPEID>

    
        <TYPIST>'bblier'</TYPIST>

        
        <STATUS>status</STATUS>

        
        <SCANDATE>'@date'</SCANDATE>

        
        <DESTINATION>entities</DESTINATION>

        
        <PRIORITY>priority</PRIORITY>

        
        <FOLDERID>folders</FOLDERID>

    
    </FIELDS>


</ROOT>

Set Up Maarch AutoImport
------------------------
</rst>
{{att|This is only needed if you use mass upload. You do not need to chain Maarch AutoImport with MCC Server otherwise.}}

{{info|This is just an outline. Please refer to the `documentation of Maarch AutoImport`_ for more information.}}

<rst>
You will find the configuration of Maarch AutoImport in the file 
./maarch_autoimport/config_*.xml (the exact name of the file depends on
your setup) in the main folder of AutoImport.

The only important point is to make sure that the path given in 
the tag <SCAN_IMPORT_DIRECTORY> of AutoImport is the same as the
<TARGET_PATH> of MCC Server.

Make sure you entered the correct parameters for database access.

.. _documentation of Maarch AutoImport: http://wiki.maarch.org/Maarch_AutoImport