Version: 2024.3.6

Overview

Any Action users can launch in inPoint.Web are defined as Command Actions - their implementation is encapsulated in separate building blocks that can be used and configured in a multitude of places.

inPoint.Web comes pre-packed with an extensive list of Command Actions, and in the future Custom Actions will also be integrated.

CommandActions can be used in Quick Actions or in Item Actions.

Syntax

    "commandAction": {
        "name": "ip_archive",
        "props": {
            "itemUri": "pam-item://hierarchy=50@path=76$1867665"
        }
    }

A CommandAction is always referenced by it's name, and optionally includes a list of props that apply to it.

Reference

editClassification

Edit current Classification in a Modal - supports both Folders and Documents. Will also show a LockInfo warning (if Document is locked), and a warning if the current user is not authorized to edit (read-only mode).

    "commandAction": {
        "name": "editClassification"
    }

ip_archive

calls ip_commandAction

Launches inPoint.Sync ArchiveDialog to enable the user to archive new files.

Note: requires local inPoint.Sync installation!

    "commandAction": {
        "name": "ip_archive",
        "props": {
            "itemUri": "pam-item://hierarchy=50@path=76$1867665"
        }
    }

commandAction.props:

itemUri

Optional itemUri to limit archiving to; if not specified the standard suggestions / search functionality will be available to the user.

ip_browse

calls ip_commandAction

Launches inPoint.Client and browses the specified Folder's itemUri.

Note: requires local inPoint.Sync installation!

    "commandAction": {
        "name": "ip_browse",
        "props": {
            "itemUri": "pam-item://hierarchy=50@path=76$1867665"
        }
    }

commandAction.props:

itemUri*

The target Folder's itemUri to browse.

ip_commandAction

Executes any inPoint.Standalone CommandAction from inPoint.Web

Note: requires local inPoint.Sync installation!

    "commandAction": {
        "name": "ip_commandAction",
        "props": {
            "commandAction": "ItemSendAsEmailCommandAction",
            "itemUri": "pam-item://hierarchy=50@path=76$1867665"
        }
    }

commandAction.props:

commandAction*

inPoint.Standalone CommandAction you want to execute. List of available CommandActions

commandParam

Optional Param for CommandAction

commandOption

Optional Option for CommandAction

itemUri

Optional itemUri (if CommandAction requires item context)

items

Array of items containing itemUri property (if CommandAction supports multiple items and requires item context)

ip_edit

calls ip_commandAction

Launches the original Application to edit the Document's contents.

Note: requires local inPoint.Sync installation!

    "commandAction": {
        "name": "ip_edit",
        "props": {
            "itemUri": "pam-item://hierarchy=50@path=76$1867665@eid=xxxxxxxxxxxxxxxx"
        }
    }

commandAction.props:

itemUri*

Target Document's itemUri to edit.

ip_properties

calls ip_commandAction

Open Properties Dialog.

Note: requires local inPoint.Sync installation!

    "commandAction": {
        "name": "ip_properties",
        "props": {
            "itemUri": "pam-item://hierarchy=50@path=76$1867665"
        }
    }

commandAction.props:

itemUri*

Launches the Properties Dialog just like in inPoint.Client.

searchResult_form

Execute any pre-defined SearchForms.

    "commandAction": {
        "name": "searchResult_form",
        "props": {
            "searchForm": 9411,
            "viewMode": "List",
            "filters": [
                { ... }
            ]
        }
    }

commandAction.props:

The Search form id to run.

viewMode

"List", "Grid" or "Map"

showFilterbar

true or false

filters

Optional extra filters to apply.
Note: if the Search form is configured to AutoBrowseToItem (in the Search Form Wizard) it will automatically browse the one result.

    "filters": [
        {
            "name": "common name",
            "valueType": "valueType"
            "value": any,
            "op": "operator",
            "boostLeafNode": number,
            "nodeType": "AllNodes/LeafNode/CustomNode/Auto"
        }
    ]

name

Name from your field you want to search in (configured in field selection window)

valueType

Depending on the field you referenced in name. This will also affect which/how you pass the value. Possible types:

String
RelativeDate/DateTime
FileSize
ItemType
Decimal
GeoPoint/GeoArea

value

The value you are searching for. The format depends on the valueType and the chosen op; - String: text to search for, e.g. "my home"

