Page Life Cycle: Core Steps - akumina/AkuminaTraining GitHub Wiki

Overview

The following document is a list of step CONSTANTS, their associated names, and brief descriptions. Step CONSTANTS and their activation statuses can be viewed by opening the Page Life Cycle section of the debug panel.

Debug Page Life Cycle

Alternatively, Page Life Cycle steps can be viewed by entering the following line into your Console.

Akumina.Digispace.ConfigurationContext.CONSTANTS

Steps

Steps are listed by their CONSTANT. Step Names are relevant when adding additional steps. Some CONSTANTS are not explicit steps within the page life cycle but enable a feature within a step, these are listed as Not a step and custom steps cannot be added after them. If any Out of the Box steps are not needed for your development scenario, you can deactivate them to increase performance.

LOADER_STEPS_ENABLE_AUTOCLEAR

Name

Auto Clear Local Cache

Description

Enables Automated Cache Clear

LOADER_STEPS_ENABLE_AUTOLOGINTOAPPMANAGER

Name

Auto Login to AppManager

Description

Automatically logs into AppManager in the background

LOADER_STEPS_ENABLE_DEBUGINFO

Name

Debug Info

Description

Enables Debug Window and binds keys accordingly to it.

LOADER_STEPS_ENABLE_DETECTMULTIPLEVISIBLELANGS

Name

Detect Multiple SiteVisible Languages

Description

Detect if Mulitlingual is enabled on the site

LOADER_STEPS_ENABLE_DISPLAYLOADER

Name

Display Loader

Description

Displays Loading symbol for the Page life cycle load

LOADER_STEPS_ENABLE_DISPLAYSHAREPOINTBAR

Name

Display Sharepoint Bar

Description

Enables ability to toggle SharePoint Bar via a rail app

LOADER_STEPS_ENABLE_DISPLAYSITELOGO

Name

Display Site Logo

Description

Displays Site Logo from configuration settings

LOADER_STEPS_ENABLE_EVENTSUBSCRIPTION

Name

Event Subscription

Description

Registers functions to events.

LOADER_STEPS_ENABLE_FETCHCONFIGCONTEXT

Name

Fetching Digispace Configuration

Description

Fetches data for Configuration Context from AppManager endpoint

LOADER_STEPS_ENABLE_FETCHLANGUAGENEUTRALLISTS

Name

Get Extra LanguageNeutral Lists

Description

Retrieves Language Neutral lists from Configuration settings

LOADER_STEPS_ENABLE_FETCHLANGUAGES

Name

Fetching Async Lists

Description

Retrieves available languages from Configuration settings

LOADER_STEPS_ENABLE_FETCHPAGEPERMISSIONS

Name

Fetching Page Permissions

Description

Retrieves Page Level permissions for the logged in user

LOADER_STEPS_ENABLE_FETCHSPGROUPS

Name

Not a step

Description

Enables loading of SharePoint Groups into the User Context.

LOADER_STEPS_ENABLE_FETCHUSERPROPERTIES

Name

Fetching Async Lists

Description

Retrieves User Properties from App Manager Endpoint and initializes UserContext

LOADER_STEPS_ENABLE_FETCHWORKSPACECONTEXT

Name

Not a step

Description

Workspace Context Functionality. Referenced within Workspaces.

LOADER_STEPS_ENABLE_GETADDITIONALMARKUP

Name

Getting Async HTML

Description

Appends addtional Markup to Masterpage.

LOADER_STEPS_ENABLE_GETFOOTERMARKUP

Name

Getting Footer Markup template

Description

Appends Footer Markup to the page.

LOADER_STEPS_ENABLE_GETGRAPHTOKEN

Name

Getting Graph Token

Description

Retrieves Graph Token

LOADER_STEPS_ENABLE_GETINTERCHANGELOGINURL

Name

Not a step

Description

Deprecated. Interchange Login Url set in digitalworkplace.custom.js

LOADER_STEPS_ENABLE_GETLOADINGTEMPLATE

Name

Set Loading Template

Description

Sets Loading markup for widgets

LOADER_STEPS_ENABLE_GETWIDGETJS

Name

Not a step

Description

Gets widget javascript files from Widget Cache. Reference in GetWidgetInstances step

LOADER_STEPS_ENABLE_INDEXPAGEDATA

Name

Index Page Data

Description

Indexes PageData_AK list

LOADER_STEPS_ENABLE_INITRAIL

Name

Not a step

Description

Deprecated

LOADER_STEPS_ENABLE_INITSEARCHFIELDS

Name

Initialize Search Fields

Description

Initializes search box in Digital Workplace Foundation site masterpage.

LOADER_STEPS_ENABLE_INITSEARCHPAGE

Name

Initialize Search Page

Description

Initializes Search.aspx page

LOADER_STEPS_ENABLE_INITSNIPPETS

Name

Initialize Generic Controls

Description

Initializes all OOB Widget Types

LOADER_STEPS_ENABLE_INITWIDGETS

Name

Initialize Widgets

Description

Initializes widget instances

LOADER_STEPS_ENABLE_LOADDASHBOARDWIDGETS

Name

Load Dashboard Widgets

Description

Loads Dashboard Widgets from the Dashboard List

LOADER_STEPS_ENABLE_LOADUSERLANGSETTINGS

Name

Load User Language Settings

Description

Loads User Language Settings from UserContext and determines Multilingual content.

LOADER_STEPS_ENABLE_LOADWIDGETSINSTANCES

Name

Fetching Async Lists

Description

Loads Widget Instances from AppManager endpoint.

LOADER_STEPS_ENABLE_LOADWIDGETSTYPES

Name

Fetching Async Lists

Description

Loads Widget Definitions

LOADER_STEPS_ENABLE_PROVISIONDASHBOARD

Name

Provision Dashboard Page

Description

Sets up Page Manager on Dashboard Page

LOADER_STEPS_ENABLE_REFRESHAKTOKEN

Name

Refresh AKToken

Description

Resets AKToken within the Cache

LOADER_STEPS_ENABLE_RESUMEMAINWINDOWLOADER

Name

Not a Step

Deprecated. Loads iFrames.

LOADER_STEPS_ENABLE_SETDEPARTMENTSITECOLOR

Name

Set Department Site Color

Description

Sets department site color from site properties

LOADER_STEPS_ENABLE_SETSITETHEME

Name

Set Site Theme

Description

Sets Site Theme from Configuration settings

LOADER_STEPS_ENABLE_TRAYMENU

Name

Init Tray

Description

Enables Akumina flywheel found in the bottom left of the browser.

LOADER_STEPS_ENABLE_VALIDATEINTERCHANGEKEY

Name

Validating Interchange Query Key

Description

This step is deprecated as of 4.0.0.0

LOADER_STEPS_ENABLE_VALIDATEWORKSPACECONFIG

Name

Validate Workspaces Extensions

Description

Checks to see if Workspaces Feature is enabled.