Support redacting transcript delivered to agents when a user connects to live chat.

Author: bobpskier

build/update-lex-web-ui-config.js

@@ -149,6 +149,7 @@ const lexV2BotLocaleVoices = {
  'CONNECT_END_LIVE_CHAT_ICON',
  'CONNECT_END_LIVE_CHAT_UTTERANCE',
  'CONNECT_TRANSCRIPT_MESSAGE_DELAY_IN_MSEC',
+ 'CONNECT_TRANSCRIPT_REDACT_REGEX',
  'APP_DOMAIN_NAME',
  'UI_TOOLBAR_TITLE',
  'UI_TOOLBAR_LOGO',

config/base.env.js

@@ -25,6 +25,7 @@ module.exports = {
  liveChatTerms: process.env.CONNECT_LIVE_CHAT_TERMS,
  endLiveChatUtterance: process.env.CONNECT_END_LIVE_CHAT_UTTERANCE,
  transcriptMessageDelayInMsec: process.env.CONNECT_TRANSCRIPT_MESSAGE_DELAY_IN_MSEC,
+ transcriptRedactRegex: process.env.CONNECT_TRANSCRIPT_REDACT_REGEX,
  },
  lex: {
  v2BotId: process.env.V2_BOT_ID,

config/env.mk

@@ -38,6 +38,7 @@ export CONNECT_END_LIVE_CHAT_LABEL ?= $()
 export CONNECT_END_LIVE_CHAT_ICON ?= $()
 export CONNECT_END_LIVE_CHAT_UTTERANCE ?= $()
 export CONNECT_TRANSCRIPT_MESSAGE_DELAY_IN_MSEC ?= $()
+export CONNECT_TRANSCRIPT_REDACT_REGEX ?= $()
 export BOT_INITIAL_TEXT ?= $()
 export BOT_INITIAL_SPEECH ?= $()
 export BOT_INITIAL_UTTERANCE ?= $()

lex-web-ui/src/store/getters.js

@@ -59,26 +59,37 @@ export default {
  return v;
  },
  liveChatTextTranscriptArray: state => () => {
+ // Support redacting messages delivered to agent based on config.connect.transcriptRedactRegex.
+ // Use case is to support redacting post chat survey responses from being seen by agents if user
+ // reconnects with an agent.
  const messageTextArray = [];
- var text = ""; 
+ var text = "";
+ let shouldRedactResponse = false; // indicates if the current message should be redacted
+ const regex = new RegExp(`${state.config.connect.transcriptRedactRegex}`, "g");
  state.messages.forEach((message) => {
  var nextMessage = message.date.toLocaleTimeString() + ' ' + (message.type === 'bot' ? 'Bot' : 'Human') + ': ' + message.text + '\n';
+ if (shouldRedactResponse) {
+ nextMessage = message.date.toLocaleTimeString() + ' ' + (message.type === 'bot' ? 'Bot' : 'Human') + ': ' + '###' + '\n';
+ }
  if((text + nextMessage).length > 400) {
  messageTextArray.push(text);
  //this is over 1k chars by itself, so we must break it up.
- var subMessageArray = nextMessage.match(/(.|[\r\n]){1,400}/g); 
+ var subMessageArray = nextMessage.match(/(.|[\r\n]){1,400}/g);
  subMessageArray.forEach((subMsg) => {
  messageTextArray.push(subMsg);
  });
  text = "";
+ shouldRedactResponse= regex.test(nextMessage);
  nextMessage = "";
- } 
- text = text + nextMessage; 
+ } else {
+ shouldRedactResponse= regex.test(nextMessage);
+ }
+ text = text + nextMessage;
  });
  messageTextArray.push(text);
  return messageTextArray;
  },
- liveChatTranscriptFile: state => () => { 
+ liveChatTranscriptFile: state => () => {
  var text = 'Bot Transcript: \n';
  state.messages.forEach((message) => text = text + message.date.toLocaleTimeString() + ' ' + (message.type === 'bot' ? 'Bot' : 'Human') + ': ' + message.text + '\n');
  var blob = new Blob([text], { type: 'text/plain'});

src/config/lex-web-ui-loader-config.json

@@ -11,6 +11,7 @@
  "chatEndedMessage": "",
  "attachChatTranscript": "",
  "endLiveChatUtterance": "",
- "transcriptMessageDelayInMsec": ""
+ "transcriptMessageDelayInMsec": "",
+ "transcriptRedactRegex": ""
  }
 }

templates/codebuild-deploy.yaml

@@ -242,6 +242,12 @@ Parameters:
  Delay to insert between each transcript message send to Connect in msec.
  Default: 150
 
+ ConnectTranscriptRedactRegex:
+ Type: String
+ Description: >
+ Optional regex used to redact entire lines in transcript sent to agent
+ Default: ''
+
  LexV2BotId:
  Description: >
  Bot ID (not bot name) of an existing Lex V2 Bot to be used by the web ui. NOTE: You must
@@ -849,6 +855,8 @@ Resources:
  Value: !Ref ConnectEndLiveChatUtterance
  - Name: CONNECT_TRANSCRIPT_MESSAGE_DELAY_IN_MSEC
  Value: !Ref ConnectTranscriptMessageDelayInMsec
+ - Name: CONNECT_TRANSCRIPT_REDACT_REGEX
+ Value: !Ref ConnectTranscriptRedactRegex
  - Name: APP_USER_POOL_CLIENT_ID
  Value: !Ref CognitoAppUserPoolClientId
  - Name: APP_USER_POOL_NAME
@@ -997,6 +1005,7 @@ Resources:
  ConnectEndLiveChatIcon: !Ref ConnectEndLiveChatIcon
  ConnectEndLiveChatUtterance: !Ref ConnectEndLiveChatUtterance
  ConnectTranscriptMessageDelayInMsec: !Ref ConnectTranscriptMessageDelayInMsec
+ ConnectTranscriptRedactRegex: !Ref ConnectTranscriptRedactRegex
  WebAppBucket: !Ref WebAppBucket
  LexV2BotId: !Ref LexV2BotId
  LexV2BotAliasId: !Ref LexV2BotAliasId

templates/master.yaml

@@ -492,6 +492,12 @@ Parameters:
  Optional utterance to send to bot after ending a live chat session
  Default: ''
 
+ ConnectTranscriptRedactRegex:
+ Type: String
+ Description: >
+ Optional regex used to redact entire lines in transcript sent to agent
+ Default: ''
+
  ## CSS Configuration Options
  MessageTextColor:
  Type: String
@@ -694,6 +700,7 @@ Metadata:
  - ConnectEndLiveChatIcon
  - ConnectEndLiveChatUtterance
  - ConnectTranscriptMessageDelayInMsec
+ - ConnectTranscriptRedactRegex
  - Label:
  default: CSS Customization Parameters
  Parameters:
@@ -856,6 +863,7 @@ Resources:
  ConnectEndLiveChatIcon: !Ref ConnectEndLiveChatIcon
  ConnectEndLiveChatUtterance: !Ref ConnectEndLiveChatUtterance
  ConnectTranscriptMessageDelayInMsec: !Ref ConnectTranscriptMessageDelayInMsec
+ ConnectTranscriptRedactRegex: !Ref ConnectTranscriptRedactRegex
  MessageTextColor: !Ref MessageTextColor
  MessageFont: !Ref MessageFont
  ChatBackgroundColor: !Ref ChatBackgroundColor
@@ -868,7 +876,7 @@ Resources:
  AllowStreamingResponses: !Ref AllowStreamingResponses
  ShouldEnableUpload: !Ref ShouldEnableUpload
  UploadBucket: !Ref UploadBucket
- Timestamp: 1724098094
+ Timestamp: 1730925847
 
  CognitoIdentityPoolConfig:
  Type: AWS::CloudFormation::Stack
@@ -882,7 +890,7 @@ Resources:
  CodeBuildProjectName: !GetAtt CodeBuildDeploy.Outputs.CodeBuildProject
  CognitoUserPool: !GetAtt CognitoIdentityPool.Outputs.CognitoUserPoolId
  CognitoUserPoolClient: !GetAtt CognitoIdentityPool.Outputs.CognitoUserPoolClientId
- Timestamp: 1724098094
+ Timestamp: 1730925847
 
  ##########################################################################
  # Lambda that will validate if user has put in an invalid CSS color/Hex string and fail deployment