...
| Info |
|---|
This Guide describes how to set up and manage custom iFrame integrations with x-bees, for different user applications and services. iFrame Client integrations in x-bees documentdocumentation: How to manage iFrame Client integrations in x-bees Other x-bees documentation: x-bees documentation. Created: October 2023 Permalink: https://wildix.atlassian.net/wiki/x/AQCFDw |
| Table of Contents |
|---|
Introduction
iFramex-bees Client integration allows to set up integration with applications and services and, if required, have the data displayed in the Info frame section in x-bees.
Requirements
- x-bees-Standard license for each user who needs to use the integration
How to add integration
| Note |
|---|
Note: The maximum number of integrations allowed is 5. |
1. Go to WMS -> PBX -> Integrations -> Cloud integrations
2. Wildix Integration Hub opens. Click on x-bees Client integrations
| Note |
|---|
Note: Your PBX should be on the x-bees licensing, otherwise, the |
...
option is not present |
...
. |
...
3. There are two tabs:
- Manage integrations: here you can add a new integration and view the list of already installed ones
- Wildix Ready integrations: integrations that are already pre-configured and ready to be installed
...
To add a new integration, click the Add Integration button on the tab Manage integrations:
| Note |
|---|
Note: If you want to develop your custom iFrame integration that can be embedded in x-bees, check out this template. |
4. Fill out the following fields:
Title: enter name of your integration
Note Note: The maximum number of allowed characters in title name is 25.
- Iframe URL: link to the iFrame client
- Description (optional): enter description or leave any comments if required
5. Enable the necessary settings:
- Use x-bees authorization token: enable if you want to receive PBX token in requests for secure communication with the integration.
- Display Iframe integrationon the Info frame: if enabled, the integration data is displayed in the Info frame section in x-bees.
- Enable Authorization (coming soon): if enabled, requires authorization to access the integration.
- Development Mode: if enabled, the integration you add is not displayed to all clients, but only to the developer, used for testing and debugging of the integration.
Notify users if authorization is required: when enabled, in case the integration requires authorization, the relevant notification is displayed to users, e.g. when Info frame is opened or search is used. 
Choose on which platforms the integration should be available (Web / Mobile / All):
By default, the integration is available to all users. But you can allow or block access to the integration for certain emails:- Make integration available only to: make the integration available only to a limited number of users by entering their emails here. You can enter multiple emails separated by commas.
- Block user access: enter emails of users who should not have access to the integration.
Once completed, click Install.
How to manage integrations
Edit integration
To edit an installed integration:
- Go to WMS Settings -> PBX -> Integrations -> Cloud integrations
- Choose x-bees Choose iFrame Client integrations
- Click on the necessary integration on the Manage integrations -> Installed Integrations tab, make required edits and click Save:
Integrations position
The order in which integrations data is displayed on the Info frame in x-bees depends on the the order of the integrations in the list.
If you want to prioritise an integration, move it up in the list, using the arrow buttons to the right of the integrations in the Position column:
Delete integration
To delete an integration:
- Go to WMS Settings -> PBX -> Integrations -> Cloud integrations
- Choose x-bees Choose Iframe Client integrations
- Click on the necessary integration and press the Delete button:
| Macrosuite divider macro | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...