命名規則
他のユーザーがプロジェクトの内容、含まれるアセット、構造をすばやく理解できるように、プロジェクトおよび連携アセットには明確で一貫した命名規則を使用することをお勧めします。
特殊文字を避ける
プロジェクトおよびアセットに名前を付ける際は、次の特殊文字の使用を避けてください:
- シングルクォート (
') - ダブルクォート (
") - 絵文字
さらに、プロジェクトコードに数字を含めないでください。
プロジェクト
プロジェクトには次の命名規則を使用します:
[DEPARTMENT_CODE] [PROJECT_CODE] PROJECT_NAME次を置き換えます:
DEPARTMENT_CODE: プロジェクトを担当する部門またはチームの2文字のショートコード。 例:HR。PROJECT_CODE: プロジェクトの2~5文字の大文字アルファベットコード。 この値は通常、プロジェクト名に含まれる単語から作成した頭字語です。 数字、シングルクォート (')、ダブルクォート (")、絵文字は使用しないでください。 例:TM。PROJECT_NAME: プロジェクトの内容を表す名前。 例:Talent Management。
一意のプロジェクトコード
ワークスペース内のすべてのプロジェクトコードが一意であることを確認してください。
例
[HR] [TM] Talent Management
フォルダ
フォルダには次の命名規則を使用します:
[PROJECT_CODE] FOLDER_NAME次を置き換えます:
PROJECT_CODE: プロジェクトの2~5文字の大文字アルファベットコード。 この値は通常、プロジェクト名に含まれる単語から作成した頭字語です。 数字、シングルクォート (')、ダブルクォート (")、絵文字は使用しないでください。 例:TM。FOLDER_NAME: フォルダの内容を表す名前。 例:Resume Screening。
マニフェストを作成する際に検索しやすくするため、すべてのフォルダ名とサブフォルダ名にはプロジェクトコードを含める必要があります。
例
[TM] Resume Screening
フォルダ構造
次の構造を使用してフォルダとサブフォルダを作成します:
シンプルなプロジェクト
|-- [DEPARTMENT_CODE] [PROJECT_CODE] PROJECT_NAME
|-- [PROJECT_CODE] Functions
|-- [PROJECT_CODE] Recipesサブ機能を含む複雑なプロジェクト
|-- [DEPARTMENT_CODE] [PROJECT_CODE] PROJECT_NAME
|-- [PROJECT_CODE] SUBFUNCTION_NAME_1
|-- [PROJECT_CODE] Functions
|-- [PROJECT_CODE] Recipes
|-- [PROJECT_CODE] SUBFUNCTION_NAME_2
|-- [PROJECT_CODE] Functions
|-- [PROJECT_CODE] Recipes例
|-- [HR] [TM] Talent Management
|-- [TM] Resume Screening
|-- [TM] Functions
|-- [TM] Recipes
|-- [TM] Interview Scheduling
|-- [TM] Functions
|-- [TM] Recipes
|-- [TM] Offers
|-- [TM] Functions
|-- [TM] Recipesコネクション
コネクションには次の命名規則を使用します:
APP_NAME (USERNAME)次を置き換えます:
APP_NAME: アプリコネクターの名前。 例:Greenhouse。USERNAME: 任意。 コネクションで特定のユーザーアカウントを使用する場合のアカウントユーザー名。 例:[email protected]
コネクション名には、複数のEnvironmentで使用できるように、ライフサイクル状態(例えば、コネクションがDevelopment Environment用かプロダクションEnvironment用か)は含めないでください。
例
Greenhouse ([email protected])
レシピ
レシピには次の命名規則を使用します:
PROJECT_CODE ASSET_CODE | RECIPE_SEQUENCE_NUMBER RECIPE_NAME次を置き換えます:
PROJECT_CODE: プロジェクトの2~5文字の大文字アルファベットコード。 この値は通常、プロジェクト名に含まれる単語から作成した頭字語です。 数字、シングルクォート (')、ダブルクォート (")、絵文字は使用しないでください。 例:TM。ASSET_CODE: レシピタイプを指定する頭字語。 すべてのレシピでは、ビルダーがそのレシピをこのアセットタイプにする意図であることを確認できるよう、レシピ名にアセットタイプを含める必要があります。RECIPE_SEQUENCE_NUMBER: 任意。 レシピを順番に実行する必要がある場合は、レシピの順序を示すことができます。 これは特にボットレシピに該当しますが、レシピを順番に実行する必要がない場合は必須ではありません。RECIPE_NAME: レシピが達成する内容を伝える説明的な名前。
使用する可能性のあるさまざまなレシピタイプのラベル付けについては、次の表を参照してください:
| アセットタイプ | アセットコード | 説明 |
|---|---|---|
| レシピ | REC | 中核となるWorkatoレシピ。 |
| グローバル関数 | GF | 別のレシピによってトリガーされるレシピ。 自動化プロジェクト全体で再利用できるように設計されています。 |
| ローカル関数 | LF | 別のレシピによってトリガーされるレシピ。 同じプロジェクト内でのモジュール式Development向けに設計されています。 |
| APIエンドポイント | API | APIトリガーを持つレシピ。 |
例
[TM] REC | 1. New application detected in Greenhouse
Last updated: