Workflow | メタデータ API 開発者ガイド

詳細は、Salesforce ヘルプの「ワークフロー」を参照してください。Metadata メタデータ型を拡張し、その fullName 項目を継承します。

マニフェストファイルを使用する場合、次のコードを使用してすべてのワークフローコンポーネントを取得します。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所

ワークフローファイルには、サフィックス .workflow が付けられます。ワークフローのある標準オブジェクトまたはカスタムオブジェクトごとに、1 つのファイルがあります。これらのファイルは、対応するパッケージの workflows ディレクトリに保存されます。

バージョン

ワークフロールールは、API バージョン 13.0 以降で使用できます。

ワークフロー

このメタデータ型は、標準オブジェクトまたはカスタムオブジェクトに関連付けられたワークフロールールおよびアクションの有効な型を表します。

項目名	項目の型	説明
alerts	WorkflowAlert[]	ワークフローに関連付けられたオブジェクトに関するすべてのアラートの配列。
fieldUpdates	WorkflowFieldUpdate[]	ワークフローに関連付けられたオブジェクトに関するすべての項目自動更新の配列。
fullName	string	API アクセスの一意の識別子として使用される開発者名。fullName には、アンダースコアと英数字のみを使用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、Metadata コンポーネントから継承されています。
knowledgePublishes	WorkflowKnowledgePublish[]	ワークフローに関連付けられている Salesforce ナレッジワークフロー公開の配列。API バージョン 27.0 以降で利用できます。
outboundMessages	WorkflowOutboundMessage[]	ワークフローに関連付けられたオブジェクトに関するすべてのアウトバウンドメッセージの配列。
rules	WorkflowRule[]	ワークフローに関連付けられてたすべてのオブジェクトの配列。
tasks	WorkflowTask[]	ワークフローに関連付けられたオブジェクトに関するすべての ToDo の配列。

WorkflowActionReference

WorkflowActionReference は、いずれかのワークフローアクションを表します。

項目名	項目の型	説明
name	string	必須。ワークフローアクションの名前。
type	WorkflowActionType (string 型の列挙)	必須。次の種別のワークフローアクションを使用できます。 `Alert` `FieldUpdate` `OutboundMessage` `Task`

WorkflowAlert

WorkflowAlert は、ワークフロールールに関連付けられたメールアラートを表します。

項目名	項目の型	説明
ccEmails	string[]	追加のメールアドレス。この項目は、メールクライアントの CC 項目に似ています。メールを正常に送信するためには、ccEmails または recipients の値を設定します。両方の項目に値を設定できます。ccEmailsの値には、最大 5 個の異なるメールアドレスを含めることができます。
description	string	必須。メールアラートの説明。API バージョン 16.0 以降で利用できます。
fullName	string	必須。API アクセスの一意の識別子として使用される開発者名。fullName には、アンダースコアと英数字のみを使用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、Metadata コンポーネントから継承されています。
protected	boolean	必須。このコンポーネントが保護されるか (`true`)、否か (`false`) を示します。保護コンポーネントは、インストールする組織で作成されたコンポーネントによってリンク設定したり参照したりすることはできません。
recipients	WorkflowEmailRecipient[]	メールの受信者。メールを正常に送信するためには、ccEmails または recipients の値を設定します。両方の項目に値を設定できます。
senderAddress	string	メールアラートの [送信者] 項目のアドレス。デフォルトの [送信者] 項目 (レコードを更新したユーザのメールアドレス) の代わりに、組織の標準のグローバルメールアドレス (`support@company.com` など) を使用できます。senderType が `OrgWideEmailAddress` に設定されている場合にのみ、この項目に値を指定できます。Salesforce ヘルプの「組織の共有メールアドレス」を参照してください。
senderType	ActionEmailSenderType (string 型の列挙)	送信者の送信者および返信先アドレスとして使用されるメール。有効な値は次のとおりです。 `CurrentUser` — レコードを更新するユーザのメールアドレス。これは、デフォルト設定です。 `DefaultWorkflowUser` — デフォルトワークフローユーザのメールアドレス。 `OrgWideEmailAddress` — `support@company.com` など、組織の検証済みグローバルメールアドレス。
template	string	必須。EmailTemplate への名前指定参照。このメールテンプレートは zip ファイル内に存在する必要はありませんが、メタデータ API には存在する必要があります。

WorkflowEmailRecipient

WorkflowEmailRecipient は、ワークフロールールに関連付けられたメールアラートの受信者を表します。

項目名	項目の型	説明
field	string	typeで参照される項目の名前。名前を指定した項目は、type で指定されている型である必要があります。
recipient	string	メールの受信者。選択した型に応じて、必須になる場合があります。
type	ActionEmailRecipientTypes (string 型の列挙)	EmailTemplate コンポーネントへの名前指定参照。有効な値は、次のとおりです。 `accountOwner` - メールはレコードの取引先所有者に送信されます (商談の取引先所有者など)。 `accountTeam` - Account オブジェクトのみに適用されます。メールはその Account の取引先チーム全員に送信されます。 `campaignMemberDerivedOwner` - 取引先責任者がキャンペーンに追加された場合、またはキャンペーンに応じて、メールがリードおよび取引先責任者所有者に送信されます。 `contactLookup` - メールは、レコードの項目から検索された値を含む取引先責任者に送信されます。この値では、`field` 項目が Contact を参照する必要があります。 `creator` - メールはレコードの作成者に送信されます。 `customerPortalOwner` - メールは特定のセルフサービスポータルユーザに送信されます。この値では、recipient 項目が User を (ユーザ名で) 参照する必要があります。セルフサービスポータルユーザのみが対象です。 `email` - メールはレコードの項目から検索された値を含むメールアドレスに送信されます。この値では、`field` 項目が email 項目を参照する必要があります。 `group` - メールはグループ内の全ユーザに送信されます。この値では、recipient 項目が group を (グループ名で) 参照する必要があります。 `opportunityTeam` - Opportunity オブジェクトのみに適用されます。メールはその Opportunity の商談チーム全員に送信されます。 `owner` - メールはレコードの所有者に送信されます。 `partnerUser` - メールは特定のパートナーユーザに送信されます。この値では、recipient 項目が User を (ユーザ名で) 参照する必要があります。パートナーユーザのみが対象です。 `portalRole` - `role` と似ていますが、ポータルロールのみが対象となります。 `portalRoleSubordinates` - `roleSubordinates` と似ていますが、ポータルロールのみが対象となります。 `role` - メールはロールの全ユーザに送信されます。この値では、recipient 項目が (ロール階層内の) Role を (ロール名で) 参照する必要があります。 `roleSubordinates` - メールは下位ロールの全ユーザに送信されます。この値では、recipient 項目が Role を参照する必要があります。 `roleSubordinatesInternal` - `roleSubordinates` と似ていますが、内部ポータルロールのみが対象となります。 `user` - メールは特定のユーザに送信されます。この値では、recipient 項目が User を (ユーザ名で) 参照する必要があります。 `userLookup` - メールはレコードの項目から検索された値を含むユーザに送信されます。この値では、`field` 項目がユーザの外部キー項目を参照する必要があります。

WorkflowFieldUpdate

WorkflowFieldUpdate は、ワークフローの項目自動更新を表します。項目自動更新を使用すると、ワークフロールールがトリガされたときに、自動的に項目値を指定した値に更新できます。

