General Section
Overview
The "General" section includes some General Settings, the Sidebar and Defaults configurations, Archive Targets, QuickActions, FormActions and ItemActions.
General settings
coreUrl (obsolete)
Default: https://localhost:8443
URL address of inPoint.Core.
NOTES
- this is now deprecated - inPointCore Url will be read from Urls section
- unless your inPoint.Core SSL Certificate also specifies
localhost, you MUST change this to the correct full URL of inPoint.Core. - do not forget to configure inPoint.Core appsettings.json firewall to allow access from inPoint.Identity.
browserLoggingLevel
Default: 4000 (WARN/ERROR/FATAL)
You can specify the default minimum logging level that inPoint.Web should output to the Browser.
| Severity | Numeric Severity |
|---|---|
| TRACE | 1000 |
| DEBUG | 2000 |
| INFO | 3000 |
| WARN | 4000 |
| ERROR | 5000 |
| FATAL | 6000 |
browserLoggingForwardToServer
Default: false
Enable forwarding browser events to the server logs.
uploadTemp
Default: "%TEMP%\tusfiles"
Where temporary files (and chunks) are stored before archiving has been finalized.
uploadTempExpirationMin
Default: 30
When is an uploaded file (but not archived) marked as expired and automatically deleted.
uploadScanAmsi
Default: false
Whether to enable AmSI scanning before archiving the uploaded files.
uploadSkipAmsiTest
Default: false
Whether to skip the AmSI functionality test when starting up the Web server. NOTE: if scanning is enabled but the functionality test fails no uploads will be accepted.
secureParamsSecret
Set this to customize the secret used for encrypting secureParams.
NOTE this has to match everywhere secureParams is used (e.g. Identity, Axon.Ivy, etc…).
secureParamsTimeoutSeconds
Default: 0
How many seconds is a secureParams token valid for before it expires.
imageViewerExtensions
Default: ".jpg,.jpeg,.gif,.png"
For which file extensions to use the ImageViewer.
mediaViewerExtensions
Default: ".webm,.mp4,.ogv,.mp3,.wav"
For which file extensions to use the MediaViewer.
htmlViewerExtensions
Default: ".html, .htm"
For which file extensions to use the HtmlViewer.
licensePath
Optional path to *.pamlic file (without this it will automatically search all parent folders).
allowEmbedding
Whether to allow embedding into an IFRAME hosted from a different domain.
Note: If you want to embed inPoint.Web with the offline feature enabled. You need to make sure that the embedding website is also served via https (e.g. AxonIvy)
features (obsolete)
"Feature flags" activates features (either experimental oder resource-intensive) - see Feature flags.
NOTE: this setting (General/features) is now deprecated and has been superseded by FeatureManagement.
sidebar
Customize the left sidebar (see Sidebar).
archiveTargets
List of predefined archive targets (see ArchiveTargets).
quickActions
List of predefined actions on Home/Actions (see Quick Actions).
uploadProvider
Specify which upload provider to use; either by natively using the browser's upload functionality, or using inPoint.Sync (which must be manually pre-installed).
Default: Any
Any
Both Upload Providers are available.
Sync
inPoint.Sync integration is used instead of Browser upload, if User is on a Windows Machine and inPointSyncIntegration is enabled via cascading settings.
Uppy
Default browser upload provider (requires no special custom installs and works on every OS).
conversionExtensions
Extend list of supported file extensions for Conversion Service.
Note: You need to handle the extensions in FileConverterPro and add them to the Pam.Storage configuration too.
{
"General": {
"conversionExtensions": [".foo", "bar"]
}
}
providerCacheInactivityMin
Sets how long should the server keep the hierarchyProvider Cache, before evicting it. Defaults to 30 minutes
Sidebar
Configure some of the items in the Sidebar (left panel), by default all the user's accessible Global/My/Mailbox sites will be visible with the default view.
Sample:
"General": {
...
"sidebar": {
"mainNavigation": [
{
"id": "home",
"title": { "en": "Dashboard" }
},
{
"id": "wf",
"icon": "code-fork"
},
{
"id": "report",
"visible": false
},
{
"id": "news",
"order": 8
},
{
"id": "otrs",
"type": "commandAction",
"visible": true,
"icon": "link",
"title": { "en": "OTRS" },
"commandAction": {
"name": "link",
"props": {
"url": "https://support.hs-soft.com/otrs/index.pl"
}
}
}
],
"replace": false,
"sortBy": "Title",
"items": [
{
"itemUri": "pam-item://hierarchy=50@path=76$63000",
"caption": "MASS flatau",
"viewName": "flat",
"mini": true
}
]
}
...
}
mainNavigation
List of navigation items to show in the Sidebar. All default items can be targeted by id. Entry settings:
id*
Must be unique. Assigned by the system: home, news, search, searchResult, wf, report and upload.
type
Any of the following: home, news, search, searchResult, wf, report, upload or commandAction
NOTE: type is mandatory for items with non-system ids.
visible
Default: true
Flag to hide/show items.
order
Default: 0
All provided navigation items will be ordered by this number.
groups
List of inPoint GroupIDs that this item should be visible for.
Note: User must be in all inPoint GroupIDs, for the item to display
icon
Which font-awesome icon to display.
NOTE: You can find a list of available icons here
title
Localized text to display to the user.
NOTE: title is mandatory for items of type commandActions.
commandAction
Any Command Action can be configured as a navigation item.
NOTES:
Property commandAction is mandatory for items of type commandActions.
If you provide url in your Command Action props, it will be shown in the href attribute of the link.
We copy the localized title from title to the commandAction.props.title, if the property is not already set.
replace
Default: false
Whether to append the items to the default system available or replace all of them
sortBy
Default: Order
Valid values: Order, Title
If set to Title, items will get ordered first by their siteType ( GlobalSites, MySites, SharedSites, RecycleBin, MailBox ) and then by their title with System Areas being an exception. They will always be first in their respective categories.
items
List of site items to show in the sidebar, entry settings:
Note: The items are distinct - only unique items (identified by ItemUri) are shown.
itemUri*
The full itemUri.
siteType*
Any of the following: GlobalSites,MySites,SharedSites,RecycleBin,MailBox
NOTE: either itemUri or siteType MUST be specified.
visible
Default: true
Flag to hide/show items.
order
Default: 0
All provided items will be ordered by this number.
groups
List of inPoint GroupIDs that this item should be visible for.
Note: User must be in all inPoint GroupIDs, for the item to display
title
Localized text to display to the user. Defaults to webDavName
caption
The caption in the sidebar.
mini
Whether to show when the sidebar is (collapsed).
viewName
Which View to use (Folder, Flat or Mailbox).
Defaults
"Defaults" allows you to specify custom settings to apply as default or to specific folders.
See Defaults for a feature description.
Sample:
"General": {
...
"defaults": [
{
"itemUri": "pam-item://...",
"exactItemUri": true/false,
"formatIds": [ ... ],
"persist": true/false,
"upload": {
"maxNumberOfFiles": number,
"maxFileSize": number (bytes),
"deniedFileTypes": [".extension or mime type", ... ],
"allowedFileTypes": [".extension or mime type", ... ]
},
"shouldBeVisible": {
"isDocEditAllowed": true/false,
"isDocDownloadAllowed": true/false,
"isDocAssignmentAllowed": true/false,
"isDocClassificationEditAllowed": true/false,
"isDocSendByEmailAllowed": true/false,
"isFolderClassificationEditAllowed": true/false,
"inPointSyncIntegration": true/false,
"isContinuousPreview": true/false,
},
"docList": {
"quickFilter": {
"name": "Common Name",
"visible": true/false,
"operator": "Equals/NotEquals/Contains/DoesNotContain/StartsWith/DoesNotStartWith/EndsWith/DoesNotEndWith"
}
},
"docListClick": {
"onIconClick": true/false,
"onIconClickNewWindow": true/false,
"onSingleClick": true/false,
"onDoubleClick": true/false,
"onContextClick": true/false
},
"sorts": [
{
"name": "Common Name",
"direction": "Ascending/Descending"
}
],
"filters": [
{
"name": "Common Name",
"operator": "Between",
"values": [ "0.1", "0.3" ]
}
],
"formActions": {
"replace": true/false,
"actions": [ ... ]
},
"itemActions": {
"replace": true/false,
"categories": [ ... ],
"actions": [ ... ]
},
"itemFlows": {
"replace": true/false,
"categories": [ ... ],
"flows": [ ... ]
},
"map": {
"name": "leaflet-raster",
"isRaster": true/false,
"rasterMapIdSelector": "{itemUri}",
"onClick": {
"confirm": true/false,
"locationTargetFieldName": "Common Name",
"commandAction": {
"name": "itemFlows",
"props": {
"direction": "in"
}
}
}
},
"viewName": "folder/mail/flat",
"visualRules": [{
"targetNames": ["location"],
"markerImage": "/path/to/marker.svg",
"markerSize": [50, 80],
"markerAnchor": [25, 80],
"iconImage": "/path/to/icon.svg",
"iconSize": [10, 10],
"color": "red",
"rules": [{
"filters": [{"name": "status", "value": "WIP"}],
"markerImage": "/path/to/marker.svg",
"iconImage": "/path/to/icon.svg",
"color": "red"
}]
}],
"activityList": {
"showNotes": true,
"showAddNote": true,
"showHistory": true,
"showRetentionInfo": true
},
"share": {
"shareType": "share/link/attachment/pdf",
"isInPointClientAllowed": true/false,
"isInPointWebAllowed": true/false,
"isLinkAllowed": true/false,
"isShareAllowed": true/false,
"isDocSendAsAttachmentAllowed": true/false,
"isDocSendAsPdfAllowed": true/false,
},
"scopeFromLevel": 2,
}
]
itemUri
The itemUri to apply to.
NOTE: either itemUri or formatIds, do not specify both at the same time.
NOTE: leave this empty to setup a global default setting
exactItemUri
Default: true
Whether to apply only to the specified itemUri or also include all it's subfolders.
formatIds
List of formatIds to apply to.
NOTE: either itemUri or formatIds, do not specify both at the same time.
NOTE: leave this empty to setup a global default setting
persist
Default: true
Whether to remember layout settings between browser instances.
upload
Apply upload restrictions.
maxNumberOfFiles
Maximum number of files allowed in one batch (using the same Target and Classification).
maxFileSize
Maximum file size (in bytes) to allow.
deniedFileTypes
List of either file extensions and/or mime types to deny.
Example:
"deniedFileTypes": [ ".zip", ".7z", "application/zip", "video/*" ]
allowedFileTypes
List of either file extensions and/or mime types to allow.
Example:
"allowedFileTypes": [ ".doc", ".docx", ".xls", ".xlsx", "application/pdf" ]
flowId
Allow to use a different flowId for drag and drop actions on DocList
Default: doc_upload
shouldBeVisible
Hide functionality for this folder format or itemUri (with optional descendents)
Note: You cannot elevate permissions only restrict them. So if a user is not allowed to download, you cannot grant this permission.
isDocEditAllowed
Default: true
Whether to allow users to edit documents.
isDocDownloadAllowed
Default: true
Whether to allow users to download documents.
isDocAssignmentAllowed
Default: true
Whether to allow user to assign documents (archive).
isDocClassificationEditAllowed
Default: true
Whether to allow user to edit document classification.
isDocSendByEmailAllowed
Default: true
Whether to allow user to send Documents via Email
isFolderClassificationEditAllowed
Default: true
Whether to allow user to edit folder classification.
inPointSyncIntegration
Default: true
Whether to allow inPoint Actions (requires inPoint.Sync).
isContinuousPreview
Default: false
Whether to enable the continuous preview in the HTML viewer.
docList
Note: planned to be consolidated with docListClick settings.
docList.quickFilter
Here you can change the default Document list QuickFilter functionality; the default runs a Contains search on the Name column.
You can either change on which Column to filter, the operator used and even disable the whole feature - either globally or for a specific folder.
name
Default: Name
The CommonName (as shown in FieldChooser).
visible
Default: true
operator
Default: Contains
Possible operators: Equals, NotEquals, Contains, DoesNotContain, StartsWith, DoesNotStartWith, EndsWith, DoesNotEndWith
Note: Case Sensitive!
docListClick
Note: planned to be consolidated with docListClick settings.
Which mouse click to allow on the Documents List:
onIconClick
document preview
onIconClickNewWindow
if onIconClick allowed, set this to true to always open in new window (false will open modal, control-click will open in new window).
onSingleClick
document preview
onDoubleClick
document edit (if inPointSyncIntegration is enabled).
onContextClick
quick document actions
sorts
name
The CommonName (as shown in FieldChooser).
direction
Ascending or Descending
Note: currently only single column sorting is supported.
filters
Only the filters you specify will actually be shown, you can also freely change the order.
name
The CommonName (as shown in FieldChooser).
operator
Possible operators: Equals, NotEquals, LessThan, LessThanOrEqualsTo, GreaterThan, GreaterThanOrEqualsTo, Contains, DoesNotContain, StartsWith, DoesNotStartWith, EndsWith, DoesNotEndWith, Between, DateRelative
Note: Case Sensitive!
value
The available DataRelative values (case-sensitive):
Today, Yesterday, ThisWeek, LastWeek, ThisMonth, LastMonth, ThisYear, LastYear
formActions
You can setup custom formActions to be displayed for this set.
replace
Default: false
Whether to totally replace the globally defined formActions or append to those.
actions
List of formActions.
itemActions
You can setup custom itemActions to be displayed only for this itemUri.
replace
Default: false
Whether to totally replace the globally defined itemActions or append to those.
categories
Default: the globally defined ones
List of categories.
actions
List of itemActions.
itemFlows
You can setup custom itemFlows to be displayed only for this itemUri.
replace
Default: false
Whether to totally replace the globally defined itemFlows or append to those.
categories
Default: the globally defined ones
List of categories.
flows
List of itemFlows.
map
You can setup the Raster configuration in this section.
name
Custom Provider to use instead of the default.
For Raster maps this must be leaflet-raster.
isRaster
Default: false
Whether Raster maps should be enabled.
rasterMapIdSelector
Default: {itemUri}
Configure how to correlate between the current folder and the raster layer definition - per default done by itemUri.
onClick
Optionally configure what should happen if the user clicks with the mouse on an empty area on the map.
The following sample will start the Item Flows dialog - basically to create a new item, and prefill the Attribute named GEORASTER_FIELD on the Classification form with the location the user clicked on the map.
"onClick": {
"locationTargetFieldName": "GEORASTER_FIELD",
"commandAction": {
"name": "itemFlows",
"props": {
"direction": "in"
}
}
}
NOTE: You can optionally disable the confirm dialog by setting onClick.confirm to false
"onClick": {
"confirm": true/false
// ...
}
viewName
Define with what view the targeted itemUris or formatIds are displayed.
Available ViewName: folder,mailbox or flat
Default ViewName: Flat archive unit (flat), Mailbox (mailbox) or Folder (folder) based on Hierarchy SiteType
Examples:
"viewName": "folder"
Note: This is NOT enforced on mini URLs
GEO features
This section relates to the Geo features of inPoint.Web, you can configure which provider to use (under /__map), required apiKeys and options, and which features to enable/disable within inPoint.Web.
Sample:
"General": {
...
"geo": {
"name": "leaflet-osm",
"key": "apikey",
"map": {
"enabled": true
},
"radius": {
"enabled": true,
"searchRadius": [200, 500, 1000, 2000, 5000, 10000]
},
"pointEdit": {
"enabled": true
},
"areaEdit": {
"enabled": true
},
"places": {
"enabled": true,
"name": "osm",
"params": {
"countrycodes": "at,de,ch"
}
}
}
name
Default: leaflet-osm
The default map provider (from [INSTALLDIR]/wwwroot/public/__map/xxx).
key
Some providers require an API key, here you can specify it.
map
enabled
Default: true
Whether to enable vieweing Point/Area on Map, including Map ViewMode in DocList/SearchResult.
radius
enabled
Default: true
Whether to enable radius search.
searchRadius
Default radius (in meters) to show in dropdown for geoSearch fields.
pointEdit
enabled
Default: true
Whether to enable editing (moving) a GeoPoint marker on a map.
areaEdit
enabled
Default: true
Whether to enable editing (moving, new path) a GeoArea marker on a map.
places
enabled
Default: true
Whether to enable geocoding (converting an adress to a GeoPoint).
name
Default: osm
Name of geocoding provider; currently only osm supported.
params
Parameters to pass to the specified geoCoding provider.
For osm see documentation
Notes:
- Each section can specify a different provider (or key), if not specified the main one defined will be used (this allows you to use one provider for vieweing the map but another for editing areas)
- The Default provider
leaflet-osm: OpenStreetMap does not require any keys, BUT: PLEASE DO NOT USE FOR PRODUCTION USE - instead talk to the customer to use MapBox
ArchiveTargets
This section allows you to configure which targets will be available when a user wants to archive a file. Per default there are 4 predefined: Favorites, Recent, Search Forms and a Folder (GlobalSites) Browser.
Sample (no need to define those!):
"General": {
...
"ArchiveTargets": [
{
"title": { "en": "Favorites", "de": "Favoriten" },
"description": { "en": "Choose a target from a Favorite." },
"uri": "at-fav"
},
{
"title": { "en": "Recents", "de": "Zuletzt verwendet" },
"description": { "en": "Choose a target from a recently visited item." },
"uri": "at-rec"
},
{
"title": { "en": "Search Forms", "de": "Suchformulare " },
"description": { "en": "Find your target with a search form." },
"uri": "at-search"
},
{
"title": { "en": "Browse Folders" },
"uri": "at-picker"
}
]
You can optionally add custom ones: to a pre-defined Folder or direct access to a SearchForm.
Shared properties
title*
Localized title to display to the user.
description
Optional localized description to display to the user.
groups
Optionally limit visibility to a list of inPoint Group IDs – only users belonging to all of the specified group ids will actually see the archiveTarget.
Example:
"groups": [ 5, 13 ]
fileTypes
Optionally limit visibility depending on the first pending file upload type (otherwise displayed for any file). Include either file extensions and/or mime types to allow.
Example:
"fileTypes": [ ".doc", ".docx", ".xls", ".xlsx", "application/pdf" ]
Folder as ArchiveTarget
When the user clicks this target he will immediately get the Document Classification as configured at the itemUri you specify.
Sample:
"ArchiveTargets": [
{
"title": { "en": "Österreich Straße" },
"description": { "en": "add details to existing road" },
"uri": "pam-item://hierarchy=50@path=76$21546",
"groups": [ ... ]
}
]
...
uri*
Target folder's itemUri to archive to.
Note: if the target itemUri has an inPoint Field "image", it will automatically be displayed.
Note: user must have Folder.Read and Document.Create rights to see this ArchiveTarget.
SearchForm as ArchiveTarget
This will present the user the pre-defined search form;
- he can fill-in any search form criteria and click the
Searchbutton to start a search (when the feature flagsearchAsYouTypeis enabled it will automatically start) - results will be displayed below
- the user can then choose any of the results as his desired archiving target
- the target classification form will be displayed
Sample:
"ArchiveTargets": [
{
"title": { "en": "SearchForm Österreich with B" },
"description": { "en": "add details to existing road" },
"uri": "pam-item://hierarchy=50@path=76$21546",
"searchItem": { "id": 9240 }
}
]
...
NOTE: if the search form is configured to AutoBrowseToItem and only one search result is available it will immediately pre-select it and go to the next step.
uri
Optionally limit the SearchScope to that folder (and below). If specified, user must have Folder.Read and Document.Create rights to see this ArchiveTarget.
searchItem*
id*
SearchForm id to display.
SearchResults as ArchiveTarget
This will immediately execute a pre-defined search form (without ever presenting it to the user) with optionally setting any existing filters' value.
Sample:
"ArchiveTargets": [
{
"title": { "en": "SearchForm Österreich with B" },
"description": { "en": "add details to existing road" },
"uri": "pam-item://hierarchy=50@path=76$21546",
"searchItem":
{
"id": 9240,
"searchType": "Form", //<-- this is required
"filters": [
{
"name": "ContentType",
"value": "ComplexOrder"
}]
}
}
]
...
NOTE: if the search form is configured to AutoBrowseToItem and only one search result is available it will immediately pre-select it and go to the next step.
uri
Optionally limit the SearchScope to that folder (and below). If specified, user must have Folder.Read and Document.Create rights to see this ArchiveTarget.
searchItem*
id*
SearchForm id to display.
searchType*
Must be set to Form.
filters
Here you can reference any Filter already existing in the SearchForm and change it's assigned value for this specific search run.
filter name
Identified by the Field's CommonName; special value supported:
$SEARCHTEXT$: this will replace theFreeTextfield
filter value
The value to assign to the filter; special value supported:
{geolocation}: will retrieve the user's current GPS location and use that as the value
QuickActions
See Quick Actions feature for a description.
NOTE: disabled per default, a featureFlag must be set for this to be visible (see Feature flags)
NOTE: some of the configurations documented below WILL change in the future!
Each action can also be limited to a list of inPoint Group IDs – only users belonging to any of the specified group ids will actually see the action.
Access QuickActions directly
Append /home?qa= or /mini/home?qa= and your QuickAction ID to your inPoint.Web URL to access the underlying QuickAction directly.
All Actions have shared properties
NOTE: these are all Case-Sensitive!
id
A unique identifier for the QuickAction. With that identifier, you are able to link your QuickActions directly.
NOTE: The id is a computed value. If you do not define it, it will starts with a- and is followed by a descending number starting with 0. If the given id is already in use, the fallback id, e.g. a-5 will be used. It is recommended to use URL safe characters [a-zA-Z0-9-_] in lower kebap case.
Sample:
"QuickActions": [
{
"id": "my-custom-identifier"
...
}
]
...
itemtype
Defines the type of the QuickAction.
title
Localized Action's title.
description
Localized Action's description (shown at the bottom of the Card).
image
Full path to a local image file (on the server) that will be displayed.
groups
List of inPoint GroupIDs that this Action should be visible for.
Note: User must be in all inPoint GroupIDs, for the item to display
Sample:
"QuickActions": [
{
...
}
]
...
Browse a Folder
"QuickActions": [
{
"itemtype": "folder",
"description": { "en": "browse to a folder" },
"title": { "en": "Österreich Straße" },
"uri": "pam-item://hierarchy=50@path=76$21546"
}
...
Preview a Document
"QuickActions": [
{
"itemtype": "doc",
"title": { "en": "_VERSIONTEST.pdf" },
"uri": "pam-item://hierarchy=51@path=78$-7\\,82$-169\\,83$-7432@eid=0000000000100720190518151054399EF0003"
}
...
NOTE: the title MUST include the file extension in order to be displayed correctly (and with the correct file type icon).
Show SearchForm
"QuickActions": [
{
"itemtype": "searchForm",
"title": { "en": "SearchForm Österreich with B" },
"description": { "en": "show a search form" },
"uri": "pam-item://hierarchy=50@path=76$21546",
"searchItem": {
"id": 9240
}
}
...
Show ArchiveTarget SearchForm
"QuickActions": [
{
"itemtype": "archiveTarget",
"title": { "en": "Archive to UPC Projekt/Objekt Bilder" },
"description": { "en": "show archiveTarget search form" },
"uri": "pam-item://hierarchy=50@path=76$1867665\\,79$1867698",
"searchItem": {
"id": 5
}
}
...
CommandActions
Any Command Action can be configured as a Quick Action.
Run SearchForm (CommandAction)
"QuickActions": [
{
"itemtype": "commandAction",
"image": "c:\\temp\\search\\icon-150x150.png",
"title": { "en": "Created by me" },
"description": { "en": "run search form" },
"commandAction": {
"name": "searchResult_form",
"props": {
"searchForm": 9411,
"viewMode": "List"
}
}
}
...
Topbar
You can append custom menu entries in the User's topbar menu (when clicking user's avatar top right).
"General": {
"topbar": {
"items": [
{
"id": "custom_id",
"title": { "en": "Manual" },
"icon": "help",
"shouldBeVisible": [ "!isAdmin" ],
"commandAction": {
"name": "link",
"props": {
...
}
}
}
]
}
...
}
Items
id*
Specify a unique id.
title*
Localized text to display to the user.
icon
Which font-awesome icon to display.
visible
Default: true
Whether to display this Action.
shouldBeVisible
List of conditions that must be matched in order to display this action to the user.
commandAction
Which CommandAction to start.
FormActions
See Form Actions feature for a description.
Actions
Here you define the actual Actions which should be visible and which CommandAction they should execute if the User chooses to do so.
"formActions": {
"actions": [
{
"id": "custom_id",
"title": { "en": "Start Workflow X" },
"description": { "en": "Start the Workflow X" },
"commandAction": {
"name": "start-wf",
"props": {
...
}
}
}
]
}
...
id*
Use any system pre-defined Action id to completely override an existing one (e.g. set Visible to false), or add your own custom Actions.
title*
Localized text to display to the user.
description
Optional localized description to as title tooltip.
icon
Which font-awesome icon to display.
visible
Default: true
Whether to display this Action.
views
Default: all
List of Views where this Action should be visible.
Possible view names: folder, document, docmodal, upload, itemflows, archive_target, search, search_scope, lock_info
shouldBeVisible
List of conditions that must be matched in order to display this category to the user.
commandAction
Which CommandAction to start.
ItemActions
See Item Actions feature for a description.
Categories
Categories defines the logical separations of actions; here you can configure your own custom ones.
"ItemActions": {
"categories": [
{
"id": "admin",
"title": { "en": "Admin" },
"icon": "gear",
"views": [ "folder" ],
"shouldBeVisible": [ "isAdmin" ],
"order": 11
}
]
}
...
id*
This is used to link a Category to a visible Action.
title*
Localized text to display to the user.
icon
Which font-awesome icon to display.
visible
Default: true
Whether to display this Category.
itemUriRegex
A RegularExpression to match to the current itemUri - if it does not match this Category will not be visible.
groups
List of inPoint GroupIDs that this Category should be visible to.
Note: User must be in all inPoint GroupIDs, for the item to display
views
Default: all
List of Views where this Category should be visible.
Possible view names: home, folder, document, docmodal, mailbox, flat, miniflat, news, search, searchResult, gridEditorControl
NOTE Negate views by prefixing with an exclamation point, e.g. !folder will render everywhere but folder.
shouldBeVisible
List of conditions that must be matched in order to display this Category to the user.
order
Order of the category in the list of categories. The lower the number, the higher the category will be displayed. Default is 0.
NOTE The order of the predefined categories is can be found here.
renderHeader
Default: true
Whether to render the parent Category header. Usually used in combination with ItemViews.
expanded
Default: true
Whether per default this category should be expanded.
Actions
Here you define the actual Actions which should be visible and which CommandAction they should execute if the User chooses to do so.
"ItemActions": {
"actions": [
{
"id": "custom_wf1",
"category": "wf",
"title": { "en": "Start Workflow X" },
"description": { "en": "Start the Workflow X" },
"commandAction": {
"name": "start-wf",
"props": {
...
}
},
"view": { ... }
}
]
}
...
id*
This is used to uniquely identify an Action.
Use any system pre-defined Action id to completely override an existing one (e.g. set Visible to false), or add your own custom Actions.
title*
Localized text to display to the user.
description
Optional description to show below the title.
category*
The category this Action should belong to.
Note: if not specified a generic "Others" category will be displayed - there are no "orphan" actions.
icon
Which font-awesome icon to display.
visible
Default: true
Whether to display this Action.
itemUriRegex
A RegularExpression to match to the current itemUri - if it does not match this Action will not be visible.
NOTE: either itemUriRegex or formatIds, do not specify both at the same time.
formatIds
A list of FormatIds to match to the current formatId - if it does not match this Action will not be visible.
NOTE: either itemUriRegex or formatIds, do not specify both at the same time.
groups
List of inPoint GroupIDs that this Action should be visible to.
Note: User must be in all inPoint GroupIDs, for the item to display
views
Default: all
List of Views where this Action should be visible.
Possible view names: home, folder, document, docmodal, mailbox, flat, miniflat, news, search, searchResult, gridEditorControl
shouldBeVisible
List of conditions that must be matched in order to display this category to the user.
commandAction
Which CommandAction to start.
view
Which ItemView to use for rendering.
ItemViews
Currently the following ItemViews can be used.
Activity List
{
"ItemActions": {
"categories": [
{
"id": "history",
"expanded": false
}
],
"actions": [
{
"id": "doc_history",
"category": "history",
"commandAction": {
"name": "doc_preview",
},
"view": {
"name": "itemView_activityList",
"showNotes": true,
"showAddNote": true,
"showHistory": true,
"showRetentionInfo": true
}
}
]
}
}
commandAction
Must be specified but will not currently be executed..
view
Specify a custom view for the ActionPanel.
name*
The name of the ItemView - in this case itemView_activityList.
showNotes
Default: true
Whether to show Notes entries.
showAddNote
Default: false
Whether to allow adding a new note directly in the ActionPanel.
showHistory
Default: true
Whether to show History entries (i.e. Created on, Modified, Locked)
showRetentionInfo
Default: false
Whether to show custom Retention info (cleanup settings).
Document List
{
"ItemActions": {
"categories": [
{
"id": "doclist",
"renderHeader": false
}
],
"actions": [
{
"id": "doclist",
"category": "doclist",
"commandAction": {
"name": "doc_preview",
},
"view": {
"name": "itemView_docList",
"header": "Current Documents",
"viewMode": "List",
"layout": {
"sorts": [ ... ],
"filters": [ ... ],
"cols": [
"ExtensionIcon",
"Name",
"Erstellt_am"
]
}
}
}
]
}
}
commandAction
Specifies the CommandAction to launch once user clicks on one of the shown documents. Usually doc_preview.
view
Specify a custom view for the ActionPanel.
name*
The name of the ItemView - in this case itemView_docList.
header*
Caption to show in the Category line.
viewMode
Default: List
Whether to launch in List or Thumbnails mode.
layout
Specifies default layout configurations (user cannot change those).
sorts for setting up Sorting;
filters for filtering the list;
and cols for the List of columns to show (max 3).
Document List Filters
{
"ItemActions": {
"actions": [
{
"id": "doclist_filters",
"category": "filter",
"views": ["flat", "folder", "miniflat", "mailbox"],
"view": {
"name": "itemView_filter",
"actions": [
"filterByValue",
"filterAddValue",
"filterRemove",
"reset"
]
},
"shouldBeVisible": ["hasRowAndColId"],
"commandAction": {}
}
]
}
}
commandAction
An empy object to propagate the props
view
Specify a custom view for the ActionPanel.
name*
The name of the ItemView - in this case itemView_filter.
actions*
Available actions to render. Must be at least one of the following: filterByValue, filterAddValue, filterRemove, reset
Multi Selection
{
"ItemActions": {
"actions": [
{
"id": "multiSelection",
"category": "multiSelection",
"view": {
"name": "itemView_multiSelection"
},
"shouldBeVisible": ["hasContext:multiSelection"],
"commandAction": {}
}
]
}
}
commandAction
An empy object to propagate the props
view
Specify a custom view for the ActionPanel.
name*
The name of the ItemView - in this case itemView_multiSelection.
Reminder
{
"ItemActions": {
"actions": [
{
"id": "reminder_manage",
"category": "reminder",
"commandAction": {
"name": "reminder_manage"
},
"view": {
"name": "itemView_reminder"
}
}
]
}
}
commandAction
Must be specified but will not currently be executed..
view
Specify a custom view for the ActionPanel.
name*
The name of the ItemView - in this case itemView_reminder.
Workflow
This is the default configuration for the ItemView_Workflow.
"ItemActions": {
"categories": [
{
"id": "wf",
"expanded": false
}
],
"actions": [
{
"id": "wf_info",
"category": "wf",
"views": [
"home",
"folder",
"document",
"docmodal",
"flat",
"miniflat",
"searchresult"
],
"commandAction": {
"name": "link",
"props": {
"asModal": true,
"docked": true
},
},
"view": {
"name": "itemView_workflow"
}
}
]
}
commandAction
Per default will open the WF Action link in a docked Modal window.
view
Specify a custom view for the ActionPanel.
name*
The name of the ItemView - in this case itemView_workflow.
ItemFlows
See Item Flows feature for a description.
Categories
Categories defines the top bar toggle bar to allow users to quickly filter shown flows; here you can also configure your own custom ones.
"ItemFlows": {
"categories": [
{
"id": "custom",
"title": { "en": "Custom Flows" },
"icon": "gear"
}
]
}
...
id*
This is used to link a Category to a visible Flow.
Default: all, document and folder are pre-defined, but you can override them by using the same id.
title*
Localized text to display to the user (when hovering with the mouse).
icon
Which font-awesome icon to display.
visible
Default: true
Whether to display this Category.
Flows
Here you define the actual Flows which should be visible and which CommandAction they should execute if the User chooses to do so.
"ItemFlows": {
"flows": [
{
"id": "custom_wf1",
"category": "wf",
"direction": "in",
"title": { "en": "Start Workflow X" },
"description": { "en": "Start the Workflow X" },
"commandAction": {
"name": "start-wf",
"props": {
...
}
}
}
]
}
...
id*
This is used to uniquely identify a Flow.
Use any system pre-defined Flow id to completely override an existing one, and/or add your own custom Flows.
Current existing Flow ids: doc_upload, doc_photo, sys-docTemplates, sys-folderTemplates, sys-folderFormats.
order
Default: 0
Number to specify display order (equal numbers are sorted alphabetically by the title).
isSuggested
Default: false
Whether this Flow should be displayed as a Suggested item or in the Others separator.
title*
Localized text to display to the user.
description
Optional description to show below the title.
category*
The category this Flow should belong to.
direction
Default: in
Specify for which Direction this Flow is used; in or out.
icon
Which icon to display. Following ways exist to define an icon:
- fontawesome icon name
- URL to an existing image (either starts with HTTP://, HTTPS://, /, ./ or ../) - for example you could place the icons in /custom and reference them with "/custom/icon.png"
- file extension (e.g.
.docx) - file path to a local existing file (local to the inPoint.Web.Server - e.g.
c:\\temp\\flatbed_scan.jpg)
visible
Default: true
Whether to display this Action.
groups
List of inPoint GroupIDs that this Flow should be visible to.
Note: User must be in all inPoint GroupIDs, for the item to display
Visual Rules
See Custom Attribute Icons & Colors and Custom Markers for a description.
Example:
"defaults": [{
"visualRules": [{
"targetNames": ["location"],
"markerImage": "/path/to/marker.svg",
"markerSize": [50, 80],
"markerAnchor": [25, 80],
"iconImage": "/path/to/icon.svg",
"iconSize": [10, 10],
"color": "red",
"rules": [{
"filters": [{"name": "status", "value": "WIP"}],
"markerImage": "/path/to/marker.svg",
"iconImage": "/path/to/icon.svg",
"color": "red"
}]
}]
}]
Target Names*
Array containing the common names of target fields, that will render the markers, colors and/or icons.
Marker Image
URL/Path to the custom marker image. Used only if no match via rules or rules does not set a specific marker.
Notes:
- Reference any attribute by
{CommonName}in your expression to calculate your URL/path of the file containing the marker. - The marker paths are case insensitive.
Marker Anchor
The position at which to anchor an image in correspondence to the location of the marker on the map. [<x>,<y>]
Note: if not specified by Default each Map Provider does it a bit differently - e.g. with GoogleMaps the anchor is located along the center point of the bottom of the image.
Marker Size
Array containing the width and height of the custom marker. [<width>,<height>]
Icon Image
URL/Path to the icon image. Used only if no match via rules or rules does not set an icon.
Notes:
- Reference any attribute by
{CommonName}in your expression to calculate your URL/path of the file containing the icon. - The icon paths are case insensitive.
Icon Size
Array containing the width and height of the custom icon. [<width>,<height>]
Color
CSS color sting, e.g. (red, #ff0000 or rgb(255,0,0) ). Used only if no match via rules or rules does not set a specific color.
Rules
Array of rule sets. Define from specific to general. The first rule set to match will be used (First or defaults).
filters
Array of filters. If more than one filter is defined, all must match, that this rule set is used. If no filters are set, it will always match.
markerImage
URL/Path to the custom marker image.
Notes:
- Reference any attribute by
{CommonName}in your expression to calculate your URL/path of the file containing the marker. - The marker paths are case insensitive.
iconImage
URL/Path to the icon image.
Notes:
- Reference any attribute by
{CommonName}in your expression to calculate your URL/path of the file containing the icon. - The icon paths are case insensitive.
color
CSS color sting, e.g. (red, #ff0000 or rgb(255,0,0) ).
Manage Activities
Specify ActivityList settings.
NOTE: This configuration will override your ItemView_Activity configuration.
Example:
"defaults": [{
"activityList": {
"showNotes": true,
"showAddNote": true,
"showHistory": true,
"showRetentionInfo": true
}
}]
showNotes
Default: true
Whether to show Notes entries.
showAddNote
Default: true
Whether to allow adding a new note directly.
showHistory
Default: true
Whether to show History entries (i.e. Created on, Modified, Locked)
showRetentionInfo
Default: true
Whether to show custom Retention info (cleanup settings).
Share
Define how to share documents/folders.
Example:
"defaults": [{
"share": {
"shareType": "share/link/attachment/pdf",
"isInPointClientAllowed": true/false,
"isInPointWebAllowed": true/false,
"isLinkAllowed": true/false,
"isShareAllowed": true/false,
"isDocSendAsAttachmentAllowed": true/false,
"isDocSendAsPdfAllowed": true/false,
}
}]
ShareType
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.
isInPointClientAllowed
Default: true
Whether to allow user send inPoint.Client Links of document/folder
isInPointWebAllowed
Default: true
Whether to allow user to send inPoint.Web Links of document/folder
isLinkAllowed
Default: true
Whether to allow user to share document/folder as Link
isShareAllowed
Default: true
Whether to allow user to share document/folder
isDocSendAsAttachmentAllowed
Default: true
Whether to allow user to send Documents via Email
isDocSendAsPdfAllowed
Default: true
Whether to allow user to send Documents as PDF via Email
Scope Breadcrumb
This allows you to make the breadcrumb not clickable up to certain level.
scopeFromLevel
Default: 0
The level from which the breadcrumb is clickable. 0 = root, 1 = first child, etc.