Akumina Developer Documentation

Akumina Developer Documentation

  • API
  • Docs
  • Blog

›Site Creator

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

Core Step Classes

Core Step Classes

We include the following classes that implement the ISiteProvisionerStep interface within the Akumina.SiteProvisioning.CoreSteps.dll

  • AddApps.cs – Adds Apps to Interchange.
  • AddContentFilesToStyleLibrary.cs – Adds the contents of Branding/Content to AssetDirectory/Content inside of the Style Library
  • AddControlsToPages.cs – Adds the content outlined in PageContent/pages.xml to the designated web part zones
  • AddCSSFilesToStyleLibrary.cs – Adds the contents of Branding/CSS and Branding/SCSS to AssetDirectory/CSS and AssetDirectory/SCSS, respectively, within the Style Library
  • AddIconFilesToStyleLibrary.cs – Adds the contents of Branding/icons to AssetDirectory/icons within the Style Library
  • AddImageFilesToStyleLibrary.cs – Adds the contents of Branding/img, Branding/images, and Branding/content-images to AssetDirectory/img, AssetDirectory/images, and AssetDirectory/content-images, respectively, within the Style Library
  • AddJSFilesToStyleLibrary.cs – Adds the contents of Branding/JS to AssetDirectory/JS within the Style Library
  • AddMasterPageFiles.cs – Adds the master page html file from the MasterPages folder to the Master Page gallery on the site, generates an associated .master file, and sets the Site Master Page to the .master file.
  • AddPageLayouts.cs – Adds the AkuminaIgnite content type to the site. Adds Page Layouts to the site.
  • AddPages.cs – Adds pages to the Pages library
  • CheckPrereqs.cs – Checks to see if Publishing features are activated on the SharePoint site.
  • EnsureAssetDirectoryExists.cs – Ensures that the AssetDirectory exists with the SiteDefinitions folder
  • ProvisionLists.cs – Adds lists to the site
  • ResetMasterPageInheritance.cs – Resets master page inheritance
  • SetSecurityOnSite.cs – Creates default permissions groups on a site
  • SetVersion.cs – Creates the Version_AK list and stores the SiteCreator version within
  • UpdateListItems.cs – Updates items within existing lists
  • UpdateSearchDisplayTemplates.cs – Adds search display template to masterpage catalog
  • UploadFiles.cs – Uploads files to SharePoint libraries
  • ValidateUserSettings.cs – Enforces user input requirements within the Deployment view These steps can be created by including the Akumina.SiteProvisioning.CoreSteps reference within your C# class inheriting the SiteProvisionerSiteBase class and then adding the step as usual. Below we use the CoreSteps dll to include the EnsureAssetDirectoryExists.cs step
using Akumina.SiteProvisioning.CoreSteps;

Within Steps:

_steps.Add(new EnsureAssetDirectoryExists());

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 Subsite Definitions
  • Sample Step Code
  • Supported Tokens
← Adding A Custom Site DefinitionCustom Site Definition Components →
  • References
Akumina Developer Documentation
Docs
Akumina Framework 5.0Akumina Widget BuilderAkumina Yeoman GeneratorSite Deployer
Community
Akumina Community Site
More
GitHubStar
Copyright © 2025 Akumina