Template for cloud-ready DMS extensions

With Vertec 6.3, cloud ready DMS extensions were introduced. These Interfaces (Extensions) are of the DMS type.

One example, which is supplied and maintained by us, is the SharePoint Online DMS extension.

Basically, other Dms can also be addressed from Vertec. There is an example template, which shows what you need to implement to create an executable DMS extension.

To do this, create a new extension in Vertec in the folder Extension and enter the extension ID DmsExampleExtension.DmsExampleExtension an. The code can then be viewed via the button with the three dots:

To create your own DMS extension, the code can be copied out and used as Scripts  

A DMS extension can also be used in addition to a normal file system. This is done via a prefix, which you can define yourself – the paths are, for example, of the format Dropbox:\meine Dateien\....

It is not possible to use multiple DMS extensions or multiple document libraries in parallel. One installed DMS extension, which connects to a document library, is supported.

If a prefix changes or there is no extension for it, an error is thrown in the corresponding operations.

Introducing a new prefix

To implement a new prefix, follow these steps:

1. Select a prefix that does not yet exist, e.g. MyNewPrefix:
2. Implementing a new DMSMyNewPrefix.py Extension
3. Using paths with MyNewPrefix:\... in Vertec

In Vertec, you can start with this prefix to specify the file location:

MyNewPrefix:\customers\DemoInc\invoice337.pdf

Vertec does not attempt to validate the path itself. As soon as it starts with a prefix, all file handling is handled via the corresponding DMS extension.

A valid prefix:

• contains only upper or lower case letters
• is at least two symbols long (because C:\ is a Windows path, for example)
• is a maximum of 20 symbols long
• is always followed by a colon : and a backslash \

Implementing Extensions

class DmsExampleExtension(VertecExtension):

A Vertec DMS extension must define the following class methods (vertecFilePath is always a path in the form SharePoint:\dir1\dir2\file.txt or MyDmsExt:\dir3\dir4\someOtherFile.docx):

def DirectoryExists(self, vertecFilePath):

Should return True or False, depending on whether the specified directory exists.

def DirectoryCreate(self, vertecFilePath):

Create the specified directory. If not possible, throw an exception with an error message. This method also creates the parent directories.

No return value.

def DirectoryOpen(self, vertecFilePath):

Should open the specified directory in a useful variant, e.g. in a browser view.

No return value.

def DocumentExists(self, vertecFilePath):

Should return True or False, depending on whether the specified document exists.

def DocumentOpen(self, vertecFilePath):

Should open the specified document in a useful variant, e.g. in a browser view.

No return value.

def Storedocument(self, content, vertecFilePath, activity):

Vertec has created an in-memory file to be saved in the DMS.

• content: In-memory byte array containing the contents of the file.
• vertecFilePath: the destination file path
• activity: provides a context for transferring metadata.

No return value.

def create_or_update_folder(self, project):

As of Vertec 6.8.0.11. Optional feature. If it is present in the installed DMS extension, the menu item appears on individual projects in the Actions menu / in the context menu on right click Im DMS aktualisieren:

When the feature is called, the method is executed in the DMS extension and the selected project is passed as a project. What exactly happens with this in the target system can be implemented here.    

No return value.