Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add reference to Flex Plugin Library in readme #695

Merged
merged 6 commits into from
Dec 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,14 @@ The template provides a means to manage all of the assets which make up a Flex s

Furthermore, with the rich library of examples and conventions, developers can quickly see how to approach different problems on the platform by seeing working code that they can easily reverse engineer.

### Flex Plugin Library

If you are primarily looking to add common contact center functionality to Flex, we recommend starting with the plugins from the [Flex Plugin Library](https://www.twilio.com/docs/flex/developer/plugins/plugin-library) to support your use case. These plugins are maintained and supported by Twilio, and many are derived from the most popular features included in the template.

Using plugins from the Plugin Library reduces the custom code footprint and total cost of ownership of your solution. Please be aware they cannot be customized and must be deployed and configured manually via the Flex Admin user interface. In case you have already developed, or plan to develop, custom code that modifies Flex actions or components, it is necessary to validate that those modifications don’t conflict with the standard plugin(s) you are planning to deploy from the Plugin Library. Depending on your use case, you may wish to use only plugins from the Plugin Library, or only the template, or a mix of both.

If you plan to use plugins from the Plugin Library alongside this template, please [remove the corresponding template feature(s)](https://twilio-professional-services.github.io/flex-project-template/building/feature-management/remove-features) to prevent conflicts.

## How do I get started?

Installing the template in your Twilio account is fast and easy. [Follow this step-by-step guide to install the template](https://twilio-professional-services.github.io/flex-project-template/getting-started/install-template) in under 10 minutes.
Expand Down
10 changes: 9 additions & 1 deletion docs/docs/00_introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The _Flex Project Template_ is a starting point for Flex solutions of any size.
- It can be used for large projects or simple standalone features
- Many of the most common features requested by Flex customers [are already packaged in the template](/feature-library/overview)
- Each feature is self-contained and easily removed if desired
- Features can be turned on and off using an [adminstration panel](/feature-library/admin-ui)
- Features can be turned on and off using an [administration panel](/feature-library/admin-ui)
- You can [deploy this solution and use it to build in just a few minutes](/getting-started/install-template) by providing your account SID, API key, and API secret.

## Why use this template?
Expand All @@ -24,6 +24,14 @@ The template provides a means to manage all of the assets which make up a Flex s

Furthermore, with the rich library of examples and conventions, developers can quickly see how to approach different problems on the platform by seeing working code that they can easily reverse engineer.

### Flex Plugin Library

If you are primarily looking to add common contact center functionality to Flex, we recommend starting with the plugins from the [Flex Plugin Library](https://www.twilio.com/docs/flex/developer/plugins/plugin-library) to support your use case. These plugins are maintained and supported by Twilio, and many are derived from the most popular features included in the template.

Using plugins from the Plugin Library reduces the custom code footprint and total cost of ownership of your solution. Please be aware they cannot be customized and must be deployed and configured manually via the Flex Admin user interface. In case you have already developed, or plan to develop, custom code that modifies Flex actions or components, it is necessary to validate that those modifications don’t conflict with the standard plugin(s) you are planning to deploy from the Plugin Library. Depending on your use case, you may wish to use only plugins from the Plugin Library, or only the template, or a mix of both.

If you plan to use plugins from the Plugin Library alongside this template, please [remove the corresponding template feature(s)](/building/feature-management/remove-features) to prevent conflicts.

## How do I get started?

Installing the template in your Twilio account is fast and easy. [Follow this step-by-step guide to install the template](/getting-started/install-template) in under 10 minutes.
Expand Down
98 changes: 49 additions & 49 deletions docs/docs/feature-library/00_overview.md

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions docs/docs/feature-library/_plugin-library-feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
:::info Also available in Flex Plugin Library
A version of this feature is also available in the [Flex Plugin Library](https://www.twilio.com/docs/flex/developer/plugins/plugin-library). If you prefer to use the Plugin Library version alongside the template, please [remove this feature](/building/feature-management/remove-features) from your instance of the template to prevent conflicts.
:::
3 changes: 3 additions & 0 deletions docs/docs/feature-library/activity-reservation-handler.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ title: activity-reservation-handler
---
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import PluginLibraryFeature from "./_plugin-library-feature.md";

<PluginLibraryFeature />

## Overview

Expand Down
3 changes: 3 additions & 0 deletions docs/docs/feature-library/activity-skill-filter.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import Enabled from '/img/features/activity-skill-filter/feature-enabled.png';
import Disabled from '/img/features/activity-skill-filter/feature-disabled.png';
import PluginLibraryFeature from "./_plugin-library-feature.md";

<PluginLibraryFeature />

## Overview

Expand Down
3 changes: 3 additions & 0 deletions docs/docs/feature-library/agent-automation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
sidebar_label: agent-automation
title: agent-automation
---
import PluginLibraryFeature from "./_plugin-library-feature.md";

<PluginLibraryFeature />

This feature provides auto select, auto accept and auto wrap-up behavior for agent tasks. Wrap-up behavior can be optionally configured to allow agents to request extended wrap-up. Tasks qualify for a configuration set based on their channel and a set of required task and/or worker attributes. The first configuration set to match is the configuration set used.

Expand Down
3 changes: 3 additions & 0 deletions docs/docs/feature-library/caller-id.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
sidebar_label: caller-id
title: caller-id
---
import PluginLibraryFeature from "./_plugin-library-feature.md";

<PluginLibraryFeature />

This feature enables the user to define which number on the Twilio account to use when dialing outbound using the dialpad.

Expand Down
3 changes: 3 additions & 0 deletions docs/docs/feature-library/canned-responses.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
sidebar_label: canned-responses
title: canned-responses
---
import PluginLibraryFeature from "./_plugin-library-feature.md";

<PluginLibraryFeature />

The Canned Chat Responses feature helps demonstrate how Agents can select from a pre-determined list of chat responses from within the CRM panel or Message Input Actions within Flex. The canned responses are returned from a Twilio Serverless function, which is contained within the `../../../../serverless-functions/src/functions/features/canned-responses/flex/chat-responses.js` file.

Expand Down
3 changes: 3 additions & 0 deletions docs/docs/feature-library/conference.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
sidebar_label: conference
title: conference
---
import PluginLibraryFeature from "./_plugin-library-feature.md";

<PluginLibraryFeature />

When in a call, and the beta native external warm transfer functionality is not enabled, a "plus" icon is added to the call canvas where you can add an external number to the call.

Expand Down
3 changes: 3 additions & 0 deletions docs/docs/feature-library/conversation-transfer.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
sidebar_label: conversation-transfer
title: conversation-transfer
---
import PluginLibraryFeature from "./_plugin-library-feature.md";

<PluginLibraryFeature />

This feature implements transferring of chats between agents and multiple agents in the same chat. It supports webchat, SMS and whatsapp that use [Flex Conversations](https://www.twilio.com/docs/flex/conversations).

Expand Down
3 changes: 3 additions & 0 deletions docs/docs/feature-library/custom-transfer-directory.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
sidebar_label: custom-transfer-directory
title: custom-transfer-directory
---
import PluginLibraryFeature from "./_plugin-library-feature.md";

<PluginLibraryFeature />

This feature enables the replacement of the queue and worker transfer directories enabling the following behavior

Expand Down
3 changes: 3 additions & 0 deletions docs/docs/feature-library/dispositions.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
sidebar_label: dispositions
title: Dispositions / wrap-up codes
---
import PluginLibraryFeature from "./_plugin-library-feature.md";

<PluginLibraryFeature />

## Overview

Expand Down
3 changes: 3 additions & 0 deletions docs/docs/feature-library/dual-channel-recording.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,16 @@
sidebar_label: dual-channel-recording
title: dual-channel-recording
---
import PluginLibraryFeature from "./_plugin-library-feature.md";

:::info Native feature available
Native dual-channel recording is now available and can be enabled via the Twilio Console. The first agent to join the call will be on the left channel, and the other participants on the right channel. See [the changelog entry](https://www.twilio.com/en-us/changelog/dual-channel-voice-conference-recordings) for more details, including restrictions and instructions to enable.

This template feature will remain available for use cases that are not supported by the native feature. If you need the conditional recording functionality that this feature provides, you can use [the `conditional-recording` feature](/feature-library/conditional-recording) instead, which works with the native recording functionality.
:::

<PluginLibraryFeature />

There are various ways to enable call recordings with Twilio Flex. Let's outline those methods to better understand when using this custom solution would be preferable.

1. The simplest approach is to turn on "Call Recording" in [Flex Settings](https://www.twilio.com/console/flex/settings) on the Twilio Console. Enabling this setting records the conference and automatically updates the task attribute `conversations.segment_link` with the recording URL so it can be played back in Flex Insights.
Expand Down
3 changes: 3 additions & 0 deletions docs/docs/feature-library/hang-up-by.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
sidebar_label: hang-up-by
title: hang-up-by
---
import PluginLibraryFeature from "./_plugin-library-feature.md";

<PluginLibraryFeature />

This feature writes to the `conversations.hang_up_by` task attribute to allow reporting within Flex Insights on which party ended a call. This is accomplished by adding various Flex UI action and event listeners to deduce the reason for the conversation ending.

Expand Down
3 changes: 3 additions & 0 deletions docs/docs/feature-library/internal-call.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
sidebar_label: internal-call
title: internal-call
---
import PluginLibraryFeature from "./_plugin-library-feature.md";

<PluginLibraryFeature />

This feature adds a new "Call Agent" and "Call Queue" section to the outbound dialpad allowing an agent to directly call another agent or to a queue. In this section, there is an autocomplete dropdown for both options where you can select the appropriate party you want to call.

Expand Down
3 changes: 3 additions & 0 deletions docs/docs/feature-library/pause-recording.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
sidebar_label: pause-recording
title: Pause & Resume Call Recording
---
import PluginLibraryFeature from "./_plugin-library-feature.md";

<PluginLibraryFeature />

This feature adds a Pause/Resume Recording button and keyboard shortcuts to the call canvas to allow the agent to temporarily pause the call recording before the customer provides sensitive information (such as credit card details, bank account, etc.) to the agent and to resume regular call recording afterwards.

Expand Down
3 changes: 3 additions & 0 deletions docs/docs/feature-library/schedule-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
sidebar_label: schedule-manager
title: Twilio Flex Schedule Manager
---
import PluginLibraryFeature from "./_plugin-library-feature.md";

<PluginLibraryFeature />

This solution provides a flexible, robust, and scalable way to manage open and closed hours for Twilio Flex applications.

Expand Down
3 changes: 3 additions & 0 deletions docs/docs/feature-library/supervisor-barge-coach.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
sidebar_label: supervisor-barge-coach
title: Supervisor Barge Coach Suite
---
import PluginLibraryFeature from "./_plugin-library-feature.md";

<PluginLibraryFeature />

This feature provides the ability for a supervisor to barge in to a call (i.e. join an active call with an agent) or coach an agent (i.e. talk only to the agent so the caller(s) are unable to hear you), all from the Teams view.

Expand Down
3 changes: 3 additions & 0 deletions docs/docs/feature-library/supervisor-capacity.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
sidebar_label: supervisor-capacity
title: supervisor-capacity
---
import PluginLibraryFeature from "./_plugin-library-feature.md";

<PluginLibraryFeature />

This feature implements a _Channel Capacity_ panel in the [Twilio Flex](https://www.twilio.com/flex) [Teams View](https://www.twilio.com/docs/flex/monitor-agent-activity). Supervisors may configure each worker's capacity per channel, as well as whether or not a worker is eligible to receive tasks for that channel.

Expand Down
3 changes: 3 additions & 0 deletions docs/docs/feature-library/supervisor-complete-reservation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
sidebar_label: supervisor-complete-reservation
title: supervisor-complete-reservation
---
import PluginLibraryFeature from "./_plugin-library-feature.md";

<PluginLibraryFeature />

This feature provides the supervisor the ability to remotely complete an agents reservation that is in the wrapping status.

Expand Down
Loading