Redirect Web Chat

Redirects Web Chat to another page.

Command availability: IBM RPA SaaS and IBM RPA on premises

Script syntax

IBM RPA's proprietary script language has a syntax similar to other programming languages. The script syntax defines the command's syntax in the script file. You can work with this syntax in IBM RPA Studio's Script mode.

chatRedirect [--to(String)]

Input parameters

The following table displays the list of input parameters available in this command. In the table, you can see the parameter name when working in IBM RPA Studio's Script mode and its Designer mode equivalent label.

Designer mode label Script mode name Required Accepted variable types Description
To to Optional Text URL of the page to which the Web Chat should be redirected.

Example

In this example, the Redirect Web Chat command is used to redirect the Web Chat to the IBM Robotic Process Automation documentation site.

defVar --name cultureEnUS --type Language
createLanguage --culture "enUS" cultureEnUS=value
botConnect --type "Chat" --language ${cultureEnUS} --autoanswer
    botSay --text "Hello, you will be redirected to the documentation site."
    // Redirects Web Chat to the documentation site.
    chatRedirect --to "https://www.ibm.com/docs/en/rpa"
botDisconnect