Developer Guide

The Developer Guide is intended for users with code-level access within your Business Intelligence tool. It provides resources to help build and maintain both integrated and stand alone deployments of Izenda.

Interacting with the Izenda API

You can interact with our API in both integrated and standalone instances of Izenda.

• Full API List
  • Back-end Integration APIs
  • Front-end Integration APIs
• Basic API Client Code Samples
  • REST API Test
  • ReactJS to manage a scalar value
  • ReactJS to manage the list of categories
  • ReactJS to toggle the list of visible data sources
• Intermediate API Client Code Samples
  • ReactJS to manage data sources and data source fields
  • JavaScript Manage UI Components, Libraries and Unit Tests
  • Building Report
  • Data, Tenant, and Role Configuration
  • Adding User

Embedding Izenda

We have created several starter kits to demonstrate how to embed Izenda into web applications. Every kit displays many of the same concepts (e.g. embedding the Izenda suite as a single page application) but each may showcase additional features more extensively (e.g. hidden filters and rendering individual reports.). All publically available kits can be found on our GitHub Repository .

• First Steps
  • Installing a standalone instance of Izenda
  • Installing an integrated instance of Izenda
    • Starter Kits
• Embedding Izenda into Your Application
  • Front-End Development: Embedding into a Pre-Existing Application
  • Full-stack Development: Starting from Scratch
    • Deployment Mode 1: Key Components for Integration
    • Deployment Mode 3: Building the MVC Starter Kit
    • Building the Webforms Starter Kit

Troubleshooting Front End Integration

• Front End Rendering Considerations
  • There are no errors in the API Logs or console but the component doesn’t render
  • The “Visual” Tab of Forms Editor in the Report and the “Text” Tile Editor in Dashboards Don’t Render
  • Re-using Containers to Render Different Izenda Components

Customizing Your Izenda Instance

Izenda supports an array of customizations ranging from style modifications to data format additions and hidden filters.

Interfacing with Izenda

• Customizing System via Interfaces
  • White Labeling URLs
  • IAdHocExtension
  • IAdHocExtension Samples
  • Customizable Interfaces
  • ICacheProvider - Redis Sample
  • DataSourceAdaptor - DB2 Sample
• Modifying Default Email Template
  • Change the Default Footer in Emails
• Modifying User Access Token
  • Adding a custom property to the User Info
  • Adding decryption logic to IAdHocExtension
  • Retrieving the access token properties from the hidden filter method

Styling Izenda

• Location of CSS
• CSS Conflicts
• Customization (Simple)
• Customization (Scalable)
• Key Styling Colors
  • Example Color Changes
  • Sample Code
• Visually Editing CSS
  • Other Helpful Tools
• Common CSS Customizations
• Customizing the Report Designer Tooltips & Overlay
• White-Labeling Izenda
  • Introduction
  • CSS Overrides
  • Common Examples

Configuring Logging

• Logging Information Into a Database
  • Using .NET Framework API
  • Using .NET Core API

Redistributing the Izenda Documentation

This documentation can be downloaded from our GitHub reposistory and redistributed for your customers.

• Download a Live Copy
• Download a Development Copy
• White Labeling the Documentation