項目名	項目の型	説明
description	string	項目自動更新の説明。この情報は、項目自動更新を最初に設定したときの理由を追跡するのに役立ちます。
field	string	必須。更新する項目 (ワークフローのオブジェクト上の)。
formula	string	operation項目値が `Formula` の場合、これは新しい項目値の計算に使用される数式に設定されます。
fullName	string	必須。API アクセスの一意の識別子として使用される開発者名。fullName には、アンダースコアと英数字のみを使用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、Metadata コンポーネントから継承されています。
literalValue	string	operation項目値が `Literal` の場合、これは項目のリテラル値です。
lookupValue	string	operation 項目値が lookupValue の場合、これは参照されるルックアップ値です。
lookupValueType	LookupValueType (string 型の列挙)	lookupValue 項目値が参照するオブジェクトの種別。有効な値は、次のとおりです。 `Queue` `RecordType` `User`
name	string	必須。コンポーネントの名前。API バージョン 16.0 以降で使用できます。
notifyAssignee	boolean	必須。項目が更新された場合に割り当て先に通知します。
operation	FieldUpdateOperation (string 型の列挙)	必須。項目の更新に使用される値を計算する操作。有効な値は、次のとおりです。 `Formula` - 項目が数式に設定されることを示します。設定されている場合、数式は有効な数式である必要があります。 `Literal` - 項目がリテラル値に設定されることを示します。設定されている場合、literalValue はこの項目にとって有効なリテラル値である必要があります。 `LookupValue` - Literal と似ていますが、contact、user、account などの、オブジェクト参照用です。設定されている場合、`lookupValue` 要素を設定する必要があります。現在の API では User のみがサポートされています。 `NextValue` - 項目が次の値に設定されることを示します。これは、項目自動更新が選択リストを参照する場合にのみ許可されます。 `Null` - 項目が null に設定されることを示します。 `PreviousValue` - 項目が前の値に設定されることを示します。これは、項目自動更新が選択リストを参照する場合にのみ許可されます。
protected	boolean	必須。このコンポーネントが保護されるか (`true`)、否か (`false`) を示します。保護コンポーネントは、インストールする組織で作成されたコンポーネントによってリンク設定したり参照したりすることはできません。
reevaluateOnChange	boolean	この項目が true に設定されているときにこの項目が項目の値を更新すると、関連付けられたオブジェクトのすべてのワークフロールールが再評価されます。条件が項目値の変更結果と一致するすべてのワークフロールールがトリガされます。トリガされたワークフロールールのいずれかにより、ワークフロールールの再評価も有効にする他の項目自動更新が実行される場合、ドミノ効果が発生し、新規にトリガされた項目自動更新の結果としてより多くのワークフロールールを再評価できます。このワーフロールールの再評価およびトリガのカスケードは、それを開始した最初の項目自動更新の後、最大 5 回実行できます。
targetObject	string	これは、子レコードで変更が検出された場合に設定されます。これが設定されている場合、親 (Case など) を指し示す子オブジェクト (`EmailMessage.ParentId` など) の外部キー参照を指し示します。設定されると、数式は子オブジェクト (`EmailMessage` など) に基づきます。この項目は、バージョン 14.0 より前では sourceField という名前です。項目名の変更は、バージョン間で自動的に処理され、既存の XML コンポーネントファイルを手動で編集する必要はありません。

WorkflowKnowledgePublish

WorkflowKnowledgePublish は、Salesforce ナレッジ記事の公開アクションおよび情報を表します。API バージョン 27.0 以降で利用できます。

項目名	項目の型	説明
action	KnowledgeWorkflowAction (string 型の列挙)	このルールが起動したときに実行可能な記事の公開アクション。有効な値は、次のとおりです。 `PublishAsNew`: 記事を新規記事として公開します。 `Publish`: 記事を公開済み記事のバージョンとして公開します。
description	string	簡単な記事の説明。
label	string	Salesforceユーザインターフェース全体で記事を表す表示ラベル。
language	string	記事の言語。
protected	boolean	必須。このコンポーネントが保護されるか (`true`)、否か (`false`) を示します。保護コンポーネントは、インストールする組織で作成されたコンポーネントによってリンク設定したり参照したりすることはできません。

