Entitlements Technical Reference

Entitlement Options

EntitlementOptions

Options for managing Entitlements in AdapTable, ie. which Modules are available to the User and whether as Full, ReadOnly or Hidden.

defaultAccessLevel?

AccessLevel| ((defaultAccessLevelContext:DefaultAccessLevelContext) =>AccessLevel)

AccessLevel used by modules that do not define their own default (via
Module.getDefaultAccessLevel()). Can be a hardcoded value or a function.

Note: some modules override the per-module default (e.g. State Management defaults to
Hidden unless explicitly entitled). Setting this to Full does not force those modules
visible — use moduleEntitlements to opt them in.

Default

'Full'

moduleEntitlements?

Entitlement[] | ((entitlementContext:EntitlementContext) =>AccessLevel | undefined)

Returns either collection of Entitlements, or a function to invoke when an Entitlement is required

defaultAccessLevel is an AccessLevel:

Value
`'ReadOnly'`
`'Hidden'`
`'Full'`

moduleEntitlements entries are an Entitlement:

Entitlement

Access granted to one AdapTable module.

Full shows the module and allows its objects to be added, edited and deleted. ReadOnly shows the module and blocks those changes. Hidden does not show the module. A module with no entitlement uses that module's default, which is Full unless the module sets its own.

accessLevel

AccessLevel

Access Level for an Entitlement; options are: Full ReadOnly Hidden

adaptableModule

AdaptableModule

Name of Adaptable Module that has the Entitlement applied

adaptableModule is an AdaptableModule:

Value
`'Alert'`
`'BulkUpdate'`
`'CalculatedColumn'`
`'CellSummary'`
`'Charting'`
`'Comment'`
`'CustomSort'`
`'Dashboard'`
`'DataChangeHistory'`
`'DataSet'`
`'Export'`
`'Fdc3'`
`'ColumnFilter'`
`'FlashingCell'`
`'FormatColumn'`
`'FreeTextColumn'`
`'GridInfo'`
`'ColumnInfo'`
`'IPushPull'`
`'Layout'`
`'OpenFin'`
`'PlusMinus'`
`'QuickSearch'`
`'SettingsPanel'`
`'Shortcut'`
`'SmartEdit'`
`'StyledColumn'`
`'StateManagement'`
`'StatusBar'`
`'SystemStatus'`
`'TeamSharing'`
`'Theme'`
`'ToolPanel'`
`'Note'`
`'DataImport'`
`'GridFilter'`
`'NamedQuery'`
`'Expression'`