Mayan EDMS Documentation, Release 2.1.1
Test improvements Instead of a flat file, each app now has a tests/ directory containing tests modules for
each particular aspect ofan apps,ie:,, The total number and coverage of
tests has been greatly increased.
Indexes recalculation Indexes are now recalculated on when a new document is ready as well as the when the
metadata of a document changes. This allows indexing documents not only based on their metadata but also based on
their properties.
Upgrade command To reduce the steps and complexity of upgrades, the new performupgrade management com-
mand was been added. All the upgrade steps will be performed by this command.
Adminchanges Installationadmins are no longer required tohave the superusers orstaff Django account flags. All
setup tasks are now governed by a permission which can be assigned to a role.
OCR functions split The textual content of a document as interpreted by the OCR now resides as data in the ocr
app and not in the documents app as before. OCR content might not be available for all documents after the upgrade
and might need to be queued again. To help with this situation there is new tool called OCR all documents for this
exact situation.
New internal document creation workflow The new document upload code now returns a document stub while
content is processing. This allows API users tohave the document id ofthe document just uploaded and perform other
actions on it while it becomes ready for access.
Auto logging App logging tothe console is now automatically enabled. IfDjango’s DEBUGflagis True the default
level for auto logging is DEBUG. If Django’s DEBUG flag is False (as in production), the default level changes
to INFO. This should make it easier to add relevant messages to issue tickets as well as a adecuate logging during
Other changes
• Merge ofdocument_print and document_hard_copy views.
• New class based andmenu based navigation system.
• Re-purpose the installation app.
• New class based transformations.
• Usage of Font Awesome icons set.
• Move document text content display code to the OCR app.
• Add new permissions PERMISSION_OCR_CONTENT_VIEW.
• Document type OCR settings move to the OCR app.
• New dependencies:
– django-autoadmin
– django-pure-pagination
– djangorestframework-recursive
4.1. Final releases
Convert pdf to word searchable text - SDK software API:C# PDF Convert to Text SDK: Convert PDF to txt files in, ASP.NET MVC, WinForms, WPF application
C# PDF to Text (TXT) Converting Library to Convert PDF to Text
Convert pdf to word searchable text - SDK software API:VB.NET PDF Convert to Text SDK: Convert PDF to txt files in, ASP.NET MVC, WinForms, WPF application
VB.NET Guide and Sample Codes to Convert PDF to Text in .NET Project
Mayan EDMS Documentation, Release 2.1.1
• Management command to remove obsolete permissions: purgepermissions.
• Normalization of ‘title’and ‘name’ fields to ‘label’.
• Improved API, now at version 1.
• Invert page title/project name order in browsertitle.
• Use Django’s class based views pagination.
• Reduction of text strings.
• OCR all documents.
• Add tool to OCR all documents of a type.
• Fix renderingof text files with Unicode characters.
• Capture bodyof emails as a text document.
• All app APIs are top level URLs.
• CI using gitlab-ci.
• Coverage report with
• Thumbnails for documents in trash.
• Production deployment documentation chapter.
• Command line to create an initial settings file: createsettings.
• Initialsetup now continues even is a settings/ exists.
• default_app_config for each app.
• Natural key support for many models allowing database migrations using dumped data.
• Separate documentation requirements file to allow forcontributor who only want to work on documentation.
• Centralized testing with a new management command, runtests.
• Addition of a tox testing configuration.
• Email test body capture.
• Email subject and from values storage.
• Gitlab CIsupport.
• Codecov support.
• Improve text file rendering.
• Showother packages licenses.
• Task delay to allow DB replication.
• Automatic debug logging and info logging during production.
• Removal ofthe CombinedSource class.
• Removal ofdefault class ACLs.
• Removal ofthe ImageMagick and GraphicsMagick converter backends.
• Remove support forapplying roles to new users automatically.
Chapter 4. Release notes
SDK software API:VB.NET PDF Convert to Word SDK: Convert PDF to Word library in vb.
Convert PDF to Word in both .NET WinForms and ASP.NET webpage. Create high quality Word documents from both scanned PDF and searchable PDF files without losing
SDK software API:C# HTML5 Viewer: Load, View, Convert, Annotate and Edit Word
C# users can convert Convert Microsoft Office Word to searchable PDF online, create multi Word text is searchable when users use Word text search
Mayan EDMS Documentation, Release 2.1.1
• Removal ofthe DOCUMENT_RESTRICTIONS_OVERRIDE permission.
• Removed the page_label field.
• Removal ofcustom HTTP 505 error view.
Upgrading from a previous version
Using PIP Type in the console:
$ pip install -U mayan-edms
the requirements will also be updated automatically.
Using Git If you installed MayanEDMS by cloningthe Git repository issue the commands:
$ git reset --hard HEAD
$ git pull
otherwise download the compressed archived and uncompress it overriding the existing installation.
Next upgrade/add the new requirements:
$ pip install --upgrade -r requirements.txt
Common steps Migrate existing database schema with:
$ performupgrade
During the migrationseveral messages of stale content types can occur:
The following content types are stale and need to be deleted:
Any objects related to these content types by a foreign key will also
be deleted. Are you sure you want to delete these content types?
If you're unsure, answer 'no'.
Type 'yes' to continue, or 'no' to cancel:
You cansafely answer“yes” to all.
Add new static media:
$ collectstatic --noinput
Remove unused dependencies:
$ pip uninstall South
$ pip uninstall GitPython
$ pip uninstall psutil
$ pip uninstall python-hkp
$ pip uninstall django-sendfile
$ pip uninstall django-pagination
$ pip uninstall slate
The upgrade procedure is now complete.
4.1. Final releases
SDK software API:VB.NET Create PDF from Word Library to convert docx, doc to PDF in
Easy to create searchable and scanned PDF files from Word. Convert Word to PDF file with embedded fonts or without original fonts fast.
SDK software API:VB.NET Image: Robust OCR Recognition SDK for VB.NET, .NET Image
and more companies are trying to convert printed business you are executing character and word recognition. Texts will be outputted as searchable PDF, PDF/A,TXT
Mayan EDMS Documentation, Release 2.1.1
Backwardincompatible changes
• Current document and document sources transformations will be lost during upgrade.
• Permissions and Access Controls granted to users and/or groups will be lost during upgrade.
Bugs fixedor issues closed
• GitHubissue#33Update to Django 1.7
• GitHubissue#59New bootstrap based UI
• GitHubissue#60Backport class based navigation code from the unstable branch
• GitHubissue#62Simplify and reduce code in templates
• GitHubissue#67Python 3 compatibility: Update models __unicode__ methdo to __str__ methods (using
Django’s six library)
• GitHubissue#121Twitter Bootstrap theme for Mayan EDMS
• GitHubissue#155Header does not fit list on documents/list on small screens (laptop)
• GitHubissue#170Remove use of python-hkp
• GitHubissue#182Reorganize signal processors
• GitLabissue#131error on initialsetup: GPGinitialization error
• GitLabissue#135Add document indexing filesystem mirroring
• GitLabissue#141Merge common and main app
• GitLabissue#142New authentication app
• GitLabissue#145Convert document tags to user RGB value for code instead of predetermined choices
• GitLabissue#150Add ‘trash can’ support
• GitLabissue#151Add support for data retention policies
• GitLabissue#152JSON API 500 error
• GitLabissue#154/documents API endpoint should return document pk
• GitLabissue#155Remove unused document page label field
• GitLabissue#156Remove post OCR language cleanup
• GitLabissue#158Django REST Swagger not working
• GitLabissue#159Errorduring template rendering on /document/folder/add with non-admin user
• GitLabissue#160Add audit logging
• GitLabissue#163Removal of the compressed file support
• GitLabissue#164Keep fancybox prev & next buttons enabled all the time
• GitLabissue#167Add workflow completion number to states
• GitLabissue#168Add field to store last error of source during execution
• GitLabissue#171tesseract fails with german language (wrong abbreviation)
• GitLabissue#173Add post_document_upload signal
• GitLabissue#174Bootstrap UIwith master branch
Chapter 4. Release notes
SDK software API:C# Create PDF Library SDK to convert PDF from other file formats
Best C#.NET component to create searchable PDF document from Microsoft Office Word, Excel and PowerPoint. Create writable PDF from text (.txt) file.
SDK software API:C# Create PDF from Word Library to convert docx, doc to PDF in C#.
Easy to create searchable and scanned PDF files from Word. Convert to PDF with embedded fonts or without original fonts fast.
Mayan EDMS Documentation, Release 2.1.1
• GitLabissue#176Replace default email domain
• GitLabissue#177Multi page tiffpreview is not working
• GitLabissue#178Add separate missing optional metadata and missing required metadata tools
• GitLabissue#181Move task <-> queue assignment to
• GitLabissue#182Document tags widget is not permissions aware
• GitLabissue#183Separate metadata validators into: validators and parsers
• GitLabissue#184Move literals in checkouts and to
• GitLabissue#186Scheduled task to delete all document stubs ofmore than X age.
• GitLabissue#187Add tests for multi page tiff files
• GitLabissue#189Use transient queues
• GitLabissue#190Bump APIversion number
• GitLabissue#192Use local model fordocument comments
• GitLabissue#197Add continuous integration that is compatible with Gitlab
• GitLabissue#201Untranslated items
• GitLabissue#202AutoAdminSingleton matching query does not exist.
• GitLabissue#203KeyError at /sources/upload/document/new/interactive/
• GitLabissue#204Problems to add required metadata after changinthe document type
• GitLabissue#216Add default_app_config value to each app
• GitLabissue#223[Documents] Triggerevent_document_type_change on the model not on the view
• GitLabissue#227decoderzip not available
• GitLabissue#228Attribute error when trying to attach a tag for a user with inadequate permissions
• GitLabissue#229Attribute error when a user tries to download a document - version 2.0.0b2
• GitLabissue#230No option to create new document version even though user given permission in document
• GitLabissue#231Usershownoptiontoupload newversion ofa document eventhoughitis blockedbycheckout
• GitLabissue#233Available users instead of available groups
• GitLabissue#237Forcefully checking in a document by a user without adequate permissions throws out an
4.1.2 1.0 series
Mayan EDMS v1.1.1 release notes
Released: May 21,2015
What’s new
Update to Django 1.6.11 The required version ofDjango has been updated to version1.6.11.
4.1. Final releases
SDK software API:VB.NET PDF Convert to HTML SDK: Convert PDF to html files in vb.
Why do we need to convert PDF document to HTML webpage One is that compared with HTML file, PDF file (a not be easily edited), is less searchable for search
SDK software API:C# PDF Convert to HTML SDK: Convert PDF to html files in
library also makes PDF document visible and searchable on the Internet by converting PDF document file to Use C#.NET Demo Code to Convert PDF Document to
Mayan EDMS Documentation, Release 2.1.1
Minor changes
• Fix script
• Add test for issue #163
• Activate tests for the sources app
• Removal ofthe registration app
• New simplified official project description
• Improvements to the index admin interface
• Removal ofinstallation statistics gathering
• Remove unused foldertag
• Fix usage of ugettext to ugettext_lazy
• Increase size of the lock name field
• New style documentation
Upgrading from a previous version
Using PIP Type in the console:
$ pip install mayan-edms==1.1.1
the requirements will also be updated.
Using Git If you installed MayanEDMS by cloningthe Git repository issue the commands:
$ git reset --hard HEAD
$ git pull
otherwise download the compressed archived and uncompress it overriding the existing installation.
Next upgrade/add the new requirements:
$ pip install --upgrade -r requirements.txt
Common steps Add new static media:
$ collectstatic --noinput
The upgrade procedure is now complete.
Backwardincompatible changes
Bugs fixedor issues closed
Chapter 4. Release notes
Mayan EDMS Documentation, Release 2.1.1
Mayan EDMS v1.1 release notes
Released: February 10, 2015
Welcome to Mayan EDMSv1.1
What’s newinMayan EDMS v1.1
Celery All background tasks processing has been converted to useCelery. By default Mayan EDMS runs in “Ea-
ger” until a broker and result backend are configured as perCelery’sdocumentation. This change made the built-in
scheduler and job_processingapps obsolete, both were removed.
Views namespaces All views arenamespaced with the name of the app which defines them. If you have developed
3rd party apps for Mayan EDMS be sure to update any reference to a view by prepending the app name to the view
Removal ofthe splashscreen The static image home screen has been replaced with a quick links view,showing the
mostusedactions: Uploadingdocuments,viewingrecentdocuments,viewing all documents and searchingdocuments.
Sending and receiving documents via email A link or entire documents can be sent as attachments via email.
Documents can also be received via email with the addition of two document sources named IMAP and POP3 which
correspond to the mail protocol used to fetch the documents. Read Django’semailconfigurationsettingsdocumenta-
Update to Django 1.6.8 Mayan EDMS has been updated to use Django 1.6.8.
Events app The built-in history app has been removed in favor of a new events wrapper app forDjangoactivity
Watch folders Filesystem folders can be monitored for change and their files automatically uploaded as documents
in Mayan EDMS.
Vagrant file included A vagrant file is now included to allow developers to provision a virtual machine with the
latest development version ofMayan EDMS.
User locale profile (language and timezone) Interface language and locale setting can now be setup for each user
and are not installation wide as before. Date and times offsets are automatically ajusted to each user’s timezone
Document states A new simple workflow app that can represent document states has been included.
Explicit document types needed per index Indexes can now be tied to document types, eliminating the need to
update indexes for every document update. Indexes will only update when a document of the type to which they are
associated is updated.
4.1. Final releases
Mayan EDMS Documentation, Release 2.1.1
Optional and required metadata types Metadata types can now be assigned in two ways to documents types, as
optional or required. Values for required metadata types as the name implies, must be entered for documents to be
able to be uploaded. Optional metadata types on the otherhandcan be left blank by the user.
Bulk document type change It is now possible to change the document type of previously uploaded documents.
When the document type of a document is changed the metadata values are reset and the metadata types of the new
document type are automatically assigned.
New release cycle Startingwith this version a new release cycle methodology willcome into effect. The goal of this
release cycle is to allowtwo series ofversions ofMayanEDMSto be active at a given time: A newmajorversionwith
new functionality and a minor version providing upgrades and fixes. This release (1.1) will be active and supported
during releases of versions 2.x, but will go into end-of-life as soon as version 3.0 is released, at which time version
series 2.xwill go into maintenance mode.
DeprecationofPython2.6 Series 1.0of Mayan EDMS willbe the last series supportingPython 2.6. Series 2.0will
be using Django 1.7.x which itself requires Python 2.7 orlater.
Improved testings Mayan EDMSis nowautomatically tested against SQLite,MySQL and PostgreSQL.
API updates Many new API endpoints have been added exposing the majority ofMayan EDMS functionality.
Messages contextual improvements Many updates and simplifications were made to the source text messages to
reduce the difficulty oftranslating Mayan EDMS and maintaing the contextual meaning of the text messages.
Improved method for custom settings Custom settings now use a string based value, it is longer needed to import
classes when customizing a setting:
from custom_app.backends import CustomStorageBackend
Instead the fully qualifiedname of the class must be passed as the setting value:
DOCUMENTS_STORAGE_BACKEND 'custom_app.backends.CustomStorageBackend'
Removal of the OCR config setting OCR behavior is now a document type property meaning that it can be turned
on or offforspecific document types.
Per document language setting Previously the document language used for OCR was specified for the entire in-
stallation. Ifdocuments in multiple languages were uploaded some suffered lower success rates. Nowthe language of
each document can be specified.
Metadata validation and parsing support It is now possible to create functions to validate metadata value input
or parse and store corrected values. Three sample metadata validations functions are included: Parse date and
time, Parse date and Parse time.
Removal of 960 grid system in favor Pure CSS’s grid system
By using Pure CSS’s columns based grid system,
the move towards a Bootstrap UImigration has advanced greatly.
Chapter 4. Release notes
Mayan EDMS Documentation, Release 2.1.1
Simplified UI All user actions as well as the logout button are now underthe userfunctions section.
Stable PDF previews generation The way PDF were being generated has been improved greatly eliminating spu-
rious segmentation faults at the expense ofa small speed penalty.
More technical documentation Many newsub topics were added to the development section of the documentation
to allow developers to better understand the innerworkings and philosophies ofMayan EDMS.
Other changes
• Removal ofthe MAIN_SIDE_BAR_SEARCH setting
• Removal ofTHEMES and themes support
• Removal ofVERBOSE_LOGIN setting
• Removal ofgraphics backend supported file format list view
• Removal ofthe MAIN_DISABLE_ICONS setting
• Removal ofspecialized Sentry support
• Removal ofthe MAIN_ENABLE_SCROLL_JSsetting
• Remove hardcoded root (/) redirections
• Removal ofAPSCheduler as a requirement
• Removal ofthe scheduled jobs view
• Removal ofthe web_theme app
• Removal ofthe sources icon selection support
• Removal ofthe in-app help panels
• Removal ofthe duplicate document search feature
• Removal offilesystem document indexes mirroring feature
• Improve sources app model sub classes and inheritance handling
• Addition of CORS support to the API
Upgrading from a previous version
IMPORTANT! Before runningthe upgrade make sure none ofyour documents have duplicatedmetadata types, mean-
ing that the same metadata type must not appeartwice forany given document.
If you installed Mayan EDMS by cloning the Git repository issue the commands:
$ git reset --hard HEAD
$ git pull
otherwise download the compressed archived and uncompress it overriding the existing installation.
Next upgrade/add the new requirements:
$ pip install --upgrade -r requirements.txt
Migrate existing database schema with:
4.1. Final releases
Mayan EDMS Documentation, Release 2.1.1
$ migrate dynamic_search 0001 --fake
$ migrate history 0001 --fake
$ migrate linking 0001 --fake
$ migrate lock_manager 0001 --fake
$ migrate tags 0001 --fake
$ migrate
During the migrationseveral messages of stale content types can occur:
The following content types are stale and need to be deleted:
metadata | documenttypedefaults
metadata | metadataset
metadata | metadatasetitem
ocr | documentqueue
ocr | queuedocument
sources | watchfolder
sources | outofprocess
sources | webform
sources | stagingfolder
tags | tagproperties
Any objects related to these content types by a foreign key will also
be deleted. Are you sure you want to delete these content types?
If you're unsure, answer 'no'.
Type 'yes' to continue, or 'no' to cancel:
You cansafely answer“yes”.
Add new static media:
$ collectstatic --noinput
Remove unused dependencies:
$ pip uninstall APScheduler
$ pip uninstall django-taggit
The upgrade procedure is now complete.
Backwardincompatible changes
• You will have to redefine yourdocument sources due to the new extended models for this app.
• Checkyour configurations of smart links and indexes to use the newly provided arguments.
Bugs fixedor issues closed
• issue#30 Document workflows
• issue#32 Watched folders
• issue#34 Postprocessing document queue
• issue#35 Metadata validation
• issue#37 Add from __future__ import unicode_literals
Chapter 4. Release notes
Documents you may be interested
Documents you may be interested