RelativeDate: Today, Yesterday, ThisWeek, LastWeek, LastMonth, ThisYear, LastYear
DateTime: standard string format, e.g. YYYY-MM-DD HH:MM:SS
FileSize: number in bytes, e.g. 5000
ItemType: Unknown, Folder, Document
Decimal: any number

`{geolocation}` token

For valueType GeoPoint/GeoArea you can specify as "value": "{geolocation}" which will retrieve the current user's location and use that as the value. Additionally you can also add the property "radius": 1000 to specify the circle radius (in meters).

`{barcode}` token

For valueType String you can specify as "value": "{barcode}" which will open ask the user to scan a Barcode and use that as the value.
Additionally you can also add the property "matchRegexp": "k=(.*)" - QR codes can be passed through a regular expression to retrieve the first group matched (instead of using the whole value).

`{user.Name}` token

The current user's full display name (only with String Equals).

`{user.Id}` token

The current user's ID (only with Decimal Equals)

op

The operator to use for the search; dependent on valueType and the chosen op;

String: Contextor,ContextorContains
FileSize, Decimal: From,To,FromTo
DateTime, RelativeDate: FromToWithTime, FromWithTime, ToWithTime, EqualsWithTime,RelativeDate, FromRelativeTo, FromRelativeToWithTime, FromToRelative,FromWithTimeToRelative,FromRelative, ToRelative
String, FileSize, ItemType, Decimal: Equals
String: Contains, StartsWith, EndsWith
GeoArea/GeoPoint: GeoRadius,GeoArea,GeoRadiusIntersect,GeoRadiusWithin,GeoAreaIntersect, GeoAreaPoint

nodeType

Specify whether:

AllNodes: includes subfolders/documents
LeafNode: only exact matches
CustomNode
Auto

searchResult_geoLocation

Deprecated - please use searchResult_form.

searchResult_barcode

Deprecated - please use searchResult_form.

createFolder_template

Create Folder from FolderTemplate.

    "commandAction": {
        "name": "createFolder_template",
        "props": {
            "template": "Project_Template",
            "itemUri": "pam-item://hierarchy=50@path=76$21546"
        }
    }

commandAction.props:

template*

The name of the folder template.

itemUri*

The root target to create the folder template.

targetFolderName

Optional proposed name for the new Folder

link

Launches any Web Link either within a Modal Window or as a new Browser Window.

    "commandAction": {
        "name": "link",
        "props": {
            "url": "https://support.hs-soft.com/otrs/index.pl"
        }
    }

commandAction.props:

url*

The external target URL to open.
You can use any of following tokens (they are all already URL encoded) that will be replaced before execution:

{itemUri}: the current Folder or Document's full itemUri
{itemUri.Web}: the current Folder or Document's full itemUri (without pam-item://)
{user.Id}: the current users ID
{user.Name}: the current users name
{user.Language}: the current users language
{name}: the current Folder or Document's name

See following useFormTokens parameter for additional tokens.

useFormTokens

Default: false
Whether to retrieve all the current fields/attributes to be able to use them as tokens in the url.
inPoint fields are prefixed with ip., ExtraAttributes with ea. (to avoid name collisions).
If you are open the ItemActions from an ExtraAttribute Grid control, you can access the current rows values with grid. See samples for some use cases.

asModal

Default: false
Whether to open as a Modal popup within inPoint.Web.
NOTE: most websites do not allow this!

title

Optional Title to show on the Modal window or external Browser window.

specs

Optional parameters to pass to window.open (see documentation), e.g.:

if none specified, will open in a new Tab
"width=600px,height=640px": will open a new Window

Samples

Using the link CommandAction allows you to basically integrate and link to any existing system by passing any form field as an argument. Here are some usage examples:

Navigate There

A form has an extraAttribute named "GEOLOC" of type Location/GeoPoint which holds Geo coordinates, the customer would like to open the Google navigation to those coordinates (on Android mobiles the Google Maps app will take over).
Let's integrate this into the itemActions:

{
  "id": "navigateThere",
  "icon": "car",
  "title": { "en": "Navigate There" },
  "commandAction": {
    "name": "link",
    "props": {
      "useFormTokens": true,
      "url": "https://www.google.com/maps/dir/?api=1&destination={ea.GEOLOC}"
    }
  }
}

Call Customer

