Skip to content
This repository has been archived by the owner on Jun 30, 2022. It is now read-only.

Commit

Permalink
[ITSM] update json and doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Hualiang Xie committed Sep 3, 2019
1 parent 27f7872 commit c5a169a
Show file tree
Hide file tree
Showing 7 changed files with 41 additions and 30 deletions.
24 changes: 18 additions & 6 deletions docs/_docs/reference/skills/experimental.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,21 +37,33 @@ The Weather skill provides a basic Skill that integrates with [AccuWeather](http

The Music skill integrates with [Spotify](https://developer.spotify.com/documentation/web-api/libraries/) to look up playlists and artists and open via the Spotify app. Provide credentials after you [create a Spotify client](https://developer.spotify.com/dashboard/) in the appsettings to configure the skill.

## IT Service Managerment Skill
## IT Service Management Skill

The [IT Service Managerment skill](https://github.com/microsoft/AI/tree/next/skills/src/csharp/experimental/itsmskill) provides a basic skill that provides ticket and knowledge base related capabilities and supports SerivceNow.
The [IT Service Management skill](https://github.com/microsoft/AI/tree/next/skills/src/csharp/experimental/itsmskill) provides a basic skill that provides ticket and knowledge base related capabilities and supports SerivceNow.

To test this skill, one should setup the following:

* Create a ServiceNow instance in [Developers](https://developer.servicenow.com/app.do#!/instance) and update the serviceNowUrl of appsettings.json
* Set up a scripted REST API for current user's sys_id following [this question](https://community.servicenow.com/community?id=community_question&sys_id=52efcb88db1ddb084816f3231f9619c7) and update the serviceNowGetUserId of appsetting.json
- Please raise an issue if simpler way is found
* Create a ServiceNow instance in [Developers](https://developer.servicenow.com/app.do#!/instance) and update the serviceNowUrl of appsettings.json: `"serviceNowUrl": "https://YOUR_INSTANCE_NAME.service-now.com"`
* Create a [scripted REST API](https://docs.servicenow.com/bundle/geneva-servicenow-platform/page/integrate/custom_web_services/task/t_CreateAScriptedRESTService.html) to get current user's sys_id and please raise an issue if simpler way is found
- In System Web Services/Scripted REST APIs, click New to create an API
- In API's Resources, click New to add a resource
- In the resource, select GET for HTTP method and input `(function process(/*RESTAPIRequest*/ request, /*RESTAPIResponse*/ response) { return gs.getUserID(); })(request, response);` in Script
- Update the serviceNowGetUserId of appsetting.json: `"serviceNowGetUserId": "YOUR_API_NAMESPACE/YOUR_API_ID"`
* Set up endpoint by [this document](https://docs.servicenow.com/bundle/london-platform-administration/page/administer/security/task/t_CreateEndpointforExternalClients.html#t_CreateEndpointforExternalClients) for Client id and Client secret to be used in the following OAuth Connection
- Redirect URL is https://token.botframework.com/.auth/web/redirect
* Add an OAuth Connection in the Settings of Web App Bot named 'ServiceNow' with Service Provider 'Generic Oauth 2'
- Authorization URL as https://instance.service-now.com/oauth_auth.do
- Token URL, Refresh URL as https://instance.service-now.com/oauth_token.do
* If one wants to use it in VA, add VA's appId to AppsWhitelist in the Startup.cs
- No Scopes are needed
- Click Test Connection to verify

To test this skill in VA, one should setup the following:

* Add https://botbuilder.myget.org/F/aitemplates/api/v3/index.json as NuGet package source
* Update VA's Microsoft.Bot.Builder.Solutions and Microsoft.Bot.Builder.Skills to 4.6.0-daily27 as this skill
* Add VA's appId to AppsWhitelist of SimpleWhitelistAuthenticationProvider under Utilities
* Add OAuth Connection as skill
* The remaining steps are same as normal skills

## Experimental Skill Deployment

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ public class KnowledgeResponses : IResponseIdCollection
// Generated accessors
public const string IfFindWanted = "IfFindWanted";
public const string IfCreateTicket = "IfCreateTicket";
public const string KnowledgeShow = "KnowledgeShow";
public const string KnowledgeEnd = "KnowledgeEnd";
public const string KnowledgeShowNone = "KnowledgeShowNone";
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
"IfFindWanted": {
"replies": [
{
"text": "Page {Page}. Do you find what you want? \"Go forward/previously\" to navigate.",
"speak": "Page {Page}. Do you find what you want? \"Go forward/previously\" to navigate."
"text": "Page {Page}. Do you find what you want? \"Go forward/previous\" to navigate.",
"speak": "Page {Page}. Do you find what you want? \"Go forward/previous\" to navigate."
}
],
"inputHint": "expectingInput"
Expand All @@ -20,17 +20,17 @@
"KnowledgeEnd": {
"replies": [
{
"text": "Page {Page} does not contain anything, try \"Go previously\".",
"speak": "Page {Page} does not contain anything, try \"Go previously\"."
"text": "Page {Page} does not contain anything, try \"Go previous\".",
"speak": "Page {Page} does not contain anything, try \"Go previous\"."
}
],
"inputHint": "acceptingInput"
},
"KnowledgeShowNone": {
"replies": [
{
"text": "I'm sorry I can't find any. Let me know when you need my help.",
"speak": "I'm sorry I can't find any. Let me know when you need my help."
"text": "I'm sorry, I can't find any articles. Let me know if I can help in another way.",
"speak": "I'm sorry, I can't find any articles. Let me know if I can help in another way."
}
],
"inputHint": "acceptingInput"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
"WelcomeMessage": {
"replies": [
{
"text": "Welcome to IT Service Managerment skill! You can view, create or resolve tickets here.",
"speak": "Welcome to IT Service Managerment skill! You can view, create or resolve tickets here."
"text": "Welcome to the IT Service Management skill! You can view, create or resolve tickets here.",
"speak": "Welcome to the IT Service Management skill! You can view, create or resolve tickets here."
}
],
"suggestedActions": [],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -110,8 +110,8 @@
"ActionEnded": {
"replies": [
{
"text": "Let me know if you need my help with something else.",
"speak": "Let me know if you need my help with something else."
"text": "Let me know if you need my help with anything else.",
"speak": "Let me know if you need my help with anything else."
},
{
"text": "I'm here if you need me.",
Expand Down Expand Up @@ -157,8 +157,8 @@
"InputDescription": {
"replies": [
{
"text": "Please input the description:",
"speak": "Please input the description:"
"text": "Please provide the description:",
"speak": "Please provide the description:"
}
],
"inputHint": "expectingInput"
Expand Down Expand Up @@ -238,17 +238,17 @@
"InputTicketNumber": {
"replies": [
{
"text": "Please input the ticket number:",
"speak": "Please input the ticket number:"
"text": "Please provide the ticket number:",
"speak": "Please provide the ticket number:"
}
],
"inputHint": "expectingInput"
},
"ServiceFailed": {
"replies": [
{
"text": "Sorry, IT service failed due to {Error}.",
"speak": "Sorry, IT service failed due to {Error}."
"text": "Sorry, connecting to the IT Service Management service failed due to {Error}.",
"speak": "Sorry, connecting to the IT Service Management service failed due to {Error}."
}
],
"inputHint": "acceptingInput"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
"IfExistingSolve": {
"replies": [
{
"text": "Page {Page}. Does one of these solve your problem? \"Go forward/previously\" to navigate.",
"speak": "Page {Page}. Does one of these solve your problem? \"Go forward/previously\" to navigate."
"text": "Page {Page}. Do any of these solve your problem? Go forward/previous to navigate",
"speak": "Page {Page}. Do any of these solve your problem? Go forward/previous to navigate"
}
],
"inputHint": "expectingInput"
Expand Down Expand Up @@ -31,8 +31,8 @@
"suggestedActions": [ "description", "urgency", "no" ],
"replies": [
{
"text": "What attribute do you want to set for updating? Or \"No\" for no more attribute.",
"speak": "What attribute do you want to set for updating? Or \"No\" for no more attribute."
"text": "Which attribute do you want to update?",
"speak": "Which attribute do you want to update?"
}
],
"inputHint": "expectingInput"
Expand All @@ -49,8 +49,8 @@
"TicketNoUpdate": {
"replies": [
{
"text": "You didn't set anything to update. Let me know when you need my help.",
"speak": "You didn't set anything to update. Let me know when you need my help."
"text": "You didn't provide any changes, let me know when you need my help.",
"speak": "You didn't provide any changes, let me know when you need my help."
}
],
"inputHint": "acceptingInput"
Expand Down
2 changes: 1 addition & 1 deletion skills/src/csharp/experimental/itsmskill/readme.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# IT Service Managerment Experimental Skill
# IT Service Management Experimental Skill

See the Experimental Skill [documentation page](/docs/reference/skills/experimental.md) for information on how to deploy and test this Skill.

0 comments on commit c5a169a

Please sign in to comment.