コネクタービルダー提出ドキュメント
すべてのOkta WorkflowsConnectorにはユーザードキュメントが必要であり、コネクター提出の一部として添付する必要があります。Okta統合ネットワークは、Okta検証プロセスの一環としてドキュメントをチェックします。
コネクターが公開され、Okta Workflowsで利用できるようになると、ドキュメントへのアクセスレベルを設定できるようになります。
-
一般:誰もがコンテンツを表示できます。
-
Customer only(顧客のみ):コネクターのドキュメントを非公開にするには、サイトにサインイン方法を構成し、承認された顧客にのみアクセスを許可します。
要件
ドキュメントには次の内容が記載されている必要があります。
-
コネクターの構成方法と使用方法
-
コネクターのアクションカードの入出力フィールドの理解
-
1つ以上のアクションカードが含まれるフローのパフォーマンス上の問題を予測し、それに対応する方法
コネクターのドキュメントには、その内容が適用されるコネクターのバージョン番号が明示的に記載されている必要があります。コネクターの新規バージョンをリリースするときは、ドキュメントを更新し、新しいバージョン番号と新機能の概要を記載してください。
ユーザーがコネクターカードやダイアログのヘルプアイコンをクリックすると、外部でホスティングされるヘルプドキュメントへのリンクがポップアップウィンドウに表示されます。
コネクターのユーザードキュメントの形式は問われませんが、一般論として、HTML、Googleドキュメント、Microsoft Word文書、PDFのいずれかを使用してください。
ドキュメントセットでは、次のトピックがカバーされている必要があります。
- 承認
- すべてのアクションカードのヘルプトピック
- 任意のCustom API Actionカードのヘルプトピック
- オプションとして、トラブルシューティング、FAQ、コネクターとそのカード向けのその他のガイダンスのヘルプトピック