Development of a document management module for SAP Enterprise Workspaces
In this blog I want to demonstrate you how we implemented the first certified 3rd party module for the SAP Enterprise Workspaces. With the SAP Enterprise Workspace API we made our extisting product, the btexx documentManager, Workspace aware.
Key features of the btexx documentManager
- Easy document management in the SAP Portal with Drag & Drop support
- Modern user interface for the Knowledge Management (KM) of the SAP Portal
- Build-in preview function for documents and images
- Support of Multiple Up- and Download
- Support of all major KM services, e.g. versioning, subscription, meta data, search, etc.
Discover the highlights of the solution in our video gallery!
Enterprise Workspace Integration
With the public API of the SAP Enterprise Workspaces we could easily integrate our existing solution into the Enterprise Workspaces. Primarily we used the eventing API of the Enterprise Workspaces to create a new document storage within the permission concept of the SAP Enterprise Workspace.
Used API’s / Functions from SAP Enterprise Workspaces
We have created a service which is registered via the portalapp.xml to respond to predefined module events. Those events are e.g. when the module is added or removed form a workspace or a new member has been added to the workspace. Our service implements a couple of callback methods which are invoked when the corresponding event happens.
When the documentManager module is added to a workspace the onCreate-method in our service is invoked which creates a new KM folder for that module inside the workspace CM repository and sets this path as root path for all files and folders for our documentManager module.
When the documentManager module is removed from the workspace another lifecycle method is called, the onDelete method. This method has the function to clean up the unused files and folders.
Furthermore the solution is compliant with the permission concept of the SAP Enterprise Workspaces. The document and folder permissions are automatically aligned with the managers and members of the workspace. This is done via the onAddPrincipal callback method. The event is called when a principal (role) is added to a workspace in which the module is running, also when the workspace permission policy is changed, e.g. from public to restricted).
The btexx documentManager enriches the SAP Enterprise Workspaces with a comfortable document management.