CMIS Document List Widget - bluesoft-rnd/aperte-workflow-core GitHub Wiki

This widget allows user to submit new or update existing files correlated with pending BPM processes. For every process instance a separate folder is maintained inside CMIS repository. All the files inside this directory are listed by this widget.

This plugin is part of CMIS Widget plugin.

Attributes

Please note that documents are stored in ${rootFolderPath}/${newFolderPrefix}${ProcessInstance.internalId}/${subFolder} directory.

Attribute name Type Required Default value Description
repositoryAtomUrl String True - CMIS repository Atom URL.
repositoryUser String True - CMIS repository user.
repositoryPassword String True - CMIS repository password.
repositoryId String True - CMIS repository id.
rootFolderPath String False / CMIS repository root folder path. This path should already exist inside CMIS repository.
subFolder String False - CMIS subfolder name. If no value is given then no subfolder is going to be created and documents will be stored directly into process instance directory.
newFolderPrefix String False - Prefix used when creating a folder dedicated to a process instance on CMIS.
mode String True - Operation mode, possible values are simple and normal. Simple mode allows only one document for every process instance, while normal mode does not enforce such a restriction.
hideMatching String False - Regular expression (java syntax) used for excluding document from the document list. If document name matches the expression, it won't be shown.
required Boolean False False If set to true, at least one document must be uploaded into process instance directory. The widget doesn't distinguish in which step the document was uploaded, it just have to exist during validation.
comment String False - Comment text that will be displayed as widget caption.

Permissions

Permission name Description
EDIT Allows to submit new files. If one does not have VIEW permission, this permission will also grant the ability to view the document list.
VIEW This permission is required to view the document list.

Examples

This example demonstrates usage of CMIS Document List widget.

<config.ProcessStateWidget className="CmisDocumentList" priority="20">
    <permissions>
        <config.ProcessStateWidgetPermission priviledgeName="EDIT" roleName=".*"/>
    </permissions>
    <attributes>
        <config.ProcessStateWidgetAttribute name="repositoryAtomUrl" 
                                            value="http://localhost:8080/nuxeo/atom/cmis"/>
        <config.ProcessStateWidgetAttribute name="repositoryId" value="default"/>
        <config.ProcessStateWidgetAttribute name="repositoryUser" value="Administrator"/>
        <config.ProcessStateWidgetAttribute name="repositoryPassword" value="Administrator"/>
        <config.ProcessStateWidgetAttribute name="rootFolderPath" value="/lr/submissions"/>
        <config.ProcessStateWidgetAttribute name="subFolder" value="incoming"/>
        <config.ProcessStateWidgetAttribute name="newFolderPrefix" value=""/>
        <config.ProcessStateWidgetAttribute name="caption" value="Submission documents"/>
        <config.ProcessStateWidgetAttribute name="required" value="false"/>
        <config.ProcessStateWidgetAttribute name="comment">
            <value>
                Any documents about the submission should be uploaded here.
            </value>
        </config.ProcessStateWidgetAttribute>
    </attributes>
</config.ProcessStateWidget>

Aperte Workflow
http://www.aperteworkflow.org

⚠️ **GitHub.com Fallback** ⚠️