User Guide

Springboard Module for K2 is a set of K2 and non-K2 assets that include K2 smartforms, SmartObjects, HTML, CSS and Javascript files. These assets have been purposely built to be independent modules supported by a set of micro-services and storage facilities as K2 service objects.

These modules focus on a specific capability to help solve either a business problem or a specific functional requirement.

Modules

Springboard consists of one foundation module that enables the framework and provides some core capabilities and a number of non foundation modules that can be independently installed and utilised. Each module can be used individually and interdependently of each other. This gives users the ability to deploy only the necessary modules to cater for their business or technical requirements. Each module can be installed using K2’s Package and Deployment tool. A module comprises of:

  • One or more purpose built reusable components that exposes the functional capability of the module
  • A set of supporting artifacts that help faciilitate the configuration and execution of the components

Example of a business module:

Example of a business problem module would be a KPI Module that enables the implementation and management of KPI’s across a solution.

Example of a functional module:

Example of a functional module would be a Address Module that enables the ability to turn any control into a address autocomplete.

To see a list of current and in development modules go to the modules section.

View Components

A view component is a reusable view that exposes the capabilities of a module. Multiple view components function as part of a module, which can be used in new or pre-existing K2 solutions and are completely reusable.

You can apply the modules to any pre-built K2 solutions by adding our Foundation Loader View Component which will allow you to utilise the extent of all our other View Components on your platform. Examples of View Components:

The Loader View Component of the foundation module is responsible for loading the framework for all other modules to work.

The Theme View Component of the foundation module is responsible for applying styling to the page.

View Component Types

View Component Types can be broken down into the following:

  1. [View] as in ViewComponents – K2 view that can be dragged and dropped onto any form that has the SBM4K2.Foundation.Components.Loader.
  2. [Logic] as in LogicComponents – K2 smartobjects that incapsulate logic that can then be utilised in any K2 workflow, view or form.
  3. [Workflow] as in WorkflowComponents – K2 workflow processes that are intended to be reused.

How do I get access to Springboard Modules for K2?

In order to install Springboard Modules for K2 on your environment, you will need an to request an API Key. You can request an API key by sending us a message via our contact page.

This API key ensures that tenant details are segregated and that the uploading of JavaScript files is restricted.

How do I use Springboard Modules for K2?

  • Once you have requested and applied your API Key to gain access to Springboard Modules for K2 on your environment
  • In your K2 Designer, drag the following View onto your Form SBM4K2.Foundation.ViewComponents.Loader
  • This modules loads the framework and is then responsible for making sure all the required files and any other modules that are on the page have been loaded. Since a module could use JavaScript the loader ensures any library and dependency are loaded accordingly.
  • Rule execution for the form will only be executed once the Springboard Module for K2 has completely loaded.
  • Make sure that the SBM4K2.FoundationViewComponents.Loader is the first action being executed with the View Initalized execution method  on the Form is Initializing Form rule.
  • Once you have completed the above, you can add any other rules as well as drag and drop any other module view components onto the page.

Knowledge Base

In the K2 Designer, click the View Knowledge Base to understand how each Module works/if you need additional information.

Debug Mode

Springboard Modules for K2 provides a debugging ability by utilising a hidden view called “Table Debug.” To get this working at Runtime, you need to run the Form and append the URL with “sbmdebug=true.

DevMode

Devmode is a runtime capability to assist with applying setting to your K2 forms.

To enter DevMode append sbmdevmode=true to the forms query-string and your will see a top bar appear showing that you are now in DevMode:

By clicking the < and opening the side panel a list of modules that exist on the page are lists as well as page level CSS and JavaScript extension manager.

This area allow you to add additional CSS and JavaScript to the page and the framework will ensure this will be loaded when the framework loads.

The CSS and JavaScript files are automatically persisted to the springboard services into a segregated repository and protected by the Application Key. ( there is a roadmap to further restrict the users that will be allowed to upload the JavaScript )