コミュニティライブラリのベストプラクティス

このページは機械翻訳により提供されています。翻訳内容と英語版に相違がある場合は、英語版が優先されます。

これらのベストプラクティスに従って、ワークフローでコミュニティアセットを効果的に使用および共有します。

アセットのインストール

コミュニティからプラットフォームアセットをインストールする際は、次のベストプラクティスを使用することをお勧めします:

  • アセットメトリクスの評価:インストール総数や重要なビルダー統計など、アセットランディングページのメトリクスを確認してアセットを評価します。

  • アセットのコードまたはワークフローロジックの評価:コネクターをワークスペースにリリースする前に、必ずコネクターのコードの品質を評価します。 コネクターをリリースすると、ワークスペース内の誰でもレシピでそのコネクターを使用できるようになるため、機能と安全性を十分にテストしてください。 同様に、コミュニティレシピをワークスペースで使用する前に、基盤となるワークフローロジックを必ず評価してください。

  • アセットのテスト:アセットをリリースする前、またはワークスペースで広く使用する前に、アセットをテストしてください。 コミュニティコネクターの機能とセキュリティは、ツール > Connector SDK > Source codeにあるWorkatoのテストコードタブでテストできます。 同様に、コミュニティレシピをワークスペースで使用する前に、カスタマイズして十分にテストすることをお勧めします。

  • Workatoリソースの使用:コミュニティからダウンロードしたアセットを使用する連携でエラーが発生した場合は、ガイダンスについてWorkatoサポートにお問い合わせください。 サポートチームは障害発生箇所を評価し、説明を求めてアセット開発者に連絡することもできます。

アセットのアップロード

アセットをコミュニティで共有する際は、次のベストプラクティスを使用することをお勧めします:

  • ソースコードから機密情報を除去する: オープンソースコネクターを掲載する場合は、OAuthクライアントID、シークレット、APIキーなど、ハードコードされた認証情報を削除する必要があります。 ユーザーがコネクターをインストールしてコードを表示すると、これらの値が公開されます。 値をハードコードするのではなく、すべてのコネクタータイプで入力フィールドを使用してユーザーから機密データを収集します。

  • アセットの掲載をカスタマイズする: 明確なロゴ、説明、タグを使用して、アセットの目的と機能を正確に伝えます。

  • 情報コンテンツを準備する: アセットに関する情報コンテンツを提供し、ユーザーが成功できるようにします。 コネクターのアクションとトリガーにドキュメントへのリンクを配置できます。 また、コネクターを掲載する際に直接インストールを防止を有効にした場合、リンク先のランディングページでは、コネクターを紹介し、ユーザーが問い合わせる方法を強調し、プライベート共有リンクへの明確な経路を提供する必要があります。

  • 連絡先情報を提供する: コミュニティプロフィールに連絡先メールアドレスまたはWebサイトを含め、ユーザーがアセットに関する質問を問い合わせられるようにします。 この情報はワークスペース管理者ページで更新できます。

  • コミュニティレシピを提供する: ユーザーが使い始めやすいように、コミュニティコネクター用のレシピをアップロードします。

  • ソースコードの表示設定を確認する: クローズドソースコネクターを公開する場合は、公開前にソースコードが非表示に設定されていることを確認してください。 コネクターがコミュニティに掲載されると、この設定はロックされます。

Last updated: