InsScheduledAutomatedTransitionService:scheduleAutomatedTransition

クラス: InsScheduledAutomatedTransitionService

方法: scheduleAutomatedTransition

操作手順

この移行は Vlocity State Model ワークフロー用です。複雑なスケジュールパターン (2 日ごと、毎月第 1 月曜日など) はサポートされません。

1. objectName と fieldName (および省略可能な typeName と typeValue) の入力により、ワークフローを表す特定の Vlocity State Model Version が決定されます。

2. fromState と toState の入力により、そのワークフロー内 (つまり前のステップの Vlocity State Model Version 内) の特定の Vlocity State Transition が決定されます。スケジュールの入力により、「fromState」から「toState」への自動状態遷移を実行する Salesforce スケジュール済みジョブを実行する頻度とタイミングに関する情報が提供されます。スケジュール済みジョブが実行されるたびに、次のアクションが実行されます。

   1. 「objectName」で表される種別のインスタンスを最大 5 件取得します。「fieldName」で表される項目の値 = 「fromState」で表される値。これにより、現在「fromState」で表される状態になっているオブジェクトインスタンスのみがトランジションを実行するために選択されます。

   2. 指定された Vlocity State Transition (上記のステップ 2 で決定) の設定済みのすべての Vlocity State Transition ルールが実行されます。

   3. ルール実行の全体的な結果 ([Vlocity State Transition (Vlocity 状態遷移)] で設定された [Transition Completion Criteria (トランジション完了条件)] によって管理される) が true の場合 (渡されたルール実行など)、オブジェクトインスタンスの状態は状態に更新され、「toState」で表されます。

   4. ルール実行の全体的な結果が false の場合、つまりルールの実行に失敗した場合、オブジェクトインスタンスの状態は [Vlocity State Transition (Vlocity 状態遷移)] で設定された [Alternate state (代替状態)] に更新されます (存在する場合)。

   5. オブジェクトインスタンスの状態が新しい状態 (指定された遷移の「toState」または「Alternate state」のいずれか) に更新されると、その状態 (Vlocity Action の [To State] 項目など) に設定された対応する Vlocity Action が実行されます。

   6. 状態が「toState」に更新されたオブジェクトインスタンスの数は、「noOfUpdatedRecords」で返されます。状態が Alternate 状態に更新されたオブジェクトインスタンスの数は、「noOfUpdatedRecordsToAlternateStates」で返されます。

   7. 遷移が実行されなかった場合、オブジェクトインスタンスは「fromState」のままです。

入力:

入力	説明
objectName	必須。 オブジェクト API 参照名
fieldName	必須。 都道府県値をホストする項目 API 参照名。
fromState	必須。 状態遷移の [From State (origin)] 項目値。
toState	必須。 状態遷移の To State (target) 項目値。
typeName	省略可能。 は、Vlocity State Model のtypeFieldName_c項目の値をtypeName 表します。これは、特定の Vlocity State Model インスタンスが設定されている別のオブジェクトの項目の名前です。たとえば、オブジェクト「Application__c」の「Type__c」項目として設定できます。
typeValue	省略可能。 は、Vlocity State Model のtypeFieldValue_c項目の値をtypeValue表します。これは、「typeName」入力で表される項目の特定の値です。<typeName, typeValue> の組み合わせは、特定の Vlocity State Model を選択するために使用します。 メモ たとえば、typeName = 'Type__c' および typeValue = 'Individual Provider' の場合、Application__c オブジェクトに設定された特定の Vlocity State Model が使用されます。
schedule	切り替えを実行するタイミングをスケジュールするためのpattern、startTime、およびdayOfTheWeekキー (下記を参照) を含む対応付けオブジェクト。
schedule.pattern	必須。 文字列値 HOURLY、DAILY、または WEEKLY。
schedule.startTime	形式: HH:MM, military time. schedule.pattern = HOURLY の場合は必要ありません。
schedule.dayOfTheWeek	文字列値。 使用可能な値: SUN、MON、TUE、WED、THU、FRI、または SAT。 日数は、1 ～ 7 の数値で表すこともできます。この場合、日曜日は1、月曜日は2となります。 schedule.pattern = WEEKLY の場合は必須です。

Input JSON

毎週月曜日の 13 時 30 分にスケジュールパターンが毎週の入力 JSON の例を次に示します。

{ 
   	"objectName":"prefix__Application__c",
  	"fieldName":"prefix__Status__c",
	"fromState":"New",
	"toState":"Submitted",
	"schedule":{
		"pattern":"WEEKLY",
		"startTime":"13:30",
		"dayOfTheWeek":"MON"
	}
}

出力 JSON

出力 JSON には、更新されたレコード数 (最大 5 件) と例外が表示されます。

{
"noOfRecordsForProcessing": <Number of records for processing from a search, max=5>,
"noOfUpdatedRecords": <Number of records that have successful 'from state' to 'to state' transition>,
"noOfUpdatedRecordsToAlternateStates": <Number of records that have successful 'from state' to 'alternate state' transition>,
"errors":<Consolidated error mapping between record ID and error detail. This is null when there's no error.>
}