Version: 2025.1.1

Item Flows

Overview​

Item Flows present the Users an overall list of ways they can either:

  • add items to the system (direction=in), like creating new folders, uploading files, etc...
  • processing/exporting items (direction=out), like printing, downloading, etc...

As an Admin you can configure to start this Dialog showing all the different Flows, or pre-select an existing one.

inPoint.Web comes pre-packaged with a pre-configured list of Categories and Item Flows, you can:

  • override any one of those or
  • add your custom ones

See Configuration for setting this up.

Categories​

Following predefined Category ids are currently available:

all​

document​

folder​

Items Flows​

Following predefined Flow ids are currently available:

doc_upload​

Archive a new Document into the current Folder.
Uses the itemFlow_document CommandAction.

doc_photo​

Archive a new Photo into the current Folder.
Uses the itemFlow_document CommandAction.

doc_inNewFolder​

Archive a new Document into a new folder within the current folder Uses the itemFlow_folderAndDoc CommandAction

Special IDs​

Following IDs are just used as "placeholders" - the Server will replace them with as many items as it can find depending on the placeholder.

sys-docTemplates​

List all Document Templates available at the current Folder.
Uses the itemFlow_docTemplate CommandAction.

sys-folderTemplates​

List all Folder Templates available at the current Folder.
Uses the itemFlow_folderTemplate` CommandAction.

sys-folderFormats​

List all Folder Formats available at the current folder.
Uses the itemFlow_folder CommandAction.

CommandActions​

Following CommandActions are the only ones that can be used as Flows

itemFlow_document​

Opens the Upload Dashboard allowing the user to select a file to upload after filling the Classification Form.

    "commandAction": {
        "name": "itemFlow_document",
        "props": {
            "openBrowseDialog": true,
            "openCamera": false
        }
    }

commandAction.props:​

openBrowseDialog​

Default: false
Whether to automatically open the File Browse Dialog (on the User's local machine).

openCamera​

Default: false
Whether to automatically open the "Take a Photo" Dialog.

url​

Allows integration with an external Document Selector (e.g. loading files from OneDrive)

itemFlow_docTemplate​

Opens the referenced Document Template.

    "commandAction": {
        "name": "itemFlow_docTemplate",
        "props": {
            "templateId": "document Template Name"
        }
    }

commandAction.props:​

templateId*​

The FolderTemplate name to use.

itemFlow_folder​

Creates a new Folder with a specific FormatId after filling the Classification Form.

    "commandAction": {
        "name": "itemFlow_folder",
        "props": {
            "templateId": 13
        }
    }

commandAction.props:​

templateId*​

The FormatId to use.

itemFlow_folderTemplate​

Will ask the User for the new root folder name to assign and create the whole folder structure based on the templateId provided.

    "commandAction": {
        "name": "itemFlow_folderTemplate",
        "props": {
            "templateId": "folder Template Name"
        }
    }

commandAction.props:​

templateId*​

The FolderTemplate name to use.

itemFlow_custom​

Opens a Custom URL.

Note: it is the plugin's responsibility to show/fill a Classification Form and actually archive the file.

    "commandAction": {
        "name": "itemFlow_custom",
        "props": {
            "url": "..."
        }
    }

commandAction.props:​

url*​

The URL to open (can be relative or absolute).

itemFlow_folderAndDoc​

Creates a new folder first, in which the documents are getting archived

Note: Requires DocInNewFolderPlugin to be enabled and configured

    "commandAction": {
        "name": "itemFlow_folderAndDoc",
        "props": {
            "openBrowseDialog": "true",
            "templateId": "123",
            "elementType": 2
        }
    }

commandAction.props:​

openBrowseDialog*​

Wheather to open the Uppy Browse Dialog on load or not

templateId*​

Element format id of the folder you want to create

elementType*​

Element Type value associated with the templateId. Valid values are: 1 Root, 2 Organization, 3 Department, 4 Shelf, 5 Folder and 6 Register