Sunbird UCI
  • Overview of Sunbird UCI
  • 📙Learn
    • UCI use cases
    • UCI for Education(Case study)
    • Tech Overview
      • Glossary
      • High-level Architecture Design
      • Design Principles
      • Standards
  • 🚀Use
    • Choose your Persona
    • Adopter - Install and use UCI
      • Pre-requisites, Installation Setup, Post Setup
      • Setting up your very first conversation
      • API Documentation
      • Data Exhaust and Analytics
      • Posthog Event
      • Whatsapp (Netcore)
      • Environment Variables
    • Developer - Contribute to UCI
      • UCI Basics
        • XMessage Specification
        • Transformers
          • ODK Transformer
            • Interactive-Messages
            • Media Messages
            • Location
          • Broadcast Transformer
        • Adapters
          • Firebase Notification Adapter
        • User Segment
        • Schema Overview
          • UCI Core Schema
            • XMessage Schema
            • Assessment DB Schema
          • UCI API Schema
      • Development environment
        • Backend Setup
        • Setting up IDE
        • Environment variable setup
        • Debug services
        • Build and Execute UCI
        • Frontend Setup (Admin Console)
        • Frontend Setup (PWA)
        • Transport Socket
      • API Documentation
        • Bot Setup APIs
        • History APIs
        • Direct Message APIs
        • Vault APIs
      • Database Schema
        • Cassandra Xmessage Database
        • Postgres Forms Database
        • Postgres User Analytics Database
        • Postgres Comms Database
      • Contribution Guide
        • Your first PR
        • Contribute an Adapter
        • Adapter Implementation
        • Create a Transformer
    • Contact the administrator
  • ✅Releases
    • Release V2
  • 🤝Engage
    • Software License
    • Acceptable Use Policy
    • Terms of Service
    • Source Code
    • Discussion Forum
Powered by GitBook
On this page

Was this helpful?

Edit on GitHub
  1. Use

Adopter - Install and use UCI

I want to use Sunbird UCI in my own project and I want to set up my own instance of Sunbird UCI

PreviousChoose your PersonaNextPre-requisites, Installation Setup, Post Setup

Last updated 1 year ago

Was this helpful?

Adoption guide - overview

This page contains guides which walk through various aspects of UCI functionality. These documents are meant to give you a thorough understanding of the technology covered.

This section lists everything you need to know about setting up the UCI on your own server. It starts with the infra pre-requisites, then details the Docker-based installation setup. At the end, the section covers the steps to test out various services that should be up. If you face any problem with one or more services, you can reach out to the community for help .

After the setup is complete. The next step is to create a conversation and to start testing the UCI for an end to end custom logical conversation flow. There are two ways listed on this page:

  1. Using the admin console to create the bot

  2. Using the APIs in the sequence to create the bot The admin console internally uses the same APIs calls as mentioned in the second method

After the bot is created you can actually test the bot on the UCI web channel. Web channel is an in-house created channel that can be used standalone or can be embedded in any existing application. It does not require any separate setup. It comes as a package with vanilla UCI setup.

This section lists all the relevant APIs required to use the UCI services. More APIs can be found in the Developer section of the documentation.

This section captures how the usage data for the bot can be extracted and used further for analytics purposes.

UCI does not differentiate between any data storage and analytics tool. We are talking about PostHog as we found it to fit the bill for our needs. In this section, we share how you can setup Posthog, view events on PostHog and also create your relevant dashboards on it.

🚀
Pre-requisites, Installation Setup, Post Setup
here
Setting up your very first conversation
API Documentation
Data Exhaust and Analytics
PostHog events