Skip to content
Nappai Documentation

OpenKM Folders

OpenKM Folders connects your flow to the OpenKM document management system to organise folders: create a new folder, read its properties, list what it contains, move it, rename it or delete it.

To work with the documents inside, use OpenKM Documents.

When to use it

  • A new client signs up and you want to create their folder in OpenKM.
  • You want to know which documents and subfolders a folder holds, to review or process them one by one.
  • A project closes and you want to move its folder to the archive area.
  • You want to rename a folder when a client’s or project’s name changes.
  • You want to delete temporary folders that are no longer used.

Configuration

You need an OpenKM credential with your server address, your username and your password. See Credentials.

FieldWhat it does
Credential (required)The OpenKM credential used to access the system.
Operation (required)What the component does. See Operations. Default: List Contents.
Folder ID / UUIDThe identifier of the folder you work on. Required in every operation except Create Folder.
Parent Folder UUIDOnly in Create Folder. The identifier of the folder the new one is created in. Required.
Folder NameOnly in Create Folder. The name of the new folder. Required.
Destination Folder UUIDOnly in Move Folder. The identifier of the folder it is moved into. Required.
New NameOnly in Rename Folder. The folder’s new name. Required.

Operations

OperationWhat it does
Create FolderCreates a new folder inside another one.
Get PropertiesReturns the properties OpenKM keeps for a folder, such as its path.
List ContentsLists what a folder contains: its subfolders and its documents.
Delete FolderDeletes a folder.
Move FolderMoves a folder into another one.
Rename FolderChanges a folder’s name.

Output

The Data output returns OpenKM’s answer. List Contents returns one item per subfolder or document, with its identifier and path, which you can pass to another step. Get Properties returns the folder’s properties. The other operations return OpenKM’s confirmation or a summary of what was done.

The component can also be connected to an Agent as a tool. See Tool Mode.

Example

A law firm creates a folder for every new client.

  1. The flow starts when a client is registered in your CRM.
  2. Add OpenKM Folders with the Create Folder operation.
  3. In Parent Folder UUID enter the identifier of the clients folder and in Folder Name connect the client’s name.
  4. Keep the identifier of the new folder, returned in Data, to upload the client’s documents later with OpenKM Documents.