Jump to content

Docmanager

From NusaATK

The 'Docmanager' module is a module that adds document storage and generation capabilities to Achievo projects, employees and possibly other Achievo components.

Important: Since Achievo 1.3.0 this module is part of Achievo!

Interface

The docmanager offers one menu item in the Setup menu:

  • Documenttypes
    Allows you to create document types that contain templates you can use to generate documents

In components the docmanger is configured to be added in, you will get an additional 'Documents' tab on every edit page. In this document page you can add/edit/delete and generate new documents on a per-record basis.

Document types

Document types are used to define document templates for a specific achievo component (also known as the master node). In each document type, you can upload a document file containing codes that can be understood by the AtkDocumentWriter.

Configuration

To configure the components in which you want to add a Documents tab, you need to add some lines to the config.inc.php file. If you want to add a Documents tab to projects (in the projects module) en employees (from the employees module), you can write this for example:

 $config_docmanagernodes = array("project.project", "employee.employee")

If you want to use a specific folder on your server to store the documents, you can use the documentpath setting (which should contain a relative path):

 $config_documentpath = "../mydocumentsfolder";

Advanced configuration

If you want, you can even configure the docmanager to:

  • Use a specific folder for each different Achievo component
  • Use url's in a user-definable format (for example file:// uri's)

Below you can see how this can be achieved:

 // Docmanager locations and nodes:
 $config_docmanageroptions = array(
   "project.project"=>array("dir"=>"../projectdocuments/", "url"=>"file:///\\\\mysambaserver\\myshare\\projectdocuments\\"),
   "quotation.quotation"=>array("dir"=>"../quotationdocuments/", "url"=>"file:///\\\\mysambaserver\\myshare\\quotationdocuments\\"),
 );
 $config_docmanagernodes = array_keys($config_docmanageroptions);