Skip to content

Commit 8d5a7d3

Browse files
author
Russ Williams
committed
Updated README doc
1 parent 4e34daf commit 8d5a7d3

File tree

4 files changed

+19
-10
lines changed

4 files changed

+19
-10
lines changed

ACSAgentHub/APIs/Conversations/putConversation.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ public putConversation(IConfiguration config)
2323
_config = config;
2424
}
2525

26-
[FunctionName("putConversation")]
26+
[FunctionName("putConversations")]
2727
public async Task<IActionResult> Run(
2828
[HttpTrigger(AuthorizationLevel.Anonymous, "put", Route = "conversations")] HttpRequest req,
2929
ExecutionContext context,

ComposerExample/ComposerExample.dialog

+1-1
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@
7878
"$kind": "Microsoft.SendHandoffActivity",
7979
"$designer": {
8080
"id": "6RC9sf",
81-
"comment": "Handoff to ACS"
81+
"comment": ""
8282
},
8383
"context": {
8484
"Skill": "offshore accouts",

Deployment/Scripts/deploy_and_configure.ps1

+7-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Run this script from the ACSAgentHub project folder (i.e., the one that has ACSAgentHub.csproj)
33
#>
44

5-
#Requires PoserShell 7
5+
# Requires PowerShell 7
66

77
# Usage:
88
# The following command deploys and configures an agent hub named TestHubRHW21 to run locally
@@ -16,6 +16,7 @@ Run this script from the ACSAgentHub project folder (i.e., the one that has ACSA
1616
Param(
1717
[string] $hubName,
1818
[string] $resourceGroup,
19+
[string] $ngrokFullPath,
1920
[string] $configurationOnly = "false", # Just configure things to run locally, but don't deploy (remaining params are not needed with -restart command)
2021
[string] $location,
2122
[string] $NuGetFullPath,
@@ -45,6 +46,10 @@ if (-not $resourceGroup) {
4546
$resourceGroup = $hubName
4647
}
4748

49+
if (-not $ngrokFullPath) {
50+
$ngrokFullPath = Read-Host "? Full path to ngrok.exe (e.g., c:\ngrok\ngrok.exe):"
51+
}
52+
4853
if (-not $location -and $configurationOnly.ToLower() -eq "false") {
4954
$location = Read-Host "? Azure resource group region"
5055
}
@@ -116,7 +121,7 @@ if ($configurationOnly.ToLower() -eq "false") {
116121

117122
# Step 5 - Create Tunnel to Agent Hub
118123
Write-Host "Creating Tunnel to Agent Hub" -NoNewline -ForegroundColor Green
119-
start -FilePath "c:\ngrok\ngrok" -ArgumentList "http 7071 -host-header=localhost:7071" -WindowStyle Minimized
124+
start -FilePath $ngrokFullPath -ArgumentList "http 7071 -host-header=localhost:7071" -WindowStyle Minimized
120125

121126
if ($?) {Write-Host " - Done." -ForegroundColor Green} else {Write-Host " - Failed" -ForegroundColor Green; $errCnt++}
122127

README.md

+10-6
Original file line numberDiff line numberDiff line change
@@ -59,12 +59,13 @@ In PowerShell, change the current directory to the root solution folder (i.e., t
5959
that contains the ACSAgentHub.sln file). Then run the following script to deploy and
6060
configure all the services required by the ACS Agent Hub:
6161
```
62-
.\Deployment\Scripts\deploy_and_configure.ps1 -hubName <hub name> -resourceGroup <resource group> -location <location name> -NuGetFullPath <nuget path>
62+
.\Deployment\Scripts\deploy_and_configure.ps1 -hubName <hub name> -resourceGroup <resource group> $ngrokFullPath <ngrok path> -location <location name> -NuGetFullPath <nuget path>
6363
```
6464
where:
6565
- **\<hub name>** is the name of your agent hub which will also be used as part of the name of
6666
other services created by this script
6767
- **\<resource group>** is the name of the resource group that services will be deployed to
68+
- **\<ngrok path>** is the full path to the ngrok.exe (e.g., c:\nuget\ngrok.exe)
6869
- **\<location name>** is the Azure location name of the region that services will be deployed in
6970
- **\<nuget path>** is the full path to the nuget.exe (e.g., c:\nuget\nuget.exe)
7071

@@ -103,15 +104,18 @@ sense for your bot<br>
103104
to ```=null```:<br>
104105
```
105106
{
106-
"Skill": "<skill 1> <skill 2> <skill N>",
107-
"Name": "<bot user's name>",
108-
"CustomerType": "<customer class (e.g., vip, premium, etc.>",
109-
"WhyTheyNeedHelp": "<reason for help request>"
107+
"Skill": "offshore accounts",
108+
"Name": "Test Name",
109+
"CustomerType": "vip",
110+
"WhyTheyNeedHelp": "lost order"
110111
}
111112
```
112113
The properties and values above are defined by the agent hub you're escalating to. So, for example, the payload
113114
is unique to LivePerson or Omnichannel and you'd check their documentation to find out what the payload should
114-
look like for those agent hub solutions but, for the ACS Agent Hub you'll use the above payload. Currently,
115+
look like for those agent hub solutions but, for the ACS Agent Hub you'll use the above payload and replace the
116+
hardcoded sample values with the appropriate values (use the values above if you are just experimenting).
117+
118+
Currently,
115119
the **Skill** and **CustomerType** properties are not being used by the ACS Agent Hub and can be set to whatever
116120
you like or left empty. The **Name** and **WhyTheyNeedHelp** properties are used in the agent-portal and the
117121
ComposerExample shows a nice way to gather and set those properties. When you're finished, it should look like

0 commit comments

Comments
 (0)