統合を公開するための要件

統合の要件

Python 3.7 - すべての統合を Python 3.7 で開発することをおすすめします。
統合の説明 - 統合に選択したプロダクトの説明を含める必要があります。
アイコン
- SVG アイコン – 各統合は、プラットフォーム内のすべての統合アイコンに影響する SVG アイコンで公開する必要があります。
- PNG アイコン – 各統合には、Chronicle Marketplace で公開される画像として表示される PNG アイコンも含める必要があります。
統合カテゴリ – 統合カテゴリを定義して、他のユーザーが Chronicle Marketplace の統合をカテゴリでフィルタリングできるようにすることをおすすめします（Chronicle Marketplace のリストからカテゴリのいずれかを選択できます）。
依存関係 - 外部ライブラリを使用する必要がある場合は、統合設定で依存関係を追加します。
統合パラメータ – 各統合には、パラメータの説明など、プロダクトを正常に統合するために必要なパラメータを含める必要があります。
マネージャー – コードの再利用を避けるため、統合にマネージャーを追加することをおすすめします。マネージャーは、統合内にある他のすべてのスクリプトから参照できる Python ファイルです。
Ping アクション – ping アクションは、プロダクトへの正常な接続をテストするために必要なアクションです。接続に成功した場合、アクションの結果値は true になります。このアクションは、ハンドブックで使用されているアクションではないため、無効にする必要があります。
Linux - 統合では Centos OS 7 以降をサポートする必要があります。

アクションの要件

アクションの説明 – 各アクションに、アクションの機能を説明する記述を含める必要があります。
アクションの構造 - 新しいアクションを作成する場合は、IDE に表示されるテンプレートに従うことをおすすめします。
アクションパラメータ – 各アクションには、そのアクションに関連するパラメータ（パラメータの説明の記述を含む）を含める必要があります。アクションの要件に応じたパラメータの型と一致していることを確認してください。
アラートのコンテキストでのアクションの実行 - アラートのコンテキストでアクションを作成することをおすすめします。つまり、このロジックを適用して、URL エンティティなど特定のエンティティスコープでアクションを実行できるようにします。これを行うには、siemplify.target_entities メソッドを使用して、アクションを実行する際に選択したスコープ内のすべてのターゲットエンティティのリストを返します。実装例について詳しくは、My first Action をご覧ください。
JSON 結果 - データを返すアクションの場合、アクションは関数 add_result_json を使用して JSON 結果を返します。
JSON の例を追加する - 統合を使用してハンドブックを作成する際に、式ビルダーで使用できる JSON の例を追加することをおすすめします。これを行うには、IDE で JSON アイコンをクリックして、JSON のサンプルをインポートします。
エンティティを拡充する – アクションに拡充が関連する場合は、アクションに拡充ステップを追加して、統合したプロダクトからのデータを使用してエンティティを拡充することをおすすめします。拡充フィールドキーに接頭辞を追加することを強くおすすめします。
たとえば、次のデータでエンティティを拡充するとします。
entity_enrichment = {"first_name":"First Name", "last_name":"Last Name"}
まず、辞書がネストされておらず、その中の階層は 1 つだけであることを確認します。
次に、プロダクト名を接頭辞として追加します。
たとえば、次のコードでは、拡充アクションによって追加された新しいフィールドに接頭辞「Zoom」を追加しています。
entity_enrichment=add_prefix_to_dict(entity_enrichment, "Zoom")
次に、メソッドを使用して特定のエンティティの追加プロパティを更新します。entity.additional_properties.update(entity_enrichment)
エンティティの追加プロパティが更新されたら、次のメソッドを使用して、それらをアラートに追加します。siemplify.update_entities(enriched_entities)
エンティティをクリックすると、その詳細が表示されます。
ロギング - 特に複雑なアクションでは、ログを追加することが非常に重要です。すべての例外またはエラーは、情報、警告、エラー、例外など、適切なレベルでログに記録される必要があります。