A form has an inPoint field named "TELEPHONE" of type Text/Telephone which holds a phone number, the customer would like to dial that number (requires an application that can handle those - e.g. on Windows desktop with Microsoft Teams or on Android phone works as-is).
Let's integrate this into the itemActions:

{
  "id": "callPhone",
  "icon": "phone",
  "title": { "en": "Call Customer" },
  "commandAction": {
    "name": "link",
    "props": {
      "useFormTokens": true,
      "url": "tel:{ip.TELEPHONE}"
    }
  }
}

E-Mail a Customer

A form has an inPoint field named "EMAIL" of type Text/Email which holds an email address, the customer would like to open a blank new E-Mail, with the Topic being the current Folder or Document name. Let's integrate this into the itemActions:

{
  "id": "emailCustomer",
  "icon": "envelope-o",
  "title": { "en": "E-Mail Customer" },
  "commandAction": {
    "name": "link",
    "props": {
      "useFormTokens": true,
      "url": "mailto:{ip.EMAIL}&subject=About%20{name}"
    }
  }
}

Start a Teams chat

A form has an inPoint field named "EMAIL" of type Text/Email which holds an email address, the customer would like to start a Microsoft Teams chat, with the Topic being the current Folder or Document name. Let's integrate this into the itemActions:

{
  "id": "teamsChat",
  "icon": "phone",
  "title": { "en": "Call Customer" },
  "commandAction": {
    "name": "link",
    "props": {
      "useFormTokens": true,
      "url": "https://teams.microsoft.com/l/chat/0/0?users={ip.EMAIL}&topicName=About%20{name}&message=Please"
    }
  }
}

Open a mini/flat from an ExtraAttribute Grid Row with an ItemURI as Link

A form has an ExtraAttribute Grid with columns named Status, Category, Link Let's integrate this into the itemActions:

{
  "id": "folderMiniFlat",
  "icon": "folder-open",
  "title": { "en": "Open folder" },
  "category": "folder",
  "views": ["gridEditorControl"],
  "commandAction": {
    "name": "link",
    "props": {
      "url": "mini/flat?uri={itemUri.Web}",
      "asModal": true,
      "icon": "folder-open",
      "title": "{grid.Category} - {grid.Status}",
    },
  }
}

favorite

Toggle favorite flag for a folder or document.

{
  "id": "fav_add",
  "icon": "star",
  "title": { "en": "Add Favorite" },
  "commandAction": {
    "name": "favorite",
    "props": {
      "itemUri": "pam-item://hierarchy=50@path=76$1867665"
    }
  }
}

commandAction.props:

itemUri*

Toggles favorite flag for specified folder or document.

offline_add

Make a folder available offline.

    "commandAction": {
        "name": "offline_add",
        "props": {
            "itemUri": "pam-item://hierarchy=50@path=76$1867665"
        }
    }

commandAction.props:

itemUri*

Makes specified folder available offline.

offline_del

Remove offline availability from a folder.

    "commandAction": {
        "name": "offline_del",
        "props": {
            "itemUri": "pam-item://hierarchy=50@path=76$1867665"
        }
    }

commandAction.props:

itemUri*

Removes offline availability from the specified folder.

folder_preview

Browse a folder.

    "commandAction": {
        "name": "folder_preview",
        "props": {
            "itemUri": "pam-item://hierarchy=50@path=76$1867665"
        }
    }

commandAction.props:

itemUri*

Browses the specified Folder in inPoint.Web.

newWindow

Default: false
Specify true to open in a new Browser Window or leave as false to replace the current view.

toggles

Available Toggles: tree folder's tree, form folder classification, doclist document(s) list
Comma separated list of active toggles, defaults to all being toggled.

folder_editClassification

Edit current Folder's Classification.

    "commandAction": {
        "name": "folder_editClassification"
    }

folder_delete

Asks for confirmation for deleting a Folder.

    "commandAction": {
        "name": "folder_delete",
        "props": {
            "itemUri": "pam-item://hierarchy=50@path=76$1867665",
            "name": "My Folder
        }
    }

commandAction.props:

itemUri*

The target Folder's itemUri to delete.

name*

The Folder's Name.

folder_emailLink

Opens the Share Modal Dialog to Email a Link to a Folder.

See share for configuration details.

clipboard_copyItemLink

Copies the current visible Folder (or Document) as a View link to the Clipboard (using mini-views).

    "commandAction": {
        "name": "clipboard_copyItemLink"
    }

clipboard_copyItemUri

Copies the current visible Folder (or Document) as an ItemUri to the Clipboard.

    "commandAction": {
        "name": "clipboard_copyItemUri"
    }

doc_preview

Opens the DocPreview Modal Window to Preview a Document.

    "commandAction": {
        "name": "doc_preview",
        "props": {
            "itemUri": "pam-item://hierarchy=50@path=76$1867665@eid=xxxxxxxxxxxxxxxxxxx"
        }
    }

commandAction.props:

itemUri*

Open the DocPreview Modal for the specified Document's itemUri.

newWindow

Default: false
Specify true to open in a new Browser Window or leave as false to use the DocPreview Modal Window.

triggerEditMode

Default: false
Specify true to switch the specified Document's itemUri classification into Edit mode

autoSave

Default: false
Specify true to disable the Confirm Dialog, when paginating in Edit Mode. This will enable continuous editing for documents

triggerPrint

Default: false
Specify true to trigger Print Dialog for PDF (previews of) document(s)

toggles

Available Toggles: viewer document viewer, form document classification, act document activity list
Comma separated list of active toggles, defaults to all being toggled.

doc_editWebDav

Opens the local installed Office Application to edit the current file (using WebDav).

    "commandAction": {
        "name": "doc_editWebDav"
    }

doc_editCloud

Opens the local installed Office Application (using WebDav) or the Cloudservices Webeditor to edit the current file.

    "commandAction": {
        "name": "doc_editCloud",
        "props": {
            "itemUri": "pam-item://hierarchy=50@path=76$1867665@eid=xxxxxxxxxxxxxxxxxxx"
        }
    }

commandAction.props:

itemUri*

Open the DocPreview Modal for the specified Document's itemUri.

onlineEditor

Default: false
Specify true to open the online Editor or leave as false to open in local installed Office Application (using Webdav).

doc_related

Opens the DocPreview Modal Window to display related documents.

    "commandAction": {
        "name": "doc_related",
        "props": {
            "itemUri": "pam-item://hierarchy=50@path=76$1867665@eid=xxxxxxxxxxxxxxxxxxx",
            "itemLinkType": 0,
            "getSource": true/false
        }
    }

commandAction.props:

itemUri*

Open the DocPreview Modal for the specified Document's itemUri.

itemLinkType*

Type of related documents you would like to retrieve. Valid values are:

0 for Manual Relations
1 for Workflow Reports
2 for Shortcuts

getSource

Default: false
Either to return the Target (= false) or Source (=true) of the provided itemUris related documents.
NOTE: This flag is needed for itemLinkType.Shortcut to retrieve the original document as preview.

doc_editClassification

Edit current Document's Classification.

    "commandAction": {
        "name": "doc_editClassification"
    }

doc_delete

Asks for confirmation for deleting a Document.

    "commandAction": {
        "name": "doc_delete",
        "props": {
            "itemUri": "pam-item://hierarchy=50@path=76$1867665@eid=xxxxxxxxxxxxxxxxxxx",
            "name": "My Document.docx"
        }
    }

commandAction.props:

itemUri*

The target Document's itemUri to delete.

name*

The Document's Name.

doc_emailLink

Opens the Share Modal Dialog to Email a Link to a Document.

See share for configuration details.

doc_emailAttachment

Opens the Share Modal Dialog to Email a Document as Attachment.

See share for configuration details.

doc_download

Download a Document.

    "commandAction": {
        "name": "doc_download",
        "props": {
             "itemUri": "pam-item://hierarchy=50@path=76$1867665@eid=xxxxxxxxxxxxxxxxxxx"
        }
    }

commandAction.props:

itemUri*

The target Document that should be downloaded.

doc_upload

Opens the Upload Modal Window to upload Document(s).

    "commandAction": {
        "name": "doc_upload",
        "props": {
             "itemUri": "pam-item://hierarchy=50@path=76$1867665"
        }
    }

commandAction.props:

itemUri

Optional target Folder's itemUri to which Document(s) should be uploaded.

doc_uploadVersion

Opens the Upload Modal Window to add a new Version to a Document.

    "commandAction": {
        "name": "doc_uploadVersion",
        "props": {
             "itemUri": "pam-item://hierarchy=50@path=76$1867665@eid=xxxxxxxxxxxxxxxxxxx"
        }
    }

