Configuring KIO Co-Pilot

Last updated 17 minutes ago

Learn how to configure KIO Co-Pilot.

Table of Contents

Group-Based Access Control
Playbook Manager Access Control
- Access Behavior
Content Variant Support

KIO Co-Pilot is a copilot-style chat UI available in CoreMedia Studio. You can configure and adapt it to your needs, for example, by providing access based on certain groups.

Group-Based Access Control

The KIO Co-Pilot plugin supports group-based access control to restrict which users have access to KIO and are allowed to use its functionalities.

To configure group-based access control, users with the necessary permissions need to create or modify the global KIO settings document:

Configuration Path: /Settings/Options/Settings/KIO

Restrict modify permissions for this settings document to ensure that only authorized users can control KIO access.

Within the kio struct, you can configure the following properties:

Single Group Configuration

To restrict access to a single user group, use the allowed-group property:

Property name: allowed-group
Property type: String
Description: Specifies a single user group allowed to use KIO functionality

Multiple Groups Configuration

To restrict access to multiple user groups, use the allowed-groups property:

Property name: allowed-groups
Property type: String List
Description: Specifies multiple user groups allowed to use KIO functionality

Access Control Behavior

Group-based access control works as follows:

No groups configured: If neither allowed-group nor allowed-groups properties are set, all users will have access to KIO functionality.
Groups specified: If one or both properties are configured, only users who are members of at least one configured group will have access to KIO features.
Access denied: If a user is not a member of any allowed group, the KIO plugin will not be instantiated in CoreMedia Studio, effectively preventing access to KIO functionality.

Users must be members of at least one of the configured groups to access KIO. Group membership is evaluated when the user logs into CoreMedia Studio. If a configured group name does not exist or is invalid, KIO will not be loaded for any user.

Playbook Manager Access Control

Creating, editing, and duplicating playbooks in KIO is restricted to users with the playbook manager role. All other users can view the list of available playbooks in read-only mode.

This setting only controls the KIO frontend. Since playbooks are standard CMS documents, any CMS user with sufficient folder permissions can still create or modify them directly in Studio, regardless of this configuration.

To configure which groups qualify as playbook managers, add the playbook-manager-groups property to the global KIO settings document at /Settings/Options/Settings/KIO:

Property name: playbook-manager-groups
Property type: String List
Description: Specifies the user groups allowed to create, edit, and duplicate playbooks.

Access Behavior

No groups configured: If playbook-manager-groups is not set, only administrators are considered playbook managers.
Groups specified: If playbook-manager-groups is configured, only members of at least one of the listed groups are playbook managers.
Non-managers: Users without the playbook manager role can view the playbook list in KIO but cannot create, edit, or duplicate playbooks.

Content Variant Support

KIO can recognize and manage Content Variants, enabling users to create and update variants tied to specific topics.

Content Variant Support requires CMCC 2512.0 or later.

This feature is disabled by default. To enable it, set the following property in your KIO backend configuration:

kio.backend.content-variants-enabled=true

A corresponding environment variable configuration looks like this:

KIO_BACKEND_CONTENT_VARIANTS_ENABLED=true

When enabled, KIO uses the default BlueprintVariantConfigurationProperties to determine how variants are created and associated with topics.

Standard Blueprint setups: No additional configuration is required. The defaults work out of the box.
Custom setups: If your project deviates from the standard Blueprint, refer to BlueprintVariantConfigurationProperties to adapt the variant configuration to your content model.

Is this page useful?