WorkflowOutboundMessage

WorkflowOutboundMessage は、ワークフロールールに関連付けられたアウトバウンドメッセージを表します。アウトバウンドメッセージは、外部サービスなどの指定したエンドポイントに指定の情報を送信するワークフローおよび承認アクションです。アウトバウンドメッセージは、エンドポイントに対し、特定の項目内のデータを SOAP メッセージとして送信します。詳細は、Salesforce ヘルプの「アウトバウンドメッセージアクション」を参照してください。

項目名	項目の型	説明
apiVersion	double	必須。アウトバウンドメッセージの API バージョン。アウトバウンドメッセージが作成されると、自動的に現在の API バージョンに設定されます。アウトバウンドメッセージの有効な API バージョンは 8.0 および 18.0 以降です。この API バージョンは、Enterprise または Partner WSDL を使用した Salesforce への API コールバックで使用されます。[API バージョン] は、メタデータ API を使用してのみ変更できます。Salesforceユーザインターフェースを使用して変更することはできません。この項目は、API バージョン 18.0 以降で使用できます。 apiVersionを、アウトバウンドメッセージに設定された fields のいずれもサポートしていないバージョンに変更した場合、更新された WSDL を消費するようにアウトバウンドメッセージリスナーを更新するまでメッセージは失敗します。アウトバウンドメッセージの状況を監視するには、[設定] から [クイック検索] ボックスに`「アウトバウンドメッセージ」`と入力し、Salesforce で [アウトバウンドメッセージ] を選択します。警告
description	string	アウトバウンドメッセージを説明します。
endpointUrl	string	必須。アウトバウンドメッセージの送信先となるエンドポイント URL。
fields	string[]	送信対象の項目への名前指定参照。
fullName	string	必須。API アクセスの一意の識別子として使用される開発者名。fullName には、アンダースコアと英数字のみを使用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、Metadata コンポーネントから継承されています。
includeSessionId	boolean	必須。アウトバウンドメッセージに Salesforce セッション ID を含める場合は設定します。API コール発行の予定があり、ユーザ名とパスワードを含めたくない場合に便利です。
integrationUser	string	必須。このメッセージの送信者となるユーザへの名前指定参照。
name	string	必須。コンポーネントの名前。API バージョン 16.0 以降で使用できます。
protected	boolean	必須。このコンポーネントが保護されるか (`true`)、否か (`false`) を示します。保護コンポーネントは、インストールする組織で作成されたコンポーネントによってリンク設定したり参照したりすることはできません。
useDeadLetterQueue	boolean	この項目は、配信不能メッセージキュー権限が有効な組織でのみ使用できます。設定されている場合、このアウトバウンドメッセージは、通常の配信が失敗した場合に配信不能メッセージキューを使用します。

WorkflowRule

このメタデータ型はワークフロールールを表します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。

項目名	項目の型	説明
actions	WorkflowActionReference[]	このルールが起動したら実行する必要があるアクションの参照の配列。
active	boolean	必須。このルールが有効かどうかを決定します。
booleanFilter	string	高度な検索条件の boolean 数式 (`(1 AND 2) OR 3` など) です。
criteriaItems	FilterItem[]	このルールを起動する boolean 条件の配列。この項目か、formula のいずれかが設定されている必要があります。
description	string	ワークフロールールの説明。
formula	string	このルールが最初に (この項目か criteriaItems に) 設定されている必要がある数式条件。
fullName	string	API アクセスの一意の識別子として使用される開発者名。fullName には、アンダースコアと英数字のみを使用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、Metadata コンポーネントから継承されています。
triggerType	WorkflowTriggerTypes (string 型の列挙)	トリガが起動する条件。有効な値は、次のとおりです。 `onAllChanges` - すべての変更でワークフロールールが考慮されます。 `onCreateOnly` - 作成でのみワークフロールールが考慮されます。 `onCreateOrTriggeringUpdate` - 作成およびトリガする更新でのみワークフロールールが考慮されます。
workflowTimeTriggers	WorkflowTimeTrigger	指定間隔の前/後に実行する一連のワークフローアクション (項目自動更新、メールアラート、アウトバウンドメッセージ、ToDo) を表します。

