Sharepoint DWS Triggers v. 0.1

Overview

Microsoft Office SharePoint Server includes document management features that you can use to control the life cycles of documents in your organization — how they are created, reviewed, published, secured, and consumed, and how they are ultimately disposed of or retained.

Requirements

• Microsoft Office SharePoint 2007. Currently only this version of SharePoint has been tested with ProcessMaker.

Creating a Sharepoint Trigger

Go to DESIGNER tab and then select TRIGGERS option.

By clicking on New a list of triggers will display:

Choose Sharepoint DWS Triggers v.0.1 (12)', triggers will listed in order to created them.

Listing the available triggers

Create a DWS in Sharepoint server(createDWS())

This trigger will create a DWS(Document workspace) in Sharepoint Server with the desired name.

Parameter List

• sharepointServer(r)): Sharepoint Server url path along with the port number if any.
• auth(r): Authentication for Sharepoint, the credentials should be in this form:

So say for example username is user1 and password is pass1, please enter the following string “user1:pass1”

• name(o): Name of DWS
• users(o): Relevant User of Sharepoint.
• title(r): Title of the newly created DWS
• documents(o): document(in string form) that need to be attached to the newly created DWS.

Create a folder in a DWS(createFolderDWS())

This Trigger will create a folder with a desired name in the DWS specified.

Parameter List

• sharepointServer(r): Sharepoint Server url path along with the port number if any.
• auth(r): Authentication for Sharepoint, the credentials should be in this form:

So say for example username is user1 and password is pass1, please enter the following string “user1:pass1”

• dwsname(r): Name of DWS(Document WorkSpace) in which folder is to be created.
• folderName(r): Name of the Folder to be created in the DWS(Document WorkSpace).

Get DWS data (getDWSData())

This Trigger will return basic data of the file/document specified.

Parameter List

• sharepointServer(r): Sharepoint Server url path along with the port number if any.
• auth(r): Authentication for Sharepoint, the credentials should be in this form:

So say for example username is user1 and password is pass1, please enter the following string “user1:pass1”

• newFileName(r):Name of the file who’s basic data is required.
• dwsname(r): Name of DWS in which document resides.
• lastUpdate(o): enter the last update date and time.

Get DWS Meta-data (getDWSMetaData ()):

This Trigger will return MetaData of the file/document specified.

Parameter List

• sharepointServer(r): Sharepoint Server url path along with the port number if any.
• auth(r): Authentication for Sharepoint, the credentials should be in this form:

So say for example username is user1 and password is pass1, please enter the following string “user1:pass1”

• newFileName(r):Name of the file who’s basic data is required.
• dwsname(r): Name of DWS in which document resides.
• Id(r): Document id, whose metadata, is required.

Get DWS Folder items (getDWSFolderItems ())

This Trigger will return Content/Children of Folder specified.

Parameter List

• sharepointServer(r): Sharepoint Server url path along with the port number if any.
• auth(r): Authentication for Sharepoint, the credentials should be in this form:

So say for example username is user1 and password is pass1, please enter the following string “user1:pass1”

• dwsname(r):Name of DWS where the folder resides, whose children are to be listed.
• strFolderUrl: Folder Name whose children are to be listed.

Get DWS Document Versions (getDWSDocumentVersions())

This Trigger will return the document version of the specified document.

Parameter List

• sharepointServer(r): Sharepoint Server url path along with the port number if any.
• auth(r): Authentication for Sharepoint, the credentials should be in this form:

So say for example username is user1 and password is pass1, please enter the following string “user1:pass1”

• newFileName:name of the file whose version is to be retrieved.
• dwsname: Name of the DWS where the Folder resides.

Copy/Upload Documents to DWS folder (uploadDocumentDWS())

This Trigger will upload the file to a specified Folder in DWS of Sharepoint Server.

Parameter List

• sharepointServer(r): Sharepoint Server url path along with the port number if any.
• auth(r): Authentication for Sharepoint, the credentials should be in this form:

So say for example username is user1 and password is pass1, please enter the following string “user1:pass1”

• dwsname(r):Name of DWS, where file would be uploaded.
• sourceUrl(r): path of the file to be uploaded from the local directory.
• Filename(r): name of the file to be uploaded.

Download DWS Documents (downloadDocumentDWS())

This Trigger will download file in the specified location.

Parameter List

• sharepointServer(r): Sharepoint Server url path along with the port number if any.
• auth(r): Authentication for Sharepoint, the credentials should be in this form:

So say for example username is user1 and password is pass1, please enter the following string “user1:pass1”

• dwsname(r):Name of DWS from where the document is to be downloaded.
• Filename: File Name which is to be downloaded.
• fileLocation: path(local path) where we would be downloading the file.

Delete DWS Document Version (deleteDWSDocumentVersion())

This Trigger will delete the specified document version.

Parameter List

• sharepointServer(r): Sharepoint Server url path along with the port number if any.
• auth(r): Authentication for Sharepoint, the credentials should be in this form:

So say for example username is user1 and password is pass1, please enter the following string “user1:pass1”

• newFileNamename of the file whose version is to be retrieved.
• dwsname: Name of the DWS where the Folder resides.
• versionNum: version number of the document to be deleted.

Delete all DWS Document Versions (deleteDWSAllDocumentVersion())

This Trigger will delete all Document versions except the latest one.

Parameter List

• sharepointServer(r): Sharepoint Server url path along with the port number if any.
• auth(r): Authentication for Sharepoint, the credentials should be in this form:

So say for example username is user1 and password is pass1, please enter the following string “user1:pass1”

• newFileNamename of the file whose versions are to be deleted.
• dwsname: Name of the DWS where the File resides.

Delete a DWS in Sharepoint server(deleteDWS())

This trigger will delete the specified DWS(Document WorkSpace) from the SharePoint Server.

Parameter List

• sharepointServer(r): Sharepoint Server url path along with the port number if any.
• auth(r): Authentication for Sharepoint, the credentials should be in this form:

So say for example username is user1 and password is pass1, please enter the following string “user1:pass1”

• dwsname(r): Name of DWS(Document WorkSpace) to be deleted.

Delete a DWS folder (deleteFolderDWS())

This Trigger will delete the specified folder from the DWS specified. Parameter List

• sharepointServer(r): Sharepoint Server url path along with the port number if any.
• auth(r): Authentication for Sharepoint, the credentials should be in this form:

So say for example username is user1 and password is pass1, please enter the following string “user1:pass1”

• dwsname(r): Name of DWS(Document WorkSpace) in which folder is to be created.
• folderName(r): Name of the Folder to be deleted in the DWS(Document WorkSpace).