지금까지 Kore.ai 가상 비서 플랫폼에서 경고 작업을 설정하는 방법을 여기에서 확인했습니다. 이 섹션에서는 경고 작업을 위한 기본 권한 부여를 설정하는 방법을 살펴봅니다.
양식 필드
기본 사용자 이름과 암호 필드가 요구 사항을 충족하지 않는 경우, 권한 부여 양식 필드를 추가하여 최종 사용자에게 표시할 새 필드를 추가할 수 있습니다. 권한 부여 양식에 필드를 추가하려면, + 양식 필드 추가를 클릭합니다. 다음 그림은 권한 부여 대화 상자에 암호 필드를 추가하는 정의의 예입니다.
다음 표에서는 권한 부여 IDP 양식 필드를 정의하는 데 사용되는 필드를 설명합니다.
필드 이름 | 설명 |
---|---|
필드 제목 | 인증 대화 상자에서 최종 사용자에게 표시되는 필드 이름을 지정합니다. |
필드 키 | 이 값은 인증 서비스에 대한 최종 사용자 입력을 나타냅니다. |
도움말 힌트 | 필드에 표시되는 도움말 텍스트로서 필드에 입력해야 하는 내용을 설명합니다. |
필드 유형 |
고급 옵션을 선택한 경우, 최종 사용자 인터페이스에서 표시되는 필드의 유형을 지정하여 다음 중 하나의 필드 키 값으로 할당된 사용자 입력을 수집합니다.
|
필수 | 고급 옵션을 선택한 경우, 최종 사용자가 인증을 완료하려면 이 필드를 정의해야 하는지 여부를 선택합니다. |
데이터 유형 | 고급 옵션을 선택한 경우, 최종 사용자의 입력으로 예상되는 데이터 유형을 지정합니다. 예: 문자열. |
가시성 | 고급 옵션을 선택한 경우, 인증 필드의 속성을 표시, 숨김 또는 읽기 전용으로 표시할지 여부를 지정합니다. |
권한 부여 필드
기본적으로, 권한 부여 필드는 작업 요청 메시지의 헤더 일부로 구성됩니다. 작업 요청에 추가 권한 부여 필드가 필요하거나 예상되는 권한 부여(예: 사회 보장 번호 또는 PIN)가 헤더의 일부가 아닌 경우, + 권한 부여 필드 추가를 클릭한 후 다음 그림과 같이 필드를 정의합니다.
- 필드 유형 필드에서, 작업 요청 메시지 및 필요한 권한 부여 필드 유형에서 위치에 따라 다음 중 하나를 선택할 수 있습니다. 헤더 – 봇은 요청 헤더의 일부로 권한 부여 필드를 예상합니다.페이로드 – 봇은 요청 본문의 내용 일부로 권한 부여 필드를 예상합니다. 쿼리 문자열 – 봇은 요청 본문에서 권한 부여 필드를 쿼리로 예상합니다. 경로 매개변수 – 봇은 권한 부여 필드를 요청의 URL 경로의 일부로 예상합니다.
- 필드 키 필드에서, 선택한 필드 유형에 대한 필드 이름을 입력합니다.
- 필드 값 필드에 지정된 필드 키의 값을 입력합니다.
- 완료를 클릭합니다. 새 권한 부여 필드가 권한 부여 필드 섹션에 추가됩니다.
- 추가 인증 권한 필드를 추가하려면, 권한 부여 필드 섹션에서 추가를 클릭합니다.
- 권한 부여 확인 URL 필드에서, 권한 부여 메커니즘으로 작업을 배포하기 전에 봇 빌더에서 인증 설정 테스트에 사용되는 URL을 선택적으로 정의하세요. 동적 필드와 경로 매개 변수 필드, 쿼리 필드 등을 사용하여 URL 테스트를 정의할 수 있습니다. 예: https://kore.someCompany.com/sap/opu/odata/sap/{{authfield1}}/?$format=json
- 커넥터를 사용한 액세스 섹션에서, Kore.ai 커넥터 에이전트를 사용하여 Kore.ai 봇의 액세스를 활성화하려면 예를 선택합니다. 도메인에 활성 Kore.ai 커넥터가 정의되지 않은 경우, 봇 관리자 콘솔 시스템, 관리자에게 문의하라는 경고 메시지가 표시됩니다. 자세한 내용은, 봇 관리 콘솔 설명서에서 Kore.ai 커넥터 사용을 참조하세요.
- 저장을 클릭하여 권한 부여 설정을 저장하고 새 권한 부여 메커니즘 대화 상자를 닫습니다.
테스트
인증을 저장한 후, 새 권한 부여 유형을 위한 권한 부여 확인 URL을 정의한 경우 권한 부여 탭에서 권한 부여 정의를 테스트할 수 있습니다.
- 작업의 나머지 단계 개발을 계속 진행하기 전에 권한 부여 테스트를 클릭합니다.
- 권한 부여 테스트를 클릭한 후, 권한 부여 테스트 창이 표시되고 다음 그림과 같이 권한 부여 확인 URL 섹션에서 지정한 URL로 채워집니다.
권한 부여(기본 권한 부여) 테스트를 설정하려면 다음 단계를 수행하세요.
- 권한 부여 확인 URL 필드에서, 인증 설정을 테스트하려는 URL을 확인하거나 입력합니다.
- 봇이 하위 도메인을 사용하는 경우, 테넌시 필드가 표시되고 테넌트를 지정해야 합니다.
- 웹 서비스의 사용자 이름 및 암호를 입력합니다.
- Content-Type 필드에서 URL에 예상되는 콘텐츠 유형을 선택합니다.
- URL을 테스트하려는 경우, 메소드 필드는 읽기 전용이며 GET으로 설정됩니다.
- 테스트를 클릭하여 권한 부여 테스트를 시작합니다.
인증 유효성 검증이 완료되면 권한 부여 테스트 창이 닫히고 성공 또는 실패 검증 결과가 다음 그림과 같이 권한 부여 테스트 버튼 바로 오른쪽에 표시됩니다.
권한 부여가 실패하면, 다음 그림과 같이 헤더 및 응답 탭과 함께 권한 부여 테스트 실패 메시지가 표시됩니다.
작동 원리
<작업에 기본 권한 부여가 사용될 때, Kore.ai 애플리케이션은 다음 그림과 같이 사용자에게 웹 애플리케이션 또는 웹 서비스에 액세스하려면 로그인 자격 증명을 입력하라는 메시지를 자동으로 표시합니다.
최종 사용자에게 권한이 부여된 후, 설정은 다음 명명 구문을 사용하여 저장됩니다.
{{ First Name }} {{ Last Name }} {{ Bot Name }} {{ Account # }} {{ Sequence # }}
예: John Smith's Twitter Account #1. Kore.ai 애플리케이션은 이 계정을 사용하여 향후 모든 작업 요청을 위해 웹 애플리케이션 또는 웹 서비스에 액세스할 수 있습니다. 또한, 최종 사용자는 동일한 봇의 다른 작업을 위해 계정을 재사용할 수 있습니다.
こちらで、Kore.aiのバーチャルアシスタントプラットフォームでの通知タスクの設定方法について確認しました。このセクションでは、通知タスクに対する基本的な権限の設定方法について見ていきます。
フォームフィールド
デフォルトのユーザー名とパスワードのフィールドがご需要を満たしていない場合、認証フォームのフィールドを追加することで、エンドユーザーに表示される新しいフィールドを追加することができます。認証フォームにフィールドを追加するには、[+フォーム フィールドの追加] をクリックします。以下の図とはダイアログへのパスワード フィールドに追加する認証その定義の作例です。 以下のテーブルは認証IDPフォームフィールドの定義に使用するフィールドの説明です。
フィールド名 | 説明 |
---|---|
フィールド タイトル | 認証ダイアログでエンドユーザー表示するフィールド名を指定します。 |
フィールドキー | この値は認証サービスにエンドユーザーが入力する値を示します。 |
ヘルプのヒント | フィールドに表示されるヘルプ文字はフィールドに入力すべくものを説明しています。 |
フィールドタイプ | 上級オプションと選択した場合、エンドユーザーインターフェイスに表示されるフィールドのタイプを指定して、ユーザー入力の割り当てたフィールドキー値として収集します、以下のうちの一つ:
|
必須 | 上級オプションと選択した場合、エンドユーザーは必ずこのフィールドを定義して認証を完成してください。 |
データタイプ | 上級オプションと選択した場合、エンドユーザーからの入力と予想するデータタイプを指定してください。例えば、文字列。 |
可視性 | [詳細オプション] を選択した場合、認証フィールドを表示、非表示、または読み取り専用のいずれにするかを指定します。 |
承認フィールド
デフォルトでは、認証フィールドとはタスクリクエストのメッセージのヘッダーの一部として調整されたものです。もしタスクリクエストには追加の認証フィールドが必須、または予想の認証はのヘッダーの一部ではないの場合(例:ソーシャルセキュリティ番号やPINなど)、+認証フィールドの追加をクリックして下記の図の通りにフィールドを定義します。
- フィールドタイプフィールドに、以下のうちの一つを選択することができます: 必須のタスクリクエストメッセージの位置および認証フィールドのタイプの次第です。ヘッダー―Botは、リクエストのヘッダの一部として認証フィールドを予想します。ペイロード―Botは、リクエストの本文のコンテンツの一部として認証フィールドを予想します。クエリー文字列―Botは認証フィールドをリクエストのボディにあるクエリー として予想します。パースパラメータ(PathParam)―認証フィールドをURLパースリクエストの一部として予想されるBot。
- フィールドキーフィールドに、選択済のフィールドタイプフィールド名を入力してください。
- フィールド値フィールドに、フィールドキーの指定された値を入力してください。
- 完了をクリックします。新規の認証フィールドは認証フィールドのセクションに追加されました。
- 認証フィールドを追加する場合、認証フィールドセクションの追加をクリックしてください。
- 認証チェックURLフィールドで、認証メカニズムでボットを展開する前にボットビルダー から認証設定をテストするために使用できるURLを定義します。ダイナミックフィールド、パスパラメータフィールド、クエリフィールドなどを使用して、テスト URL を定義することができます。たとえば、https://kore.someCompany.com/sap/opu/odata/sap/{{authfield1}}/?$format=json
- コネクタでアクセスのセクションで、はいを選択するとKore.aiコネクタエイジェントでKore.aiボットへのアクセスをできるようにします。もしご使用のドメインは定義済の活動的なKore.ai コネクタではないの場合、警告メッセージは表示され、ボットのアドミンコンソールのシステムアドミニストレータに連絡します。詳細については、ボット管理コンソールのドキュメントのKore.aiコネクタの使用を参照してください。
- 保存をクリックして保存認証を保存して新規認証メカニズムのダイアログを閉めます。
テスト
認証の保存後、新しい認証タイプに認証確認URLを定義していた場合は、認証タブで認証定義をテストすることができます。
- タスクの残りの手順の開発を続ける前に、認証をテストをクリックします。
- テスト認証をクリックすると、下記の図の通りに、テスト認証ダイアログは表示され、そして認証チェックURLセクションにご指定のURLが発生します。
認証(基本認証)のテストの設定は、以下の手順に従います。
- 認証チェックURLフィールドに、実証やURLをテスト認証調整に入力してください。
- Botはサブドメインを使用する場合、テンナンシーフィールドは表示されて、必ずテナントを指定してください。
- ウェブサービスのユーザー名とパスワードを入力します。
- URL として求めるコンテンツ タイプは、 [コンテンツ タイプ] フィールドで選択します。
- URLのテストの場合、方法フィールドはリードオンリーそしてGETと設定されました。</li>
- テストをクリックすると認証テストを開始します。
認証の検証が完成の場合、下記の図の通りに、テスト認証のウィンドウが閉じて、その検証の結果、成功や失敗は即刻、テスト認証のボタンに表示します。 認証失敗の場合、下記の図の通りに、認証テスト失敗のメッセージはヘッダーおよび応答のタブとともに表示します。
仕組みについて
タスクに基本認証を使用する場合、下記の図の通り、Kore.aiアプリケーションは自動的にユーザーをプロンプトしてクレデンシャルのロクインでウェブアプリケーションやウェブサービスへのアクセスへ進めます。エンドユーザーが承認された後、以下のシンタックスを使用して設定が保存されます。
{{ First Name }} {{ Last Name }} {{ Bot Name }} {{ Account # }} {{ Sequence # }}
たとえば、ジョン・スミスのツイッター アカウント#1。Kore.aiアプリケーションは、このアカウントを使用して、将来のすべてのタスクリクエストに対して、WebアプリケーションまたはWebサービスにアクセスすることができます。その他、エンドユーザーはアカウントを他のタスクに同じボットで再使用することができます。
Leave a Reply
We have seen how an Alert task can be set up in Kore.ai virtual assistant platform here. In this section, we will see how basic authorization for the alert tasks can be set up.
Setting Up
The following illustration is an example of the Basic Auth fields that you must define to enable basic authorization for your task.
To define basic authorization, select Basic Auth in the Authorization Type field. Then specify a Name for the authorization to be displayed in the Bot builder user interface.
Tenancy
If required, in the Subdomain section, select Yes if the base URL for a web application or user interface uses a tenant name in the URL. For example, kore is the tenant organization for a web service using tenants as www.kore.someCompany.com.
In the following example configuration, the tenancy URL contains the {tenant} organization placeholder.
Form Fields
If the default username and password fields do not meet your needs, you can add new fields displayed to the end-user by adding authorization form fields. To add fields on the authorization form, click + Add Form Field.
The following illustration is an example of a definition to add a password field to the authorization dialog.
The following table describes the fields used to define an authorization IDP form field.
FIELD NAME | DESCRIPTION |
---|---|
Field Title | Specify the name of the field displayed to the end-user in the authentication dialog. |
Field Key | The value represents the end-user input value to the authenticating service. |
Help Hint | The help text displayed in the field to describe what should be entered into the field. |
Field Type | When Advanced Options is selected, specify the type of field displayed in the end-user interface to collect the user input assigned as the value for the Field Key, one of:
|
Mandatory | When Advanced Options is selected, select if the end-user must define this field to complete authentication. |
Data Type | When Advanced Options is selected, specify the type of data expected as input from the end-user. For example, String. |
Visibility | When Advanced Options is selected, specify if the authentication field should be visible, hidden, or displayed as read-only. |
Authorization Fields
By default, authorization fields are configured as part of the header of the task request message. If your task request requires additional authorization fields or the expected authorization is not part of the header, for example, social security number or PIN, click+ Add Authorization Field and then define the fields as shown in the following illustration.
- In the Field Type field, you can select one of the following depending on where in the task request message and the type of authorization fields that are required.
Header – The bot expects the authorization fields as part of the header of the request.Payload – The bot expects the authorization fields as part of the content of the body of the request.
Query String – The bot expects the authorization fields as a query in the body of the request.
Path Param – The bot expects the authorization fields as part of the URL path for the request. - In the Field Key field, enter the name of the field for the selected Field Type.
- In the Field Value field, enter the value for the Field Key specified.
- Click Done. The new authorization field is added in the Authorization Fields section.
- To add additional authorization fields, click Add in the Authorization Fields section.
- In the Authorization Check URL field, optionally define a URL that is used to test the authentication settings from Bot Builder before you deploy the task with the authorization mechanism. You can use dynamic fields, path parameter fields, query fields, and so forth, to define the test URL, for example, https://kore.someCompany.com/sap/opu/odata/sap/{{authfield1}}/?$format=json
- In the Access Using a Connector section, select Yes to enable access for Kore.ai Bots using the Kore.ai Connector agent. If your domain does not have any active Kore.ai Connectors defined, a warning message is displayed to contact the Bots Admin Console system, administrator. For more information, refer to Using the Kore.ai Connector in the Bots Admin Console documentation.
- Click Save to save the authorization settings and close the New Authorization Mechanism dialog.
Testing
After you save the authentication, if you have defined an Authorization Check URL for your new authorization type, you can test your authorization definition on the Authorization tab.
- Click Test Authorization before continuing to develop the remaining steps of your task.
- After you click Test Authorization, the Test Authorization window is displayed and populated with the URL you specified in the Authorization Check URL section, as shown in the following illustration.
To configure the Test Authorization – Basic Auth, follow the below steps:
- In the Auth Check URL field, verify or enter the URL to test the authentication configuration.
- If your bot uses subdomains, the Tenancy field is displayed and you must specify the tenant.
- Enter your User Name and Password for the web service.
- Select the content type expected for the URL in the Content-Type field.
- For testing the URL, the Method field is read-only and set to GET.
- Click Test to begin the authorization test.
When the validation of authentication is complete, the Test Authorization window is closed and the results of the validation, either success or failure, is displayed to the immediate right of the Test Authorization button as shown in the following illustration.
If the authorization fails, the Auth Test Failed message is displayed along with the Headers and Response tabs as shown in the following illustration.
How it all Works
When basic authorization is used for a task, the Kore.ai application automatically prompts the user for login credentials to access the web application or web service as shown in the following illustration.
After the end-user is authorized, the settings are saved using the following naming syntax:
{{ First Name }} {{ Last Name }} {{ Bot Name }} {{ Account # }} {{ Sequence # }}
For example, John Smith’s Twitter Account #1.
The Kore.ai application can access the web application or web service for all future task requests using this account. In addition, the end-user can reuse the account for other tasks for the same Bot.