Akumina Developer Documentation

Akumina Developer Documentation

  • API
  • Docs
  • Blog

›Site Creator

Akumina

  • Quickstart

Modern

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

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

Virtual Page Builder

  • Akumina Virtual Page Builder
  • Using Virtual Page Layouts

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

Yo Akumina

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

Widget Info

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

Site Deployer

  • Overview
  • Version 4.8
  • Version 5.0
  • List Attribute Deployments
  • NPM Commands
  • SPA Updates and Deploying to multiple sites
  • Using site deployer with MFA

Headless

  • Quickstart
  • Headless Troubleshooting

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

Adding A Custom Site Definition

Adding a Custom Site Definition

The Akumina Framework permits the integration and deployment of custom site definitions onto SharePoint Publishing Sites.

Prerequisites

  • A publishing site collection in Office 365
  • AppManager App (hosted on Azure) installed on your site collection
  • AppManager Admin apps set accessible to a user group within the site
  • The InterChangeSDK project

Adding SiteProvisioning.SampleSite To AppManager

Within the AppManagerSDK project will be a project called SiteProvisioning.SampleSite. This is a basic example of a custom site definition we can deploy with the Deployment App.

Adding the SiteProvisioning.SampleSite project with the Deployment App can be done in a few simple steps.

  1. Build the SiteProvisioning.SampleSite project
  2. Copy the SiteProvisioning.SampleSite.dll from $\InterChangeSDK\Main\Src\SiteProvisioning.SampleSite\bin\Debug over to Akumina.Interchange.Web\bin within your instance of AppManager (use FTP if you’re hosting it on Azure).
  3. Copy the $\InterChangeSDK\Main\Src\SiteProvisioning.SampleSite\SiteDefinitions folder over to Akumina.Interchange.Web within your instance of AppManager
  4. Log into AppManager, go to the Deployment App within the Management Apps tab. You should now see “SampleSite” appear in the dropdown. Any custom site definitions can be added to the Deployment App in the same manner.

References

To learn how to leverage the Deployment Manager SDK see the following articles:

  • Overview
  • Adding A Custom Site Definition
  • Core Step Classes
  • Custom Site Definition Components
  • Custom Site Definition XML
  • Custom Subsite Definitions
  • Sample Step Code
← OverviewCore Step Classes →
  • Prerequisites
  • Adding SiteProvisioning.SampleSite To AppManager
  • References
Akumina Developer Documentation
Docs
Akumina Framework 5.0Akumina Widget BuilderAkumina Yeoman GeneratorSite Deployer
Community
Akumina Community Site
More
GitHubStar
Copyright © 2023 Akumina