Pega Constellation Mobile SDK

Overview

The Pega Constellation Mobile SDK is designated for Native Android and iOS applications. It allows to embed Pega form into existing application with the possibility of using customized UI.

The SDK allows developers to:

• register their implementations for custom components
• provide implementations for Pega components not yet available in the SDK
• register overrides for existing components

It utilizes Constellation JavaScript library and JavaScript components logic. By default the SDK uses hidden WebView as the JavaScript execution engine.

Supported Pega use-case

Currently, the SDK supports creating cases of a specified type, opening and processing assignments.

Supported components

The SDK provides following components out-of-the-box:

• Simple fields:
  • Checkbox, Currency, Date, DateTime, Decimal, Dropdown, Email, Integer, Phone, RadioButtons, TextArea, TextInput, Time, Url
• Advanced fields:
  • EmbeddedData
    • Single record - not supported
    • List of records
      • Displayed as "Repeating View” - supported
      • Displayed as “Table”, “SimpleTable” - not supported
  • DataReference
    • Single record
      • Displayed as “SimpleTable”, “Table”, “Dropdown” - supported
      • Displayed as “Autocomplete”, “Advanced Search" - not supported
    • List of records - not supported
    • Many to many - not supported
• Containers:
  • Assignment, AssignmentCard, DefaultForm, FlowContainer, Region, RootContainer, View, ViewContainer, Field Group
• Other:
  • ActionButtons, AlertBanner

Architecture

The SDK is implemented using Kotlin Multiplatform technology. It allows to share common code between multiple platforms.

The SDK consists of several modules:

• core: Contains core SDK logic, configuration and component abstractions. It is platform-independent and shared between all supported platforms.
• engine: Contains platform-specific engine implementations, which use Constellation CoreJS library that orchestrates the application logic.
• samples: Contains sample applications for Android and iOS platforms.
• ui: Contains UI components for supported UI technologies.

The SDK supports following UI technologies:

• Android: Compose Multiplatform, Jetpack Compose, XML/Views (*)
• iOS: Compose Multiplatform, SwiftUI, UIKit (*)

* SDK does not provide out-of-the-box components for these UI technologies

Get started

• Getting started with the SDKs
• How to integrate with Constellation SDK

Running sample applications

• Setting up sample Pega application
• Configuring sample mobile applications
• Running Android sample application using Compose Multiplatform
• Running iOS sample application using Compose Multiplatform
• Running Android sample application using Jetpack Compose
• Running iOS sample application using SwiftUI

Screenshots

Sample apps using Compose Multiplatform (Android and iOS)

Sample app using SwiftUI (iOS)

License

Sources of this repository are licensed using Apache 2 license.