foundation-entity-management.users

Home > @genesislcap/foundation-entity-management > Users

Users class

Warning: This API is now obsolete.

• Use '@genesislcap/pbc-auth' instead. 'https://www.npmjs.com/package/@genesislcap/pbc-auth'

Main class which defines the user management functionality

Signature:

export declare class Users extends Users_base 

Extends: Users_base

Remarks

Under the hood the user-management is the entity-management micro-frontend configured for use with the ALL_USERS resource.

Example

With no customisation required the user management micro-frontend can simply be dropped into the template as shown. However, it is advised to wrap it in an error boundary component.

<user-management></user-management>

With this default example above the columns will be the UsersColumnConfig as well as the entity and status columns. The entity and status columns are always added regardless of the other columns which are configured.

You can add in additional customisation options. For example you can define a custom column and then mix-in with the standard columns

import { Users, UsersColumnConfig, } from '@genesislcap/foundation-entity-management';

const userColumns = [
  {
    field: 'ACCESS_TYPE',
    headerName: 'Access Type',
  },
];

// Definition inside of the html template
<user-management :columns=${() => [...UsersColumnConfig, ...userColumns]}></user-management>

Constructors

Constructor	Modifiers	Description
(constructor)()		Constructor will set the Users.createEvent Users.deleteEvent Users.updateEvent to match the permissions set from the server

Properties

Property	Modifiers	Type	Description
additionalCreateFields		AdditionalEntry[]
additionalUpdateFields		AdditionalEntry[]
allAccessType		boolean
columns		(ColDef<any> | ColGroupDef<any>)[]	Column definition, default to the UsersColumnConfig
createEvent		string	String which contains event if we have permission to insert user of empty string if not
datasourceType		DatasourceType	If set to 'server' it will enable Server-Side Row Model and use grid-pro-server-side-datasource for the grid of the entity-list sub-component. By default grid-pro-client-side-datasource will be used.
deleteEvent		string	String which contains event if we have permission to delete user of empty string if not
enableSearchBar		boolean	This attribute controls whether to enable the search-bar.
gridOptions		GridOptions	GridOptions to be passed down from application
isServerSideDatasource	readonly	boolean
persistColumnStateKey		string	This attribute controls whether and how the user manager stores the state of the columns when the user edits them. Defaulted to entity_users_management.
persistFilterModelKey		string	The key to use for persisting the filter model in local browser or KV storage.
prefix		string	Name of the design system prefix that will be used for components.
updateEvent		string	String which contains event if we have permission to update user of empty string if not

Methods

Method	Modifiers	Description
connectedCallback()
deepClone()
disconnectedCallback()