Akumina Developer Documentation

Akumina Developer Documentation

  • API
  • Docs
  • Blog

›Authoring

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

Content Action Event

Applies to

6.0+

Overview

A few content actions in Authoring Modules publish an event called /authoring/contentaction/, which provides clients with several properties.

The following content actions publish this event:

  • Publish
  • Save
  • Delete
  • WorkFlow Submit
  • WorkFlow Cancel
  • Approve
  • Reject

This allows clients to create custom behavior that happens after an above content action.

Components

There is technically only one required component for this feature - code that subscribes to the /authoring/contentaction/ event. From there, it is up to you how you want to use the payload provided.

Example

In this example I am showing a modal that displays the item's contents. The Javascript code is placed inside of digitalworkplace.custom.js, and HTML is placed inside AdditionalMasterMarkup.html.

Javascript

Akumina.Digispace.AppPart.Eventing.Subscribe("/authoring/contentaction/", (contentAction) => {
      document.getElementById("authoring-events-content").textContent = JSON.stringify(contentAction, undefined, 2);
      $("#authoring-events-overlay").show();
      $("#authoring-events").show();
});

HTML

<div id="authoring-events-overlay" class="akv-modal-overlay" style="display: none"></div>
<div id="authoring-events" class="akv-modal akv-left-layer akv-modal-center akv-modal-small-medium" style="height: unset; display: none">
    <header class="akv-modal-header ">
        <div class="akv-modal-header-title-wrapper">
            <h2>Authoring Events</h2>
        </div>
        <div class="akv-modal-header-right-wrapper">
            <div class="akv-modal-actions">
                <button class="akv-modal-close" onclick="onCloseAuthoringEvents()">
                    <i class="fa-regular fa-xmark" aria-label="Close"></i>
                </button>
            </div>
        </div>
    </header>
    <section class="akv-modal-content ">
        <pre id="authoring-events-content">
        </pre>
    </section>
    <footer class="akv-modal-footer">
        <button class="akv-btn-form akv-primary" onclick="onCloseAuthoringEvents()">Close</button>
    </footer>
</div>
<script>
    const onCloseAuthoringEvents = () => {
        $("#authoring-events").hide();
        $("#authoring-events-overlay").hide();
    }
</script>

Payload

The ContentAction property contains a string that tells you what exactly the action was:

← SPA Updates and Deploying to multiple sitesPublish Validation Integration →
Akumina Developer Documentation
Docs
Akumina Framework 5.0Akumina Widget BuilderAkumina Yeoman GeneratorSite Deployer
Community
Akumina Community Site
More
GitHubStar
Copyright © 2024 Akumina