commandAction.props:

itemUri*

Add a new Version to the specified existing Document's itemUri.

doc_print

Toggles Print dialog for PDFs

    "commandAction": {
        "name": "doc_print"
    }

Note: Needs an PDF.js preview to work, to trigger a preview and the print dialog see doc_preview

doc_printMultiple

Toggles Print dialog for one or more documents

    "commandAction": {
        "name": "doc_printMultiple"
    }

Note: Needs to be a PDF or able to be converted into a PDF, an image or HTML document.

doclist_exportCsv

Export current Document List as .CSV file (only Metadata).

    "commandAction": {
        "name": "docList_exportCsv"
    }

Note: Not possible as QuickAction, because it needs the current item as context

doclist_resetFilters

Clears the current Document List filters.

    "commandAction": {
        "name": "doclist_resetFilters"
    }

lock

Locks a specific document or folder.

    "commandAction": {
        "name": "lock",
        "props": {
             "itemUri": "pam-item://hierarchy=50@path=76$1867665@eid=xxxxxxxxxxxxxxxxxxx"
        }
    }

commandAction.props:

itemUri

Locks the specified existing document or folder.

unlock

Unlocks a specific document or folder.

    "commandAction": {
        "name": "unlock",
        "props": {
             "itemUri": "pam-item://hierarchy=50@path=76$1867665@eid=xxxxxxxxxxxxxxxxxxx"
        }
    }

commandAction.props:

itemUri

Unlocks the specified existing document or Folder.

wf_start

Opens the ListWorkflows Modal Window to display a list of available Workflows to start.

    "commandAction": {
        "name": "wf_start",
        "props": {
            "itemUri": "pam-item://hierarchy=50@path=76$1867665@eid=xxxxxxxxxxxxxxxxxxx"
        }
    }

commandAction.props:

itemUri

Open the ListWorkflows Modal for the specified Folder's or Document's itemUri.

recyclebin_docClear

Permanently deletes a Document from the Recycle Bin by itemUri

    "commandAction": {
        "name": "recyclebin_docClear",
        "props": {
            "itemUri": "pam-item://hierarchy=50@path=76$1867665@eid=xxxxxxxxxxxxxxxxxxx",
            "name": "WebDavName"
        }
    }

commandAction.props:

itemUri*

Permanently delete provided Document

name*

Name of Document for the Success/Failure message.

recyclebin_docRestore

Restores a document from the Recycle Bin by itemUri

    "commandAction": {
        "name": "recyclebin_docRestore",
        "props": {
            "itemUri": "pam-item://hierarchy=50@path=76$1867665@eid=xxxxxxxxxxxxxxxxxxx",
            "name": "WebDavName"
        }
    }

commandAction.props:

itemUri*

Restores Document by given itemUri

name*

Name of Document for the Success/Failure message.

recyclebin_folderClear

Permanently deletes a folder from the Recycle Bin by itemUri

    "commandAction": {
        "name": "recyclebin_folderClear",
        "props": {
            "itemUri": "pam-item://hierarchy=50@path=76$1867665",
            "name": "WebDavName"
        }
    }

commandAction.props:

itemUri*

Permanently deletes provided Folder and all its containing Folders and Documents

name*

Name of Folder for the Success/Failure message.

recyclebin_folderRestore

Restores a Folder from the Recycle Bin by itemUri

    "commandAction": {
        "name": "recyclebin_folderRestore",
        "props": {
            "itemUri": "pam-item://hierarchy=50@path=76$1867665",
            "name": "WebDavName"
        }
    }

commandAction.props:

itemUri*

Restores Folder by given itemUri and all its containing Folders and Documents

name*

Name of Folder for the Success/Failure message.

reminder_manage

Create a new reminder for itemUri

NOTE: Since it is currently NOT possible to fetch reminders by ID, use the ItemView_Reminder to edit or delete already existing reminders.

    "commandAction": {
        "name": "reminder_manage",
        "props": {
            "itemUri": "pam-item://hierarchy=50@path=76$1867665",
            "name": "WebDavName"
        }
    }

commandAction.props:

itemUri*

Creates reminder for given itemUri (Folder or Document)

name*

Name of Item (Folder or Document) for the Form and Success/Failure message.

itemFlows

