Skip to main content Skip to search
Help us improve your experience: In general, do you find what you're looking for in the Help Center?
Thank you for your contribution!
close

Deploying a custo-manifest

Related to

Quentin Grabenstaetter
  • Updated
Edit article Translate article Notify subscribers

You can use this article to deploy a custo-manifest to Rainbow users. You will see the difference between administration-console deployment and local import, how deployment priority works, and how to remove a manifest when needed.

Overview

A custo-manifest is a JSON file that customizes the Rainbow interface for your users: action buttons, API calls, embedded applications, widgets… Once deployed, it is automatically applied every time the Rainbow client starts.

License requirement: Custo-manifest extensions (action buttons, API calls, embedded apps, widgets) require a Business or higher license. Only PBX events (monitoring incoming/outgoing calls) are available without a Business license.

There are two deployment modes:

Mode Who Scope Priority
Administration console You, from the administration console All user clients (Web + Desktop, all sessions) Takes priority
Local import End user The machine or browser used for the import only Overridden by administration-console deployment
Note: Admin deployment always takes priority. If a manifest is assigned via the console, it replaces any local import and the Import/Export option disappears from the Rainbow client.
Disabling local import: You can disable the Import/Export option for your users via profiles: Company → Profiles → [profile] → Permissions → Custo-manifest. Once disabled, the option disappears from the client menu and only the manifest assigned from the administration console is applied.

Deployment via the administration console

This is the recommended method for production. You upload the manifest once, then Rainbow automatically applies it to all relevant users.

Configuration screen

The manifest and trusted domains are configured in the same place:

Company → Information → Customization

Rainbow console — Company → Information → Customization

Import into the console

  1. Go to Company → Information → Customization → Custo-manifest
  2. Click Import and select the .json or .zip file
  3. Verify that the manifest appears in the list

Assign to users

Two assignment methods:

By individual user

  • Go to Member → Information → Custo-manifest
  • Select the manifest to apply

By user profile

  • Go to Company → Profiles
  • Edit the profile → Custo-manifest section
  • Select the manifest — it applies to all members of the profile

By mass provisioning (CSV import or LDAP synchronization)

  • The custo-manifest assignment can be included in a bulk CSV import or in LDAP synchronization
  • The corresponding field in the CSV is selectedAppCustomisationTemplate
  • In LDAP, the attribute is also selectedAppCustomisationTemplate
Note: This method is particularly suited to assigning a manifest to a large number of users in a single operation.

Client uptake

The deployed manifest is automatically downloaded at the next client startup. No action is required from your users.

Web: the manifest is loaded at each session start. An update therefore takes effect upon the next login.
Desktop: the manifest is downloaded when the application starts.

Trusted domains

Before deploying, verify that all URL origins referenced in the manifest are declared in:

Company → Information → Customization → Custo-manifest domains

Without this declaration, a warning is shown at load time and extensions fail silently. See the article Network security and trusted domains for custo-manifest extensions.

Updating a deployed manifest

Modify the manifest

  1. Edit the JSON file locally
  2. In the console: Company → Customization → Custo-manifest → Replace
  3. Import the new version

The old version is replaced. Clients download it at the next startup.

Note: There is no automatic versioning in the Rainbow console. Keep previous versions locally so you can roll back if needed.

Force reload (Web)

On Rainbow Web, clearing the browser cache or logging out and back in forces the manifest to reload.

Remove the manifest

To remove the manifest from one of your users: go to Member → Information → Custo-manifest and select No manifest. The client returns to its default state at the next startup.

Local import (development and testing)

Local import lets a user load a manifest directly into their Rainbow client without going through the administration console. It is recommended for the development phase and pre-deployment testing.

Limited scope: a locally imported manifest only applies to the machine or browser used for the import. It does not follow the user to other workstations or sessions.

Import in Rainbow Desktop

  1. Open Rainbow Desktop
  2. Go to Settings → Telephony → Customization
  3. Click Import and select the .json or .zip file
  4. The manifest is applied immediately

To get a starter template: click Export before any import — Rainbow generates a sample file containing all supported extension points.

Import in Rainbow Web

Local import on Rainbow Web follows the same procedure as Desktop (Settings → Customization menu), but is limited to the browser currently in use.

Legacy setup CLI

Deprecated procedure: Prefer administration console deployment. Central deployment has priority over this legacy Desktop setup mode and is easier to manage.

For older Rainbow Desktop integrations, a manifest could be provided at installation time with the /Custom setup option.

RainbowSetup.exe /Custom=C:\path\to\manifest.json

When this mode is used, the Import/Export option is hidden from the end user. If an administrator later assigns a manifest through the Rainbow administration console, the centrally deployed manifest takes priority.

Common issues

The manifest is not applied

Likely cause How to check Fix
Manifest not assigned to the user Console → Member → Custo-manifest Assign the manifest
Client not restarted — Ask the user to restart Rainbow
Invalid JSON Developer tools → Console → errors at load time Validate the JSON (online tool or Rainbow Generator)
Local import disabled by admin Import/Export option is missing Use admin deployment

A warning appears when loading the manifest

The manifest references a URL whose origin is not declared in the trusted domains.

Fix: declare the origin in Company → Customization → Custo-manifest domains.

Warning: Dismissing the warning does not fix the problem — affected extensions will fail silently at runtime.

Extensions do not appear in the client

Likely cause Fix
Manifest assigned but client not restarted Restart Rainbow
Extension point not supported on the client (Web vs Desktop) Check Web/Desktop EP compatibility in the documentation
Maximum number of actions reached (3 per EP) Reduce the number of actions in the manifest
Local import overridden by admin manifest Expected behavior — admin manifest takes priority

Local import is not possible (option greyed out or missing)

The administrator has disabled local import via the profile. Contact the Rainbow administrator to obtain access or request deployment via the console.

Pre-production deployment checklist

  • JSON validated (no syntax error, "version": "2", "jsonType" present)
  • Manifest tested via local import on Rainbow Desktop and Web
  • All URL origins declared in Custo-manifest domains
  • If local resources: ZIP archive created with custo-manifest.json at the root
  • Manifest assigned to the correct users or profiles in the console
Was this article helpful?
0 out of 0 found this helpful

Related articles