docbow/docbow_project/pfwb/README.txt

59 lines
2.1 KiB
Plaintext

Docbow Plugin: PFWB plugin
==========================
This plugins add many adpation to the PFWB context. I allows to associate a
Plone GED portail document type to any file type inside Docbow. For such
filetypes, all posted documents are dump into a directory as a pair: the
attached file and json file describing the document.
Settings
========
GED export
----------
You must add the following lines to your local_settings.py file::
from docbow_project.settings.dev import INSTALLED_APPS
INSTALLED_APPS += ('docbow_project.pfwb',)
Then you must define in the same local_settings.py file the directory where new
attached files will be written, for example::
DOCBOW_PFWB_GED_DIRECTORY = '/var/lib/plone/docbow_import_directory/'
SMTP interface
--------------
PFWB_SENDMAIL_DEFAULT_TYPE_ID: default FileType id for mails with unknown filetype
PFWB_SENDMAIL_DEFAULT_TYPE_NAME: default FileType name to create if no default FileType id exists
PFWB_SENDMAIL_TABELLIO_EXPEDITION_EMAIL: email to match for accepting mails
coming from Tabellio expedition
PFWB_SENDMAIL_TABELLIO_EXPEDITION_USER_ID: id of the user to assign to document
received from tabellio expedition
PFWB_SENDMAIL_ATTACHED_FILE_EMAIL: email to match for accepting mails with
files attached
PFWB_SENDMAIL_ATTACHED_FILE_USER_ID: user id of the user to assign to document
received with files attached
File naming
===========
For any attached file named my_document.pdf two files are created:
2013-01-12T23:24:24.34333-my_document.pdf
2013-01-12T23:24:24.34333-my_document.pdf.json
Those name are composed of the date at the time of the posting and the original
file name of the posted file. The JSON file containss the following keys:
Key name Description
================= ======================
reception_date The ISO8601 date and time of the posting
description The description attached to this posting
sender First name, last name and username (between parenthesis) of
the sender
plone_portal_type The plone portal type configured for the file type of the
document
title The docbow file type