Opens the ItemFlows Modal Window to display a list of available Flows (depending on the direction).

    "commandAction": {
        "name": "itemFlows",
        "props": {
            "itemUri": "pam-item://hierarchy=50@path=76$1867665",
            "direction": "in",
            "flowId": "doc_photo",
            "visibleFlowIds": [ "doc_photo" ],
            "categoryId": "id",
            "defaultValues": { "prop1": "value" }
        }
    }

commandAction.props:

itemUri*

Pass the folder ItemUri to use to fetch the possible ItemFlows and where the final flow will be created (when direction = in).

direction

Default: in
Either in or out.

flowId

Default: none
You can optionally specify which Flow (identified by it's id) to pre-select.

visibleFlowIds

Default: all
You can optionally specify which Flows (identified by their id) to show at all to the user.

categoryId

Default: none
You can optionally specify which Category to pre-select.

defaultValues

Default: none
You can optionally specify which form values to prefill (prefix with type - ea. or ip.)

useFormTokens

Default: false
Whether to retrieve all the current fields/attributes to be able to use them as tokens in the defaultValues.
inPoint fields are prefixed with "ip.", ExtraAttributes with "ea." (to avoid name collisions).

Manage current user's shares for itemUri

Note: CommandAction additionally relies on the following calculated props: formatId, itemStatus, isDoc, isDocSendByEmailAllowed

    "commandAction": {
        "name": "share",
        "props": {
            "itemUri": "pam-item://hierarchy=50@path=76$1867665",
            "name": "WebDavName",
            "isEdit": true/false,
            "shareType": "share/link/attachment/pdf"
        }
    }

commandAction.props:

itemUri*

Manages current user's shares for given itemUri (Folder or Document)

name*

Name of Item (Folder or Document) for the Form and Success/Failure message.

isEdit

Whether to edit existing or create a new share. Defaults to false.

shareType

Optional default share type to use. One of the following:

share Creates a new Share to the Document/Folder and Email with a link to the Share;
link Email a link to inPoint.Web and inPoint.Client to the Document/Folder;
attachment Email the Document as an Attachment;
pdf Email the PDF converted Document as an Attachment

Notes:
If the defined Share Type is not allowed by other settings or by permissions, the next available type will be used instead.
Persited Share Type settings are overruled, by defined Share Types.

Subscribes the user to the given itemUri.

    "commandAction": {
        "name": "subscribe",
        "props": {
            "itemUri": "pam-item://hierarchy=50@path=76$1867665@eid=xxxxxxxxxxxxxxxxxxx",
            "name": "Title of the document"
        }
    }

commandAction.props:

itemUri*

Subscribes user to the specified Folder's or Document's itemUri.

name*

Folder's or Document's Name (For success and error messages).

unsubscribe

Unsubscribes the user from the given itemUri.

    "commandAction": {
        "name": "unsubscribe",
        "props": {
            "itemUri": "pam-item://hierarchy=50@path=76$1867665@eid=xxxxxxxxxxxxxxxxxxx",
            "name": "Title of the document"
        }
    }

commandAction.props:

itemUri*

Unsubscribes user from the specified Folder's or Document's itemUri.

name*

Folder's or Document's Name (For success and error messages).

confirm

Default: false
Specify true to display a confirm dialog before unsubscribing, if the specified itemUri is subscribed by one of its parents.

search_favorite

Toggles favorite flag for the given search request

    "commandAction": {
        "name": "search_favorite",
        "props": {
            "searchRequest": {
                "id": 1234,
                "searchType": 0
            }
        }
    }

commandAction.props:

searchRequest*

Adds recent searches to Favorites or removes search requests of type favorite from Favorites.

searchRequest.id*

Generated recent or favorite identifier

searchRequest.searchType*

Type of search request. Valid values are numbers from 0 to 3:
0=Favorite
1=Recent
2=Freetext
3=Form

search_preview

Displays a search result

    "commandAction": {
        "name": "search_preview",
        "props": {
            "searchRequest": {
                "id": 1234,
                "searchType": 0
            },
            "newWindow": false
        }
    }

commandAction.props:

searchRequest*

Displays results for the specified SearchRequestDTO.

searchRequest.id*

Generated recent or favorite identifier.

searchRequest.searchType*

Type of search request. Valid values are numbers from 0 to 3. 0=Favorite, 1=Recent, 2=Freetext or 3=Form

newWindow

Default: false
Specify true to open in a new Browser Window or leave as false to replace the current view.

transfer

Triggers target selection to copy (documents only), link or move an item.

    "commandAction": {
        "name": "transfer",
        "props": {
            "itemUri": "",
            "isDoc": false,
            "type": "move",
        }
    }

commandAction.props:

itemUri*

Source Folder's or Document's itemUri to transfer

name*

Folder's or Document's Name (For success and error messages).

isDoc*

Whether the provided itemUri is a document or a folder.

type

Valid values are move, copy, link. If empty, the user can decide the TransferType upon target selection.

Support multiple targets

Several CommandActions support multiple targets, either by queueing or by default.

doc_delete
doc_download
doc_printMultiple
favorite
folder_delete
ip_commandAction
lock
offline_add
offline_del
recyclebin_docClear
recyclebin_docRestore
recyclebin_folderClear
recyclebin_folderRestore
share
subscribe
unlock
unsubscribe

To execute a commandAction on multiple items, provide the following props:

Note: The needed props are calculated automatically for ItemAction in the ActionPanel. Only needed for custom QuickActions

multiple*

Boolen flag that indicates that multiple items are targeted

items*

Array of targeted items. An item contains the following properties

isDoc*

Whether the provided itemUri is a document or a folder.

name*

Folder's or Document's Name (to display in the UI).

itemUri*

Folder's or Document's itemUri to execute the CommandAction on

formatId *

Folder's or Document's Format ID

ItemFlows CommandActions

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

Overview​

Syntax​

Reference​

editClassification​

ip_archive​

commandAction.props:​

itemUri​

ip_browse​

commandAction.props:​

itemUri*​

ip_commandAction​

commandAction.props:​

commandAction*​

commandParam​

commandOption​

itemUri​

items​

ip_edit​

commandAction.props:​

itemUri*​

ip_properties​

commandAction.props:​

itemUri*​

searchResult_form​

commandAction.props:​

searchForm*​

viewMode​

showFilterbar​

filters​

name​

valueType​

value​

{geolocation} token​

{barcode} token​

{user.Name} token​

{user.Id} token​

op​

nodeType​

searchResult_geoLocation​

searchResult_barcode​

createFolder_template​

commandAction.props:​

template*​

itemUri*​

targetFolderName​

link​

commandAction.props:​

url*​

useFormTokens​

asModal​

title​

specs​

Samples​

Navigate There​

Call Customer​

E-Mail a Customer​

Start a Teams chat​

Open a mini/flat from an ExtraAttribute Grid Row with an ItemURI as Link​

favorite​

commandAction.props:​

itemUri*​

offline_add​

commandAction.props:​

itemUri*​

offline_del​

commandAction.props:​

itemUri*​

folder_preview​

commandAction.props:​

itemUri*​

newWindow​

toggles​

folder_editClassification​

folder_delete​

commandAction.props:​

itemUri*​

name*​

folder_emailLink​

clipboard_copyItemLink​

clipboard_copyItemUri​

Overview

Syntax

Reference

editClassification

ip_archive

commandAction.props:

itemUri

ip_browse

commandAction.props:

itemUri*

ip_commandAction

commandAction.props:

commandAction*

commandParam

commandOption

itemUri

items

ip_edit

commandAction.props:

itemUri*

ip_properties

commandAction.props:

itemUri*

searchResult_form

commandAction.props:

searchForm*

viewMode

showFilterbar

filters

name

valueType

value

`{geolocation}` token

`{barcode}` token

`{user.Name}` token

`{user.Id}` token

op

nodeType

searchResult_geoLocation

searchResult_barcode

createFolder_template

commandAction.props:

template*

itemUri*

targetFolderName

link

commandAction.props:

url*

useFormTokens

asModal

title

specs

Samples

Navigate There

Call Customer

E-Mail a Customer

Start a Teams chat

Open a mini/flat from an ExtraAttribute Grid Row with an ItemURI as Link

favorite

commandAction.props:

itemUri*

offline_add

commandAction.props:

itemUri*

offline_del

commandAction.props:

itemUri*

folder_preview

commandAction.props:

itemUri*

newWindow

toggles

folder_editClassification

folder_delete

commandAction.props:

itemUri*

name*

folder_emailLink

clipboard_copyItemLink

clipboard_copyItemUri