Akumina Developer Documentation

Akumina Developer Documentation

  • API
  • Docs
  • Blog

›Advanced

Akumina

  • Quickstart

Yo Akumina

  • Yo Akumina
  • Start with Yeoman
  • React
  • Simple template

Widget Builder

  • Widget Builder Structure
  • Akumina Widget Builder
  • Skipping instances
  • Token replacement for widget properties

Widget Development Quickstart

  • Setting up the Project
  • Configuring .env file
  • Configuring - akumina.sitedployer.config.json file
  • Configuring - akumina.config.json file
  • Extras

Widget Info

  • Akumina Widgets Overview
  • Building a New Widget Instance
  • Widget Views
  • Widget Properties
  • Global vs Local widgets (Widget Scoping)
  • Akumina React Widgets
  • Callbacks
  • RenderChildWidgets
  • Vendor Package List

Virtual Page Builder

  • Akumina Virtual Page Builder
  • Using Virtual Page Layouts
  • Creating a Custom Layout

Stream Card Builder

  • Installation
  • Stream Card Builder
  • Custom Cards
  • Activity Comments Config
  • Akumina Activity Stream PUSH Subscription using PowerAutomate to connect to ServiceNow
  • Akumina Activity Stream PUSH Subscription using PowerAutomate to connect to Dynamic 365

Site Deployer

  • Overview
  • Version 6.0
  • List Attribute Deployments
  • NPM Commands
  • SPA Updates and Deploying to multiple sites

Authoring

  • Content Action Event
  • Publish Validation Integration
  • Field Event Integration
  • CK Editor external plugins

Headless

  • Quickstart
  • Headless Teams support
  • Headless Troubleshooting

Modern

  • Overview
  • FAQ
  • Single Page Application
  • Modern Web Part Library
  • Google Analytics for Modern Pages

Site Creator

  • Overview
  • Adding A Custom Site Definition
  • Core Step Classes
  • Custom Site Definition Components
  • Custom Site Definition XML
  • Custom Subsite Definitions
  • Sample Step Code
  • Supported Tokens

Azure DevOps

  • CI/CD using Azure DevOps
  • Setting up a build to deploy a site package
  • Setting up a build to deploy file to App Manager hosted in an app service

Configuration

  • Configuration Context Overview
  • Edit the Redis cache timeout
  • Using a key vault for the client id and client secret

Debugging

  • Debugging in Akumina

Advanced

  • Central Site Collection Support
  • Eventing OOB Digital Workplace Events
  • Working with custom JSX Views
  • Page Indexing

Service Hub

  • Quickstart

Patch Notes

  • Patch Notes

Eventing OOB Digital Workplace Events

OOB Digital Workplace Events

The following are events that are already fired within the Akumina Framework that you can subscribe functions to.

Loader

/loader/executestep/

Fires once a step within the Digispace loader is completed

/loader/onexecuted/

Fires when a step within the Digispace loader is executed

/loader/completed/

Fires once all the steps for the loader are completed

/loader/showloading/

Fires when the loader is shown

/loader/handlesharepointbar/

Fires during the Digispace loader core step that determines whether the sharepoint bar will be shown or hidden

/loader/servicehubendpointready/

For calling graph (Note: introduced in 5.0, but improved in 5.5)

Page

/page/changed/

When using the SPA, fires when the page is changed. Note - this is not a full reload of the page, just the interior.

/page/loaded/

Fires after the page has loaded - for attaching analytics code (new in 5.5). Note - this fires when navigating within the SPA as well as on full page load.

Dashboard

/dashboardcontainer/render/

Fires whenever the dashboard is navigated to or updated

MM

/MM/Go/

Fires when we click on a widget in edit widget mode

Widget

/widget/loaded/

For those widgets that support it, fires after the widget is loaded (binds its UI and events)

/widget/updated/

Fires after we click ‘Update’ in the WidgetManager Menu

Genericlistcontrol

/genericlistcontrol/loaded/

Fires after we load a Generic List Control Widget

Myteam

/myteam/profileclicked/

Fires after the profile is clicked within the Team Widget modal

Peoplelistsearch

/peoplelistsearch/searchclick/

Fires when we click ‘Search’ within the People List Search Widget

Practiceareapeople

/practiceareapeople/search/

Fires when we call the Search function within the People List Widget

/practiceareapeople/searchcompleted/

Fires when the search is completed within the People List Widget

/practiceareapeople/error/

Fires when there is an error in searching within the People List Widget

Authoring

/authoring/rail/close/

Fires when the authoring rail (in the front end) fully closes. NOTE - requires 6.0.2301.1506 and above.

/authoring/rail/open/

Fires when the authoring rail (in the front end) fully opens. NOTE - requires 6.0.2301.1506 and above.

References

See the article below for the overview of Eventing

  • Overview
← Central Site Collection SupportWorking with custom JSX Views →
  • Loader
    • /loader/executestep/
    • /loader/onexecuted/
    • /loader/completed/
    • /loader/showloading/
    • /loader/handlesharepointbar/
    • /loader/servicehubendpointready/
  • Page
    • /page/changed/
    • /page/loaded/
  • Dashboard
    • /dashboardcontainer/render/
  • MM
    • /MM/Go/
  • Widget
    • /widget/loaded/
    • /widget/updated/
  • Genericlistcontrol
    • /genericlistcontrol/loaded/
  • Myteam
    • /myteam/profileclicked/
  • Peoplelistsearch
    • /peoplelistsearch/searchclick/
  • Practiceareapeople
    • /practiceareapeople/search/
    • /practiceareapeople/searchcompleted/
    • /practiceareapeople/error/
  • Authoring
    • /authoring/rail/close/
    • /authoring/rail/open/
  • References
Akumina Developer Documentation
Docs
Akumina Framework 5.0Akumina Widget BuilderAkumina Yeoman GeneratorSite Deployer
Community
Akumina Community Site
More
GitHubStar
Copyright © 2024 Akumina