Document Management - manual installation

⚠️ This guide assumes you have not used GenX to add the Document Management component. You should only add components manually if your project is on an older framework version that does not support GenX Add.

For the UI, add the following to the dependencies section of client/package.json in your project:

"@genesislcap/pbc-documents-ui": "<version>"

Note that each component requires a permission so that the user can view it or perform a specific action; check the permissions available and ensure that your user is permissioned accordingly.

Adding the Document Management component to the UI

Set up a route for the component in the file client/src/routes/config.ts. This makes the component visible to your application:

{/
  title: 'Document Management',
  path: 'document-management',
  name: 'document-management',
  element: async () => (await import('@genesislcap/pbc-documents-ui')).FoundationDocumentManager,
  settings: { autoAuth: true, maxRows: 500 },
  navItems: [
    {
      navId: 'header',
      title: 'Document Management',
      icon: {
        name: 'file-csv',
        variant: 'solid',
      },
      placementIndex: 35,
    },
    {
      navId: 'side',
      title: 'Special Document Manager',
      routePath: 'document-management/foo', // < example if there were child routes
      icon: {
        name: 'file-csv',
        variant: 'solid',
      },
    },
  ]
}