Below you will find a description how to model a CMIS connection in your Blueriq application. With this connection it will be possible to upload documents to your Blueriq session, upload documents to a Document Management System and manage the data of these documents within your application. At this moment only the DMS Alfresco is supported.

1. Required elements

The following CMIS components are needed in Blueriq Studio:

• AQ_webfile upload (container)
• AQ_CMIS_Documentmanager (service)
• AQ_CMIS_GetDocumentMetadata (service)
• AQ_CMIS_DownloadDocument (container)
• AQ_Document_Renderer (container)

The folowing plugins need to be installed in Blueriq Runtime:

• CMIS plugin
• WebFileUpload plugin

2. Modelling

Download the CMIS Example package and extract the files to Blueriq\Studio\Configuration\Libraries (make sure you have the latest update of Blueriq).

Now create a new project with the project name CMIS example and use the CMIS example package as input.

The studio model wil automatically start and you can see how you can set up the CMIS connection. 

2.1 Make your domainmodel suitable to handle documents 

At first the user should make it possible that your domain can handle documents. Therefore you need to create a document entity where you can store the meta data of the document data that you will get back from the DMS. It's also recommended to have a entity to store the file name and file path that you need for the AQ_WebFileUpload container.

Note : when creating attributes, make sure they have the same properties as defined in the DMS!

The Document meta data entity consist of some basic document attributes:

• FileName
• Unique ID
• CreatedBy
• Creation date
• Modfied by
• Last modified on
• Version

You can also define some custom properties, for example case information. Please remind that you will need to define the document property with the document type as configured in Alfresco (in this example br: ).

2.2 Uploading file to the profile session

Uploading a document with the CMIS connection consist out of 2 steps, the first step is storing the document to the profile session and the second step is actually storing (sending) the document into the DMS. 

For the first step you have to create a flow with a page on it, this page contains the AQ_WebFileUpload container.

The WebFileUpload container contains two parameters, the file name attribute where the document path will be stored and a text item, where you can define the test to show on your screen after a successful upload to session.

Keep in mind that document store function only supports one document on the session at a time.

2.3 Documentmanager

For the second step of storing the document into the DMS, you need to model the documentmanager service .

Create a Documentmanager_Save service with the AQ_CMIS_DocumentManager and define the following parameters:

• Action : Store
• Document Name or Id is mandatory
• The document path, this is the path in your DMS where the document should be placed.
  This document path in this example is placed on the screen so it can be manually defined. In practice it's wise to derive the document path by a decision table.
• The Remove from scope means that after a successful upload of the document to the DMS the document, the document will be removed from the session so a new document can be placed.

The document manager is also used when you want to delete or update a document.

In this case create 2 service:

• DocumentManager_Update service for updating the DMS
  Using parameter action Save
• DocumentManager_Delete service for deleting the document from the DMS
  Using the parameter action Delete, when selecting the option Delete all, all versions of the document will be removed from the DMS.

2.4 Get Document (Meta) Data

After uploading a document, you can use the GetDocumentMetaData service, to receive the data of the uploaded documents from the DMS.

Create a service with the AQ_CMIS_GetDocumentMetaData and fill in at least all the basic document properties (and custom properties if needed) as described in 3.1. Don't forget the document type in case of using custom properties.

After downloading the Document (meta) data, you can show the downloaded document on your screen with the AQ_CMIS_DownloadDocument container, this will create a download link on your screen. This download link is a text item which the user can define.

2.5 Generating a Blueriq Document and store it to session

Instead of selecting a document from a directory on you hard drive, it is also possible to generate a Blueriq Document with the AQ_DocumentRenderer service and place this document as PDF on your profile session.

The following two parameters are required to create :

• Document name you have to define the name of the Blueriq document that you would like to generate (between " ")
  Document type, the only supported type is PDF

The generated PDF document can be saved to the DMS with the DocumentManager_Save service. Please make sure that the required document file name and the document path name is derived! 
 

3. Runtime 

Download here an example project.