Welcome to our configuration documentation for the Kwantu platform.

Business process Analyst guide

Before an app can be developed, business process analysis is required in order to understand and document a specification for an app. Refer to the Analyst guide here.

App development Guide

The app development process has a recommended sequence of steps. Refer to the app Developer guide here where these steps are summarised and detailed.

Guide to operations

The operation of the Kwantu platform and its environment has is not much different from the challenges faced by IT operations in most organisations. Whether it's an in-sourcing, outsourcing, cloud or blend, the problems are the same and the solutions need to solve them. This guide talks to the issues of managing (backup & recovery, high availability computing, scale, migrations and integration, [stack, platform & app upgrades]) on the Kwantu platform and the features techniques and tips which will benefit operations staff responsible day-to-day business continuity.

Reference documentation

General architecture and concepts

• What is the Kwantu platform?
• Key concepts and terms
• Entity list
• Entity relationship diagram --> Edit in draw.io
• Entity relationships
• Application programming interface

Public portal

The public portal uses STRAPI and nextjs to render a portal website with extracted data for use either publically or internally.

• Strapi configuration

Communities

• Community
• Adoption level functions

Apps

This section of the documentation covers Apps.

1. Apps.
2. Apps are containers with includes their own pages,
3. App roles,
4. App permissions and
5. App workflow.
6. They reference shared data objects and
7. taxonomies.
8. Apps may be configured in multiple [languages].
9. Some workflow actions may only be processed on the server. Here is a reference of those actions
10. There is a GIS tool included that allows for the display and edit of map data.
11. The special Performance Application widgets may be found here
12. Creating and configuring help files for an app.

Get started here.

Reports and Dashboards

1. Reports
2. Dashboards

API to access the workflow directly

• GET API to retrieve data from the system
• API to update the system using the workflow engine
• External API: Accessing data objects through the API as a feed

Data registry

• Interoperability
• Shared apps
• Shared resources
• Shared data

Support and maintenance services and procedures

• This section deals with all those support and maintenance services and procedures used to perform updates on the databases and data, set up communities etc.
• Manage indexes
• Configuration builds to production
• Setting up online help
• Daily System Administration
• Daily System Administration for DRDLR
• Support for individual apps
• Restart servers
• Couchdb database maintenance
• Strapi and mongodb administration

Installation and upgrade

• Server requirements
• Installation
• Builds
• Developer environment
• Configuration environment
• Securing existdb

Load and performance testing

• Configure performance and load testing services

Lucene and Clouseau

• Clouseau index issues

ETL, Reports and Dashboards

• Managing the ETL environment
• Setting up the ETL to ElasticSearch
• Setting up the ETL for Couchdb to Oracle transformatiom
• Setting up the ETL for Couchdb to MySQL transformatiom
• Configure graphs with Vega lite

Tools and utilities

• Various tools to assist with maintenance and support functions
• Configuring backups

GIS and OpenMapTiles data

• Configure maps using leaflet and dashboards
• Build a map vector tiles with open street map
• Convert map boundaries for a country

Other client specific applications

1. EPWP
2. SEF

Configuration apps

This covers the specification for apps to configure apps on the platform.

App	Description	Link
Config apps	Covers the community, app and workflow config apps	https://docs.google.com/document/d/1LuEnuP9WzAT4fyMUc4P5U85YXmC0_eF4UxfTIszOXcs/edit#
Taxonomy	Covers the taxonomy editor	https://docs.google.com/document/d/1Z3ZjA4HZ--Rc3sRfqk1RSThpI3gKulvKroFcXbB9U0k/edit#heading=h.3ofsqig2719p
Reports	Covers the reports	https://docs.google.com/document/d/16Io6k4uz2JD0sJlrP-9O8nxl1r2af1Zm0uc83he8aV4/edit#

Platform specification

This covers the specification for core platform functionality.

Module	Description	Link
User management	Covers user management	https://docs.google.com/document/d/1tLvlcWyxyEyA_02gFR3dQvK8Y8EAgLolu-BI6adus8Y/edit#
Notifications	Covers platform notifications	https://docs.google.com/document/d/1djrVPUX8-r8dvRE9-VRnFqRK0SHAVLi98nPJ2Y931Sg/edit#