Skip to content

Kentico/xperience-by-kentico-aira-unified

Repository files navigation

Xperience by Kentico Aira Unified

Kentico Labs CI: Build and Test NuGet Package

Description

Aira Unified integration provides an alternative administration UI and chatbot that can be easily added to an Xperience by Kentico project. It is designed for content editors and marketers who need essential functionality on mobile devices.

Screenshots

UI Chat

UI Smart Uploader

Library Version Matrix

Xperience Version Library Version
>= 30.0.0 >= 0.1.0-prerelase-1

Dependencies

Full Instructions

To activate the communication of Aira Unified app with the Aira service, you need to request an activation key. Please contact us at productmanagement@xperience.io for more information.

Follow the steps below to add the Aira Unified app to your Xperience project.

Package Installation

Add the package to your application using the .NET CLI

dotnet add package Kentico.Xperience.AiraUnified

Quick Start

  1. Add the Aira Unified API subscription key to your appsettings.json.:
"AiraUnifiedOptions": {
  "AiraUnifiedApiSubscriptionKey": "<your Aira Unified API key>"
}
  1. Configure your project for HTTPS.

  2. Include the Kentico.Xperience.AiraUnified package in your project:

    dotnet add package Kentico.Xperience.AiraUnified
  3. Register the required services in Program.cs:

    var builder = WebApplication.CreateBuilder(args);
    
    // ...
    
    builder.Services.AddKenticoAiraUnified(builder.Configuration);
    
    // ...
    
    var app = builder.Build();
    
    // ...
    
    app.UseAiraUnifiedEndpoints();
    
    app.Run();
  4. Configure the Aira Unified settings in the administration UI: Open the Aira Unified application in the Xperience administration. Fill in:

    • Relative Path Base: Defines where Aira Unified is available.
    • Logo: Select an asset from the Media Library.
    • Chat Title: Title for the chat page.
    • Smart Upload Title: Title for the smart upload page.

    Admin Configuration

  5. Set up a Content Type for Mass Asset Upload.

  6. Configure role-based permissions in the Role Management application:

    • View: Access the Aira Unified chat.
    • Create: Access and upload content via Smart Upload.

    Role Configuration

At the moment the administrator user/role must be assigned to a custom role with the correct permission.

  1. Aira Unified expects a workspace named "Kentico Default" (code name 'KenticoDefault'). When using this library in a project with Xperience versions > 30.2.0, add a workspace with the code name KenticoDefault.

  2. Users can now # to the Aira Unified app - <your-path-base>/signin.

View the Usage Guide for more instructions.

Contributing

To see the guidelines for Contributing to Kentico open source software, please see Kentico's CONTRIBUTING.md for more information and follow the Kentico's CODE_OF_CONDUCT.

Find project-specific contribution details in Contributing Setup.

License

Distributed under the MIT License. See LICENSE.md for more information.

Support

Kentico Labs

This project has Kentico Labs limited support.

See SUPPORT.md for more information.

This feature is currently in a Preview mode, do not use for production instances.

For any security issues see SECURITY.md.