WorkflowTask

このメタデータ型は、割り当てられたワークフロー ToDo を参照します。

項目名	項目の型	説明
assignedTo	string	ワークフロールールまたはアクションが割り当てられているユーザ、ロール、またはチームを指定します。ここで指定した値に対応する項目は、指定された assignedToType と同じである必要があります。
assignedToType	ActionTaskAssignedToTypes (string 型の列挙)	この型の有効な string 値は次のとおりです。 `accountCreator` - 設定した場合、ToDo はレコードの取引先の作成者に割り当てられます。 `accountOwner` - 設定した場合、ToDo はレコードの取引先の所有者 (Opportunity) に割り当てられます。 `accountTeam` - WorkflowAlert 型と同じです。 `creator` - 設定した場合、ToDo はレコードの作成者に割り当てられます。 `opportunityTeam` - WorkflowAlert 型と同じです。 `owner` - 設定した場合、ToDo はレコードの所有者に割り当てられます。 `partnerUser` - 設定した場合、assignedTo 項目は User を (ユーザ名で) 参照します。パートナーユーザが対象です。 `portalRole` - 設定した場合、assignedTo 項目は Role を (ロール名で) 参照します。ポータルロールが対象です。 `role` - 設定した場合、assignedTo 項目は Role を (ロール名で) 参照します。 `user` - 設定した場合、assignedTo 項目は User を (ユーザ名で) 参照します。
description	string	このワークフロー ToDo の説明。
dueDateOffset	int	必須。トリガ日または (省略可能な) offsetFromField で指定された日付からのオフセット (日数)。負の数値を設定できます。
fullName	string	必須。API アクセスの一意の識別子として使用される開発者名。fullName には、アンダースコアと英数字のみを使用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、Metadata コンポーネントから継承されています。
notifyAssignee	boolean	必須。ToDo が割り当てられたときにメール通知を送信する場合に設定します。
offsetFromField	string	`dueDate`の計算の基準となる date 項目の項目参照 (省略可能)。
priority	string	必須。作成された ToDo に割り当てる優先度。
protected	boolean	必須。このコンポーネントが保護されるか (`true`)、否か (`false`) を示します。保護コンポーネントは、インストールする組織で作成されたコンポーネントによってリンク設定したり参照したりすることはできません。
status	string	必須。作成した ToDo を割り当てる状況。
subject	string	必須。ワークフロー ToDo の件名。ToDo が割り当てられたときにメール通知を送信する場合に使用されます。API バージョン 16.0 以降で利用できます。

WorkflowTimeTrigger

指定間隔の前/後に実行する一連のワークフローアクション (項目自動更新、メールアラート、アウトバウンドメッセージ、ToDo) を表します。

項目名	項目の型	説明
actions	WorkflowActionReference[]	このトリガが起動した場合に実行するアクションの参照の配列。
offsetFromField	string	時間ベースのワークフローがトリガされる基準となる date 型の項目名 ([作成日]、[最終更新日]、[ルール適用日])、またはワークフロールールが定義されている、オブジェクトのカスタム日付項目。
timeLength	string	ワークフローをトリガした後/トリガする前の時間 (数値)。負の値は、トリガが起動する前の時間の長さを表します。timeLengthは、workflowTimeTriggerUnit で指定される時間または日のいずれかで測定されます。
workflowTimeTriggerUnit	WorkflowTimeUnits (string 型の列挙)	時間ベースのワークフローがトリガされる前または後の時間の単位。有効な string 値は次のとおりです。 `Hours` `Days`

宣言的なメタデータの定義のサンプル

ワークフロールールの定義を次に示します。

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。