InsScheduledAutomatedTransitionService:scheduleAutomatedTransition

Classe: InsScheduledAutomatedTransitionService

Méthode : scheduleAutomatedTransition

Fonctionnement

Cette transition concerne les workflows Vlocity State Model. Les schémas de planification complexes (tous les deux jours, tous les premiers lundis du mois, etc.) ne sont pas pris en charge.

1. Avec les entrées objectName et fieldName (et les entrées facultatives typeName et typeValue), la version spécifique du modèle d'état Vlocity qui représente le workflow est déterminée.

2. Avec les entrées fromState et toState, la Transition vers l'état Vlocity spécifique dans ce workflow, c'est-à-dire dans la Version du modèle d'état Vlocity de l'étape précédente, est déterminée. Les entrées de planification fournissent des informations sur la fréquence et la date d'exécution d'une tâche planifiée Salesforce qui effectuerait la transition d'état automatisée, depuis 'fromState' vers 'toState'. Chaque fois que la tâche planifiée est exécutée, elle exécute les actions suivantes :

   1. Récupérez jusqu'à 5 instances du type représenté par 'objectName', où la valeur du champ représenté par 'fieldName' = la valeur représentée par 'fromState'. Cela garantit que seules les instances d'objet actuellement à l'état représenté par 'fromState' sont sélectionnées pour effectuer la transition.

   2. Toutes les règles de Transition d'état Vlocity configurées pour la Transition d'état Vlocity spécifiée (déterminée à l'étape 2 ci-dessus) sont exécutées.

   3. Si le résultat global de l'exécution de la règle (qui est régi par l'ensemble Critères de réalisation de la transition dans Transition vers l'état Vlocity) est vrai, par exemple l'exécution de la règle réussie, l'état de l'instance de l'objet est mis à jour sur l'état et représenté par 'toState'.

   4. Si le résultat global de l'exécution de la règle est false, c'est-à-dire que l'exécution de la règle a échoué, l'état de l'instance de l'objet est mis à jour sur l'état Alternate configuré dans la Transition de l'état Vlocity s'il existe.

   5. Si l'état de l'instance de l'objet est mis à jour vers un nouvel état (état 'toState' ou Alternate pour la Transition spécifiée), les actions Vlocity correspondantes configurées pour cet état (c'est-à-dire le champ 'To State' dans Action Vlocity) sont exécutées.

   6. Le nombre d'instances d'objet dont l'état a été mis à jour sur 'toState' est renvoyé dans 'noOfUpdatedRecords'. Le nombre d'instances d'objet dont l'état a été mis à jour sur l'état Alternate est renvoyé dans 'noOfUpdatedRecordsToAlternateStates'.

   7. Si aucune transition n'a été effectuée, l'instance de l'objet reste dans 'fromState'.

Entrées

Entrée	Description
objectName	Obligatoire. Nom d'API de l'objet
fieldName	Obligatoire. Nom d'API du champ qui héberge la valeur state.
fromState	Obligatoire. De la valeur de champ État (origine) de la transition d'état.
toState	Obligatoire. Valeur du champ État (cible) de la transition d'état.
typeName	Facultatif. typeName représente la valeur dutypeFieldName_c champ de Vlocity State Model. Il correspond au nom d'un champ d'un autre objet pour lequel une instance Vlocity State Model donnée est configurée. Par exemple, il peut être défini en tant que champ 'Type__c' pour l'objet 'Application__c'.
typeValue	Facultatif. typeValuereprésente la valeur dutypeFieldValue_c champ de Vlocity State Model. Il s'agit d'une valeur spécifique pour le champ représenté par l'entrée 'typeName'. La combinaison de <typeName, typeValue> est utilisée pour sélectionner un modèle d'état Vlocity spécifique. Remarque Par exemple, avec typeName = 'Type__c' et typeValue = 'Individual Provider', un modèle d'état Vlocity spécifique configuré pour l'objet Application__c sera utilisé.
schedule	Un objet carte qui contient des clés de pattern, de startTime et de dayOfTheWeek (voir ci-dessous) pour planifier l'exécution de la transition.
schedule.pattern	Obligatoire. Valeur de chaîne HOURLY, DAILY, ou WEEKLY.
schedule.startTime	Format : HH:MM, heure militaire. Pas obligatoire si schedule.pattern = HOURLY.
schedule.dayOfTheWeek	Valeur de chaîne. Valeurs acceptables : SUN, MON,TUE, WED, THU, FRI ou SAT. Les jours peuvent également être représentés numériquement, de 1 à 7, où Dimanche = 1, Lundi = 2, etc. Obligatoire si schedule.pattern = WEEKLY.

JSON d'entrée

Voici un exemple de JSON d'entrée dont le schéma de planification est hebdomadaire à 13h30 tous les lundis :

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

JSON de sortie

Le JSON de sortie affiche le nombre d'enregistrements mis à jour (maximum cinq) et répertorie toutes les exceptions.

{
"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.>
}